basis/furnace/auth/basic/basic-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: furnace.auth.basic
   3
   4 HELP: <basic-auth-realm>
   5 { $values { "responder" "a responder" } { "name" "an authentication realm name" } { "realm" basic-auth-realm } }
   6 { $description "Wraps a responder in a basic authentication realm. The realm must be configured before use; see " { $link "furnace.auth.realm-config" } "." } ;
   7
   8 HELP: basic-auth-realm
   9 { $class-description "The basic authentication realm class. Slots are described in " { $link "furnace.auth.realm-config" } "." } ;
  10
  11 ARTICLE: "furnace.auth.basic" "Basic authentication"
  12 "The " { $vocab-link "furnace.auth.basic" } " vocabulary implements HTTP basic authentication."
  13 { $subsections
  14     basic-auth-realm
  15     <basic-auth-realm>
  16 } ;
  17
  18 ABOUT: "furnace.auth.basic"