Changeset d2c5a74


Ignore:
Timestamp:
07/27/09 18:27:57 (5 years ago)
Author:
Antti-Juhani Kaijanaho <antti-juhani@…>
Branches:
master
Children:
2447606
Parents:
203105d
git-author:
Antti-Juhani Kaijanaho <antti-juhani@…> (07/27/09 18:27:57)
git-committer:
Antti-Juhani Kaijanaho <antti-juhani@…> (07/27/09 18:27:57)
Message:

README update

Signed-off-by: Antti-Juhani Kaijanaho <antti-juhani@…>

File:
1 edited

Legend:

Unmodified
Added
Removed
  • README

    rc759c32 rd2c5a74  
    88and providing the others as bolted-on gateways. 
    99 
    10 Currently only NNTP access is implemented, but that much is 
    11 essentially fully functional.  HTTP access is under development. 
     10Currently NNTP access is implemented and essentially fully functional. 
     11HTTPS access provides basic functionality.  HTTPS administration is 
     12lacking, and is under development. 
    1213 
    1314 
     
    9192certificate is certified by the certification immediately after it). 
    9293 
     94The options --log-http, --log-nntp and --log-smtp take one argument 
     95each (a boolean), and all default to false.  If true, then the 
     96corresponding protocol is extensively logged.  Do note the privacy 
     97implications. 
    9398 
    94                             User database 
     99The option --vm-limit allows you to specify a virtual memory ulimit 
     100for the Alue process, in order to protect the host system from runaway 
     101allocation bugs in Alue (none currently known, but they have 
     102occasionally manifested during development testing). 
    95103 
    96 The user database should be put in the file users.db in the current 
    97 directory.  It is a line-oriented file, each line defining one user. 
    98 The format of the line is 
     104The option --include-dir specifies the directory where the HTML and 
     105email template files reside.  The option --files-dir specifies the 
     106directory where files like CSS stylesheets and images (to be served 
     107verbatim by the HTTPS system) are located. 
    99108 
    100    <username> <password> <realname> <email> <allow_cleartext> <allow_post> 
     109The option --operator-email specifies an email address through which 
     110the operator is reachable.  This address will be used in 
     111Alue-generated emails. 
    101112 
    102 The fields are separated by linear whitespace.  The password is stored 
    103 in the clear.  The field allow_cleartext is 0 if the user may only use 
    104 eir password in a secure session (SSL/TLS), and 1 otherwise.  The 
    105 field allow_post is 1 if the user is authorized to post, and 0 
    106 otherwise.  (Unauthenticated users are not allowed to post.)  Realname 
    107 must be percent-encoded (and particularly every space must be encoded 
    108 as %20). 
     113                           Central database 
    109114 
    110 Alue can be instructed to reread the user database by sending it the 
    111 SIGHUP signal. 
    112  
    113  
    114                            Message database 
    115  
    116 The message database is located in the file alue.db2 in the current 
    117 directory.  Its format is described in the file db/FORMAT.txt.  In 
    118 addition to messages, it also stores information about groups. 
     115The central database is located in the file alue.db2 in the current 
     116directory.  Its format is described in the file db/FORMAT.txt. It 
     117stores messages as well as information about groups and users. 
    119118 
    120119 
Note: See TracChangeset for help on using the changeset viewer.