Mercurial > p > roundup > code

annotate doc/admin_guide.txt @ 8412:0663a7bcef6c reauth-confirm_id

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
feat: finish reauth docs, enhance code. Decided to keep name Reauth for now. admin_guide.txt: add reference mark to roundup admin help. Used for template command reference in upgrading.txt. customizing.txt: added worked example of adding a reauth auditor for address and password. Also links to OWASP recommendations. Added link to example code in design.doc on detectors. glossary.txt: reference using roundup-admin template command in def for tracker templates. pydoc.txt: Added methods for Client class. Added class and methods for (cgi) Action, LoginAction and ReauthAction. reference.txt Edited and restructured detector section. Added section on registering a detector and priority use/execution order. (reference to design doc was used before). Added/enhanced description of exception an auditor can raise (includes Reauth). Added section on Reauth implementation and use (Confirming the User). Also has paragraph on future ideas. upgrading.txt Stripped down the original section. Moved a lot to reference.txt. Referenced customizing example, mention installation of _generic.reauth.html and reference reference.txt. cgi/actions.py: fixed bad ReST that was breaking pydoc.txt processing changed doc on limitations of Reauth code. added docstring for Reauth::verifyPassword cgi/client.py: fix ReST for a method breaking pydoc.py processing cgi/templating.py: fix docstring on embed_form_fields templates/*/html/_generic.reauth.html disable spelling for password field add timing info to the javascript function that processes file data. reformat javascript IIFE templates/jinja2/html/_generic.reauth.html create a valid jinja2 template. Looks like my original jinja template got overwritten and committed. feature parity with the other reauth templates. test/test_liveserver.py add test case for Reauth workflow. Makefile add doc.
author John Rouillard <rouilj@ieee.org>
date Wed, 13 Aug 2025 23:52:49 -0400
parents 6ea309c6d17c
children 94eed885e958
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.
8297
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
226 **loghttpvialogger** section
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
227 If you:
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
228
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
229 * have **loghttpvialogger** enabled
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
230 * use **pidfile**
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
231 * use a logging config file in the tracker's config.ini
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
232
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
233 it is essential to specify absolute paths for log files in the
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
234 tracker's logging.config file. The use of pidfile causes the
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
235 server to switch to the root directory ('/'). As a result
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
236 relative paths in the logging ini configuration file (as
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
237 opposed to the tracker's config.ini) will be written to the
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
238 system's root directory. The access error will cause the server
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
239 to exit.
3465
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
240 **trackers** section
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
241 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
242 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
243 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
244
7333
b92ecb730510 Document how save-config replaces and backs up config.ini.
John Rouillard <rouilj@ieee.org>
parents: 7332
diff changeset
245 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
246 roundup-server command line use::
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
247
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
248 roundup_server -p 8017 -u roundup --save-config demo=/trackers/demo \
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
249 sysadmin=/trackers/sysadmin
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
250
7334
a83c932a00dc reword doc update
John Rouillard <rouilj@ieee.org>
parents: 7333
diff changeset
251 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
252 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
253 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
254 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
255 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
256 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
257 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
258 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
259
7981
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
260 .. _configuring-compression:
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
261
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
262 Configuring Compression
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
263 =======================
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
264
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
265 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
266 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
267
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
268 [web]
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
269 ...
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
270 dynamic_compression = No
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
271
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
272 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
273 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
274 to compress responses on the fly. The python standard library includes
7385
87e9d761ecc6 fix typo
John Rouillard <rouilj@ieee.org>
parents: 7382
diff changeset
275 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
276 the `installation documentation`_ for details.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
277
7853
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
278 .. 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
279
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
280 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
281 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
282 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
283 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
284
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
285 from roundup.cgi.client import Client
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
286
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
287 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
288
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
289 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
290
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
291 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
292 errors messages, short json responses).
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
293
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
294 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
295 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
296 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
297 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
298
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
299 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
300 ``@@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
301 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
302 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
303
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
304 [web]
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 use_precompressed_files = Yes
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
307
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
308 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
309 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
310 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
311
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
312 tracker_home/html/library.js.gzip
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
313 tracker_home/html/library.js.br
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
314 tracker_home/html/library.js.zstd
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
315
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
316 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
317
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
318 gzip --keep --suffix .gzip library.js
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
319 brotli library.js
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
320 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
321
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
322 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
323 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
324 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
325
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
326 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
327 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
328 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
329 ``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
330 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
331 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
332
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
333 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
334 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
335 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
336 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
337 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
338 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
339 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
340
8039
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
341 .. _browser_handling_attached_files:
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
342
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
343 .. index:: single: interfaces.py; Controlling browser handling of attached files
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
344
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
345 Controlling Browser Handling of Attached Files
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
346 ==============================================
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
347
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
348 You may be aware of the ``allow_html_file`` `config.ini setting
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
349 <reference.html#config-ini-section-web>`_. When set to yes, it permits
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
350 html files to be attached and displayed in the browser as html
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
351 files. The underlying mechanism used to enable/disable attaching HTML
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
352 is exposed using ``interfaces.py``.
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
353
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
354 Similar to ``Client.precompressed_mime_types`` above, there is a
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
355 ``Client.mime_type_allowlist``. If a mime type is present in this
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
356 list, an attachment with this mime type is served to the browser. If
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
357 the mime type is not present, the mime type is set to
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
358 ``application/octet-stream`` which causes the browser to download the
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
359 attachment to a file.
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
360
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
361 In release 2.4.0, the mime type ``application/pdf`` was removed from
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
362 the precompressed_mime_types list. This prevents the browser from
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
363 executing scripts that may be included in the PDF file. If you trust
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
364 the individuals uploading PDF files to your tracker and wish to allow
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
365 viewing PDF files from your tracker, you can do so by editing your
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
366 tracker's "interfaces.py" file. Adding::
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
367
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
368 from roundup.cgi.client import Client
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
369 Client.mime_type_allowlist.append('application/pdf')
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
370
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
371 will permit the PDF files to be viewed in the browser rather than
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
372 downloaded to a file.
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
373
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
374 Similarly, you can remove a mime type (e.g. audio/oog) using::
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
375
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
376 from roundup.cgi.client import Client
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
377 Client.mime_type_allowlist.remove('audio/oog')
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
378
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
379 which will force the browser to save the attachment to a file rather
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
380 than playing the audio file.
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
381
7853
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
382 .. 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
383
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
384 Configuring REST Maximum Result Limit
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
385 =====================================
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
386
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
387 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
388 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
389 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
390 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
391 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
392 ``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
393
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
394 # change max response rows
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
395 from roundup.rest import RestfulInstance
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
396 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
397
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
398 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
399 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
400 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
401 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
402 "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
403 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
404 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
405 ``@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
406
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
407 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
408 ==========================================
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
409
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
410 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
411 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
412 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
413 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
414 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
415 support for CSP in Roundup.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
416
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
417 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
418 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
419 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
420 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
421 configurations can be used.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
422
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
423 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
424 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
425 break functionality.
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 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
428
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
429 1. a fixed CSP added by a server
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
430 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
431
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
432 Fixed CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
433 ---------
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 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
436 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
437 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
438 header would look like::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
439
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
440 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
441
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
442 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
443 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
444 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
445 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
446 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
447 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
448 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
449 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
450 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
451
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
452 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
453 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
454 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
455 when invoked.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
456
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
457 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
458 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
459
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
460 .. _dynamic_csp:
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
461
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
462 Dynamic CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
463 -----------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
464
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
465 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
466 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
467
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
468 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
469 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
470 by Roundup.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
471
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
472 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
473 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
474
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
475 default_security_headers = {
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
476 'Content-Security-Policy': (
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
477 "default-src 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
478 "base-uri 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
479 "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
480 "style-src 'self' 'nonce-{nonce}'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
481 "img-src 'self' data:; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
482 "frame-ancestors 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
483 "object-src 'self' 'nonce-{nonce}'; "
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 }
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
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
488 def AddHtmlHeaders(self, header_dict=None):
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
489 ''' 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
490
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
491 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
492 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
493
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
494 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
495 nonce. Use to set a nonce for inline scripts.
8352
6ea309c6d17c docs: fix registerutilMethod docs, format for highlights.
John Rouillard <rouilj@ieee.org>
parents: 8297
diff changeset
496
6ea309c6d17c docs: fix registerutilMethod docs, format for highlights.
John Rouillard <rouilj@ieee.org>
parents: 8297
diff changeset
497 self is an instance of the TemplatingUtilities class, so
6ea309c6d17c docs: fix registerutilMethod docs, format for highlights.
John Rouillard <rouilj@ieee.org>
parents: 8297
diff changeset
498 you have access to self.client as well as any functions added
6ea309c6d17c docs: fix registerutilMethod docs, format for highlights.
John Rouillard <rouilj@ieee.org>
parents: 8297
diff changeset
499 using registerUtil.
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
500 '''
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
501 try:
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
502 if self.client.client_nonce is None:
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
503 # logger.warning("client_nonce is None")
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
504 self.client.client_nonce = self.client.session_api._gen_sid()
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
505 except AttributeError:
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
506 # self.client.client_nonce doesn't exist, create it
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
507 # logger.warning("client_nonce does not exist, creating")
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
508 self.client.client_nonce = client.session_api._gen_sid()
7238
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 headers = default_security_headers.copy()
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
511 if isinstance(header_dict, dict):
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
512 headers.update(header_dict)
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
513
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
514 client_headers = self.client.additional_headers
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
515
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
516 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
517 if value is None:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
518 continue
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
519 client_headers[header] = value.format(
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
520 nonce=self.client.client_nonce)
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
521
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
522 def init(instance):
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
523 # Note the use of the new (in version 2.5) registerUtilMethod
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
524 instance.registerUtilMethod('AddHtmlHeaders', AddHtmlHeaders)
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
525
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
526
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
527 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
528 ``<html....`>`` tag::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
529
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
530 <tal:code tal:content="python:utils.AddHtmlHeaders()" />
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
531
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
532 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
533
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
534 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
535 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
536
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
537 <script src="javascript.js"></script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
538
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
539 to::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
540
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
541 <script
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
542 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
543 src="javascript.js"></script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
544
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
545 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
546
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
547 If you are using a version of Roundup before version 2.5, you need to
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
548 replace ``instance.registerUtilMethod`` with
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
549 ``instance.registerUtil``. For example::
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
550
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
551 def init(instance):
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
552 instance.registerUtil('AddHtmlHeaders', AddHtmlHeaders)
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
553
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
554 The AddHtmlHeaders function needs to be changed so that ``self.client``
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
555 is replaced by ``client``::
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
556
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
557 # replace self parameter with client
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
558 def AddHtmlHeaders(client, header_dict=None):
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
559 ''' Generate https headers from dict use default security headers
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
560
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
561 Setting the header with a value of None will not inject the
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
562 header and can override the default set.
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
563
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
564 Header values will be formatted with a dictionary including a
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
565 nonce. Use to set a nonce for inline scripts.
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
566 '''
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
567
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
568 ### Then change all references to self.client to client
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
569
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
570 try:
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
571 if client.client_nonce is None: # note self.client -> client
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
572 # logger.warning("client_nonce is None")
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
573 client.client_nonce = self.client.session_api._gen_sid()
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
574
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
575 ...
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
576
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
577 Lastly the client must be passed explicitly when calling
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
578 AddHtmlHeaders. The call looks like::
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
579
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
580 <tal:code tal:content="python:utils.AddHtmlHeaders(request.client)" />
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
581
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
582
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
583 Remediating ``unsafe-inline``
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
584 -----------------------------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
585 .. _remediating unsafe-inline:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
586
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
587 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
588 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
589 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
590 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
591 enable a callback function.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
592
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
593 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
594 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
595
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
596 <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
597 /* 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
598 onsubmit (case insensitive) attribute */
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
599 forms = document.querySelectorAll(form[onsubmit])
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
600 for (let form of f) {
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
601 form.addEventListener('submit',
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
602 () => submit_once());
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
603 };
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
604 </script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
605
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
606 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
607 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
608 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
609
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
610 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
611 "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
612 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
613 handlers.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
614
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
615 .. _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
616
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
617 Classhelper Web Component
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
618 =========================
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
619
7974
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
620 Version 2.4.0 provides a new classhelper popup written as a web
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
621 component. By installing 3 files and editing the tracker's templates
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
622 you can enable the new component.
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
623
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
624 The `development of this component was done by team-03
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
625 <https://github.com/UMB-CS-682-Team-03/tracker>`_ of the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
626 Spring 2024 CS682 graduate software engineering SDL capstone
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
627 class at the University of Massachusetts - Boston. Their
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
628 documentation is copied/adapted below.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
629
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
630 File Installation
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
631 -----------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
632
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
633 There are three files to install in your tracker. You can
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
634 copy them from the template directory for the classic
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
635 tracker. The location of the template file can be obtained
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
636 by running: ``roundup-admin templates`` and looking for the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
637 path value of the classic template. If the path value is
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
638 ``/path/to/template``, copy::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
639
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
640 /path/to/template/html/classhelper.js
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
641 /path/to/template/html/classhelper.css
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
642 /path/to/template/html/_generic.translation
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
643
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
644 to your tracker's html directory.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
645
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
646 Wrapping the Classic Classhelper
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
647 --------------------------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
648
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
649 To allow your users to select items in the web interface
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
650 using the new classhelper, you should edit the template files
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
651 in the ``html/`` subdirectory of your tracker. Where you see
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
652 code like::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
653
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
654 <th i18n:translate="">Superseder</th>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
655 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
656 <span tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
657 python:context.superseder.field(showid=1,size=20)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
658 <span tal:condition="context/is_edit_ok"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
659 tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
660 python:db.issue.classhelp('id,title',
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
661 property='superseder', pagesize=100)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
662 [...]
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
663 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
664
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
665 change it to wrap the classhelp span like this::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
666
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
667 <th i18n:translate="">Superseder</th>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
668 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
669 <span tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
670 python:context.superseder.field(showid=1,size=20)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
671 <roundup-classhelper
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
672 data-popup-title="Superseder Classhelper - {itemDesignator}"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
673 data-search-with="title,status,keyword[]-name">
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
674 <span tal:condition="context/is_edit_ok"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
675 tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
676 python:db.issue.classhelp('id,title',
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
677 property='superseder', pagesize=100)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
678 </roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
679 [...]
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
680 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
681
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
682 which displays a three part classhelper.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
683
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
684 1. the search pane includes a text search box for the `title`
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
685 and `status` properties and a dropdown for the keyword property,
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
686 sorted by name in descending order.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
687 2. the selection pane will show 100 search results per page.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
688 It also allows the user to move to the next or previous result
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
689 page.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
690 3. the accumulator at the bottom shows all the selected items. It
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
691 also has buttons to accept the items or cancel the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
692 classhelper, leaving the original page unchanged.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
693
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
694 Note that the user class is a little different because users without
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
695 an Admin role can't search for a user by Role. So we hide the Role
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
696 search element for non admin users. Starting with::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
697
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
698 <th i18n:translate="">Nosy List</th>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
699 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
700 <span tal:replace="structure context/nosy/field" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
701 <span tal:condition="context/is_edit_ok" tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
702 python:db.user.classhelp('username,realname,address',
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
703 property='nosy', width='600'" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
704 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
705
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
706 wrap the classhelp span with ``<roundup-classhelper>`` like::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
707
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
708 <th i18n:translate="">Nosy List</th>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
709 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
710 <span tal:replace="structure context/nosy/field" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
711 <roundup-classhelper tal:define="search string:name,phone,roles[]"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
712 tal:attributes="data-search-with python:search
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
713 if request.user.hasRole('Admin') else
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
714 ','.join(search.split(',')[:-1])">
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
715 <span tal:condition="context/is_edit_ok" tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
716 python:db.user.classhelp('username,realname,address',
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
717 property='nosy', width='600'" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
718 </roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
719 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
720
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
721 The ``','.join(search.split(',')[:-1])`` removes the last element of
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
722 the search string (``roles[]``) if the user does not have the Admin
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
723 role.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
724
7981
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
725 Loading the <roundup-classhelper> Script
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
726 ----------------------------------------
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
727
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
728 To make the ``<roundup-classhelper>`` wrappers work, you
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
729 have to load the classhelper.js script. Add the following
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
730 html script tag in the head section of page.html::
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
731
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
732 <script type="text/javascript" src="@@file/classhelper.js">
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
733 </script>
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
734
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
735 You can place it anywhere before ``</head>``. This will make
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
736 it available on all pages.
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
737
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
738 The script will also work if it is loaded at the end of the
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
739 body. It can also be added to the ``more-javascript`` slot
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
740 in one of the templates (see ``user.item.html`` for an
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
741 example) if you don't want the overhead of loading the script
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
742 on every page.
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
743
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
744 You may want to minimize and precompress the file. Using
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
745 dynamic compression, the file is 10k when compressed with
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
746 gzip (8k with brotli). If you minimize the file first with
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
747 `rjsmin <https://pypi.org/project/rjsmin/>`_ and then
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
748 compress it, it's about 6k. See the information about using
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
749 precompressed files in the :ref:`section on compression
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
750 <configuring-compression>`.
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
751
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
752 <roundup-classhelper> configuration
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
753 -----------------------------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
754
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
755 There are two attributes used to configure the classhelper.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
756
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
757 data-popup-title:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
758 * this attribute is optional. A reasonable default is
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
759 provided if it is missing.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
760 * Adding ``data-popup-title`` changes the title of the popup
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
761 window with the value of the attribute.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
762 * ``{itemDesignator}`` can be used inside the attribute value
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
763 to replace it with the current classhelper usage context.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
764 E.G. ``data-popup-title="Nosy List Classhelper - {itemDesignator}"``
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
765 will display the popup window title as ``Nosy List Classhelper - issue24``
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
766
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
767 data-search-with:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
768 * this attribute is optional. If it is not set, a search
7975
16c2e2849fd6 doc: grammar fixup.
John Rouillard <rouilj@ieee.org>
parents: 7974
diff changeset
769 panel is not created to allow the user to search within
16c2e2849fd6 doc: grammar fixup.
John Rouillard <rouilj@ieee.org>
parents: 7974
diff changeset
770 the class.
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
771 * Adding ``data-search-with`` specifies the fields that can
7976
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
772 be used for searching. For example when invoking the
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
773 classhelper for the issue class, using
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
774 ``data-search-with="title,status,keyword"`` wil enable
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
775 three search fields.
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
776 * The search can be customized using the following syntax:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
777
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
778 * Adding ``[]`` at then end of a field (``"status[]"``)
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
779 will displays a dropdown for the "status" field
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
780 listing all the values the user can access. E.G.::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
781
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
782 <roundup-classhelper
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
783 data-search-with="title,status[],keyword[]">
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
784 <span tal:condition="context/is_edit_ok"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
785 tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
786 python:db.issue.classhelp('id,title',
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
787 property='superseder', pagesize=100)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
788 </roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
789
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
790 will create a search pane with a text search for title
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
791 and dropdowns for status and keyword.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
792
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
793 * Adding a sort key after the ``[]`` allows you to
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
794 select the order of the elements in the dropdown. For
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
795 example ``keyword[]+name`` sorts the keyword
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
796 dropdown in ascending order by name. While
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
797 ``keyword[]-name`` sorts the keyword dropdown in
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
798 descending order by name. If the sort order is not
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
799 specified, the default order for the class is used.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
800
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
801 <roundup-classhelper> styling
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
802 -----------------------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
803
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
804 The roundup-classhelper component uses minimal styling so it
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
805 can blend in with most trackers. If you want to change the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
806 styling, you can modify the classhelper.css file in the html
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
807 directory. Even though roundup-classhelper is a web
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
808 component, it doesn't use the shadow DOM. If you don't know
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
809 what this means, it just means that it's easy to style.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
810
7977
d3c0d3c9f5e7 docs: update cache updating for css file.
John Rouillard <rouilj@ieee.org>
parents: 7976
diff changeset
811 Getting the web component to load changes to the css file is
d3c0d3c9f5e7 docs: update cache updating for css file.
John Rouillard <rouilj@ieee.org>
parents: 7976
diff changeset
812 a bit tricky. The browser caches the old file and you have
d3c0d3c9f5e7 docs: update cache updating for css file.
John Rouillard <rouilj@ieee.org>
parents: 7976
diff changeset
813 to resort to tricks to make it get a new copy of the file.
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
814
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
815 One way to do this is to open to the ``classhelper.css``
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
816 file in your browser and force refresh it. To do this:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
817
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
818 1. Open the home page for your Roundup issue tracker in a
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
819 web browser.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
820
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
821 2. In the address bar, append ``@@file/classhelper.css``
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
822 to the end of your Roundup URL. For example, if your
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
823 Roundup URL is ``https://example.com/tracker/``, the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
824 URL you should visit would be
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
825 ``https://example.com/tracker/@@file/classhelper.css``.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
826
8015
72fb18809559 docs: fix markup
John Rouillard <rouilj@ieee.org>
parents: 7981
diff changeset
827 3. This will open the ``classhelper.css`` file in your browser.
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
828
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
829 4. Press ``Ctrl+Shift+R`` (on Windows and Linux) or
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
830 ``Cmd+Shift+R`` (on macOS). This triggers a hard
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
831 refresh of the page, which forces the browser to
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
832 reload the file and associated resources from the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
833 server.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
834
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
835 This should resolve any issues caused by cached or outdated
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
836 files. It is possible that you have to open devtools and set
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
837 the disable cache option in the network panel in extreme
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
838 cases.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
839
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
840 Also during development, you might want to `set a very low
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
841 cache time
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
842 <customizing.html#changing-cache-control-headers>`_ for
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
843 classhelper.css using something like::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
844
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
845 Client.Cache_Control['classhelper.css'] = "public, max-age=10"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
846
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
847
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
848 Translations
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
849 ------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
850
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
851 To set up translations for the <roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
852 component, follow these steps.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
853
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
854 1. Create a ``messages.pot`` file by running
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
855 ``roundup-gettext <tracker_home_directory>``. This
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
856 creates ``locale/messages.pot`` in your tracker's home
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
857 directory. It extracts all translatable strings from
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
858 your tracker. We will use it as a base template for the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
859 new strings you want to translate.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
860 2. See if you already have a ``.po`` translation file for
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
861 your language in the tracker's locale/ directory. If you
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
862 don't, copy ``messages.pot`` to a .po file for the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
863 language you want to translate. For example German
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
864 would be at ``de.po`` English would be at ``en.po``
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
865 (for example if you want to change the ``apply`` button
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
866 to say ``Do It``.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
867
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
868 3. Edit the new .po file. After the header, add the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
869 translation entries for the <roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
870 component. For example `next` and `submit` are
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
871 displayed in English when the rest of the interface is
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
872 in German. Add::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
873
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
874 msgid "submit"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
875 msgstr "gehen"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
876
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
877 msgid "next"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
878 msgstr "nächste"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
879
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
880 msgid "name"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
881 msgstr "name"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
882
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
883 Note: the value for `msgid` is case sensitive. You can
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
884 see the msgid for static strings by looking for
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
885 ``CLASSHELPER_TRANSLATION_KEYWORDS`` in classhelper.js.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
886
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
887 4. Save the .po file.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
888
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
889 5. Restart your Roundup instance.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
890
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
891 This should display the missing translations, for more
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
892 details refer to the `translation (i18n) section of the
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
893 developers documentation
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
894 <developers.html#extracting-translatable-messages>`_.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
895
7974
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
896 The default title used for read only popups can be changed by using
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
897 the translation mechanism. Use the following::
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
898
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
899 msgid "Info on {className} - {itemDesignator} - Classhelper"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
900 msgstr "{itemDesignator} - info on {className}"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
901
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
902 in ``en.po`` to reformat the title for the English language. Note that
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
903 ``{classname}`` is only supported in the default title.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
904
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
905 In addition to the default template you can translate a title set
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
906 using ``data-popup-title`` by matching the template as the msgid.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
907 Using an example above::
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
908
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
909 msgid "Nosy List Classhelper - {itemDesignator}"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
910 msgstr "Nosy List Klassenhelfer - {itemDesignator}"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
911
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
912 placed in ``de.po`` will translate the title into German.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
913
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
914 Troubleshooting
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
915 ---------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
916
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
917 The roundup-classhelper will fallback to using the classic
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
918 classhelper if:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
919
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
920 * the user doesn't have REST access
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
921 * the browser doesn't support web components
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
922
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
923 It will display an alert modal dialog to the user before triggering
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
924 the classic classhelper as a fallback. A detailed error will be
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
925 printed to the browser console. The console is visible in devtools and
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
926 can be opened by pressing the ``F12`` key.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
927
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
928 You can disable the classhelper on a per URL basis by adding
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
929 ``#classhelper-wc-toggle`` to the end of the URL. This will prevent
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
930 the web component from starting up.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
931
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
932 Also you can set ``DISABLE_CLASSHELP = true`` at the top of
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
933 classhelper.js to disable the classhelper without having to make any
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
934 changes to your templates.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
935
7974
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
936 Advanced Configuration
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
937 ----------------------
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
938
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
939 The classhelper.js file has a few tweakable options for use
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
940 by advanced users. The endpoint for the roles list requires
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
941 the user to have Admin rights. You can add your own roles
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
942 endpoint with a different authorization mechanism. The
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
943 following code can be added to your tracker's interfaces.py.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
944 You can create this file if it doesn't exist. This code
7979
ecb09e5d0bfa docs: fix formatting.
John Rouillard <rouilj@ieee.org>
parents: 7978
diff changeset
945 creates a new REST endpoint at ``/rest/roles``::
7974
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
946
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
947 from roundup.rest import Routing, RestfulInstance, _data_decorator
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
948
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
949 class RestfulInstance:
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
950
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
951 @Routing.route("/roles", 'GET')
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
952 @_data_decorator
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
953 def get_roles(self, input):
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
954 """Return all defined roles. The User class property
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
955 roles is a string but simulate it as a MultiLink
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
956 to an actual Roles class.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
957 """
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
958 return 200, {"collection":
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
959 [{"id": rolename,"name": rolename}
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
960 for rolename in list(self.db.security.role.keys())]}
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
961
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
962
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
963 See the `REST documentation <rest.html>`_ for details on
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
964 using ``interfaces.py`` to add new REST endpoints.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
965
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
966 The code above allows any user with REST access to see all
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
967 the roles defined in the tracker.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
968
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
969 To make classhelper.js use this new endpoint, look for::
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
970
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
971
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
972 const ALTERNATIVE_DROPDOWN_PATHNAMES = {
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
973 "roles": "/rest/data/user/roles"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
974 }
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
975
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
976 and change it to::
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
977
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
978 const ALTERNATIVE_DROPDOWN_PATHNAMES = {
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
979 "roles": "/rest/roles"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
980 }
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
981
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
982 Users may have to perform a hard reload to cache this change
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
983 on their system.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
984
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
985 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
986 =======================================
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
987
6612
d05800c6bdfa text change.
John Rouillard <rouilj@ieee.org>
parents: 6606
diff changeset
988 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
989 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
990 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
991
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
992 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
993 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
994 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
995 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
996 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
997
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
998 SQLite details
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
999 --------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1000
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1001 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
1002 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
1003 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
1004 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
1005 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
1006 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
1007
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1008 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
1009 language described at:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1010 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
1011 supports:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1012
7593
7c3aee35a5ac docs: clarify sentence.
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
1013 * plain word search (joined by 'and', similar to other search methods)
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1014 * phrase search with terms enclosed in quotes (``"``)
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1015 * proximity search with varying distances using ``NEAR()``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1016 * boolean operations by grouping with parentheses and using ``AND``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1017 and ``OR``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1018 * exclusion using ``NOT``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1019 * 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
1020
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1021 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
1022 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
1023 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
1024
6915
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
1025 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
1026 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
1027 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
1028 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
1029 return no results but "the book" will return
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
1030 results. Pre-filtering the stopwords when indexing would
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
1031 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
1032 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
1033
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1034 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
1035 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
1036 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
1037 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
1038 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
1039
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1040 PostgreSQL info
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1041 ---------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1042
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1043 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
1044 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
1045 languages are supported.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1046
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1047 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
1048 `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
1049
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1050 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
1051 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
1052
8073
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1053 .. _Parsing Queries:
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1054 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
1055
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1056 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
1057
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1058 * plain word search (stemmed in most cases)
6613
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6612
diff changeset
1059 * 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
1060 * 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
1061 * 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
1062 * 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
1063
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1064 Tsquery supports:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1065
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1066 * a strict query syntax
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1067 * plain word search
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1068 * 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
1069 ``'`` 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
1070 in the phrase).
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1071 * 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
1072 * 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
1073 and ``|``
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1074 * exclusion using ``!``
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1075 * 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
1076
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1077 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
1078 weighing is not used.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1079
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1080 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
1081 ``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
1082 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
1083 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
1084 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
1085 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
1086
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1087 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
1088 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
1089 ``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
1090 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
1091 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
1092
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1093 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
1094 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
1095 requires reindexing.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1096
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1097 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
1098 ``\dF`` command.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1099
8073
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1100 .. _configuration list can be obtained using using psql's:
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1101 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
1102
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1103 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
1104 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
1105 ``custom1`` ... ``custom5`` to allow you to set up your `own textsearch
8073
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1106 configuration`_ using one of the custom names. Depending on your
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1107 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
1108 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
1109 exist``.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1110
8073
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1111 .. _own textsearch configuration:
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1112 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
1113
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1114 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
1115 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
1116 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
1117 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
1118 of your success.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1119
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1120 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
1121 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
1122 querying.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1123
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1124 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
1125
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1126 * add stopwords
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1127 * override stemming for a term
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1128 * add synonyms (e.g. a search for "pg" can also match 'psql'
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1129 "postgresql")
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1130 * add terms that expand/contract the search space (Thesaurus
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1131 dictionary)
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1132 * additional transforms
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1133
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1134 .. _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
1135
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1136 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
1137 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
1138
7257
16d6d81b4565 update http to https url.
John Rouillard <rouilj@ieee.org>
parents: 7238
diff changeset
1139 * 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
1140
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1141 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
1142 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
1143
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1144 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
1145 ------------------------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1146
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1147 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
1148 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
1149 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
1150 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
1151 the following SQL commands::
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1152
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1153 delete from __words;
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1154 delete from __textids;
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1155
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1156 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
1157 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
1158 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
1159 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
1160 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
1161 <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
1162
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1163 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
1164 =============================
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1165
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1166 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
1167 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
1168 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
1169
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1170 * 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
1171 * CSRF tokens,
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1172 * 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
1173 * 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
1174 * ...
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1175
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1176 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
1177 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
1178 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
1179 transaction rates.
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1180
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1181 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
1182 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
1183 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
1184
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1185 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
1186 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
1187
7886
2946354d6ccd doc: replace X by + to indicate compatible options.
John Rouillard <rouilj@ieee.org>
parents: 7853
diff changeset
1188 .. 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
1189 :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
1190
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1191 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1192 | | session db |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1193 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1194 |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
1195 +===============+========+========+=======+=======+============+
8016
098ceff38349 docs: escape + in table, prevent it from starting an unordered list
John Rouillard <rouilj@ieee.org>
parents: 8015
diff changeset
1196 |anydbm | D | | \+ | | |
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1197 +---------------+--------+--------+-------+-------+------------+
8016
098ceff38349 docs: escape + in table, prevent it from starting an unordered list
John Rouillard <rouilj@ieee.org>
parents: 8015
diff changeset
1198 |sqlite | \+ | D | \+ | | |
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1199 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1200 |mysql | | | | D | |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1201 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1202 |postgresql | | | | | D |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1203 +---------------+--------+--------+-------+-------+------------+
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1204
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1205 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
1206 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
1207
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1208 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
1209 ---------------------------------
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1210
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1211 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
1212
6819
1319ab13f286 redis works with python 2.7 too.
John Rouillard <rouilj@ieee.org>
parents: 6814
diff changeset
1213 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
1214 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
1215 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
1216
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1217 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
1218 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
1219 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
1220 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
1221 ``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
1222 ``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
1223
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1224
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1225 For example::
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1226
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1227 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
1228
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1229 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
1230 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
1231 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
1232 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
1233 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
1234 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
1235 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
1236
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1237 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
1238 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
1239 ``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
1240 parameters::
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1241
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1242 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
1243
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1244 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
1245 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
1246
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1247 .. _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
1248 .. _redis-py: https://pypi.org/project/redis/
8055
335b8a40e355 docs: update link to redis.io security doc.
John Rouillard <rouilj@ieee.org>
parents: 8041
diff changeset
1249 .. _Securing Redis: https://redis.io/docs/latest/operate/oss_and_stack/management/security/
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1250
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
1251
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1252 Users and Security
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1253 ==================
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1254
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1255 Roundup holds its own user database which primarily contains a username,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1256 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
1257 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
1258 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
1259 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
1260 :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
1261 `LDAP <https://wiki.roundup-tracker.org/LDAPLogin>`_, etc.)
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1262
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1263 Roundup identifies users in a number of ways:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1264
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1265 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
1266 Authentication or cookie authentication. If you are running the web
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1267 server (roundup-server) through another HTTP server (eg. apache or IIS)
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1268 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
1269 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
1270 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
1271 present, then Roundup defaults to using its own cookie-based login
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1272 mechanism.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1273 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
1274 From address in the message.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1275
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1276 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
1277 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
1278 tracker's ``schema.py`` module:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1279
6751
2f7b653b7d6f Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
1280 Web Access and Register
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1281 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
1282 register through the web.
6751
2f7b653b7d6f Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
1283 Email Access and Register
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1284 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
1285 will result in those users being registered with the tracker.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1286
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1287 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
1288 may be found in the `reference documentation`_.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1289
6436
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1290 Configuring Authentication Header/Variable
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1291 ------------------------------------------
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1292
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1293 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
1294 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
1295 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
1296 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
1297 ``[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
1298 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
1299
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1300 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
1301 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
1302 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
1303 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
1304 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
1305 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
1306 roundup-server config file).
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1307
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1308 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
1309 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
1310 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
1311
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1312 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
1313
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1314 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
1315 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
1316 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
1317 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
1318 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
1319 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
1320
7594
c9180009a286 docs: fix sentence.
John Rouillard <rouilj@ieee.org>
parents: 7593
diff changeset
1321 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
1322 ``config.ini`` to read::
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1323
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1324 [web]
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1325 ...
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1326 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
1327
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1328 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
1329 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
1330 mailing list.
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
1331
7306
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1332
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1333 Securing Secrets
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1334 ================
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1335
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1336 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
1337 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
1338 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
1339 of the tracker home.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1340
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1341 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
1342 secrets management. This example config.ini configuration gets
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1343 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
1344
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1345 [rdbms]
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1346 # Database user password.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1347 # 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
1348 # path relative to the tracker home. Using 'file:///' defines
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1349 # 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
1350 # 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
1351 # 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
1352 # 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
1353 #
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1354 # Default: roundup
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1355 password = file:///run/secrets/db_password
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1356
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1357 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
1358 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
1359 Roundup service.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1360
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1361 Because environment variables can be inadvertently exposed in
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1362 logs or process listings, Roundup does not currently support
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1363 loading secrets from environment variables.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1364
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1365 Tasks
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1366 =====
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1367
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1368 Maintenance of Roundup can involve one of the following:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1369
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1370 1. `tracker backup`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1371 2. `software upgrade`_
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1372 3. `migrating backends`_
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2003
diff changeset
1373 4. `moving a tracker`_
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1374 5. `migrating from other software`_
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1375 6. `adding a user from the command-line`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1376
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1377
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1378 Tracker Backup
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1379 --------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1380
3959
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1381 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
1382 performing backup.
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1383
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1384 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
1385 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
1386 This means using
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1387 *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
1388 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
1389 it to be elsewhere) will then complete the backup.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1390
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1391
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1392 Software Upgrade
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1393 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1394
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1395 .. _make a backup: #tracker-backup
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1396
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1397 Always `make a backup`_ of your tracker before upgrading software.
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1398 Steps you may take:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1399
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1400 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
1401 (using your preferred python version)::
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
1402
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1403 pip2 install pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1404 python2 -m pytest test/
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1405
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1406
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1407 pip3 install pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1408 python3 -m pytest test/
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
1409
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
1410 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
1411 3. Make a backup of the tracker home itself.
8041
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
1412 4. Stop the tracker web, email frontends and any scheduled
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
1413 (cron) jobs that access the tracker.
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
1414 5. Install the new version of the software in a new virtual
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
1415 environment::
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
1416
8041
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
1417 python3 -m venv /path/to/env
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
1418 . /path/to/env/bin/activate
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
1419 python3 pip install roundup
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
1420
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1421 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
1422 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
1423
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1424 Usually you should run `roundup_admin -i <tracker_home> migrate`
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1425 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
1426
3230f9c88086 Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents: 3959
diff changeset
1427 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
1428 habit.
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
1429 7. Restart your tracker web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1430
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
1431 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
1432 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
1433
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
1434 python setup.py install
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
1435
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1436 .. 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
1437 single: roundup-admin; import and export
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1438
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1439 Migrating Backends
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1440 ------------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1441
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1442 1. Stop the existing tracker web and email frontends (preventing changes).
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1443 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
1444 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
1445 `issue1441336 <https://issues.roundup-tracker.org/issue1441336>`_
4f74b97dddcd Doc how to export on windows.
John Rouillard <rouilj@ieee.org>
parents: 5300
diff changeset
1446 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
1447 export data.)
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1448 3. Copy the tracker home to a new directory.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1449 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
1450 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
1451 section of the tracker's ``config.ini`` file.
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1452 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
1453 the new tracker home. If non-interactively::
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1454
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1455 roundup-admin -i <tracker home> import <tracker export dir>
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1456
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4489
diff changeset
1457 If interactively, enter 'commit' before exiting.
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1458 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
1459 backend.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1460 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
1461 move the new tracker home into its place.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
1462 9. Restart web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1463
7668
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
1464 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
1465 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
1466 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
1467 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
1468
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
1469 pragma savepoint_limit=20000
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
1470
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
1471 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
1472 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
1473 set on the roundup-admin command line as described below.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1474
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1475 Moving a Tracker
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1476 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1477
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1478 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
1479
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1480 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
1481 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1482 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
1483 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
1484
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1485 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
1486 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
1487 moved using the above steps) then you'll need to:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1488
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1489 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
1490 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1491 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
1492 the existing tracker,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1493 4. copy the export to the new machine,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1494 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
1495 machine, and
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1496 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
1497
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1498 .. index::
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1499 pair: roundup; migrate from other bugtracker software
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1500
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1501 Migrating From Other Software
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1502 -----------------------------
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1503
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1504 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
1505 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
1506 directly. The latter is almost always simpler -- see the "scripts"
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1507 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
1508
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1509 "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
1510 directory containing files with the following format:
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1511
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1512 - 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
1513 named <classname>.csv
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1514 - one colon-separated-values file per Class with journal information,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1515 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
1516 - 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
1517 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
1518 structure::
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1519
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1520 <classname>-files/<N>/<designator>
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1521
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1522 where ``<designator>`` is the item's ``<classname><id>`` combination.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1523 The ``<N>`` value is ``int(<id> / 1000)``.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1524
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1525
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1526 .. index:: pair: roundup-admin; managing users
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
1527
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1528 Adding A User From The Command-Line
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1529 -----------------------------------
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1530
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1531 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
1532 database. To create a new user, use::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1533
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1534 roundup-admin create user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1535
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1536 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
1537 you can just display another user::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1538
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1539 roundup-admin list user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1540
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1541 (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
1542
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1543 roundup-admin filter user username=richard
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1544
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1545 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
1546 commands, you may display the user's details::
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1547
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1548 roundup-admin display <designator>
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1549
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
1550 where designator is ``user5``.
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1551
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1552 Running the Servers
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1553 ===================
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1554
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1555 Unix
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1556 ----
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1557
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1558 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
1559 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
1560 to reflect your specific installation.
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1561
6344
c63df349f319 issue2551117 - add example systemd config
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
1562 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
1563 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
1564 point for your setup.
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1565
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1566 Windows
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1567 -------
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1568
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1569 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
1570 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
1571 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
1572 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
1573 service directly:
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1574
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1575 **install the service**
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3465
diff changeset
1576 ``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
1577 **start the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1578 ``roundup-server -c start``
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1579 **stop the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1580 ``roundup-server -c stop``
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1581
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1582 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
1583
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1584 Windows 2000 and later
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1585 Start/Control Panel/Administrative Tools/Services
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1586 Windows NT4
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
1587 Start/Control Panel/Services
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
1588
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1589 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
1590 `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
1591 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
1592 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
1593
2203
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1594 Running the Mail Gateway Script
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1595 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1596
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1597 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
1598 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
1599 solution to this is to:
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1600
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1601 1. Create a new local account on the Roundup server
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1602 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
1603 of your normal login
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
1604
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1605 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
1606 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1607
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1608 Usage::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1609
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1610 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
1611 [-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
1612 [-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
1613 [args ...]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1614
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1615
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1616 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
1617
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1618 - without arguments. Then the env var ROUNDUP_INSTANCE will be tried.
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1619 - with an instance home as the only argument,
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1620 - with both an instance home and a mail spool file, or
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1621 - 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
1622
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1623 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
1624 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
1625 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
1626 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
1627 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
1628 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
1629 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
1630 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
1631
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1632 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
1633 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
1634 settings.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1635
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1636 PIPE:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1637 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
1638 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
1639 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
1640
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1641 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
1642 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
1643 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
1644 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
1645 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
1646
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1647 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
1648
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1649 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
1650 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
1651 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
1652 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
1653 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
1654
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1655 POP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1656 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
1657 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
1658 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
1659
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1660 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
1661
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1662 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
1663
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1664 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
1665 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
1666
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1667 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
1668
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1669 POPS:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1670 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
1671 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
1672
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1673 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
1674
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1675 APOP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1676 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
1677
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1678 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
1679
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1680 IMAP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1681 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
1682 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
1683
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1684 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
1685
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1686 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
1687 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
1688
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1689 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
1690
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1691 IMAPS:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1692 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
1693 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
1694
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1695 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
1696
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1697 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
1698 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
1699 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
1700
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1701 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
1702
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1703 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
1704 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
1705 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
1706 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
1707 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
1708 ``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
1709 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
1710 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
1711 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
1712 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
1713 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
1714 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
1715
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1716 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
1717
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1718 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
1719 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
1720 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
1721
7503
7b6278da3faa Update roundup-mailgw install with other methods; formatting
John Rouillard <rouilj@ieee.org>
parents: 7499
diff changeset
1722 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
1723
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1724 .. _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
1725
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1726 .. 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
1727 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
1728 single: roundup-admin; data formats
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1729 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
1730 pair: roundup-admin; designator
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1731
8412
0663a7bcef6c feat: finish reauth docs, enhance code.
John Rouillard <rouilj@ieee.org>
parents: 8352
diff changeset
1732 .. _`roundup-admin templates`:
0663a7bcef6c feat: finish reauth docs, enhance code.
John Rouillard <rouilj@ieee.org>
parents: 8352
diff changeset
1733
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1734 Using roundup-admin
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1735 ===================
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1736
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1737 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
1738 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
1739 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
1740 tracker.
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1741
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1742 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
1743
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1744 * install and initialize a new tracker
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1745 * export/import tracker data for migrating between backends
7477
f40626db85dd typo fix.
John Rouillard <rouilj@ieee.org>
parents: 7454
diff changeset
1746 * creating a new user from the command line
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1747 * list/find users in the tracker
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
1748
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1749 The basic usage is:
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1750
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1751 .. 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
1752
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1753 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
1754
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1755 Options:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1756 -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
1757 -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
1758 -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
1759 -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
1760 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
1761 -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
1762 -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
1763 Same as '-S " "'.
7546
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7503
diff changeset
1764 -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
1765 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
1766 -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
1767 -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
1768
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1769 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
1770
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1771 Help:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1772 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
1773 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
1774 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
1775 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
1776
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1777 Commands:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1778 commit
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1779 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
1780 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
1781 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
1782 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
1783 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
1784 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
1785 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
1786 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
1787 help topic
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
1788 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
1789 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
1790 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
1791 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
1792 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
1793 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
1794 migrate
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1795 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
1796 perftest [mode] [arguments]*
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1797 pragma setting=value | 'list'
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1798 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
1799 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
1800 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
1801 rollback
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1802 security [Role name]
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
1803 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
1804 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
1805 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
1806 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
1807 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
1808 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
1809 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
1810
7093
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1811 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
1812 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
1813 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
1814 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
1815 config.ini.
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1816
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1817 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
1818 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
1819 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
1820 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
1821 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
1822 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
1823 command line access to a tracker.
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1824
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
1825 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
1826
7404
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
1827 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
1828 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
1829 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
1830 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
1831 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
1832 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
1833 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
1834
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1835 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
1836 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
1837 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
1838
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1839 - 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
1840 - 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
1841 - 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
1842 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
1843 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
1844
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1845 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
1846 "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
1847 "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
1848 "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
1849 "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
1850 "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
1851 "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
1852 "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
1853 "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
1854 "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
1855 "." "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
1856
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1857 - 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
1858 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
1859 - 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
1860 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
1861 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
1862 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
1863
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1864 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
1865 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
1866 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
1867 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
1868 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
1869
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1870 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
1871 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
1872
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1873 - ``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
1874 - 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
1875
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1876 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
1877 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
1878
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1879 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
1880 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
1881 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
1882 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
1883 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
1884
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1885 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
1886 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
1887 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
1888 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
1889 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
1890 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
1891 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
1892
7454
76b2f3c95c03 Add anchor for init section.
John Rouillard <rouilj@ieee.org>
parents: 7404
diff changeset
1893 .. _initpw:
76b2f3c95c03 Add anchor for init section.
John Rouillard <rouilj@ieee.org>
parents: 7404
diff changeset
1894
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1895 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
1896 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
1897 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
1898 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
1899 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
1900 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
1901 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
1902
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1903 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
1904
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1905 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
1906
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1907 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
1908
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1909 (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
1910
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1911 .. 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
1912
7795
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1913 Using Interactively
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1914 -------------------
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1915
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1916 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
1917 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
1918 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
1919 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
1920 package (see `installation documentation`_).
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1921
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1922 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
1923 for just one session.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1924
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1925 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
1926 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
1927 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
1928 (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
1929
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1930 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
1931 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
1932 persistently set the history size using ``history size
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1933 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
1934 ``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
1935 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
1936
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1937 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
1938 directory (for windows usually ``\Users\<username>``.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
1939
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1940 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
1941 --------------------
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1942
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1943 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
1944 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
1945
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1946 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
1947 "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
1948 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
1949
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1950 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
1951 > 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
1952 > done
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1953 msg23
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1954 msg49
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1955 msg50
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1956 msg61
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1957 shell%
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1958
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1959 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
1960
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1961 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
1962 \`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
1963 msg23
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1964 msg49
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1965 msg50
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1966 msg61
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1967 shell%
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1968
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1969 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
1970
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1971 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
1972 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
1973 files: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1974 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
1975 recipients: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1976 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
1977 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
1978 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
1979 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
1980 files: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1981 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
1982 recipients: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1983 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
1984 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
1985 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
1986 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
1987
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1988 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
1989
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1990 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
1991 -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
1992 unread
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1993 deferred
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1994
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1995 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
1996
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
1997 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
1998 -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
1999 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
2000
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2001 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
2002
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2003 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
2004 -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
2005 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
2006
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2007 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
2008
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2009 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
2010 `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
2011 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
2012 chatting
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2013 chatting
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2014
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2015 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
2016 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
2017
7667
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2018 A Note on Import and Export
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2019 ---------------------------
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2020
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2021 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
2022 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
2023
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2024 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
2025 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
2026
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2027 For example::
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2028
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2029 $ 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
2030 Exporting priority - 5
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2031 Exporting Journal for priority
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2032 Exporting status - 1
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2033 Exporting Journal for status
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2034 [...]
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2035
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2036
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2037 $ 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
2038 Importing priority - 7
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2039 setting priority 8
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2040 Importing status - 8
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2041 setting status 9
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2042 [...]
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2043
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2044 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
2045 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
2046 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
2047
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2048 ``Exporting issue - XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2049
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2050 ``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
2051 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
2052 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
2053 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
2054 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
2055
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2056 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
2057 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
2058 processing at the time.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2059
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2060 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
2061 when sorted alphabetically by name.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2062
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2063 ``Importing <class> - XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2064
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2065 ``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
2066 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
2067 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
2068 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
2069 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
2070 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
2071 the line at XXX+1.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2072
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2073 ``setting <class> XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2074
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2075 ``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
2076 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
2077 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
2078 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
2079
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2080 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
2081 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
2082 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
2083 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
2084
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2085 Interactive Help
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2086 ----------------
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2087
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2088 The help command produces the following output for all the commands.
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2089
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2090
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2091 .. raw:: html
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2092 :file: admin_help.html
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2093
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2094 .. _`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
2095 .. _`reference documentation`: reference.html
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
2096 .. _`upgrading documentation`: upgrading.html
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
2097 .. _`installation documentation`: installation.html
Roundup Issue Tracker: http://roundup-tracker.org/