auth: have cgit calculate login address

[ps-cgit] / cgitrc.5.txt

diff --git a/cgitrc.5.txt b/cgitrc.5.txt
index c45dbd3681de8f7a258d8f84669d1bc08ca7d6d5..8eafc4a8ff4ff031d5b792236253b59ce013c890 100644 (file)
--- a/cgitrc.5.txt
+++ b/cgitrc.5.txt
@@ -645,7 +645,7 @@ source filter::
        filtered contents is expected on standard output.
 
 auth filter::
-       The authentication filter receives 11 parameters:
+       The authentication filter receives 12 parameters:
          - filter action, explained below, which specifies which action the
            filter is called for
          - http cookie
@@ -656,13 +656,15 @@ auth filter::
          - cgit repo
          - cgit page
          - cgit url
+         - cgit login url
        When the filter action is "body", this filter must write to output the
-       HTML for displaying the login form, which POSTs to "/?p=login". When
+       HTML for displaying the login form, which POSTs to the login url. When
        the filter action is "authenticate-cookie", this filter must validate
        the http cookie and return a 0 if it is invalid or 1 if it is invalid,
        in the exit code / close function. If the filter action is
        "authenticate-post", this filter receives POST'd parameters on
-       standard input, and should write to output one or more "Set-Cookie"
+       standard input, and should write a complete CGI request, preferably
+       with a 302 redirect, and write to output one or more "Set-Cookie"
        HTTP headers, each followed by a newline.
 
        Please see `filters/simple-authentication.lua` for a clear example