roundup-server now has a configuration file (-C option)

Author: Richard Jones

CHANGES.txt

@@ -15,6 +15,7 @@ Feature:
   from Vickenty Fesunov)
 - hide "(list)" popup links when issue is only viewable
 - roundup-server options -g and -u accept both ids and names (sf bug 983769)
+- roundup-server now has a configuration file (-C option)
 - added mod_python interface (see installation.txt)
 
 

doc/admin_guide.txt

@@ -2,7 +2,7 @@
 Administration Guide
 ====================
 
-:Version: $Revision: 1.12 $
+:Version: $Revision: 1.13 $
 
 .. contents::
 
@@ -67,6 +67,55 @@ Configuration for "BasicLogging" implementation:
 In both cases, if no logfile is specified then logging will simply be sent
 to sys.stderr with only logging of ERROR messages.
 
+Configuring roundup-server
+==========================
+
+The basic configuration file layout is as follows (take from the
+``roundup-server.ini.example`` file in the "doc" directory)::
+
+    [server]
+    port = 8080
+    ;hostname = 
+    ;user = 
+    ;group = 
+    ;log_ip = yes
+    ;pidfile = 
+    ;logfile = 
+
+    ; Add one of these per tracker being served
+    [tracker_url_component]
+    home = /path/to/tracker
+
+Values ";commented out" are optional. The meaning of the various options
+are as follows:
+
+**port**
+  Defines the local TCP port to listen for clients on.
+**hostname**
+  Defines the local hostname to listen for clients on. Only required if
+  "localhost" is not sufficient.
+**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.
+**example_tracker** sections
+  These are used to specify which Roundup trackers are to be served up by
+  roundup-server. Each tracker has its own ``[section]`` with a single
+  ``home`` value defined pointing to the tracker's home. The section name is
+  used in the URL to select the appropriate reacker. Make sure the name part
+  doesn't include any url-unsafe characters like spaces. Stick to
+  alphanumeric characters and you'll be ok.
+
 
 Users and Security
 ==================

doc/roundup-server.1

@@ -1,21 +1,25 @@
-.TH ROUNDUP-SERVER 1 "24 January 2003"
+.TH ROUNDUP-SERVER 1 "27 July 2004"
 .SH NAME
-roundup-server \- start roundup server
+roundup-server \- start roundup web server
 .SH SYNOPSIS
 \fBroundup-server\fP [\fIoptions\fP] [\fBname=\fP\fItracker home\fP]*
 .SH OPTIONS
 .TP
+\fB-C\fP \fIfile\fP
+Use options read from the configuration file (see below).
+.TP
 \fB-n\fP \fIhostname\fP
-sets the host name
+Sets the host name.
 .TP
 \fB-p\fP \fIport\fP
-sets the port to listen on
-.TP
-\fB-l\fP \fIfile\fP
-sets a filename to log to (instead of stdout)
+Sets the port to listen on.
 .TP
 \fB-d\fP \fIfile\fP
-daemonize, and write the server's PID to the nominated file
+Daemonize, and write the server's PID to the nominated file.
+.TP
+\fB-l\fP \fIfile\fP
+Sets a filename to log to (instead of stdout). This is required if the -d
+option is used.
 .TP
 \fB-h\fP
 print help
@@ -29,6 +33,8 @@ pairs on the command-line. For convenience, you may edit the
 TRACKER_HOMES variable in the roundup-server file instead.
 Make sure the name part doesn't include any url-unsafe characters like
 spaces, as these confuse the cookie handling in browsers like IE.
+.SH CONFIGURATION FILE
+See the "admin_guide" in the Roundup "doc" directory.
 .SH AUTHOR
 This manpage was written by Bastian Kleineidam
 <[email protected]> for the Debian distribution of roundup.

doc/roundup-server.ini.example

@@ -0,0 +1,16 @@
+; This is a sample configuration file for roundup-server. See the
+; admin_guide for information about its contents.
+[server]
+port = 8080
+;hostname = 
+;user = 
+;group = 
+;log_ip = yes
+;pidfile = 
+;logfile = 
+
+
+; Add one of these per tracker being served
+[tracker_url_component]
+home = /path/to/tracker
+