diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--extensions/auth-file.lua (renamed from extensions/file-authentication.lua)17
1 file changed, 15 insertions, 2 deletions
diff --git a/extensions/file-authentication.lua b/extensions/auth-file.lua
index 0248804..1f435c6 100644
--- a/extensions/file-authentication.lua
+++ b/extensions/auth-file.lua
@@ -1,6 +1,19 @@
--- This script may be used with the auth-filter.
+-- cgit auth-filter that gates repositories behind a login form and a
+-- signed session cookie.
--
--- Requirements:
+-- This is the FILE-BACKED variant. The user accounts, the groups, and
+-- the per-repository access lists are read from files on disk. Set their
+-- paths below and edit those files without touching this script. This
+-- suits larger or externally managed user sets.
+--
+-- The companion auth-inline.lua behaves identically but keeps its
+-- accounts and access lists inline in the script itself, which suits a
+-- small fixed set of users.
+--
+-- Enable it in cgitrc with
+-- auth-filter=lua:/path/to/auth-file.lua
+--
+-- Requirements
-- luaossl
-- <http://25thandclement.com/~william/projects/luaossl.html>
-- luaposix