Mercurial > p > roundup > code

annotate share/man/man1/roundup-server.1 @ 8408:e882a5d52ae5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
refactor: move RateLimitExceeded to roundup.cgi.exceptions RateLimitExceeded is an HTTP exception that raises code 429. Move it to roundup.cgi.exceptions where all the other exceptions that result in http status codes are located. Also make it inherit from HTTPException since it is one. Also add docstrings for all HTTP exceptions and order HTTPExceptions by status code. BREAKING CHANGE: if somebody is importing RateLimitExceeded they will need to change their import. I consider it unlikely anybody is using RateLimitExceeded. Detectors and extensions are unlikely to raise RateLimitExceeded. So I am leaving it out of the upgrading doc. Just doc in change log.
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Aug 2025 21:27:06 -0400
parents 627c5d6a0551
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
1 .TH ROUNDUP-SERVER 1 "27 July 2004"
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
2 .SH NAME
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
3 roundup-server \- start roundup web server
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
4 .SH SYNOPSIS
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
5 \fBroundup-server\fP [\fIoptions\fP] [\fBname=\fP\fItracker home\fP]*
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
6 .SH OPTIONS
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
7 .TP
5969
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
8 \fB-C\fP \fIfile\fP or \fB--config\fP \fIfile\fP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
9 Use options read from the configuration file (see below).
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
10 .TP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
11 \fB-n\fP \fIhostname\fP
5138
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
12 Sets the host name or IP address to listen on. Default is localhost
c54720396f40 issue2550882. Reported by Karl-Philipp Richter. Fixed
John Rouillard <rouilj@ieee.org>
parents: 4706
diff changeset
13 (127.0.0.1). Use 0.0.0.0 to listen on all interfaces on the system.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
14 .TP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
15 \fB-p\fP \fIport\fP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
16 Sets the port to listen on (default: 8080).
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
17 .TP
5969
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
18 \fB-d\fP \fIPIDfile\fP
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
19 Run the server in the background and write the server's PID to the
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
20 file indicated by PIDfile. The -l (or -L) option \fBmust\fP be
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
21 specified if -d is used.
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
22 .TP
8169
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
23 \fB-D\fP
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
24 Run the server in the foreground even if -d is used.
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
25 .TP
6830
36cf8a12a26b add thread option to roundup-server.1 man page.
John Rouillard <rouilj@ieee.org>
parents: 6514
diff changeset
26 \fB-t\fP \fBfork|thread|debug|none\fP
6831
e0b29e3fe995 Expand on explanation for multiprocess-mode in roundup-server.1.
John Rouillard <rouilj@ieee.org>
parents: 6830
diff changeset
27 Control multi-process mode. \fBdebug\fP and \fBnone\fP are always
6833
da9a78957bd4 Fix spelling.
John Rouillard <rouilj@ieee.org>
parents: 6831
diff changeset
28 available. If an invalid mode is specified the server starts in
6831
e0b29e3fe995 Expand on explanation for multiprocess-mode in roundup-server.1.
John Rouillard <rouilj@ieee.org>
parents: 6830
diff changeset
29 \fBnone\fP (also called single) mode. Default fork.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
30 .TP
7387
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7335
diff changeset
31 \fB-m\fP \fImax_children\fP
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7335
diff changeset
32 Set the maximum number of child processes (servers). This value
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7335
diff changeset
33 may need to be increased on a heavily loaded site. Default 40.
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7335
diff changeset
34 .TP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
35 \fB-l\fP \fIfile\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
36 Sets a filename to log to (instead of stdout). This is required if the -d
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
37 option is used.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
38 .TP
8169
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
39 \fB-P\fP
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
40 If a reverse proxy is used in front of the roundup-server, the server
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
41 will log the ip address of the proxy, not the client browser. Using -P
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
42 logs the left most entry in the X-Forwarded-For http header as the
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
43 IP address of the client. This address will be logged or resolved to a
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
44 hostname (with \fB-N\fP) and a '+' character will be appended.
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
45 \fB-P\fP should only be used when the
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
46 roundup server is accessible only from trusted proxy hosts. See:
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
47 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
48 for details and warnings about using the X-Forwarded-For header.
627c5d6a0551 allow roundup-server to log real client IP behind reverse proxy
John Rouillard <rouilj@ieee.org>
parents: 8031
diff changeset
49 .TP
5969
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
50 \fB-L\fP
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
51 Have the server log using the Python logger with key roundup.http.
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
52 .TP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
53 \fB-i\fP \fIfile\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
54 Sets a filename to use as a template for generating the tracker index page.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
55 The variable "trackers" is available to the template and is a dict of all
8029
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
56 configured trackers. If you connect to the root of the server (without
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
57 a tracker name), the default index page is shown. Using \fB-i\fP
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
58 allows you to customize the index page.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
59 .TP
6514
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
60 \fB-I\fP \fIheader1[,header2,...]\fP
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
61 Pass the header(s) and their values to the backend. This allow-list
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
62 of header variables can be used by custom code in the tracker or with
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
63 a tracker's \fBhttp_auth_header\fP configuration option to allows a
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
64 front end server to authenticate a user and pass the user identity to
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
65 roundup.
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
66 .TP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
67 \fB-s\fP
6835
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6834
diff changeset
68 Enables use of SSL. In most cases, you will want to run a real web server
6834
5129fc03dc1f issue2551137, 2551138 - roundup-server SSL issues.
John Rouillard <rouilj@ieee.org>
parents: 6833
diff changeset
69 (Apache, Nginx) as a proxy to roundup-server running without SSL.
5129fc03dc1f issue2551137, 2551138 - roundup-server SSL issues.
John Rouillard <rouilj@ieee.org>
parents: 6833
diff changeset
70 The real web server can filter/rate limit/firewall requests to
5129fc03dc1f issue2551137, 2551138 - roundup-server SSL issues.
John Rouillard <rouilj@ieee.org>
parents: 6833
diff changeset
71 roundup-server.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
72 .TP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
73 \fB-e\fP \fIfile\fP
6834
5129fc03dc1f issue2551137, 2551138 - roundup-server SSL issues.
John Rouillard <rouilj@ieee.org>
parents: 6833
diff changeset
74 Sets a filename containing the PEM file to use for SSL. The PEM file
5129fc03dc1f issue2551137, 2551138 - roundup-server SSL issues.
John Rouillard <rouilj@ieee.org>
parents: 6833
diff changeset
75 must include both the private key and certificate with appropriate
8031
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
76 header/trailer markers:
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
77
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
78 .EX
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
79 -----BEGIN PRIVATE KEY-----
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
80 -----END PRIVATE KEY-----
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
81 .EE
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
82
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
83 and
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
84
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
85 .EX
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
86 -----BEGIN CERTIFICATE-----
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
87 -----END CERTIFICATE-----
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
88 .EE
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
89
0f5d31be5418 issue2551219 - use of PEM file with roundup-server
John Rouillard <rouilj@ieee.org>
parents: 8029
diff changeset
90 If no file is specified, a temporary self-signed
6834
5129fc03dc1f issue2551137, 2551138 - roundup-server SSL issues.
John Rouillard <rouilj@ieee.org>
parents: 6833
diff changeset
91 certificate will be used.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
92 .TP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
93 \fB-N\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
94 Log client machine names instead of IP addresses (much slower).
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
95 .TP
6514
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
96 \fB-V\fP \fIHTTPVER\fP
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
97 By default roundup-server uses HTTP/1.1 to enable keepalives for faster
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
98 response. HTTPVER can be set to \fBHTTP/1.0\fP to disable keepalives.
a036712c96f4 Enable HTTP/1.1 support for roundup-server
John Rouillard <rouilj@ieee.org>
parents: 5969
diff changeset
99 .TP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
100 \fB-u\fP \fIUID\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
101 Runs the Roundup web server as this UID.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
102 .TP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
103 \fB-g\fP \fIGID\fP
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
104 Runs the Roundup web server as this GID.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
105 .TP
5969
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
106 \fB-v\fP or \fB--version\fP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
107 Print version and exit.
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
108 .TP
5969
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
109 \fB-h\fP or \fB--help\fP
4706
a5a9b81f8f6b issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents: 4096
diff changeset
110 Print help and exit.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
111 .TP
5969
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
112 \fB--save-config\fP
7335
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
113 Create configuration file and exit. The old config.ini will be saved to
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
114 config.bak. Note that this command doesn't attempt to load or verify
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
115 an existing config.ini. Running this in a tracker home directory will
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
116 move the existing config.ini to config.bak and replace it with the
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
117 roundup-server's config.ini. This will make the tracker in the
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
118 directory fail to start until the original config.ini is restored.
5969
247f176f9020 issue2550885 - man page documentation roundup-server.1
John Rouillard <rouilj@ieee.org>
parents: 5138
diff changeset
119 .TP
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
120 \fBname=\fP\fItracker home\fP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
121 Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
122 identified in the URL (it's the first part of the URL path). The \fItracker
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
123 home\fP variable is the directory that was identified when you did
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
124 "roundup-admin init". You may specify any number of these name=home pairs on
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
125 the command-line. For convenience, you may edit the TRACKER_HOMES variable in
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
126 the roundup-server file instead. Make sure the name part doesn't include any
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
127 url-unsafe characters like spaces, as these confuse the cookie handling in
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
128 browsers like IE.
8029
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
129 .PP
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
130 If you connect to the root directory (I.E. you do not include the
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
131 \fBname\fP component in the URL, the server will display an index page
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
132 of trackers served by roundup-server if more than one tracker is
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
133 defined. If only one tracker is defined it will redirect to the tracker.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
134 .SH EXAMPLES
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
135 .TP
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
136 .B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
137 Start the server on port \fB9000\fP serving two trackers; one under
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
138 \fB/bugs\fP and one under \fB/reqs\fP.
8029
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
139 .PP
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
140 If you connect to the server at the root level (http://host:9000/) it
55238195033f docs: issue2551311 document when index returned from roundup-server
John Rouillard <rouilj@ieee.org>
parents: 7993
diff changeset
141 will display a list of the available trackers.
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
142
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
143 .SH CONFIGURATION FILE
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
144 See the "admin_guide" in the Roundup "doc" directory.
7993
d614d8e1c09d update man pages with see also section.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
145 .SH SEE ALSO
d614d8e1c09d update man pages with see also section.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
146 roundup-admin(1), roundup-demo(1), roundup-mailgw(1)
d614d8e1c09d update man pages with see also section.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
147
4096
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
148 .SH AUTHOR
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
149 This manpage was written by Bastian Kleineidam
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
150 <calvin@debian.org> for the Debian distribution of roundup.
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
151
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
152 The main author of roundup is Richard Jones
ab542607f2fb Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
153 <richard@users.sourceforge.net>.
Roundup Issue Tracker: http://roundup-tracker.org/