Mercurial > p > roundup > code
annotate share/man/man1/roundup-server.1 @ 5096:e74c3611b138
- issue2550636, issue2550909: Added support for Whoosh indexer.
Also adds new config.ini setting called indexer to select
indexer. See ``doc/upgrading.txt`` for details. Initial patch
done by David Wolever. Patch modified (see ticket or below for
changes), docs updated and committed.
I have an outstanding issue with test/test_indexer.py. I have to
comment out all imports and tests for indexers I don't have (i.e.
mysql, postgres) otherwise no tests run.
With that change made, dbm, sqlite (rdbms), xapian and whoosh indexes
are all passing the indexer tests.
Changes summary:
1) support native back ends dbm and rdbms. (original patch only fell
through to dbm)
2) Developed whoosh stopfilter to not index stopwords or words outside
the the maxlength and minlength limits defined in index_common.py.
Required to pass the extremewords test_indexer test. Also I
removed a call to .lower on the input text as the tokenizer I chose
automatically does the lowercase.
3) Added support for max/min length to find. This was needed to pass
extremewords test.
4) Added back a call to save_index in add_text. This allowed all but
two tests to pass.
5) Fixed a call to:
results = searcher.search(query.Term("identifier", identifier))
which had an extra parameter that is an error under current whoosh.
6) Set limit=None in search call for find() otherwise it only return
10 items. This allowed it to pass manyresults test
Also due to changes in the roundup code removed the call in
indexer_whoosh to
from roundup.anypy.sets_ import set
since we use the python builtin set.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 25 Jun 2016 20:10:03 -0400 |
| parents | a5a9b81f8f6b |
| children | c54720396f40 |
| 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 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
8 \fB-C\fP \fIfile\fP |
|
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 |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
12 Sets the host name or IP address to listen on |
|
4096
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
13 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
14 \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
|
15 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
|
16 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
17 \fB-d\fP \fIfile\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
18 Daemonize, and write the server's PID to the nominated file. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
19 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
20 \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
|
21 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
|
22 option is used. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
23 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
24 \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
|
25 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
|
26 The variable "trackers" is available to the template and is a dict of all |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
27 configured trackers. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
28 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
29 \fB-s\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
30 Enables to use of SSL. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
31 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
32 \fB-e\fP \fIfile\fP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
33 Sets a filename containing the PEM file to use for SSL. If left blank, a |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
34 temporary self-signed certificate will be used. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
35 .TP |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
36 \fB-N\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
37 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
|
38 .TP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
39 \fB-u\fP \fIUID\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
40 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
|
41 .TP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
42 \fB-g\fP \fIGID\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
43 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
|
44 .TP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
45 \fB-d\fP \fIPIDfile\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
46 Run the server in the background and write the server's PID |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
47 to the file indicated by PIDfile. The -l option \fBmust\fP be |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
48 specified if -d is used. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
49 .TP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
50 \fB-v\fP |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
51 Print version and exit. |
|
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
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-h\fP |
|
4706
a5a9b81f8f6b
issue2550760: Several improvements to the manpages (thanks Kai Storbeck)
John Kristensen <john@jerrykan.com>
parents:
4096
diff
changeset
|
54 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
|
55 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
56 \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
|
57 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
|
58 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
|
59 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
|
60 "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
|
61 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
|
62 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
|
63 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
|
64 browsers like IE. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
65 .SH EXAMPLES |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
66 .TP |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
67 .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
|
68 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
|
69 \fB/bugs\fP and one under \fB/reqs\fP. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
70 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
71 .SH CONFIGURATION FILE |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
72 See the "admin_guide" in the Roundup "doc" directory. |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
73 .SH AUTHOR |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
74 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
|
75 <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
|
76 |
|
ab542607f2fb
Move man pages into 'share/man/man1' and simplify setup.py
Stefan Seefeld <stefan@seefeld.name>
parents:
diff
changeset
|
77 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
|
78 <richard@users.sourceforge.net>. |
