Skip to content

Commit d4c9899

Browse files
committed
docs: issue2551311 document when index returned from roundup-server
in issue2551311 a user was confused when setting the tracker web to the root URL path. While resolving this, it turns out there was no explanation of what was returned when the root URL was accessed compared to a tracker URL. Added explanation that index is returned for multiple trackers and a redirect for only one tracker. Now that the man pages are available online, this is a reasonable place to put the doc as there are no suitable places in the core docs.
1 parent 12f3552 commit d4c9899

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

share/man/man1/roundup-server.1

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ Have the server log using the Python logger with key roundup.http.
3939
\fB-i\fP \fIfile\fP
4040
Sets a filename to use as a template for generating the tracker index page.
4141
The variable "trackers" is available to the template and is a dict of all
42-
configured trackers.
42+
configured trackers. If you connect to the root of the server (without
43+
a tracker name), the default index page is shown. Using \fB-i\fP
44+
allows you to customize the index page.
4345
.TP
4446
\fB-I\fP \fIheader1[,header2,...]\fP
4547
Pass the header(s) and their values to the backend. This allow-list
@@ -98,11 +100,19 @@ the command-line. For convenience, you may edit the TRACKER_HOMES variable in
98100
the roundup-server file instead. Make sure the name part doesn't include any
99101
url-unsafe characters like spaces, as these confuse the cookie handling in
100102
browsers like IE.
103+
.PP
104+
If you connect to the root directory (I.E. you do not include the
105+
\fBname\fP component in the URL, the server will display an index page
106+
of trackers served by roundup-server if more than one tracker is
107+
defined. If only one tracker is defined it will redirect to the tracker.
101108
.SH EXAMPLES
102109
.TP
103110
.B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1
104111
Start the server on port \fB9000\fP serving two trackers; one under
105112
\fB/bugs\fP and one under \fB/reqs\fP.
113+
.PP
114+
If you connect to the server at the root level (http://host:9000/) it
115+
will display a list of the available trackers.
106116

107117
.SH CONFIGURATION FILE
108118
See the "admin_guide" in the Roundup "doc" directory.

0 commit comments

Comments
 (0)