Mercurial > p > roundup > code

annotate doc/admin_guide.txt @ 7962:828f79ae965b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: update links and docs on checking links Add timeout for link checking so make linkcheck completes. Document grep command to use to filter broken links to external links. Fix PostgreSQL links to point to current pages. Fix pyreadline3 link. Fix vim po file plugin link Use wayback machine for zpi internationalization link.
author John Rouillard <rouilj@ieee.org>
date Mon, 13 May 2024 18:42:26 -0400
parents 2946354d6ccd
children fe0348bbe45b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
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
7387
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7385
diff changeset
118 # Maximum number of children to spawn using fork multiprocess mode.
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7385
diff changeset
119 # Default: 40
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7385
diff changeset
120 max_children = 40
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7385
diff changeset
121
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
122 # don't fork (this overrides the pidfile mechanism)'
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
123 # Allowed values: yes, no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
124 # Default: no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
125 nodaemon = no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
126
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
127 # Log client machine names instead of IP addresses (much slower)
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
128 # Allowed values: yes, no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
129 # Default: no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
130 log_hostnames = no
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
131
7332
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
132 # Have http(s) request logging done via python logger module.
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
133 # If set to yes the python logging module is used with qualname
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
134 # 'roundup.http'. Otherwise logging is done to stderr or the file
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
135 # specified using the -l/logfile option.
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
136 # Allowed values: yes, no
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
137 # Default: no
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
138 loghttpvialogger = no
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
139
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
140 # 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
141 # 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
142 #
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
143 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
144 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
145 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
146 pidfile =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
147
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
148 # Log file path. If unset, log to stderr.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
149 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
150 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
151 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
152 logfile =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
153
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
154 # Set processing of each request in separate subprocess.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
155 # Allowed values: debug, none, thread, fork.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
156 # Default: fork
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
157 multiprocess = fork
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
158
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
159 # Tracker index template. If unset, built-in will be used.
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 template =
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 # Enable SSL support (requires pyopenssl)
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
166 # Allowed values: yes, no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
167 # Default: no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
168 ssl = no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
169
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
170 # PEM file used for SSL. A temporary self-signed certificate
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
171 # will be used if left blank.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
172 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
173 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
174 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
175 pem =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
176
7332
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
177 # Comma separated list of extra headers that should
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
178 # be copied into the CGI environment.
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
179 # E.G. if you want to access the REMOTE_USER and
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
180 # X-Proxy-User headers in the back end,
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
181 # set to the value REMOTE_USER,X-Proxy-User.
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
182 # Allowed values: comma-separated list of words
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
183 # Default:
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
184 include_headers =
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
185
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
186 # Change to HTTP/1.0 if needed. This disables keepalive.
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
187 # Default: HTTP/1.1
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
188 http_version = HTTP/1.1
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
189
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
190 # Roundup trackers to serve.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
191 # Each option in this section defines single Roundup tracker.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
192 # Option name identifies the tracker and will appear in the URL.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
193 # Option value is tracker home directory path.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
194 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
195 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
196 [trackers]
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
197
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
198 demo = /trackers/demo
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
199 sysadmin = /trackers/sysadmin
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
200
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
201 Additional notes for each keyword:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
202
3880
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
203 **template**
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
204 Specifies a template used for displaying the tracker index when
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
205 multiple trackers are being used. It is processed by TAL and
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
206 the variable "trackers" is available to the template and is a
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
207 dict of all configured trackers.
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
208 **ssl**
6835
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
209 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
210 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
211 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
212 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
213 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
214 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
215 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
216 additional information.
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
217 **pem**
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
218 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
219 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
220 headers (e.g. ``-----BEGIN PRIVATE KEY-----``,
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
221 ``-----END PRIVATE KEY-----`` and
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
222 ``-----BEGIN CERTIFICATE-----``,
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
223 ``-----END CERTIFICATE-----``.
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
224 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
225 for use.
3465
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
226 **trackers** section
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
227 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
228 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
229 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
230
7333
b92ecb730510 Document how save-config replaces and backs up config.ini.
John Rouillard <rouilj@ieee.org>
parents: 7332
diff changeset
231 To generate a config.ini in the current directory from the
b92ecb730510 Document how save-config replaces and backs up config.ini.
John Rouillard <rouilj@ieee.org>
parents: 7332
diff changeset
232 roundup-server command line use::
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
233
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
234 roundup_server -p 8017 -u roundup --save-config demo=/trackers/demo \
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
235 sysadmin=/trackers/sysadmin
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
236
7334
a83c932a00dc reword doc update
John Rouillard <rouilj@ieee.org>
parents: 7333
diff changeset
237 Note it will save an old config.ini file to config.bak and create a
a83c932a00dc reword doc update
John Rouillard <rouilj@ieee.org>
parents: 7333
diff changeset
238 new config.ini. The file is recreated from scratch ignoring the
7335
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 7334
diff changeset
239 contents of the current config.ini. You may need to merge the backup
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 7334
diff changeset
240 and config files. save-config doesn't attempt to load or verify an
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 7334
diff changeset
241 existing config.ini. Running this in a tracker home directory will
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 7334
diff changeset
242 move the exsiting config.ini to config.bak and replace it with the
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 7334
diff changeset
243 roundup-server's config.ini. This will make the tracker in the
b84718ea4228 document result of running save-config in a tracker home directory
John Rouillard <rouilj@ieee.org>
parents: 7334
diff changeset
244 directory fail to start util the original config.ini is restored.
7333
b92ecb730510 Document how save-config replaces and backs up config.ini.
John Rouillard <rouilj@ieee.org>
parents: 7332
diff changeset
245
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
246 Configuring Compression
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
247 =======================
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
248
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
249 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
250 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
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 dynamic_compression = No
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``. You should disable compression if
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
257 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
258 to compress responses on the fly. The python standard library includes
7385
87e9d761ecc6 fix typo
John Rouillard <rouilj@ieee.org>
parents: 7382
diff changeset
259 gzip support. For brotli or zstd you will need to install packages. See
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
260 the `installation documentation`_ for details.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
261
7853
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
262 .. index:: single: interfaces.py; configuring http compression
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
263
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
264 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
265 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
266 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
267 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
268
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
269 from roundup.cgi.client import Client
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
270
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
271 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
272
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
273 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
274
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
275 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
276 errors messages, short json responses).
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
277
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
278 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
279 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
280 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
281 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
282
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
283 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
284 ``@@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
285 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
286 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
287
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
288 [web]
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
289 ...
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
290 use_precompressed_files = Yes
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
291
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
292 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
293 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
294 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
295
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
296 tracker_home/html/library.js.gzip
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
297 tracker_home/html/library.js.br
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
298 tracker_home/html/library.js.zstd
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
299
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
300 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
301
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
302 gzip --keep --suffix .gzip library.js
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
303 brotli library.js
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
304 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
305
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
306 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
307 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
308 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
309
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
310 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
311 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
312 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
313 ``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
314 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
315 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
316
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
317 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
318 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
319 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
320 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
321 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
322 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
323 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
324
7853
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
325 .. index:: single: interfaces.py; setting REST maximum result limit
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
326
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
327 Configuring REST Maximum Result Limit
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
328 =====================================
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
329
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
330 To prevent denial of service (DOS) and limit user wait time for an
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
331 unbounded request, the REST endpoint has a maximum limit on the number
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
332 of rows that can be returned. By default, this is set to 10 million.
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
333 This setting applies to all users of the REST interface. If you want
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
334 to change this limit, you can add the following code to the
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
335 ``interfaces.py`` file in your tracker::
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
336
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
337 # change max response rows
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
338 from roundup.rest import RestfulInstance
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
339 RestfulInstance.max_response_row_size = 26
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
340
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
341 This code will set the maximum number of rows to 25 (one less than the
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
342 value). Note that this setting is rarely used and is not available in
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
343 the tracker's ``config.ini`` file. Setting it through this mechanism
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
344 allows you to enter a string or number that may break Roundup, such as
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
345 "asdf" or 0. In general, it is recommended to keep the limit at its
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
346 default value. However, this option is available for cases when a
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
347 request requires more than 10 million rows and pagination using
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
348 ``@page_index`` and ``@page_size=9999999`` is not possible.
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
349
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
350 Adding a Web Content Security Policy (CSP)
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
351 ==========================================
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
352
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
353 A Content Security Policy (`CSP`_) adds a layer of security to
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
354 Roundup's web interface. It makes it more difficult for an
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
355 attacker to compromise Roundup. By default Roundup does not add
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
356 a CSP. If you need to implement a CSP, this section will help you
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
357 understand how to add one and document the current level of
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
358 support for CSP in Roundup.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
359
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
360 Roundup's web interface has remained mostly unchanged since it
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
361 was created over a decade ago. Current releases have been slowly
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
362 modernizing the HTML to improve security. There are still some
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
363 improvements that need to happen before the tightest CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
364 configurations can be used.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
365
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
366 Writing a CSP is complex. This section just touches on how to
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
367 create and install a CSP to improve security. Some of it might
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
368 break functionality.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
369
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
370 There are two ways to add a CSP:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
371
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
372 1. a fixed CSP added by a server
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
373 2. a dynamic CSP added by Roundup
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
374
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
375 Fixed CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
376 ---------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
377
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
378 If you are using a web server (Apache, Nginx) to run Roundup, you can
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
379 add a ``Content-Security-Policy`` header using that server. WSGI
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
380 servers like uWSGI can also be configured to add headers. An example
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
381 header would look like::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
382
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
383 Content-Security-Policy: default-src 'self' 'unsafe-inline' 'strict-dynamic';
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
384
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
385 One thing that may need to be included is the ``unsafe-inline``.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
386 The default templates use ``onload``, ``onchange``, ``onsubmit``,
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
387 and ``onclick`` JavaScript handlers. Without ``unsafe-inline``
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
388 these won't work and popup helpers will not work. Sadly the use
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
389 of ``unsafe-inline`` is a pretty big hole in this CSP. You can
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
390 set the hashes for all the JavaScript handlers in the CSP. Then
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
391 replace ``unsafe-inline`` with ``unsafe-hashes`` to help close
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
392 this hole, but has its own issues. See `remediating
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
393 unsafe-inline`_ for another way to mitigate this.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
394
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
395 The inclusion of ``strict-dynamic`` allows trusted JavaScript
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
396 files that are downloaded from Roundup to make changes to the web
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
397 interface. These changes are also trusted code that will be run
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
398 when invoked.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
399
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
400 More secure CSPs can also be created. However because of the ability
7499
a072331c843b Change customizing to customising in all variants.
John Rouillard <rouilj@ieee.org>
parents: 7477
diff changeset
401 to customise the web interface, it is difficult to provide guidance.
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
402
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
403 Dynamic CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
404 -----------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
405
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
406 Roundup creates a cryptographic nonce for every client request. The
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
407 nonce is the value of the ``client.client_nonce`` property.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
408
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
409 By changing the templates to use the nonce, we can better secure the
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
410 Roundup instance. However the nonce has to be set in the CSP returned
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
411 by Roundup.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
412
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
413 One way to do this is to add a templating utility to the extensions
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
414 directory that generates the CSP on the fly. For example::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
415
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
416 default_security_headers = {
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
417 'Content-Security-Policy': (
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
418 "default-src 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
419 "base-uri 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
420 "script-src https: 'nonce-{nonce}' 'strict-dynamic'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
421 "style-src 'self' 'nonce-{nonce}'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
422 "img-src 'self' data:; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
423 "frame-ancestors 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
424 "object-src 'self' 'nonce-{nonce}'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
425 ),
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
426 }
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
427
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
428
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
429 def AddHtmlHeaders(client, header_dict=None):
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
430 ''' Generate https headers from dict use default security headers
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
431
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
432 Setting the header with a value of None will not inject the
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
433 header and can override the default set.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
434
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
435 Header values will be formatted with a dictionary including a
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
436 nonce. Use to set a nonce for inline scripts.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
437 '''
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
438 try:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
439 if client.client_nonce is None:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
440 # logger.warning("client_nonce is None")
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
441 client.client_nonce = client.session_api._gen_sid()
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
442 except AttributeError:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
443 # client.client_nonce doesn't exist, create it
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
444 # logger.warning("client_nonce does not exist, creating")
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
445 client.client_nonce = client.session_api._gen_sid()
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
446
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
447 headers = default_security_headers.copy()
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
448 if isinstance(header_dict, dict):
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
449 headers.update(header_dict)
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
450
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
451 client_headers = client.additional_headers
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
452
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
453 for header, value in list(headers.items()):
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
454 if value is None:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
455 continue
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
456 client_headers[header] = value.format(
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
457 nonce=client.client_nonce)
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
458
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
459 def init(instance):
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
460 instance.registerUtil('AddHtmlHeaders', AddHtmlHeaders)
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
461
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
462
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
463 Adding the following to ``page.html`` right after the opening
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
464 ``<html....`>`` tag::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
465
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
466 <tal:code tal:content="python:utils.AddHtmlHeaders(request.client)" />
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
467
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
468 will invoke ``AddHtmlHeaders()`` to add the CSP header with the nonce.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
469
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
470 With this set of CSP headers, all style, script and object tags will
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
471 need a ``nonce`` attribute. This can be added by changing::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
472
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
473 <script src="javascript.js"></script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
474
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
475 to::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
476
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
477 <script
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
478 tal:attributes="nonce request/client/client_nonce"
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
479 src="javascript.js"></script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
480
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
481 for each script, object or style tag.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
482
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
483 Remediating ``unsafe-inline``
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
484 -----------------------------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
485 .. _remediating unsafe-inline:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
486
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
487 Using a trusted script to set event handlers to replace the ``onX``
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
488 handlers allows removal of the ``unsafe-inline`` handlers. If you
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
489 remove ``unsafe-inline`` the ``onX`` handlers will not run. However
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
490 you can use the label provided by the ``onX`` attribute to securely
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
491 enable a callback function.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
492
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
493 This method is a work in progress. As an example proof of concept,
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
494 adding this "decorator" script at the end of page.html::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
495
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
496 <script tal:attributes="nonce request/client/client_nonce">
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
497 /* set submit event listener on forms that have an
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
498 onsubmit (case insensitive) attribute */
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
499 forms = document.querySelectorAll(form[onsubmit])
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
500 for (let form of f) {
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
501 form.addEventListener('submit',
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
502 () => submit_once());
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
503 };
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
504 </script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
505
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
506 will set callback for the submit even on any form that has an onsubmit
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
507 attribute to ``submit_once()``. ``submit_once`` is defined in Roundup's
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
508 base_javascript and is generated with a proper nonce.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
509
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
510 By including the nonce in the dynamic CSP, we can use our trusted
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
511 "decorator" script to add event listeners. These listeners will call
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
512 the trusted function in base_javascript to replace the ignored ``onX``
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
513 handlers.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
514
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
515 .. _CSP: https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
516
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
517 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
518 =======================================
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
519
6612
d05800c6bdfa text change.
John Rouillard <rouilj@ieee.org>
parents: 6606
diff changeset
520 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
521 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
522 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
523
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
524 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
525 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
526 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
527 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
528 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
529
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
530 SQLite details
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
531 --------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
532
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
533 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
534 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
535 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
536 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
537 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
538 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
539
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
540 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
541 language described at:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
542 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
543 supports:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
544
7593
7c3aee35a5ac docs: clarify sentence.
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
545 * plain word search (joined by 'and', similar to other search methods)
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
546 * phrase search with terms enclosed in quotes (``"``)
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
547 * proximity search with varying distances using ``NEAR()``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
548 * boolean operations by grouping with parentheses and using ``AND``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
549 and ``OR``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
550 * exclusion using ``NOT``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
551 * prefix searching by prefixing the term with``^``
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
552
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
553 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
554 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
555 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
556
6915
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
557 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
558 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
559 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
560 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
561 return no results but "the book" will return
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
562 results. Pre-filtering the stopwords when indexing would
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
563 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
564 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
565
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
566 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
567 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
568 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
569 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
570 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
571
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
572 PostgreSQL info
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
573 ---------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
574
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
575 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
576 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
577 languages are supported.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
578
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
579 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
580 `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
581
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
582 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
583 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
584
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
585 .. _Parsing Queries: \
7962
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7886
diff changeset
586 https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
587
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
588 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
589
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
590 * plain word search (stemmed in most cases)
6613
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6612
diff changeset
591 * 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
592 * 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
593 * 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
594 * 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
595
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
596 Tsquery supports:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
597
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
598 * a strict query syntax
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
599 * plain word search
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
600 * 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
601 ``'`` 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
602 in the phrase).
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
603 * 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
604 * 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
605 and ``|``
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
606 * exclusion using ``!``
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
607 * 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
608
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
609 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
610 weighing is not used.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
611
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
612 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
613 ``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
614 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
615 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
616 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
617 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
618
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
619 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
620 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
621 ``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
622 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
623 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
624
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
625 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
626 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
627 requires reindexing.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
628
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
629 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
630 ``\dF`` command.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
631
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
632 .. _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
633 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
634
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
635 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
636 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
637 ``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
638 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
639 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
640 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
641 exist``.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
642
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
643 .. _own textsearch configuration: \
7962
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7886
diff changeset
644 https://www.postgresql.org/docs/current/textsearch-configuration.html
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
645
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
646 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
647 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
648 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
649 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
650 of your success.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
651
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
652 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
653 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
654 querying.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
655
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
656 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
657
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
658 * add stopwords
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
659 * override stemming for a term
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
660 * add synonyms (e.g. a search for "pg" can also match 'psql'
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
661 "postgresql")
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
662 * add terms that expand/contract the search space (Thesaurus
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
663 dictionary)
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
664 * additional transforms
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
665
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
666 .. _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
667
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
668 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
669 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
670
7257
16d6d81b4565 update http to https url.
John Rouillard <rouilj@ieee.org>
parents: 7238
diff changeset
671 * https://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
672
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
673 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
674 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
675
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
676 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
677 ------------------------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
678
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
679 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
680 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
681 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
682 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
683 the following SQL commands::
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
684
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
685 delete from __words;
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
686 delete from __textids;
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
687
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
688 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
689 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
690 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
691 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
692 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
693 <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
694
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
695 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
696 =============================
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
697
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
698 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
699 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
700 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
701
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
702 * 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
703 * CSRF tokens,
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
704 * 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
705 * 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
706 * ...
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
707
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
708 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
709 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
710 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
711 transaction rates.
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
712
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
713 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
714 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
715 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
716
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
717 The following table shows which primary databases support
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
718 different session database backends:
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
719
7886
2946354d6ccd doc: replace X by + to indicate compatible options.
John Rouillard <rouilj@ieee.org>
parents: 7853
diff changeset
720 .. table:: D - default if unconfigured, + - compatible choice
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
721 :class: captionbelow
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
722
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
723 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
724 | | session db |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
725 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
726 |primary db | anydbm | sqlite | redis | mysql | postgresql |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
727 +===============+========+========+=======+=======+============+
7886
2946354d6ccd doc: replace X by + to indicate compatible options.
John Rouillard <rouilj@ieee.org>
parents: 7853
diff changeset
728 |anydbm | D | | + | | |
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
729 +---------------+--------+--------+-------+-------+------------+
7886
2946354d6ccd doc: replace X by + to indicate compatible options.
John Rouillard <rouilj@ieee.org>
parents: 7853
diff changeset
730 |sqlite | + | D | + | | |
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
731 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
732 |mysql | | | | D | |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
733 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
734 |postgresql | | | | | D |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
735 +---------------+--------+--------+-------+-------+------------+
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
736
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
737 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
738 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
739
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
740 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
741 ---------------------------------
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
742
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
743 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
744
6819
1319ab13f286 redis works with python 2.7 too.
John Rouillard <rouilj@ieee.org>
parents: 6814
diff changeset
745 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
746 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
747 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
748
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
749 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
750 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
751 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
752 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
753 ``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
754 ``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
755
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
756
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
757 For example::
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
758
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
759 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
760
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
761 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
762 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
763 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
764 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
765 specify a username/password and access control lists to
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
766 improve the security of your data. Another good alternative
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
767 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
768
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
769 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
770 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
771 ``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
772 parameters::
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
773
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
774 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
775
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
776 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
777 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
778
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
779 .. _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
780 .. _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
781 .. _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
782
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
783
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
784 Users and Security
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
785 ==================
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
786
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
787 Roundup holds its own user database which primarily contains a username,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
788 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
789 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
790 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
791 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
792 :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
793 `LDAP <https://wiki.roundup-tracker.org/LDAPLogin>`_, etc.)
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
794
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
795 Roundup identifies users in a number of ways:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
796
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
797 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
798 Authentication or cookie authentication. If you are running the web
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
799 server (roundup-server) through another HTTP server (eg. apache or IIS)
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
800 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
801 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
802 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
803 present, then Roundup defaults to using its own cookie-based login
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
804 mechanism.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
805 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
806 From address in the message.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
807
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
808 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
809 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
810 tracker's ``schema.py`` module:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
811
6751
2f7b653b7d6f Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
812 Web Access and Register
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
813 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
814 register through the web.
6751
2f7b653b7d6f Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
815 Email Access and Register
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
816 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
817 will result in those users being registered with the tracker.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
818
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
819 More information about how to customise your tracker's security settings
7354
692242b3effd initial pass to change references to reference doc where needed.
John Rouillard <rouilj@ieee.org>
parents: 7335
diff changeset
820 may be found in the `reference documentation`_.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
821
6436
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
822 Configuring Authentication Header/Variable
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
823 ------------------------------------------
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
824
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
825 The front end server running Roundup can perform the user
6436
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
826 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
827 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
828 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
829 ``[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
830 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
831
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
832 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
833 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
834 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
835 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
836 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
837 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
838 roundup-server config file).
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
839
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
840 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
841 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
842 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
843
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
844 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
845
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
846 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
847 server. It is **not** prefixed with ``HTTP_`` like other headers since
7615
60fc16b6a1cc doc: remove whitelist replace with allowing
John Rouillard <rouilj@ieee.org>
parents: 7594
diff changeset
848 you are explicitly allowing the header. Multiple comma separated
6436
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
849 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
850 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
851 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
852
7594
c9180009a286 docs: fix sentence.
John Rouillard <rouilj@ieee.org>
parents: 7593
diff changeset
853 To make the tracker honor the new variable, change the tracker's
6436
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
854 ``config.ini`` to read::
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
855
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
856 [web]
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
857 ...
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
858 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
859
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
860 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
861 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
862 mailing list.
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
863
7306
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
864
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
865 Securing Secrets
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
866 ================
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
867
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
868 Roundup can read secrets from a file that is referenced from any
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
869 of the config.ini files. If you use Docker, you can bind mount
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
870 the files from a secure location, or store them in a subdirectory
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
871 of the tracker home.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
872
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
873 You can also use a secrets management tool like Docker Swarm's
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
874 secrets management. This example config.ini configuration gets
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
875 the database password from a file populated by Swarm secrets::
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
876
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
877 [rdbms]
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
878 # Database user password.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
879 # A string that starts with 'file://' is interpreted as a file
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
880 # path relative to the tracker home. Using 'file:///' defines
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
881 # an absolute path. The first line of the file will be used as
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
882 # the value. Any string that does not start with 'file://' is
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
883 # used as is. It removes any whitespace at the end of the
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
884 # line, so a newline can be put in the file.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
885 #
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
886 # Default: roundup
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
887 password = file:///run/secrets/db_password
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
888
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
889 assuming that Docker Swarm secrets has the key ``db_password``
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
890 and the ``--secret db_password`` option is used when starting the
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
891 Roundup service.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
892
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
893 Because environment variables can be inadvertently exposed in
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
894 logs or process listings, Roundup does not currently support
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
895 loading secrets from environment variables.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
896
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
897 Tasks
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
898 =====
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
899
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
900 Maintenance of Roundup can involve one of the following:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
901
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
902 1. `tracker backup`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
903 2. `software upgrade`_
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
904 3. `migrating backends`_
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2003
diff changeset
905 4. `moving a tracker`_
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
906 5. `migrating from other software`_
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
907 6. `adding a user from the command-line`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
908
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
909
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
910 Tracker Backup
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
911 --------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
912
3959
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
913 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
914 performing backup.
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
915
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
916 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
917 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
918 This means using
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
919 *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
920 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
921 it to be elsewhere) will then complete the backup.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
922
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
923
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
924 Software Upgrade
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
925 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
926
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
927 .. _make a backup: #tracker-backup
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
928
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
929 Always `make a backup`_ of your tracker before upgrading software.
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
930 Steps you may take:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
931
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
932 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
933 (using your preferred python version)::
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
934
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
935 pip2 install pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
936 python2 -m pytest test/
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
937
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
938
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
939 pip3 install pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
940 python3 -m pytest test/
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
941
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
942 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
943 3. Make a backup of the tracker home itself.
3ab2b91cdd2c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2474
diff changeset
944 4. Stop the tracker web and email frontends.
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
945 5. Install the new version of the software::
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
946
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
947 python setup.py install
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
948
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
949 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
950 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
951
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
952 Usually you should run `roundup_admin -i <tracker_home> migrate`
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
953 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
954
3230f9c88086 Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents: 3959
diff changeset
955 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
956 habit.
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
957 7. Restart your tracker web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
958
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
959 If something bad happens, you may reinstate your backup of the tracker and
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
960 reinstall the older version of the sofware using the same install command::
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
961
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
962 python setup.py install
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
963
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
964 .. 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
965 single: roundup-admin; import and export
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
966
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
967 Migrating Backends
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
968 ------------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
969
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
970 1. Stop the existing tracker web and email frontends (preventing changes).
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
971 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
972 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
973 `issue1441336 <https://issues.roundup-tracker.org/issue1441336>`_
4f74b97dddcd Doc how to export on windows.
John Rouillard <rouilj@ieee.org>
parents: 5300
diff changeset
974 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
975 export data.)
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
976 3. Copy the tracker home to a new directory.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
977 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
978 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
979 section of the tracker's ``config.ini`` file.
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
980 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
981 the new tracker home. If non-interactively::
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
982
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
983 roundup-admin -i <tracker home> import <tracker export dir>
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
984
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4489
diff changeset
985 If interactively, enter 'commit' before exiting.
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
986 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
987 backend.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
988 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
989 move the new tracker home into its place.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
990 9. Restart web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
991
7668
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
992 If you are importing into PostgreSQL, it autocommits the data every
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
993 10000 objects/rows by default. This can slow down importing, but it
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
994 prevents an out of memory error caused by using a savepoint for each
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
995 object. You can control the commit frequency by using::
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
996
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
997 pragma savepoint_limit=20000
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
998
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
999 to set a higher or lower number in roundup-admin. In this example a
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
1000 commit will be done every 20,000 objects/rows. The pragma can also be
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
1001 set on the roundup-admin command line as described below.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1002
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1003 Moving a Tracker
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1004 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1005
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1006 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
1007
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1008 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
1009 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1010 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
1011 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
1012
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1013 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
1014 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
1015 moved using the above steps) then you'll need to:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1016
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1017 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
1018 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1019 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
1020 the existing tracker,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1021 4. copy the export to the new machine,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1022 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
1023 machine, and
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1024 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
1025
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1026 .. index::
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1027 pair: roundup; migrate from other bugtracker software
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1028
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1029 Migrating From Other Software
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1030 -----------------------------
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1031
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1032 You have a couple of choices. You can either use a CSV import into Roundup,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1033 or you can write a simple Python script which uses the Roundup API
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1034 directly. The latter is almost always simpler -- see the "scripts"
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1035 directory in the Roundup source for some example uses of the API.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1036
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1037 "roundup-admin import" will import data into your tracker from a
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1038 directory containing files with the following format:
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1039
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1040 - one colon-separated-values file per Class with columns for each property,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1041 named <classname>.csv
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1042 - one colon-separated-values file per Class with journal information,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1043 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
1044 - if the Class is a FileClass, you may have the "content" property
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1045 stored in separate files from the csv files. This goes in a directory
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1046 structure::
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1047
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1048 <classname>-files/<N>/<designator>
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1049
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1050 where ``<designator>`` is the item's ``<classname><id>`` combination.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1051 The ``<N>`` value is ``int(<id> / 1000)``.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1052
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1053
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1054 .. index:: pair: roundup-admin; managing users
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1055
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1056 Adding A User From The Command-Line
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1057 -----------------------------------
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1058
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1059 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
1060 database. To create a new user, use::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1061
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1062 roundup-admin create user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1063
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1064 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
1065 you can just display another user::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1066
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1067 roundup-admin list user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1068
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1069 (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
1070
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1071 roundup-admin filter user username=richard
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1072
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1073 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
1074 commands, you may display the user's details::
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1075
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1076 roundup-admin display <designator>
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1077
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1078 where designator is ``user5``.
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1079
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1080 Running the Servers
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1081 ===================
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1082
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1083 Unix
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1084 ----
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1085
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1086 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
1087 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
1088 to reflect your specific installation.
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1089
6344
c63df349f319 issue2551117 - add example systemd config
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
1090 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
1091 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
1092 point for your setup.
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1093
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1094 Windows
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1095 -------
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1096
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1097 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
1098 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
1099 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
1100 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
1101 service directly:
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1102
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1103 **install the service**
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3465
diff changeset
1104 ``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
1105 **start the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1106 ``roundup-server -c start``
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1107 **stop the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1108 ``roundup-server -c stop``
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1109
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1110 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
1111
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1112 Windows 2000 and later
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1113 Start/Control Panel/Administrative Tools/Services
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1114 Windows NT4
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1115 Start/Control Panel/Services
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1116
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1117 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
1118 `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
1119 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
1120 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
1121
2203
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1122 Running the Mail Gateway Script
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1124
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1125 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
1126 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
1127 solution to this is to:
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1128
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1129 1. Create a new local account on the Roundup server
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1130 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
1131 of your normal login
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1132
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1133 Mail gateway script command line
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1134 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1135
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1136 Usage::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1137
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1138 usage: roundup_mailgw.py [-h] [-v] [-c DEFAULT_CLASS] [-I OAUTH_CLIENT_ID]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1139 [-O OAUTH_DIRECTORY] [-S SET_VALUE]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1140 [-T OAUTH_TOKEN_ENDPOINT]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1141 [args ...]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1142
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1143
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1144 The roundup mail gateway may be called in one of three ways:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1145
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1146 - without arguments. Then the env var ROUNDUP_INSTANCE will be tried.
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1147 - with an instance home as the only argument,
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1148 - with both an instance home and a mail spool file, or
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1149 - with an instance home, a mail source type and its specification.
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1150
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1151 It also supports optional ``-S`` (or ``--set-value``) arguments that allows you
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1152 to set fields for a class created by the roundup-mailgw. The format for
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1153 this option is [class.]property=value where class can be omitted and
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1154 defaults to msg. The ``-S`` options uses the same
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1155 property=value[;property=value] notation accepted by the command line
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1156 roundup command or the commands that can be given on the Subject line of
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1157 an email message (if you're using multiple properties delimited with a
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1158 semicolon the class must be specified only once in the beginning).
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1159
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1160 It can let you set the type of the message on a per e-mail address basis
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1161 by calling roundup-mailgw with different email addresses and other
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1162 settings.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1163
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1164 PIPE:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1165 If there is no mail source specified, the mail gateway reads a single
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1166 message from the standard input and submits the message to the
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1167 roundup.mailgw module.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1168
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1169 UNIX mailbox:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1170 In this case, the gateway reads all messages from the UNIX mail spool
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1171 file and submits each in turn to the roundup.mailgw module. The file is
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1172 emptied once all messages have been successfully handled. The file is
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1173 specified as::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1174
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1175 mailbox /path/to/mailbox
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1176
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1177 In all of the following mail source types, the username and password
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1178 can be stored in a ``~/.netrc`` file. If done so, only the server name
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1179 needs to be specified on the command-line.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1180 The username and/or password will be prompted for if not supplied on
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1181 the command-line or in ``~/.netrc``.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1182
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1183 POP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1184 For the mail source "pop", the gateway reads all messages from the POP
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1185 server specified and submits each in turn to the roundup.mailgw module.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1186 The server is specified as::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1187
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1188 pop username:password@server
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1189
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1190 The username and password may be omitted::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1191
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1192 pop username@server
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1193 pop server
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1194
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1195 are both valid.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1196
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1197 POPS:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1198 Connect to a POP server over tls/ssl.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1199 This supports the same notation as POP::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1200
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1201 pops username:password@server
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1202
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1203 APOP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1204 Same as POP, but using Authenticated POP::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1205
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1206 apop username:password@server
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1207
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1208 IMAP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1209 Connect to an IMAP server. This supports the same notation as that of
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1210 POP mail::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1211
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1212 imap username:password@server
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1213
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1214 It also allows you to specify a specific mailbox other than INBOX using
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1215 this format::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1216
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1217 imap username:password@server mailbox
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1218
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1219 IMAPS:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1220 Connect to an IMAP server over tls/ssl.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1221 This supports the same notation as IMAP::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1222
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1223 imaps username:password@server [mailbox]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1224
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1225 IMAPS_CRAM:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1226 Connect to an IMAP server over tls/ssl using CRAM-MD5 authentication.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1227 This supports the same notation as IMAP::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1228
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1229 imaps_cram username:password@server [mailbox]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1230
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1231 IMAPS_OAUTH:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1232 Connect to an IMAP server over tls/ssl using OAUTH authentication.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1233 Note that this does not support a password in imaps URLs.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1234 Instead it uses only the user and server and a command-line option for
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1235 the directory with the files ``access_token``, ``refresh_token``,
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1236 ``client_secret``, and ``client_id``.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1237 By default this directory is ``oauth`` in your tracker home directory. The
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1238 access token is tried first and, if expired, the refresh token together
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1239 with the client secret is used to retrieve a new access token. Note that
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1240 both token files need to be *writeable*, the access token is
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1241 continuously replaced and some cloud providers may also renew the
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1242 refresh token from time to time::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1243
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1244 imaps_oauth username@server [mailbox]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1245
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1246 The refresh and access tokens (the latter can be left empty), the
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1247 client id and the client secret need to be retrieved via cloud provider
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1248 specific protocols or websites.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1249
7503
7b6278da3faa Update roundup-mailgw install with other methods; formatting
John Rouillard <rouilj@ieee.org>
parents: 7499
diff changeset
1250 You need the requests_ library installed to ue the IMAPS_OAUTH method.
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1251
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1252 .. _requests: https://requests.readthedocs.io/en/latest/
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1253
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1254 .. index:: ! roundup-admin
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1255 single: roundup-admin; usage
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1256 single: roundup-admin; data formats
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1257 single: roundup-admin; man page reference
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1258 pair: roundup-admin; designator
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1259
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1260 Using roundup-admin
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1261 ===================
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1262
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1263 Part of the installation includes a man page for roundup-admin. Ypu
6175
72a69753f49a fix typos.
John Rouillard <rouilj@ieee.org>
parents: 6173
diff changeset
1264 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
1265 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
1266 tracker.
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1267
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1268 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
1269
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1270 * install and initialize a new tracker
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1271 * export/import tracker data for migrating between backends
7477
f40626db85dd typo fix.
John Rouillard <rouilj@ieee.org>
parents: 7454
diff changeset
1272 * creating a new user from the command line
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1273 * list/find users in the tracker
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1274
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1275 The basic usage is:
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1276
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1277 .. code-block:: text
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1278
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1279 Usage: roundup-admin [options] [<command> <arguments>]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1280
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1281 Options:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1282 -i instance home -- specify the issue tracker "home directory" to administer
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1283 -u -- the user[:password] to use for commands (default admin)
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1284 -d -- print full designators not just class id numbers
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1285 -c -- when outputting lists of data, comma-separate them.
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1286 Same as '-S ","'.
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1287 -S <string> -- when outputting lists of data, string-separate them
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1288 -s -- when outputting lists of data, space-separate them.
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1289 Same as '-S " "'.
7546
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7503
diff changeset
1290 -P pragma=value -- Set a pragma on command line rather than interactively.
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7503
diff changeset
1291 Can be used multiple times.
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1292 -V -- be verbose when importing
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1293 -v -- report Roundup and Python versions (and quit)
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1294
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1295 Only one of -s, -c or -S can be specified.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1296
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1297 Help:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1298 roundup-admin -h
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1299 roundup-admin help -- this help
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1300 roundup-admin help <command> -- command-specific help
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1301 roundup-admin help all -- all available help
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1302
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1303 Commands:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1304 commit
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1305 create classname property=value ...
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1306 display designator[,designator]*
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1307 export [[-]class[,class]] export_dir
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1308 exporttables [[-]class[,class]] export_dir
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1309 filter classname propname=value ...
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1310 find classname propname=value ...
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1311 genconfig <filename>
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1312 get property designator[,designator]*
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1313 help topic
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1314 history designator [skipquiet] [raw]
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1315 import import_dir
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1316 importtables export_dir
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1317 initialise [adminpw]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1318 install [template [backend [key=val[,key=val]]]]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1319 list classname [property]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1320 migrate
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1321 pack period | date
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1322 perftest [mode] [arguments]*
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1323 pragma setting=value | 'list'
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1324 reindex [classname|classname:#-#|designator]*
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1325 restore designator[,designator]*
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1326 retire designator[,designator]*
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1327 rollback
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1328 security [Role name]
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1329 set items property=value [property=value ...]
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1330 specification classname
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1331 table classname [property[,property]*]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1332 templates [trace_search]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1333 updateconfig <filename>
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1334 Commands may be abbreviated as long as the abbreviation
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1335 matches only one command, e.g. l == li == lis == list.
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1336
7093
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1337 One thing to note, The ``-u user`` setting does not currently operate
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1338 like a user logging in via the web. The user running roundup-admin
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1339 must have read access to the tracker home directory. As a result the
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1340 user has access to the files and the database info contained in
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1341 config.ini.
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1342
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1343 Using ``-u user`` sets the actor/user parameter in the
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1344 journal. Changes that are made are attributed to that
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1345 user. The password is ignored if provided. Any existing
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1346 username has full access to the data just like the admin
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1347 user. This is an area for further development so that
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1348 roundup-admin could be used with sudo to provide secure
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1349 command line access to a tracker.
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1350
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1351 In general you should forget that there is a -u parameter.
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1352
7404
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1353 All commands (except help, genconfig, templates) require a tracker
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1354 specifier. This is just the path to the roundup tracker you're working
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1355 with. A roundup tracker is where roundup keeps the database and
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1356 configuration file that defines an issue tracker. It may be thought of
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1357 as the issue tracker's "home directory". It may be specified in the
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1358 environment variable ``TRACKER_HOME`` or on the command line as "``-i
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1359 tracker``".
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1360
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1361 A designator is a classname and an itemid concatenated, eg. bug1,
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1362 user10, ... Property values are represented as strings in command
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1363 arguments and in the printed results:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1364
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1365 - Strings are, well, strings.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1366 - Password values will display as their encoded value.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1367 - Date values are printed in the full date format in the local time
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1368 zone, and accepted in the full format or any of the partial formats
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1369 explained below.::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1370
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1371 Input of... Means...
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1372 "2000-04-17.03:45" 2000-04-17.03:45:00
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1373 "2000-04-17" 2000-04-17.00:00:00
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1374 "01-25" yyyy-01-25.00:00:00
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1375 "08-13.22:13" yyyy-08-13.22:13:00
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1376 "11-07.09:32:43" yyyy-11-07.09:32:43
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1377 "14:25" yyyy-mm-dd.14:25:00
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1378 "8:47:11" yyyy-mm-dd.08:47:11
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1379 "2003" 2003-01-01.00:00:00
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1380 "2003-04" 2003-04-01.00:00:00
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1381 "." "right now"
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1382
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1383 - Link values are printed as item designators. When given as an
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1384 argument, item designators and key strings are both accepted.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1385 - Multilink values are printed as lists of item designators joined by
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1386 commas. When given as an argument, item designators and key strings
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1387 are both accepted; an empty string, a single item, or a list of items
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1388 joined by commas is accepted.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1389
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1390 When multiple items are specified to the roundup get or roundup set
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1391 commands, the specified properties are retrieved or set on all the
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1392 listed items. When multiple results are returned by the roundup get or
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1393 roundup find commands, they are printed one per line (default) or joined
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1394 by commas (with the "``-c``" option).
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1395
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1396 Where the command changes data, a login name/password is required. The
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1397 login may be specified as either "``name``" or "``name:password``".
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1398
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1399 - ``ROUNDUP_LOGIN`` environment variable
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1400 - the "``-u``" command-line option
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1401
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1402 If either the name or password is not supplied, they are obtained from
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1403 the command-line.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1404
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1405 The ``-u user`` setting does not currently operate like a
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1406 user logging in via the web. The user running roundup-admin
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1407 must have read access to the tracker home directory. As a
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1408 result the user has access to the files and the database
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1409 info contained in config.ini.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1410
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1411 Using ``-u user`` sets the actor/user parameter in the
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1412 journal. Changes that are made are attributed to that
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1413 user. The password is ignored if provided. Any existing
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1414 username has full access to the data just like the admin
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1415 user. This is an area for further development so that
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1416 roundup-admin could be used with sudo to provide secure
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1417 command line access to a tracker.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1418
7454
76b2f3c95c03 Add anchor for init section.
John Rouillard <rouilj@ieee.org>
parents: 7404
diff changeset
1419 .. _initpw:
76b2f3c95c03 Add anchor for init section.
John Rouillard <rouilj@ieee.org>
parents: 7404
diff changeset
1420
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1421 When you initialise a new tracker instance you are prompted for the
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1422 admin password. If you want to initialise a tracker non-interactively
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1423 you can put the initialise command and password on the command
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1424 line. But this allows others on the host to see the password (using
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1425 the ps command). To initialise a tracker non-interactively without
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1426 exposing the password, create a file (e.g init_tracker) set to mode
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1427 600 (so only the owner can read it) with the contents:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1428
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1429 initialise admin_password
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1430
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1431 and feed it to roundup-admin on standard input. E.G.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1432
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1433 cat init_tracker | roundup-admin -i tracker_dir
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1434
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1435 (for more details see https://issues.roundup-tracker.org/issue2550789.)
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1436
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1437 .. index:: ! roundup-admin; usage in scripts
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1438
7795
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1439 Using Interactively
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1440 -------------------
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1441
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1442 You can edit the command line using left/right arrow keys to move the
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1443 cursor. Using the up/down arrow keys moves among commands. It will
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1444 save your commands between roundup-admin sessions. This is supported
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1445 on Unix/Linux and Mac's. On windows you should install the pyreadline3
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1446 package (see `installation documentation`_).
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1447
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1448 Using the ``history_length`` pragma you can set the saved history size
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1449 for just one session.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1450
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1451 You can add initialization commands to ``~/.roundup_admin_rlrc``. It
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1452 will be loaded when roundup-admin starts. This is the mechanism to
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1453 persistently set the number of history commands, change editing modes
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1454 (Vi vs. Emacs). Note that redefining the history file will not work.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1455
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1456 If you are using GNU readline, ``set history-size 10``. If your
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1457 installation uses libedit (macs), it should be possible to
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1458 persistently set the history size using ``history size
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1459 10``. Pyreadline3 can set history length using
7962
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7886
diff changeset
1460 ``history_length(10)``. See the documentation for example syntax:
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7886
diff changeset
1461 https://pythonhosted.org/pyreadline/usage.html#configuration-file.
7795
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1462
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1463 History is saved to the file ``.roundup_admin_history`` in your home
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1464 directory (for windows usually ``\Users\<username>``.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1465
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1466 Using with the shell
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1467 --------------------
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1468
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1469 With version 0.6.0 or newer of roundup (which introduced support for
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1470 multiple designators to display and the -d, -S and -s flags):
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1471
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1472 To find all messages regarding chatting issues that contain the word
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1473 "spam", for example, you could execute the following command from the
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1474 directory where the database dumps its files::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1475
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1476 shell% for issue in `roundup-admin -ds find issue status=chatting`; do
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1477 > grep -l spam `roundup-admin -ds ' ' get messages $issue`
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1478 > done
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1479 msg23
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1480 msg49
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1481 msg50
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1482 msg61
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1483 shell%
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1484
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1485 Or, using the -dc option, this can be written as a single command::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1486
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1487 shell% grep -l spam `roundup get messages \
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1488 \`roundup -dc find issue status=chatting\``
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1489 msg23
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1490 msg49
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1491 msg50
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1492 msg61
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1493 shell%
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1494
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1495 You can also display issue contents::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1496
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1497 shell% roundup-admin display `roundup-admin -dc get messages \
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1498 issue3,issue1`
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1499 files: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1500 inreplyto: None
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1501 recipients: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1502 author: 1
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1503 date: 2003-02-16.21:23:03
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1504 messageid: None
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1505 summary: jkdskldjf
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1506 files: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1507 inreplyto: None
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1508 recipients: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1509 author: 1
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1510 date: 2003-02-15.01:59:11
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1511 messageid: None
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1512 summary: jlkfjadsf
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1513
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1514 or status::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1515
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1516 shell% roundup-admin get name `/tools/roundup/bin/roundup-admin \
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1517 -dc -i /var/roundup/sysadmin get status issue3,issue1`
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1518 unread
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1519 deferred
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1520
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1521 or status on a single line::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1522
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1523 shell% echo `roundup-admin get name \`/tools/roundup/bin/roundup-admin \
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1524 -dc -i /var/roundup/sysadmin get status issue3,issue1\``
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1525 unread deferred
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1526
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1527 which is the same as::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1528
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1529 shell% roundup-admin -s get name `/tools/roundup/bin/roundup-admin \
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1530 -dc -i /var/roundup/sysadmin get status issue3,issue1`
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1531 unread deferred
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1532
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1533 Also the tautological::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1534
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1535 shell% roundup-admin get name \
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1536 `roundup-admin -dc get status \`roundup-admin -dc find issue \
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1537 status=chatting\``
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1538 chatting
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1539 chatting
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1540
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1541 Remember the roundup commands that accept multiple designators accept
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1542 them ',' separated so using '-dc' is almost always required.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1543
7667
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1544 A Note on Import and Export
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1545 ---------------------------
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1546
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1547 This is a little in the weeds, but I have noticed this and was asked
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1548 about it so I am documenting it for the future.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1549
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1550 Running ``roundup-admin`` with ``-V`` to get additional info when
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1551 importing/exporting the tracker generates three types of messages.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1552
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1553 For example::
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1554
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1555 $ roundup-admin -i tracker -V export ./myExport
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1556 Exporting priority - 5
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1557 Exporting Journal for priority
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1558 Exporting status - 1
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1559 Exporting Journal for status
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1560 [...]
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1561
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1562
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1563 $ roundup-admin -i tracker -V import ./myExport
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1564 Importing priority - 7
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1565 setting priority 8
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1566 Importing status - 8
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1567 setting status 9
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1568 [...]
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1569
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1570 Note the numbers for status. Exported ends up at 1, Imported ends up
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1571 at 8 and setting chooses 9. These numbers are derived differently and
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1572 used differently. You can't directly compare them.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1573
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1574 ``Exporting issue - XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1575
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1576 ``XXX`` is the id number of the node being exported/processed from
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1577 the database. The order is determined by sorting by the key of the
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1578 class (as set by sortkey). If the class key is 'id', then it's a
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1579 string sort so '9' comes before '1009'. You might notice if the
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1580 export is slow the numbers jumping around.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1581
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1582 It does not usually end up as the total number of nodes
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1583 exported. However if it crashes, you know what node it was
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1584 processing at the time.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1585
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1586 In the example above, the status node with id 1 was the last one
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1587 when sorted alphabetically by name.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1588
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1589 ``Importing <class> - XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1590
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1591 ``XXX`` is the number of the node (not the node id) being
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1592 imported/currently processed at line XXX+1 in the file. It is an
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1593 incrementing number starting at 0 and never jumps around. Value 0
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1594 is consumed when reading the header and not displayed. The final
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1595 value is the same as the number of objects and one less then the
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1596 number of lines in the file. If it crashes, you were processing
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1597 the line at XXX+1.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1598
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1599 ``setting <class> XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1600
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1601 ``XXX`` in the setting line should always be one more than the
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1602 number of imported objects. The setting value is the id for the
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1603 next created object of that type. So in theory the Importing
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1604 number should be one less than the setting number.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1605
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1606 However under certain circumstances, Roundup can skip an id
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1607 number. This can lead to a difference of more than 1 between the
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1608 Importing and setting numbers. It's not a problem. However setting
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1609 can (and must) always be higher than the Importing number.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
1610
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1611
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1612 .. _`customisation documentation`: customizing.html
7354
692242b3effd initial pass to change references to reference doc where needed.
John Rouillard <rouilj@ieee.org>
parents: 7335
diff changeset
1613 .. _`reference documentation`: reference.html
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
1614 .. _`upgrading documentation`: upgrading.html
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
1615 .. _`installation documentation`: installation.html
Roundup Issue Tracker: http://roundup-tracker.org/