Mercurial > p > roundup > code
comparison doc/admin_guide.txt @ 2632:9c55f2bc5961
roundup-server now has a configuration file (-C option)
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Tue, 27 Jul 2004 00:45:49 +0000 |
| parents | d15b71b8a85a |
| children | ad4fb8a14a97 |
comparison
equal
deleted
inserted
replaced
| 2631:2bbcfc80ba5b | 2632:9c55f2bc5961 |
|---|---|
| 1 ==================== | 1 ==================== |
| 2 Administration Guide | 2 Administration Guide |
| 3 ==================== | 3 ==================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.12 $ | 5 :Version: $Revision: 1.13 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 What does Roundup install? | 9 What does Roundup install? |
| 10 ========================== | 10 ========================== |
| 65 (``roundup-mailgw`` always logs to the tracker's log file) | 65 (``roundup-mailgw`` always logs to the tracker's log file) |
| 66 | 66 |
| 67 In both cases, if no logfile is specified then logging will simply be sent | 67 In both cases, if no logfile is specified then logging will simply be sent |
| 68 to sys.stderr with only logging of ERROR messages. | 68 to sys.stderr with only logging of ERROR messages. |
| 69 | 69 |
| 70 Configuring roundup-server | |
| 71 ========================== | |
| 72 | |
| 73 The basic configuration file layout is as follows (take from the | |
| 74 ``roundup-server.ini.example`` file in the "doc" directory):: | |
| 75 | |
| 76 [server] | |
| 77 port = 8080 | |
| 78 ;hostname = | |
| 79 ;user = | |
| 80 ;group = | |
| 81 ;log_ip = yes | |
| 82 ;pidfile = | |
| 83 ;logfile = | |
| 84 | |
| 85 ; Add one of these per tracker being served | |
| 86 [tracker_url_component] | |
| 87 home = /path/to/tracker | |
| 88 | |
| 89 Values ";commented out" are optional. The meaning of the various options | |
| 90 are as follows: | |
| 91 | |
| 92 **port** | |
| 93 Defines the local TCP port to listen for clients on. | |
| 94 **hostname** | |
| 95 Defines the local hostname to listen for clients on. Only required if | |
| 96 "localhost" is not sufficient. | |
| 97 **user** and **group** | |
| 98 Defines the Unix user and group to run the server as. Only work if the | |
| 99 server is started as root. | |
| 100 **log_ip** | |
| 101 If ``yes`` then we log IP addresses against accesses. If ``no`` then we | |
| 102 log the hostname of the client. The latter can be much slower. | |
| 103 **pidfile** | |
| 104 If specified, the server will fork at startup and write its new PID to | |
| 105 the file. | |
| 106 **logfile** | |
| 107 Any unhandled exception messages or other output from Roundup will be | |
| 108 written to this file. It must be specified if **pidfile** is specified. | |
| 109 If per-tracker logging is specified, then very little will be written to | |
| 110 this file. | |
| 111 **example_tracker** sections | |
| 112 These are used to specify which Roundup trackers are to be served up by | |
| 113 roundup-server. Each tracker has its own ``[section]`` with a single | |
| 114 ``home`` value defined pointing to the tracker's home. The section name is | |
| 115 used in the URL to select the appropriate reacker. Make sure the name part | |
| 116 doesn't include any url-unsafe characters like spaces. Stick to | |
| 117 alphanumeric characters and you'll be ok. | |
| 118 | |
| 70 | 119 |
| 71 Users and Security | 120 Users and Security |
| 72 ================== | 121 ================== |
| 73 | 122 |
| 74 Roundup holds its own user database which primarily contains a username, | 123 Roundup holds its own user database which primarily contains a username, |