Mercurial > p > roundup > code
comparison doc/admin_guide.txt @ 3465:81542d49c8cb
fix admin doc description of roundup-server config file
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 13 Jan 2006 02:55:49 +0000 |
| parents | df693c0aaba9 |
| children | ee73abcc95d2 |
comparison
equal
deleted
inserted
replaced
| 3464:75b4c2c32cf3 | 3465:81542d49c8cb |
|---|---|
| 1 ==================== | 1 ==================== |
| 2 Administration Guide | 2 Administration Guide |
| 3 ==================== | 3 ==================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.19 $ | 5 :Version: $Revision: 1.20 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 What does Roundup install? | 9 What does Roundup install? |
| 10 ========================== | 10 ========================== |
| 72 ========================== | 72 ========================== |
| 73 | 73 |
| 74 The basic configuration file layout is as follows (take from the | 74 The basic configuration file layout is as follows (take from the |
| 75 ``roundup-server.ini.example`` file in the "doc" directory):: | 75 ``roundup-server.ini.example`` file in the "doc" directory):: |
| 76 | 76 |
| 77 [server] | 77 [main] |
| 78 port = 8080 | 78 port = 8080 |
| 79 ;hostname = | 79 ;hostname = |
| 80 ;user = | 80 ;user = |
| 81 ;group = | 81 ;group = |
| 82 ;log_ip = yes | 82 ;log_ip = yes |
| 83 ;pidfile = | 83 ;pidfile = |
| 84 ;logfile = | 84 ;logfile = |
| 85 | 85 |
| 86 [trackers] | |
| 86 ; Add one of these per tracker being served | 87 ; Add one of these per tracker being served |
| 87 [tracker_url_component] | 88 name = /path/to/tracker/name |
| 88 home = /path/to/tracker | |
| 89 | 89 |
| 90 Values ";commented out" are optional. The meaning of the various options | 90 Values ";commented out" are optional. The meaning of the various options |
| 91 are as follows: | 91 are as follows: |
| 92 | 92 |
| 93 **port** | 93 **port** |
| 107 **logfile** | 107 **logfile** |
| 108 Any unhandled exception messages or other output from Roundup will be | 108 Any unhandled exception messages or other output from Roundup will be |
| 109 written to this file. It must be specified if **pidfile** is specified. | 109 written to this file. It must be specified if **pidfile** is specified. |
| 110 If per-tracker logging is specified, then very little will be written to | 110 If per-tracker logging is specified, then very little will be written to |
| 111 this file. | 111 this file. |
| 112 **example_tracker** sections | 112 **trackers** section |
| 113 These are used to specify which Roundup trackers are to be served up by | 113 Each line denotes a mapping from a URL component to a tracker home. |
| 114 roundup-server. Each tracker has its own ``[section]`` with a single | 114 Make sure the name part doesn't include any url-unsafe characters like |
| 115 ``home`` value defined pointing to the tracker's home. The section name is | 115 spaces. Stick to alphanumeric characters and you'll be ok. |
| 116 used in the URL to select the appropriate reacker. Make sure the name part | |
| 117 doesn't include any url-unsafe characters like spaces. Stick to | |
| 118 alphanumeric characters and you'll be ok. | |
| 119 | 116 |
| 120 | 117 |
| 121 Users and Security | 118 Users and Security |
| 122 ================== | 119 ================== |
| 123 | 120 |