From 3a8185f5130dc34da4e4a0b12fc1da99f0b61d43 Mon Sep 17 00:00:00 2001
From: Michael Aldridge <aldridge.mac@gmail.com>
Date: Thu, 24 Feb 2022 15:35:22 -0600
Subject: [PATCH] Add README.md

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ae9a535
--- /dev/null
+++ 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/
+```