Merge commit 'upstream/master'

[git.ikiwiki.info.git] / doc / plugins / contrib / unixauth.mdwn

diff --git a/doc/plugins/contrib/unixauth.mdwn b/doc/plugins/contrib/unixauth.mdwn
index 2de6fc51fdda01402400a67146304449c1054c4d..d91ed45f1c791e7c7bf23a2912df2adae5b947fb 100644 (file)
--- a/doc/plugins/contrib/unixauth.mdwn
+++ b/doc/plugins/contrib/unixauth.mdwn
@@ -47,6 +47,7 @@ __Security__: [As with passwordauth](/security/#index14h2), be wary of sending u
     use IkiWiki 2.00;
     
     sub import { #{{{
     use IkiWiki 2.00;
     
     sub import { #{{{

+        hook(type => "getsetup", id => "unixauth", call => \&getsetup);

             hook(type => "formbuilder_setup", id => "unixauth",
                 call => \&formbuilder_setup);
             hook(type => "formbuilder", id => "unixauth",
             hook(type => "formbuilder_setup", id => "unixauth",
                 call => \&formbuilder_setup);
             hook(type => "formbuilder", id => "unixauth",


@@ -54,6 +55,36 @@ __Security__: [As with passwordauth](/security/#index14h2), be wary of sending u
         hook(type => "sessioncgi", id => "unixauth", call => \&sessioncgi);
     } # }}}
     
         hook(type => "sessioncgi", id => "unixauth", call => \&sessioncgi);
     } # }}}
     

+    sub getsetup () { #{{{
+        return
+        unixauth_type => {
+                type => "string",
+                example => "checkpassword",
+                description => "type of authenticator; can be 'checkpassword' or 'pwauth'",
+                safe => 0,
+                rebuild => 1,
+        },
+        unixauth_command => {
+                type => "string",
+                example => "/path/to/checkpassword",
+                description => "full path and any arguments",
+                safe => 0,
+                rebuild => 1,
+        },
+        unixauth_requiressl => {
+                type => "boolean",
+                example => "1",
+                description => "require SSL? strongly recommended",
+                safe => 0,
+                rebuild => 1,
+        },
+        plugin => {
+                description => "Unix user authentication",
+                safe => 0,
+                rebuild => 1,
+        },
+    } #}}}
+    

     # Checks if a string matches a user's password, and returns true or false.
     sub checkpassword ($$;$) { #{{{
         my $user=shift;
     # Checks if a string matches a user's password, and returns true or false.
     sub checkpassword ($$;$) { #{{{
         my $user=shift;