steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document webapps.user-admin

db4
Slava Pestov 2008-11-16 08:39:18 -06:00
parent 2d561ade79
commit 9e23fe2df4
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
extra/webapps/user-admin/user-admin-docs.factor Normal file
View File

@ -0,0 +1,22 @@
USING: help.markup help.syntax db strings ;
IN: webapps.user-admin
HELP: <user-admin>
{ $values { "responder" "a new responder" } }
{ $description "Creates a new instance of the user admin tool. This tool must be added to an authentication realm, and access is restricted to users having the " { $link can-administer-users? } " capability." } ;
HELP: can-administer-users?
{ $description "A user capability. Users having this capability may use the " { $link user-admin } " tool." }
{ $notes "See " { $link "furnace.auth.capabilities" } " for information about capabilities." } ;
HELP: make-admin
{ $values { "username" string } }
{ $description "Makes an existing user into an administrator by giving them the " { $link can-administer-users? } " capability, thus allowing them to use the user admin tool." } ;
ARTICLE: "furnace.auth.user-admin" "Furnace user administration tool"
"The " { $vocab-link "webapps.user-admin" } " vocabulary implements a web application for adding, removing and editing users in authentication realms that use " { $link "furnace.auth.providers.db" } "."
{ $subsection <user-admin> }
"Access to the web app itself is protected, and only users having an administrative capability can access it:"
{ $subsection can-administer-users? }
"To make an existing user an administrator, call the following word in a " { $link with-db } " scope:"
{ $subsection make-admin } ;