Documentation would be much appreciated

[MirjamSchr]

Hi,

thank you for developing useful SFTP integration tools for iRODS. However, I would appreciate it if the most important parts of the documentation for these packages were included in the README. What exactly is the package for? How can I install it? How to configure it? Are there any restrictions on using the package or do I need additional packages or are there packages that extend the functionality?

Creating documentation in this direction would be extremely helpful and opens up the possibility that the code can also be further developed by me and others.

Thanks!

[iychoi]

This is an external authentication module for SFTPGo (https://github.com/cyverse/sftpgo).

You need to setup SFTPGo first and configure it to use this external authentication module to allow users to authenticate using iRODS credentials.

Checkout this doc for details.
https://github.com/cyverse/sftpgo/blob/main/docs/external-auth.md

I'll try to add detailed documentation sometime later, but I can't guarantee as I have too many things to work on.