Add README.md

netauth · Feb 24, 2022 · 3a8185f · 3a8185f
1 parent 47d9665
commit 3a8185f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# sftpgo-hook
+
+This is a hook as described in the SFTPGo documentation for [external
+authentication](https://github.com/drakkan/sftpgo/blob/main/docs/external-auth.md)
+that allows you to validate your SFTPGo users via NetAuth.
+
+It can be enabled by configuring the following environment variables:
+
+```
+SFTPGO_DATA_PROVIDER__EXTERNAL_AUTH_HOOK=/absolute/path/to/sftpgo-hook
+SFTPGO_NETAUTH_HOMEDIR=/base/path/for/netauth/users/
+```