Mercurial > p > roundup > code
annotate doc/admin_guide.txt @ 6915:9ff091537f43
postgresql native-fts; more indexer tests
1) Make postgresql native-fts actually work.
2) Add simple stopword filtering to sqlite native-fts indexer.
3) Add more tests for indexer_common get_indexer
Details:
1) roundup/backends/indexer_postgresql_fts.py:
ignore ValueError raised if we try to index a string with a null
character in it. This could happen due to an incorrect text/ mime
type on a file that has nulls in it.
Replace ValueError raised by postgresql with customized
IndexerQueryError if a search string has a null in it.
roundup/backends/rdbms_common.py:
Make postgresql native-fts work. When specified it was using using
whatever was returned from get_indexer(). However loading the
native-fts indexer backend failed because there was no connection to
the postgresql database when this call was made.
Simple solution, move the call after the open_connection call in
Database::__init__().
However the open_connection call creates the schema for the
database if it is not there. The schema builds tables for
indexer=native type indexing. As part of the build it looks at the
indexer to see the min/max size of the indexed tokens. No indexer
define, we get a crash.
So it's a a chicken/egg issue. I solved it by setting the indexer
to the Indexer from indexer_common which has the min/max token size
info. I also added a no-op save_indexer to this Indexer class. I
claim save_indexer() isn't needed as a commit() on the db does all
the saving required. Then after open_connection is called, I call
get_indexer to retrieve the correct indexer and
indexer_postgresql_fts woks since the conn connection property is
defined.
roundup/backends/indexer_common.py:
add save_index() method for indexer. It does nothing but is needed
in rdbms backends during schema initialization.
2) roundup/backends/indexer_sqlite_fts.py:
when this indexer is used, the indexer test in DBTest on the word
"the" fail. This is due to missing stopword filtering. Implement
basic stopword filtering for bare stopwords (like 'the') to make the
test pass. Note: this indexer is not currently automatically run by
the CI suite, it was found during manual testing. However there is a
FIXME to extract the indexer tests from DBTest and run it using this
backend.
roundup/configuration.py, roundup/doc/admin_guide.txt:
update doc on stopword use for sqlite native-fts.
test/db_test_base.py:
DBTest::testStringBinary creates a file with nulls in it. It was
breaking postgresql with native-fts indexer. Changed test to assign
mime type application/octet-stream that prevents it from being
processed by any text search indexer.
add test to exclude indexer searching in specific props. This code
path was untested before.
test/test_indexer.py:
add test to call find with no words. Untested code path.
add test to index and find a string with a null \x00 byte. it was
tested inadvertently by testStringBinary but this makes it explicit
and moves it to indexer testing. (one version each for: generic,
postgresql and mysql)
Renamed Get_IndexerAutoSelectTest to Get_IndexerTest and renamed
autoselect tests to include autoselect. Added tests for an invalid
indexer and using native-fts with anydbm (unsupported combo) to make
sure the code does something useful if the validation in
configuration.py is broken.
test/test_liveserver.py:
add test to load an issue
add test using text search (fts) to find the issue
add tests to find issue using postgresql native-fts
test/test_postgresql.py, test/test_sqlite.py:
added explanation on how to setup integration test using native-fts.
added code to clean up test environment if native-fts test is run.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 05 Sep 2022 16:25:20 -0400 |
| parents | 7a48f771cd4f |
| children | f72ce883e677 |
| rev | line source |
|---|---|
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
1 .. meta:: |
|
6774
e7b4ad2c57ac
landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents:
6751
diff
changeset
|
2 :description: |
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
3 How to administer, backup, upgrade a Roundup installation. |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
4 System and user security, configuring web compression, |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
5 documentation on using roundup-server and running |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
6 roundup-admin. |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
7 |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
8 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 ==================== |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
10 Administration Guide |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 ==================== |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 .. contents:: |
|
4890
609edf9de0a5
docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents:
4786
diff
changeset
|
14 :local: |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
15 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 What does Roundup install? |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
17 ========================== |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
18 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
19 There's two "installations" that we talk about when using Roundup: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
20 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
21 1. The installation of the software and its support files. This uses the |
|
6727
3f3ce3004013
issue2551206 - remove mention of roundup installer, fix up windows docs
John Rouillard <rouilj@ieee.org>
parents:
6613
diff
changeset
|
22 standard Python mechanism called "setuptools" and thus Roundup's core code, |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 executable scripts and support data files are installed in Python's |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 directories. On Windows, this is typically: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 Scripts |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
27 ``<python dir>\scripts\...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 Core code |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
29 ``<python dir>\lib\site-packages\roundup\...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 Support files |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
31 ``<python dir>\share\roundup\...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 |
|
2005
fc52d57c6c3e
documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
33 and on Unix-like systems (eg. Linux): |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
35 Scripts |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
36 ``<python root>/bin/...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
37 Core code |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
38 ``<python root>/lib-<python version>/site-packages/roundup/...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 Support files |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
40 ``<python root>/share/roundup/...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
41 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
42 2. The installation of a specific tracker. When invoking the roundup-admin |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
43 "inst" (and "init") commands, you're creating a new Roundup tracker. This |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
44 installs configuration files, HTML templates, detector code and a new |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
45 database. You have complete control over where this stuff goes through |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
46 both choosing your "tracker home" and the ``main`` -> ``database`` variable |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
47 in the tracker's config.ini. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
48 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
49 |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
50 Configuring Roundup's Logging of Messages For Sysadmins |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
51 ======================================================= |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
52 |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
53 You may configure where Roundup logs messages in your tracker's config.ini |
|
4786
6018617c55ab
Removing remains of "rlog" module, fixes db unit test debug logging via environment variable.
Bernhard Reiter <bernhard@intevation.de>
parents:
4567
diff
changeset
|
54 file. Roundup will use the standard Python (2.3+) logging implementation. |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
55 |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
56 Configuration for standard "logging" module: |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
57 - tracker configuration file specifies the location of a logging |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
58 configration file as ``logging`` -> ``config`` |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
59 - ``roundup-server`` specifies the location of a logging configuration |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
60 file on the command line |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
61 Configuration for "BasicLogging" implementation: |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
62 - tracker configuration file specifies the location of a log file |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
63 ``logging`` -> ``filename`` |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
64 - tracker configuration file specifies the level to log to as |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
65 ``logging`` -> ``level`` |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
66 - ``roundup-server`` specifies the location of a log file on the command |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
67 line |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
68 - ``roundup-server`` specifies the level to log to on the command line |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
69 |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
70 (``roundup-mailgw`` always logs to the tracker's log file) |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
71 |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
72 In both cases, if no logfile is specified then logging will simply be sent |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
73 to sys.stderr with only logging of ERROR messages. |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
74 |
| 3250 | 75 |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
76 Configuring roundup-server |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
77 ========================== |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
78 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
79 The basic configuration file is as follows (taken from the |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
80 ``roundup-server.ini.example`` file in the "doc" directory):: |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
81 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
82 [main] |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
83 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
84 # Host name of the Roundup web server instance. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
85 # If left unconfigured (no 'host' setting) the default |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
86 # will be used. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
87 # If empty, listen on all network interfaces. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
88 # If you want to explicitly listen on all |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
89 # network interfaces, the address 0.0.0.0 is a more |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
90 # explicit way to achieve this, the use of an empty |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
91 # string for this purpose is deprecated and will go away |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
92 # in a future release. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
93 # Default: localhost |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
94 host = localhost |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
95 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
96 # Port to listen on. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
97 # Default: 8080 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
98 port = 8017 |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
99 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
100 # Path to favicon.ico image file. If unset, built-in favicon.ico is used. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
101 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
102 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
103 # Default: favicon.ico |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
104 favicon = favicon.ico |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
105 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
106 # User ID as which the server will answer requests. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
107 # In order to use this option, the server must be run initially as root. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
108 # Availability: Unix. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
109 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
110 user = roundup |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
111 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
112 # Group ID as which the server will answer requests. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
113 # In order to use this option, the server must be run initially as root. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
114 # Availability: Unix. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
115 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
116 group = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
117 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
118 # don't fork (this overrides the pidfile mechanism)' |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
119 # Allowed values: yes, no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
120 # Default: no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
121 nodaemon = no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
122 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
123 # Log client machine names instead of IP addresses (much slower) |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
124 # Allowed values: yes, no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
125 # Default: no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
126 log_hostnames = no |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
127 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
128 # File to which the server records the process id of the daemon. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
129 # If this option is not set, the server will run in foreground |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
130 # |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
131 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
132 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
133 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
134 pidfile = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
135 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
136 # Log file path. If unset, log to stderr. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
137 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
138 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
139 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
140 logfile = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
141 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
142 # Set processing of each request in separate subprocess. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
143 # Allowed values: debug, none, thread, fork. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
144 # Default: fork |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
145 multiprocess = fork |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
146 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
147 # Tracker index template. If unset, built-in will be used. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
148 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
149 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
150 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
151 template = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
152 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
153 # Enable SSL support (requires pyopenssl) |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
154 # Allowed values: yes, no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
155 # Default: no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
156 ssl = no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
157 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
158 # PEM file used for SSL. A temporary self-signed certificate |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
159 # will be used if left blank. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
160 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
161 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
162 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
163 pem = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
164 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
165 # Roundup trackers to serve. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
166 # Each option in this section defines single Roundup tracker. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
167 # Option name identifies the tracker and will appear in the URL. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
168 # Option value is tracker home directory path. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
169 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
170 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
171 [trackers] |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
172 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
173 demo = /trackers/demo |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
174 sysadmin = /trackers/sysadmin |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
175 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
176 Additional notes for each keyword: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
177 |
|
3880
2359d6304a4f
Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3781
diff
changeset
|
178 **template** |
|
2359d6304a4f
Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3781
diff
changeset
|
179 Specifies a template used for displaying the tracker index when |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
180 multiple trackers are being used. It is processed by TAL and |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
181 the variable "trackers" is available to the template and is a |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
182 dict of all configured trackers. |
|
3883
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
183 **ssl** |
|
6835
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
184 Enables use of SSL to secure the connection to the |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
185 roundup-server. In most cases, you will want to run a |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
186 real web server (Apache, Nginx) as a proxy to |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
187 roundup-server running without SSL. The real web server |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
188 can filter/rate limit/firewall requests to roundup-server. |
|
3883
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
189 If you enable this, ensure that your tracker's config.ini specifies |
|
6835
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
190 an *https* URL. See roundup-server.1 man page for |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
191 additional information. |
|
3883
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
192 **pem** |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
193 If specified, the SSL PEM file containing the private key and certificate. |
|
6835
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
194 The file must include both the private key and certificate with appropriate |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
195 headers (e.g. ``-----BEGIN PRIVATE KEY-----``, |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
196 ``-----END PRIVATE KEY-----`` and |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
197 ``-----BEGIN CERTIFICATE-----``, |
|
7a48f771cd4f
Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents:
6819
diff
changeset
|
198 ``-----END CERTIFICATE-----``. |
|
3883
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
199 If not specified, roundup will generate a temporary, self-signed certificate |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
200 for use. |
|
3465
81542d49c8cb
fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents:
3341
diff
changeset
|
201 **trackers** section |
|
81542d49c8cb
fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents:
3341
diff
changeset
|
202 Each line denotes a mapping from a URL component to a tracker home. |
|
81542d49c8cb
fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents:
3341
diff
changeset
|
203 Make sure the name part doesn't include any url-unsafe characters like |
|
81542d49c8cb
fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents:
3341
diff
changeset
|
204 spaces. Stick to alphanumeric characters and you'll be ok. |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
205 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
206 To generate a config.ini in the current directory (note it will |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
207 overwrite an existing file) from the roundup-server command line use:: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
208 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
209 roundup_server -p 8017 -u roundup --save-config demo=/trackers/demo \ |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
210 sysadmin=/trackers/sysadmin |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
211 |
|
6458
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
212 Configuring Compression |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
213 ======================= |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
214 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
215 Roundup will compress HTTP responses to clients on the fly. Dynamic, |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
216 on the fly, compression is enabled by default, to disable it set:: |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
217 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
218 [web] |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
219 ... |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
220 dynamic_compression = No |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
221 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
222 in the tracker's ``config.ini``. You should disable compression if |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
223 your proxy (e.g. nginx or apache) or wsgi server (uwsgi) is configured |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
224 to compress responses on the fly. The python standard library includes |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
225 gzip support. For brotli or zstd you will need to install packges. See |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
226 the `installation documentation`_ for details. |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
227 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
228 Some assets will not be compressed on the fly. Assets with mime types |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
229 of "image/png" or "image/jpeg" will not be compressed. You |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
230 can add mime types to the list by using ``interfaces.py`` as discussed |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
231 in the `customisation documentation`_. As an example adding:: |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
232 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
233 from roundup.cgi.client import Client |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
234 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
235 Client.precompressed_mime_types.append('application/zip`) |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
236 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
237 to ``interfaces.py`` will prevent zip files from being compressed. |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
238 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
239 Any content less than 100 bytes in size will not be compressed (e.g |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
240 errors messages, short json responses). |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
241 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
242 Zstd will be used if the client can understand it, followed by brotli |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
243 then gzip encoding. Currently the preference order is hard coded into |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
244 the server and not parsed using ``q`` values from the client's |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
245 Accept-Encoding header. This is an area for improvement. |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
246 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
247 In addition to dynamic compression, static files/assets accessed using |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
248 ``@@file`` can be pre-compressed. This reduces CPU load on the server |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
249 and reduces the time required to respond to the client. By default |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
250 searching for pre-compressed files is disabled. To enable it set:: |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
251 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
252 [web] |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
253 ... |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
254 use_precompressed_files = Yes |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
255 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
256 in the tracker's ``config.ini`` file. Then you can create a |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
257 precompressed file and it will be served if the client is able to |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
258 accept it. For a file ``.../@@file/library.js`` you can create:: |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
259 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
260 tracker_home/html/library.js.gzip |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
261 tracker_home/html/library.js.br |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
262 tracker_home/html/library.js.zstd |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
263 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
264 which should be created by using (respectively):: |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
265 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
266 gzip --keep --suffix .gzip library.js |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
267 brotli library.js |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
268 zstd library.js && mv library.js.zst library.js.zstd |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
269 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
270 see the man pages for options that control compression level. Note |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
271 that some levels require additional memory on the client side, so you |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
272 may not always want to use the highest compression available. |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
273 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
274 A pre-compressed file will not be used if its modified date is earlier |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
275 than the uncompressed file. For example, if ``library.js.gzip`` is |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
276 older (has earlier modification date) than ``library.js``, |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
277 ``library.js.gzip`` will be ignored. ``library.js`` will be |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
278 served instead. ``library.js`` will be dynamically compressed on the |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
279 fly and a warning message will be logged. |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
280 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
281 Precompressed files override dynamic compression. For example, assume |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
282 the client can accept brotli and gzip. If there are no precompressed |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
283 files, the data will be compressed dynamically (on the fly) using |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
284 brotli. If there is a precompressed gzip file present the client will |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
285 get the gzip version and not a brotli compressed version. This |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
286 mechanism allows the admin to allow use of brotli and zstd for |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
287 dynamic content, but not for static content. |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
288 |
|
6604
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
289 Configuring native-fts Full Text Search |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
290 ======================================= |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
291 |
| 6612 | 292 Roundup release 2.2.0 supports database-native full text search. |
|
6604
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
293 SQLite (minimum version 3.9.0) with FTS5 and PostgreSQL (minimum |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
294 version 11.0) with websearch_to_tsvector are supported. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
295 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
296 To enable this method, change the ``indexer`` setting in the tracker's |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
297 config.ini to ``native-fts``. Then reindex using ``roundup-admin -i |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
298 tracker_home reindex``. The amount of time it takes to reindex |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
299 depends on the amount of data in your tracker, the speed of your |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
300 disks, etc. It can take hours. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
301 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
302 SQLite details |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
303 -------------- |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
304 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
305 The SQLite native-fts changes the full text search query a little bit. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
306 For the other search methods, the search terms are split on white |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
307 space and each item in the index: a field (e.g. title), message |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
308 content and file content is searched for all the terms. If any term is |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
309 missing that item is ignored. Once the items are found they are mapped |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
310 to an issue and the normal issue index is displayed. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
311 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
312 When using FTS5, the search terms can use the full text search query |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
313 language described at: |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
314 https://www.sqlite.org/fts5.html#full_text_query_syntax. This |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
315 supports: |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
316 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
317 * plain word search (joined with and similar to other search methods) |
|
6613
2eec7a500333
Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents:
6612
diff
changeset
|
318 * phrase search with terms enclosed in quotes (``"``) |
|
6604
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
319 * proximity search with varying distances using ``NEAR()`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
320 * boolean operations by grouping with parentheses and using ``AND`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
321 and ``OR`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
322 * exclusion using ``NOT`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
323 * prefix searching by prefixing the term with``^`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
324 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
325 All of the data that is indexed is in a single column, so when column |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
326 specifiers are used they usually result in an error which is detected |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
327 and an enhanced error message is produced. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
328 |
|
6915
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
329 Unlike the native, xapian and whoosh indexers there is no |
|
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
330 limit to the length of terms that are indexed. Also |
|
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
331 stopwords are indexed but ignored when searching if they are |
|
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
332 the only word in the search. So a search for "the" will |
|
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
333 return no results but "the book" will return |
|
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
334 results. Pre-filtering the stopwords when indexing would |
|
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
335 break proximity and phrase searching. This may be helpful or |
|
9ff091537f43
postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents:
6835
diff
changeset
|
336 problematic for your particular tracker. |
|
6604
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
337 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
338 To support the most languages available, the unicode61 tokenizer is |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
339 used without porter stemming. Using the ``indexer_language`` setting |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
340 to enable stemming for ``english`` is not available in this |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
341 implementation. Also ranking information is not used in this |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
342 implementation. These are areas for improvement. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
343 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
344 PostgreSQL info |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
345 --------------- |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
346 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
347 The PostgreSQL native-fts changes the full text search query a little |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
348 bit. When using PostgreSQL full text search, two different query |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
349 languages are supported. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
350 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
351 1. websearch - described at the end of |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
352 `Parsing Queries`_ under websearch_to_tsquery. This is the default. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
353 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
354 2. tsquery - described at the beginning of `Parsing Queries`_ with |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
355 to_tsquery. It is enabled by starting the search phrase with ``ts:``. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
356 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
357 .. _Parsing Queries: \ |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
358 https://www.postgresql.org/docs/14/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
359 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
360 Websearch provides a more natural style of search and supports: |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
361 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
362 * plain word search (stemmed in most cases) |
|
6613
2eec7a500333
Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents:
6612
diff
changeset
|
363 * phrase search with terms enclosed in quotes (``"``) |
|
6604
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
364 * exclusion by prefixing a term/phrase with ``-`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
365 * alternative/or searching with ``or`` between terms |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
366 * ignores non-word characters including punctuation |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
367 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
368 Tsquery supports: |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
369 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
370 * a strict query syntax |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
371 * plain word search |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
372 * phrase search with the ``<->`` operator or enclosing the phrase in |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
373 ``'`` single quotes (note this will use a stemmer on the terms |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
374 in the phrase). |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
375 * proximity search with varying distances using ``<N>`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
376 * boolean operations by grouping with parentheses and using ``&`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
377 and ``|`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
378 * exclusion using ``!`` |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
379 * prefix searching using ``:*`` at the end of the prefix |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
380 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
381 All of the data that is indexed is in a single column and input |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
382 weighing is not used. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
383 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
384 Depending on the FTS configuration (determined by the |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
385 ``indexer_language`` setting), stopwords are supported. PostgreSQL |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
386 takes the stopwords into account when calculating the data needed for |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
387 proximity/near searches. Like SQLite FTS, there is no limit to the |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
388 length of terms that are indexed. Again this may be helpful or |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
389 problematic for your particular tracker. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
390 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
391 The config.ini ``indexer_language`` setting is used to define the |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
392 configuration used for indexing. For example with the default |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
393 ``english`` setting a snowball stemmer (english_stem) is used. So |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
394 words like 'drive' and 'driving' and 'drive-in' will all match a |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
395 search for 'drive' but will not match 'driver'. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
396 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
397 The indexer_language is used as the configuration name for every call |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
398 to the text search functions (to_tsvector, to_tsquery). Changing this |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
399 requires reindexing. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
400 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
401 The `configuration list can be obtained using using psql's`_ |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
402 ``\dF`` command. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
403 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
404 .. _configuration list can be obtained using using psql's: \ |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
405 https://www.postgresql.org/docs/current/textsearch-psql.html |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
406 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
407 Roundup includes a hardcoded list for all languages supported by |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
408 PostgreSQL 14.1. The list includes 5 custom "languages" |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
409 ``custom1`` ... ``custom5`` to allow you to set up your `own textsearch |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
410 configuration`_ using one of the custom names. Depending on your |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
411 PostgreSQL version, we may allow an invalid language to be configured. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
412 You will see an error about ``text search configuration ... does not |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
413 exist``. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
414 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
415 .. _own textsearch configuration: \ |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
416 https://www.postgresql.org/docs/14/textsearch-configuration.html |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
417 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
418 It may be possible to append to this list using the tracker's |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
419 interfaces.py. For details, see ``test/test_indexer.py`` in the |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
420 roundup distribution and search for ``valid_langs``. If you succeed |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
421 please email roundup-users AT lists.sourceforge.net with a description |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
422 of your success. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
423 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
424 After changing the configuration language, you must reindex the |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
425 tracker since the index must match the configuration language used for |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
426 querying. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
427 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
428 Also there are various `dictionaries`_ that allow you to: |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
429 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
430 * add stopwords |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
431 * override stemming for a term |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
432 * add synonyms (e.g. a search for "pg" can also match 'psql' |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
433 "postgresql") |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
434 * add terms that expand/contract the search space (Thesaurus |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
435 dictionary) |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
436 * additional transforms |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
437 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
438 .. _dictionaries: https://www.postgresql.org/docs/14/textsearch-dictionaries.html |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
439 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
440 Use of these is beyond this documentation. Please visit the |
|
6606
328ad56e438a
postgresql database fts - add to CHANGES and add url to admin.
John Rouillard <rouilj@ieee.org>
parents:
6604
diff
changeset
|
441 appropriate PostgreSQL documents. The following my also be helpful: |
|
328ad56e438a
postgresql database fts - add to CHANGES and add url to admin.
John Rouillard <rouilj@ieee.org>
parents:
6604
diff
changeset
|
442 |
|
328ad56e438a
postgresql database fts - add to CHANGES and add url to admin.
John Rouillard <rouilj@ieee.org>
parents:
6604
diff
changeset
|
443 * http://rachbelaid.com/postgres-full-text-search-is-good-enough/ |
|
6604
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
444 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
445 Ranking information is not used in this implementation. Also stop |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
446 words set in config.ini are ignored. These are areas for improvement. |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
447 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
448 Cleaning up old native indexes |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
449 ------------------------------ |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
450 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
451 If you are happy with the database fts indexing, you can save some space by |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
452 removing the data from the native text indexing tables. This requires |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
453 using the ``sqlite3`` or ``psql`` commands to execute SQL to delete the |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
454 rows in the ``__textids`` and ``__words`` tables. You can do this with |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
455 the following SQL commands:: |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
456 |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
457 delete from __words; |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
458 delete from __textids; |
|
0d99ae7c8de6
Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
459 |
|
6814
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
460 Note this deletes data from the tables and does *not* delete |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
461 the table. This allows you to revert to Roundup's native |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
462 full text indexing on SQLite or Postgres. If you were to |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
463 delete the tables, Roundup will not recreate the |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
464 tables. Under PostgreSQL, you can use the ``truncate |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
465 <tablename>`` command if you wish. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
466 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
467 Configuring Session Databases |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
468 ============================= |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
469 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
470 The session and OTK (one time key) databases |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
471 store information about the operation of Roundup. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
472 This ephemeral data: |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
473 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
474 * web login session keys, |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
475 * CSRF tokens, |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
476 * email password recovery one time keys, |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
477 * rate limiting data, |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
478 * ... |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
479 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
480 can be a performance bottleneck. It usually happens with |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
481 anydbm or SQLite backends. PostgreSQL and MySQL are |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
482 sufficiently powerful that they can handle the higher |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
483 transaction rates. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
484 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
485 If you are using sqlite, you can choose to use the anydbm |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
486 database for session data. By default it will use additional |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
487 sqlite databases for storing the session and otk data. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
488 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
489 The following table shows which primary databases support |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
490 different session database backends:: |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
491 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
492 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
493 main\/ session>| anydbm | sqlite | redis | mysql | postgresql | |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
494 anydbm | D | | X | | | |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
495 sqlite | X | D | X | | | |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
496 mysql | | | | D | | |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
497 postgresql | | | | | D | |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
498 --------------------------------------------------------------+ |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
499 D - default if unconfigured, X - compatible choice |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
500 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
501 The ``backend`` setting is in the tracker's ``config.ini`` |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
502 file under the ``sessiondb`` section. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
503 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
504 Using Redis for Session Databases |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
505 --------------------------------- |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
506 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
507 Redis is an in memory key/value data structure store. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
508 |
|
6819
1319ab13f286
redis works with python 2.7 too.
John Rouillard <rouilj@ieee.org>
parents:
6814
diff
changeset
|
509 You need to install the redis-py_ module from pypi. Then |
|
1319ab13f286
redis works with python 2.7 too.
John Rouillard <rouilj@ieee.org>
parents:
6814
diff
changeset
|
510 install Redis using your package manager or by downloading |
|
1319ab13f286
redis works with python 2.7 too.
John Rouillard <rouilj@ieee.org>
parents:
6814
diff
changeset
|
511 it from the Redis_ website. |
|
6814
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
512 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
513 You need to secure your redis instance. The data that |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
514 Roundup stores includes session cookies and other |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
515 authentication tokens. At minimum you should require a |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
516 password to connect to your redis database. Set |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
517 ``requirepass`` in ``redis.conf``. Then change the |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
518 ``redis_url`` in ``config.ini`` to use the password. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
519 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
520 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
521 For example:: |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
522 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
523 redis://:mypassword@localhost:7200/10 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
524 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
525 will connect to the redis instance running on localhost at |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
526 port 7200 using the password ``mypassword`` to open database |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
527 10. The ``redis_url`` setting can load a file to better |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
528 secure the url. If you are using redis 6.0 or newer, you can |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
529 specify a username/password and access control lists to |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
530 improv the security of your data. Another good alternative |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
531 is to talk to redis using a Unix domain socket. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
532 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
533 If you are connecting to redis across the network rather |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
534 than on localhost, you should configure ssl/tls and use the |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
535 ``rediss`` scheme in the url along with the query |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
536 parameters:: |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
537 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
538 ssl_cert_reqs=required&ssl_ca_certs=/path/to/custom/ca-cert |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
539 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
540 where you specify the file that can be used to validate the |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
541 SSL certificate. `Securing Redis`_ has more details. |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
542 |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
543 .. _Redis: https://redis.io |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
544 .. _redis-py: https://pypi.org/project/redis/ |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
545 .. _Securing Redis: https://redis.io/docs/manual/security/ |
|
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
546 |
|
6458
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
547 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
548 Users and Security |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
549 ================== |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
550 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
551 Roundup holds its own user database which primarily contains a username, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
552 password and email address for the user. Roundup *must* have its own user |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
553 listing, in order to maintain internal consistency of its data. It is a |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
554 relatively simple exercise to update this listing on a regular basis, or on |
|
4891
ad3d628e73f2
docs: Link custom authentication examples in admin guide
anatoly techtonik <techtonik@gmail.com>
parents:
4890
diff
changeset
|
555 demand, so that it matches an external listing (eg. |
|
ad3d628e73f2
docs: Link custom authentication examples in admin guide
anatoly techtonik <techtonik@gmail.com>
parents:
4890
diff
changeset
|
556 :ref:`unix passwd file<external-authentication>`, |
|
6265
b2eb59ada444
Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents:
6227
diff
changeset
|
557 `LDAP <https://wiki.roundup-tracker.org/LDAPLogin>`_, etc.) |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
558 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
559 Roundup identifies users in a number of ways: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
560 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
561 1. Through the web, users may be identified by either HTTP Basic |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
562 Authentication or cookie authentication. If you are running the web |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
563 server (roundup-server) through another HTTP server (eg. apache or IIS) |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
564 then that server may require HTTP Basic Authentication, and it will pass |
|
6436
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
565 the ``REMOTE_USER`` variable (or variable defined using |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
566 http_auth_header) through to Roundup. If this variable is not |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
567 present, then Roundup defaults to using its own cookie-based login |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
568 mechanism. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
569 2. In email messages handled by roundup-mailgw, users are identified by the |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
570 From address in the message. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
571 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
572 In both cases, Roundup's behaviour when dealing with unknown users is |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
573 controlled by Permissions defined in the "SECURITY SETTINGS" section of the |
|
2983
9614a101b68f
Stuff from the train ride this morning:
Richard Jones <richard@users.sourceforge.net>
parents:
2921
diff
changeset
|
574 tracker's ``schema.py`` module: |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
575 |
|
6751
2f7b653b7d6f
Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents:
6727
diff
changeset
|
576 Web Access and Register |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
577 If granted to the Anonymous Role, then anonymous users will be able to |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
578 register through the web. |
|
6751
2f7b653b7d6f
Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents:
6727
diff
changeset
|
579 Email Access and Register |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
580 If granted to the Anonymous Role, then email messages from unknown users |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
581 will result in those users being registered with the tracker. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
582 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
583 More information about how to customise your tracker's security settings |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
584 may be found in the `customisation documentation`_. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
585 |
|
6436
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
586 Configuring Authentication Header/Variable |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
587 ------------------------------------------ |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
588 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
589 The front end server running roundup can perform the user |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
590 authentication. It pass the authenticated username to the backend in a |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
591 variable. By default roundup looks for the ``REMOTE_USER`` variable |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
592 This can be changed by setting the parameter ``http_auth_header`` in the |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
593 ``[web]`` section of the tracker's ``config.ini`` file. If the value |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
594 is unset (the default) the REMOTE_USER variable is used. |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
595 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
596 If you are running roundup using ``roundup-server`` behind a proxy |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
597 that authenticates the user you need to configure ``roundup-server`` to |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
598 pass the proper header to the tracker. By default ``roundup-server`` |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
599 looks for the ``REMOTE_USER`` header for the authenticated user. You |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
600 can copy an arbitrary header variable to the tracker using the ``-I`` |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
601 option to roundup-server (or the equivalent option in the |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
602 roundup-server config file). |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
603 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
604 For example to use the ``uid_variable`` header, two configuration |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
605 changes are needed: First configure ``roundup-server`` to pass the |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
606 header to the tracker using:: |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
607 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
608 roundup-server -I uid_variable .... |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
609 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
610 note that the header is passed exactly as supplied by the upstream |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
611 server. It is **not** prefixed with ``HTTP_`` like other headers since |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
612 you are explicitly whitelisting the header. Multiple comma separated |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
613 headers can be passed to the ``-I`` option. These could be used in a |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
614 detector or other tracker extensions, but only one header can be used |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
615 by the tracker as an authentication header. |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
616 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
617 To make the tracker honor the new variable changing the tracker |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
618 ``config.ini`` to read:: |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
619 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
620 [web] |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
621 ... |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
622 http_auth_header = uid_variable |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
623 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
624 At the time this is written, support is experimental. If you use it |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
625 you should notify the roundup maintainers using the roundup-users |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
626 mailing list. |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
627 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
628 Tasks |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
629 ===== |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
630 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
631 Maintenance of Roundup can involve one of the following: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
632 |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
633 1. `tracker backup`_ |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
634 2. `software upgrade`_ |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
635 3. `migrating backends`_ |
|
2005
fc52d57c6c3e
documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
636 4. `moving a tracker`_ |
| 3250 | 637 5. `migrating from other software`_ |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
638 6. `adding a user from the command-line`_ |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
639 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
640 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
641 Tracker Backup |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
642 -------------- |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
643 |
|
3959
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
644 The roundup-admin import and export commands are **not** recommended for |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
645 performing backup. |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
646 |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
647 Optionally stop the web and email frontends and to copy the contents of the |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
648 tracker home directory to some other place using standard backup tools. |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
649 This means using |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
650 *pg_dump* to take a snapshot of your Postgres backend database, for example. |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
651 A simple copy of the tracker home (and files storage area if you've configured |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
652 it to be elsewhere) will then complete the backup. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
653 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
654 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
655 Software Upgrade |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
656 ---------------- |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
657 |
| 6781 | 658 .. _make a backup: #tracker-backup |
| 659 | |
| 660 Always `make a backup`_ of your tracker before upgrading software. | |
| 661 Steps you may take: | |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
662 |
|
6297
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
663 1. Install pytest and ensure that the unit tests run on your system |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
664 (using your preferred python version):: |
| 2474 | 665 |
|
6297
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
666 pip2 install pytest |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
667 python2 -m pytest test/ |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
668 |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
669 |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
670 pip3 install pytest |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
671 python3 -m pytest test/ |
| 2474 | 672 |
|
2387
4962f99aaa27
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2203
diff
changeset
|
673 2. If you're using an RDBMS backend, make a backup of its contents now. |
|
2478
3ab2b91cdd2c
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2474
diff
changeset
|
674 3. Make a backup of the tracker home itself. |
|
3ab2b91cdd2c
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2474
diff
changeset
|
675 4. Stop the tracker web and email frontends. |
|
4014
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
676 5. Install the new version of the software:: |
|
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
677 |
|
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
678 python setup.py install |
|
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
679 |
| 6781 | 680 6. Follow the steps in the `upgrading documentation`_ for all the |
|
6814
3f60a71b0812
Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents:
6781
diff
changeset
|
681 versions between your original version and the new version. |
|
3963
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
682 |
| 6781 | 683 Usually you should run `roundup_admin -i <tracker_home> migrate` |
| 684 on your tracker(s) before you allow users to start accessing the tracker. | |
|
3963
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
685 |
|
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
686 It's safe to run this even if it's not required, so just get into the |
|
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
687 habit. |
|
4014
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
688 7. Restart your tracker web and email frontends. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
689 |
| 2474 | 690 If something bad happens, you may reinstate your backup of the tracker and |
| 691 reinstall the older version of the sofware using the same install command:: | |
| 692 | |
| 693 python setup.py install | |
| 694 | |
| 6163 | 695 .. index:: database; convert from one database backend to another |
|
6173
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
696 single: roundup-admin; import and export |
| 6163 | 697 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
698 Migrating Backends |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
699 ------------------ |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
700 |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
701 1. Stop the existing tracker web and email frontends (preventing changes). |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
702 2. Use the roundup-admin tool "export" command to export the contents of |
|
5902
4f74b97dddcd
Doc how to export on windows.
John Rouillard <rouilj@ieee.org>
parents:
5300
diff
changeset
|
703 your tracker to disk. (If you are running on windows see |
|
4f74b97dddcd
Doc how to export on windows.
John Rouillard <rouilj@ieee.org>
parents:
5300
diff
changeset
|
704 `issue1441336 <https://issues.roundup-tracker.org/issue1441336>`_ |
|
4f74b97dddcd
Doc how to export on windows.
John Rouillard <rouilj@ieee.org>
parents:
5300
diff
changeset
|
705 on how to use the command line rather than interactive mode to |
|
6227
5105df69145d
Fix typo in admin doc exprt -> export.
John Rouillard <rouilj@ieee.org>
parents:
6176
diff
changeset
|
706 export data.) |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
707 3. Copy the tracker home to a new directory. |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
708 4. Delete the "db" directory from the new directory. |
|
5300
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
709 5. Set the value of the ``backend`` key under the ``[database]`` |
|
d8ed32b297e2
Update to migrating backend and tweak to install doc.
John Rouillard <rouilj@ieee.org>
parents:
5140
diff
changeset
|
710 section of the tracker's ``config.ini`` file. |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
711 6. Use the roundup-admin "import" command to import the previous export with |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
712 the new tracker home. If non-interactively:: |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
713 |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
714 roundup-admin -i <tracker home> import <tracker export dir> |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
715 |
|
4567
32b24abfe98e
Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents:
4489
diff
changeset
|
716 If interactively, enter 'commit' before exiting. |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
717 7. Test each of the admin tool, web interface and mail gateway using the new |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
718 backend. |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
719 8. Move the old tracker home out of the way (rename to "tracker.old") and |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
720 move the new tracker home into its place. |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
721 9. Restart web and email frontends. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
722 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
723 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
724 Moving a Tracker |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
725 ---------------- |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
726 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
727 If you're moving the tracker to a similar machine, you should: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
728 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
729 1. install Roundup on the new machine and test that it works there, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
730 2. stop the existing tracker web and email frontends (preventing changes), |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
731 3. copy the tracker home directory over to the new machine, and |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
732 4. start the tracker web and email frontends on the new machine. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
733 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
734 Most of the backends are actually portable across platforms (ie. from Unix to |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
735 Windows to Mac). If this isn't the case (ie. the tracker doesn't work when |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
736 moved using the above steps) then you'll need to: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
737 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
738 1. install Roundup on the new machine and test that it works there, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
739 2. stop the existing tracker web and email frontends (preventing changes), |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
740 3. use the roundup-admin tool "export" command to export the contents of |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
741 the existing tracker, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
742 4. copy the export to the new machine, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
743 5. use the roundup-admin "import" command to import the tracker on the new |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
744 machine, and |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
745 6. start the tracker web and email frontends on the new machine. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
746 |
| 6163 | 747 .. index:: |
| 748 pair: roundup; migrate from other bugtracker software | |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
749 |
| 3250 | 750 Migrating From Other Software |
| 751 ----------------------------- | |
| 752 | |
| 753 You have a couple of choices. You can either use a CSV import into Roundup, | |
| 754 or you can write a simple Python script which uses the Roundup API | |
| 755 directly. The latter is almost always simpler -- see the "scripts" | |
| 756 directory in the Roundup source for some example uses of the API. | |
| 757 | |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
758 "roundup-admin import" will import data into your tracker from a |
| 3250 | 759 directory containing files with the following format: |
| 760 | |
| 761 - one colon-separated-values file per Class with columns for each property, | |
| 762 named <classname>.csv | |
| 763 - one colon-separated-values file per Class with journal information, | |
| 764 named <classname>-journals.csv (this is required, even if it's empty) | |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
765 - if the Class is a FileClass, you may have the "content" property |
| 3250 | 766 stored in separate files from the csv files. This goes in a directory |
| 767 structure:: | |
| 768 | |
| 769 <classname>-files/<N>/<designator> | |
| 770 | |
| 771 where ``<designator>`` is the item's ``<classname><id>`` combination. | |
| 772 The ``<N>`` value is ``int(<id> / 1000)``. | |
| 773 | |
| 774 | |
| 6163 | 775 .. index:: pair: roundup-admin; managing users |
| 776 | |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
777 Adding A User From The Command-Line |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
778 ----------------------------------- |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
779 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
780 The ``roundup-admin`` program can create any data you wish to in the |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
781 database. To create a new user, use:: |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
782 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
783 roundup-admin create user |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
784 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
785 To figure out what good values might be for some of the fields (eg. Roles) |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
786 you can just display another user:: |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
787 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
788 roundup-admin list user |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
789 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
790 (or if you know their username, and it happens to be "richard"):: |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
791 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
792 roundup-admin filter user username=richard |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
793 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
794 then using the user id (e.g. 5) you get from one of the above |
|
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
795 commands, you may display the user's details:: |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
796 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
797 roundup-admin display <designator> |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
798 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
799 where designator is ``user5``. |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
800 |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
801 Running the Servers |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
802 =================== |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
803 |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
804 Unix |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
805 ---- |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
806 |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
807 On Unix systems, use the scripts/server-ctl script to control the |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
808 roundup-server server. Copy it somewhere and edit the variables at the top |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
809 to reflect your specific installation. |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
810 |
|
6344
c63df349f319
issue2551117 - add example systemd config
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
811 If you use systemd look at scripts/systemd.gunicorn. It is configured |
|
c63df349f319
issue2551117 - add example systemd config
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
812 for a wsgi deployment using gunicorn, but may be a good starting |
|
c63df349f319
issue2551117 - add example systemd config
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
813 point for your setup. |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
814 |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
815 Windows |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
816 ------- |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
817 |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
818 On Windows, the roundup-server program runs as a Windows Service, and |
|
5140
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
819 therefore may be controlled through the Services control panel. Note |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
820 that you **must** install the pywin32 package to allow roundup to |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
821 run as a service. The roundup-server program may also control the |
|
7ea6bbf4286c
update docs for windows installer: 32 bit version of python, must run nstaller as administrator, ned pywin32 to run as service. Encourage installation of pytz.
John Rouillard <rouilj@ieee.org>
parents:
5102
diff
changeset
|
822 service directly: |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
823 |
|
2405
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
824 **install the service** |
|
3779
ee73abcc95d2
Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents:
3465
diff
changeset
|
825 ``roundup-server -C /path/to/my/roundup-server.ini -c install`` |
|
2405
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
826 **start the service** |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
827 ``roundup-server -c start`` |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
828 **stop the service** |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
829 ``roundup-server -c stop`` |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
830 |
|
2405
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
831 To bring up the services panel: |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
832 |
|
2405
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
833 Windows 2000 and later |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
834 Start/Control Panel/Administrative Tools/Services |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
835 Windows NT4 |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
836 Start/Control Panel/Services |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
837 |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
838 You will need a server configuration file (as described in |
|
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
839 `Configuring roundup-server`_) for specifying tracker homes |
|
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
840 and other roundup-server configuration. Specify the name of |
|
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
841 this file using the ``-C`` switch when installing the service. |
|
3779
ee73abcc95d2
Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents:
3465
diff
changeset
|
842 |
|
2203
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
843 Running the Mail Gateway Script |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
844 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
845 |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
846 The mail gateway script should be scheduled to run regularly on your |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
847 Windows server. Normally this will result in a window popping up. The |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
848 solution to this is to: |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
849 |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
850 1. Create a new local account on the Roundup server |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
851 2. Set the scheduled task to run in the context of this user instead |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
852 of your normal login |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
853 |
|
6173
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
854 .. index:: ! roundup-admin |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
855 single: roundup-admin; man page reference |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
856 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
857 Using roundup-admin |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
858 =================== |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
859 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
860 Part of the installation includes a man page for roundup-admin. Ypu |
| 6175 | 861 should be able to read it using ``man roundup-admin``. As shown above, |
|
6173
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
862 it is a generic tool for manipulating the underlying database for you |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
863 tracker. |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
864 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
865 Examples above show how to use it to: |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
866 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
867 * install and initialize a new tracker |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
868 * export/import tracker data for migrating between backends |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
869 * creating a new user fom the command line |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
870 * list/find users in the tracker |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
871 |
| 6175 | 872 A brief (incomplete) summary is:: |
|
6173
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
873 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
874 roundup-admin help |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
875 roundup-admin -i <tracker_dir> get [-list] designator[, designator,...] propname |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
876 roundup-admin -i <tracker_dir> set designator[, designator,...] propname=value ... |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
877 roundup-admin -i <tracker_dir> find [-list] classname propname=value ... |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
878 |
| 6175 | 879 Run ``roundup-admin help commands`` for a complete list of subcommands. |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
880 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
881 .. _`customisation documentation`: customizing.html |
|
2387
4962f99aaa27
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2203
diff
changeset
|
882 .. _`upgrading documentation`: upgrading.html |
|
6458
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
883 .. _`installation documentation`: installation.html |
