view 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
line wrap: on
line source

.TH ROUNDUP-SERVER 1 "27 July 2004"
.SH NAME
roundup-server \- start roundup web server
.SH SYNOPSIS
\fBroundup-server\fP [\fIoptions\fP] [\fBname=\fP\fItracker home\fP]*
.SH OPTIONS
.TP
\fB-C\fP \fIfile\fP
Use options read from the configuration file (see below).
.TP
\fB-n\fP \fIhostname\fP
Sets the host name or IP address to listen on
.TP
\fB-p\fP \fIport\fP
Sets the port to listen on (default: 8080).
.TP
\fB-d\fP \fIfile\fP
Daemonize, and write the server's PID to the nominated file.
.TP
\fB-l\fP \fIfile\fP
Sets a filename to log to (instead of stdout). This is required if the -d
option is used.
.TP
\fB-i\fP \fIfile\fP
Sets a filename to use as a template for generating the tracker index page.
The variable "trackers" is available to the template and is a dict of all
configured trackers.
.TP
\fB-s\fP
Enables to use of SSL.
.TP
\fB-e\fP \fIfile\fP
Sets a filename containing the PEM file to use for SSL. If left blank, a
temporary self-signed certificate will be used.
.TP
\fB-N\fP
Log client machine names instead of IP addresses (much slower).
.TP
\fB-u\fP \fIUID\fP
Runs the Roundup web server as this UID.
.TP
\fB-g\fP \fIGID\fP
Runs the Roundup web server as this GID.
.TP
\fB-d\fP \fIPIDfile\fP
Run the server in the background and write the server's PID
to the file indicated by PIDfile. The -l option \fBmust\fP be
specified if -d is used.
.TP
\fB-v\fP
Print version and exit.
.TP
\fB-h\fP
Print help and exit.
.TP
\fBname=\fP\fItracker home\fP
Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is
identified in the URL (it's the first part of the URL path). The \fItracker
home\fP variable is the directory that was identified when you did
"roundup-admin init". You may specify any number of these name=home pairs on
the command-line. For convenience, you may edit the TRACKER_HOMES variable in
the roundup-server file instead.  Make sure the name part doesn't include any
url-unsafe characters like spaces, as these confuse the cookie handling in
browsers like IE.
.SH EXAMPLES
.TP
.B roundup-server -p 9000 bugs=/var/tracker reqs=/home/roundup/group1
Start the server on port \fB9000\fP serving two trackers; one under
\fB/bugs\fP and one under \fB/reqs\fP.

.SH CONFIGURATION FILE
See the "admin_guide" in the Roundup "doc" directory.
.SH AUTHOR
This manpage was written by Bastian Kleineidam
<calvin@debian.org> for the Debian distribution of roundup.

The main author of roundup is Richard Jones
<richard@users.sourceforge.net>.

Roundup Issue Tracker: http://roundup-tracker.org/