Mercurial > p > roundup > code
diff doc/admin_guide.txt @ 5102:96dc9f07340a
issue2161722: oudated docs
Fix old entry in FAQ, update roundup-server config docs and
example file from current roundup-server output. Update
some typos in .py files.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 26 Jun 2016 20:53:11 -0400 |
| parents | ad3d628e73f2 |
| children | 7ea6bbf4286c |
line wrap: on
line diff
--- a/doc/admin_guide.txt Sun Jun 26 20:50:06 2016 -0400 +++ b/doc/admin_guide.txt Sun Jun 26 20:53:11 2016 -0400 @@ -68,55 +68,110 @@ Configuring roundup-server ========================== -The basic configuration file layout is as follows (take from the +The basic configuration file is as follows (taken from the ``roundup-server.ini.example`` file in the "doc" directory):: - [main] - port = 8080 - ;host = - ;user = - ;group = - ;log_ip = yes - ;pidfile = - ;logfile = - ;template = - ;ssl = no - ;pem = + [main] + + # Host name of the Roundup web server instance. + # If left unconfigured (no 'host' setting) the default + # will be used. + # If empty, listen on all network interfaces. + # If you want to explicitly listen on all + # network interfaces, the address 0.0.0.0 is a more + # explicit way to achieve this, the use of an empty + # string for this purpose is deprecated and will go away + # in a future release. + # Default: localhost + host = localhost + + # Port to listen on. + # Default: 8080 + port = 8017 - [trackers] - ; Add one of these per tracker being served - name = /path/to/tracker/name + # Path to favicon.ico image file. If unset, built-in favicon.ico is used. + # The path may be either absolute or relative + # to the directory containing this config file. + # Default: favicon.ico + favicon = favicon.ico + + # User ID as which the server will answer requests. + # In order to use this option, the server must be run initially as root. + # Availability: Unix. + # Default: + user = roundup -Values ";commented out" are optional. The meaning of the various options -are as follows: + # Group ID as which the server will answer requests. + # In order to use this option, the server must be run initially as root. + # Availability: Unix. + # Default: + group = + + # don't fork (this overrides the pidfile mechanism)' + # Allowed values: yes, no + # Default: no + nodaemon = no + + # Log client machine names instead of IP addresses (much slower) + # Allowed values: yes, no + # Default: no + log_hostnames = no -**port** - Defines the local TCP port to listen for clients on. -**host** - Defines the hostname or IP number to listen for clients on. Only - required if `localhost` is not sufficient. If left empty (as opposed - to no `host` keyword in the config-file) this will listen to all - network interfaces and is equivalent to an explicit address `0.0.0.0`. - The use of an empty string to listen to all interfaces is deprecated - and will go away in a future version. -**user** and **group** - Defines the Unix user and group to run the server as. Only work if the - server is started as root. -**log_ip** - If ``yes`` then we log IP addresses against accesses. If ``no`` then we - log the hostname of the client. The latter can be much slower. -**pidfile** - If specified, the server will fork at startup and write its new PID to - the file. -**logfile** - Any unhandled exception messages or other output from Roundup will be - written to this file. It must be specified if **pidfile** is specified. - If per-tracker logging is specified, then very little will be written to - this file. + # File to which the server records the process id of the daemon. + # If this option is not set, the server will run in foreground + # + # The path may be either absolute or relative + # to the directory containing this config file. + # Default: + pidfile = + + # Log file path. If unset, log to stderr. + # The path may be either absolute or relative + # to the directory containing this config file. + # Default: + logfile = + + # Set processing of each request in separate subprocess. + # Allowed values: debug, none, thread, fork. + # Default: fork + multiprocess = fork + + # Tracker index template. If unset, built-in will be used. + # The path may be either absolute or relative + # to the directory containing this config file. + # Default: + template = + + # Enable SSL support (requires pyopenssl) + # Allowed values: yes, no + # Default: no + ssl = no + + # PEM file used for SSL. A temporary self-signed certificate + # will be used if left blank. + # The path may be either absolute or relative + # to the directory containing this config file. + # Default: + pem = + + # Roundup trackers to serve. + # Each option in this section defines single Roundup tracker. + # Option name identifies the tracker and will appear in the URL. + # Option value is tracker home directory path. + # The path may be either absolute or relative + # to the directory containing this config file. + [trackers] + + demo = /trackers/demo + sysadmin = /trackers/sysadmin + +Additional notes for each keyword: + **template** Specifies a template used for displaying the tracker index when - multiple trackers are being used. The variable "trackers" is available - to the template and is a dict of all configured trackers. + multiple trackers are being used. It is processed by TAL and + the variable "trackers" is available to the template and is a + dict of all configured trackers. **ssl** Enables the use of SSL to secure the connection to the roundup-server. If you enable this, ensure that your tracker's config.ini specifies @@ -130,6 +185,11 @@ Make sure the name part doesn't include any url-unsafe characters like spaces. Stick to alphanumeric characters and you'll be ok. +To generate a config.ini in the current directory (note it will +overwrite an existing file) from the roundup-server command line use:: + + roundup_server -p 8017 -u roundup --save-config demo=/trackers/demo \ + sysadmin=/trackers/sysadmin Users and Security ==================
