Skip to content

Commit 9667f9d

Browse files
rouiljrouilj
committed
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.
1 parent 98214d0 commit 9667f9d

File tree

5 files changed

+198
-74
lines changed

5 files changed

+198
-74
lines changed

‎doc/FAQ.txt‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -111,19 +111,6 @@ that describes the needed option in detail. With the standalone server
111111
now XMLRPC over SSL works, too.
112112

113113

114-
Roundup runs very slowly on my XP machine when accessed from the Internet
115-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116-
117-
The issue is probably related to host name resolution for the client
118-
performing the request. You can turn off the resolution of the names
119-
when it's so slow like this. To do so, edit the module
120-
roundup/scripts/roundup_server.py around line 77 to add the following
121-
to the RoundupRequestHandler class::
122-
123-
def address_string(self):
124-
return self.client_address[0]
125-
126-
127114
Templates
128115
---------
129116

‎doc/admin_guide.txt‎

Lines changed: 105 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -68,55 +68,110 @@ to sys.stderr with only logging of ERROR messages.
6868
Configuring roundup-server
6969
==========================
7070

71-
The basic configuration file layout is as follows (take from the
71+
The basic configuration file is as follows (taken from the
7272
``roundup-server.ini.example`` file in the "doc" directory)::
7373

74-
[main]
75-
port = 8080
76-
;host =
77-
;user =
78-
;group =
79-
;log_ip = yes
80-
;pidfile =
81-
;logfile =
82-
;template =
83-
;ssl = no
84-
;pem =
85-
86-
[trackers]
87-
; Add one of these per tracker being served
88-
name = /path/to/tracker/name
89-
90-
Values ";commented out" are optional. The meaning of the various options
91-
are as follows:
92-
93-
**port**
94-
Defines the local TCP port to listen for clients on.
95-
**host**
96-
Defines the hostname or IP number to listen for clients on. Only
97-
required if `localhost` is not sufficient. If left empty (as opposed
98-
to no `host` keyword in the config-file) this will listen to all
99-
network interfaces and is equivalent to an explicit address `0.0.0.0`.
100-
The use of an empty string to listen to all interfaces is deprecated
101-
and will go away in a future version.
102-
**user** and **group**
103-
Defines the Unix user and group to run the server as. Only work if the
104-
server is started as root.
105-
**log_ip**
106-
If ``yes`` then we log IP addresses against accesses. If ``no`` then we
107-
log the hostname of the client. The latter can be much slower.
108-
**pidfile**
109-
If specified, the server will fork at startup and write its new PID to
110-
the file.
111-
**logfile**
112-
Any unhandled exception messages or other output from Roundup will be
113-
written to this file. It must be specified if **pidfile** is specified.
114-
If per-tracker logging is specified, then very little will be written to
115-
this file.
74+
[main]
75+
76+
# Host name of the Roundup web server instance.
77+
# If left unconfigured (no 'host' setting) the default
78+
# will be used.
79+
# If empty, listen on all network interfaces.
80+
# If you want to explicitly listen on all
81+
# network interfaces, the address 0.0.0.0 is a more
82+
# explicit way to achieve this, the use of an empty
83+
# string for this purpose is deprecated and will go away
84+
# in a future release.
85+
# Default: localhost
86+
host = localhost
87+
88+
# Port to listen on.
89+
# Default: 8080
90+
port = 8017
91+
92+
# Path to favicon.ico image file. If unset, built-in favicon.ico is used.
93+
# The path may be either absolute or relative
94+
# to the directory containing this config file.
95+
# Default: favicon.ico
96+
favicon = favicon.ico
97+
98+
# User ID as which the server will answer requests.
99+
# In order to use this option, the server must be run initially as root.
100+
# Availability: Unix.
101+
# Default:
102+
user = roundup
103+
104+
# Group ID as which the server will answer requests.
105+
# In order to use this option, the server must be run initially as root.
106+
# Availability: Unix.
107+
# Default:
108+
group =
109+
110+
# don't fork (this overrides the pidfile mechanism)'
111+
# Allowed values: yes, no
112+
# Default: no
113+
nodaemon = no
114+
115+
# Log client machine names instead of IP addresses (much slower)
116+
# Allowed values: yes, no
117+
# Default: no
118+
log_hostnames = no
119+
120+
# File to which the server records the process id of the daemon.
121+
# If this option is not set, the server will run in foreground
122+
#
123+
# The path may be either absolute or relative
124+
# to the directory containing this config file.
125+
# Default:
126+
pidfile =
127+
128+
# Log file path. If unset, log to stderr.
129+
# The path may be either absolute or relative
130+
# to the directory containing this config file.
131+
# Default:
132+
logfile =
133+
134+
# Set processing of each request in separate subprocess.
135+
# Allowed values: debug, none, thread, fork.
136+
# Default: fork
137+
multiprocess = fork
138+
139+
# Tracker index template. If unset, built-in will be used.
140+
# The path may be either absolute or relative
141+
# to the directory containing this config file.
142+
# Default:
143+
template =
144+
145+
# Enable SSL support (requires pyopenssl)
146+
# Allowed values: yes, no
147+
# Default: no
148+
ssl = no
149+
150+
# PEM file used for SSL. A temporary self-signed certificate
151+
# will be used if left blank.
152+
# The path may be either absolute or relative
153+
# to the directory containing this config file.
154+
# Default:
155+
pem =
156+
157+
# Roundup trackers to serve.
158+
# Each option in this section defines single Roundup tracker.
159+
# Option name identifies the tracker and will appear in the URL.
160+
# Option value is tracker home directory path.
161+
# The path may be either absolute or relative
162+
# to the directory containing this config file.
163+
[trackers]
164+
165+
demo = /trackers/demo
166+
sysadmin = /trackers/sysadmin
167+
168+
Additional notes for each keyword:
169+
116170
**template**
117171
Specifies a template used for displaying the tracker index when
118-
multiple trackers are being used. The variable "trackers" is available
119-
to the template and is a dict of all configured trackers.
172+
multiple trackers are being used. It is processed by TAL and
173+
the variable "trackers" is available to the template and is a
174+
dict of all configured trackers.
120175
**ssl**
121176
Enables the use of SSL to secure the connection to the roundup-server.
122177
If you enable this, ensure that your tracker's config.ini specifies
@@ -130,6 +185,11 @@ are as follows:
130185
Make sure the name part doesn't include any url-unsafe characters like
131186
spaces. Stick to alphanumeric characters and you'll be ok.
132187

188+
To generate a config.ini in the current directory (note it will
189+
overwrite an existing file) from the roundup-server command line use::
190+
191+
roundup_server -p 8017 -u roundup --save-config demo=/trackers/demo \
192+
sysadmin=/trackers/sysadmin
133193

134194
Users and Security
135195
==================

‎doc/roundup-server.ini.example‎

Lines changed: 91 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,96 @@
11
; This is a sample configuration file for roundup-server. See the
22
; admin_guide for information about its contents.
3+
34
[main]
4-
port = 8080
5-
;hostname =
6-
;user =
7-
;group =
8-
;log_ip = yes
9-
;pidfile =
10-
;logfile =
11-
;template =
12-
;ssl = no
13-
;pem =
14-
15-
16-
; Add one of these per tracker being served
5+
6+
# Host name of the Roundup web server instance.
7+
# If left unconfigured (no 'host' setting) the default
8+
# will be used.
9+
# If empty, listen on all network interfaces.
10+
# If you want to explicitly listen on all
11+
# network interfaces, the address 0.0.0.0 is a more
12+
# explicit way to achieve this, the use of an empty
13+
# string for this purpose is deprecated and will go away
14+
# in a future release.
15+
# Default: localhost
16+
host = localhost
17+
18+
# Port to listen on.
19+
# Default: 8080
20+
port = 8017
21+
22+
# Path to favicon.ico image file. If unset, built-in favicon.ico is used.
23+
# The path may be either absolute or relative
24+
# to the directory containing this config file.
25+
# Default: favicon.ico
26+
favicon = favicon.ico
27+
28+
# User ID as which the server will answer requests.
29+
# In order to use this option, the server must be run initially as root.
30+
# Availability: Unix.
31+
# Default:
32+
user = roundup
33+
34+
# Group ID as which the server will answer requests.
35+
# In order to use this option, the server must be run initially as root.
36+
# Availability: Unix.
37+
# Default:
38+
group =
39+
40+
# don't fork (this overrides the pidfile mechanism)'
41+
# Allowed values: yes, no
42+
# Default: no
43+
nodaemon = no
44+
45+
# Log client machine names instead of IP addresses (much slower)
46+
# Allowed values: yes, no
47+
# Default: no
48+
log_hostnames = no
49+
50+
# File to which the server records the process id of the daemon.
51+
# If this option is not set, the server will run in foreground
52+
#
53+
# The path may be either absolute or relative
54+
# to the directory containing this config file.
55+
# Default:
56+
pidfile =
57+
58+
# Log file path. If unset, log to stderr.
59+
# The path may be either absolute or relative
60+
# to the directory containing this config file.
61+
# Default:
62+
logfile =
63+
64+
# Set processing of each request in separate subprocess.
65+
# Allowed values: debug, none, thread, fork.
66+
# Default: fork
67+
multiprocess = fork
68+
69+
# Tracker index template. If unset, built-in will be used.
70+
# The path may be either absolute or relative
71+
# to the directory containing this config file.
72+
# Default:
73+
template =
74+
75+
# Enable SSL support (requires pyopenssl)
76+
# Allowed values: yes, no
77+
# Default: no
78+
ssl = no
79+
80+
# PEM file used for SSL. A temporary self-signed certificate
81+
# will be used if left blank.
82+
# The path may be either absolute or relative
83+
# to the directory containing this config file.
84+
# Default:
85+
pem =
86+
87+
# Roundup trackers to serve.
88+
# Each option in this section defines single Roundup tracker.
89+
# Option name identifies the tracker and will appear in the URL.
90+
# Option value is tracker home directory path.
91+
# The path may be either absolute or relative
92+
# to the directory containing this config file.
1793
[trackers]
18-
home = /path/to/tracker
1994

95+
demo = /trackers/demo
96+
sysadmin = /trackers/sysadmin

‎roundup/configuration.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ class FilePathOption(Option):
331331
"""
332332

333333
class_description = "The path may be either absolute or relative\n" \
334-
"to the directory containig this config file."
334+
"to the directory containing this config file."
335335

336336
def get(self):
337337
_val = Option.get(self)

‎roundup/scripts/roundup_server.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -534,7 +534,7 @@ class ServerConfig(configuration.Config):
534534
"Option name identifies the tracker and will appear in the URL.\n"
535535
"Option value is tracker home directory path.\n"
536536
"The path may be either absolute or relative\n"
537-
"to the directory containig this config file."),
537+
"to the directory containing this config file."),
538538
)
539539

540540
# options recognized by config

0 commit comments

Comments
 (0)