Changes between Version 1 and Version 2 of Bookmarks Project/Authentication


Ignore:
Timestamp:
02/18/16 23:17:40 (9 years ago)
Author:
peter
Comment:

as of [116/bookmarks], the digest_key is generated automatically if not present in the server.yml; added config reference section

Legend:

Unmodified
Added
Removed
Modified

  • Bookmarks Project/Authentication

    v1 v2  
    77# default realm is "Bookmarks"; uncomment and change if you want to use something different 
    88#realm: Bookmarks 
    9 digest_key: secret 
    109}}} 
    11  
    12 Replace the `digest_key` "secret" with an appropriately random string. This is the secret that is used to generate the digest nonce; see [perldoc:Plack::Middleware::Auth::Digest] for more info. 
    1310 
    1411The `htdigest` file can be created using the `htdigest` utility: 
    … …  
    1916 
    2017The `htdigest` utility comes with the Apache webserver, or in the `apache2-utils` package if you don't have the full Apache and don't want to install it. The realm you use in the digest file ''must'' match the `realm` configuration setting ("Bookmarks" by default). See the [https://httpd.apache.org/docs/2.2/programs/htdigest.html Apache docs] for more info. 
     18 
     19== Configuration Setting Reference == 
     20 
     21    auth:: Set to a true value to enable authentication on non-GET requests. 
     22    htdigest:: Path to the htdigest credentials file. Relative paths are interpreted relative to the `server_root` location. Required if `auth` is set. 
     23    digest_key:: ''(Optional)'' Secret used during digest authentication. If not provided, one is generated at server startup using [perldoc:Bytes::Random::Secure].