Mercurial > p > roundup > code

annotate doc/admin_guide.txt @ 8478:ed4ef394d5d6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: initial attempt to document setup of pgp support for email. Used an AI assistant to help write this. Basic gpg commands seem to work, but I have not tested this totally. Docs basically follow the setup used for pgp testing in the test suite. It looks like roundup accepts signed emails as well as encrypted and signed emails. But it does not generate signed emails. Also it looks like there is no PGP support for alternate email addresses. Only primary addresses can do PGP emails.
author John Rouillard <rouilj@ieee.org>
date Sat, 15 Nov 2025 16:59:24 -0500
parents d36bd4c521ac
children 0fda84bc7584 b09ef85f0da6
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
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
49 .. _rounduplogging:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
51 Configuring Roundup Message Logging
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
52 ===================================
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
53
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
54 You can control how Roundup logs messages using your tracker's
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
55 config.ini file. Roundup uses the standard Python logging
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
56 implementation. The config file and ``roundup-server`` provide
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
57 very basic control over logging.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
58
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
59 ``roundup-server``'s logging is controlled from the command
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
60 line. You can:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
61
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
62 - specify the location of a log file or
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
63 - enable logging using the standard Python logging library under
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
64 the tag/channel ``roundup.http``
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
65
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
66 Configuration for "BasicLogging" implementation for your tracker
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
67 is done using the settings in the tracker's ``config.ini`` under
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
68 the ``logging`` section:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
69
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
70 - ``filename`` setting: specifies the location of a log file
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
71 - ``level`` setting: specifies the minimum level to log
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
72 - ``disable_loggers`` setting: disable other loggers (e.g. when
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
73 running under a wsgi framework)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
74 - ``format`` setting: set the log format template. See
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
75 :ref:`logFormat` for more info.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
76
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
77 In either case, if logfile is not specified, logging is sent to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
78 sys.stderr. If level is not set, only ERROR or higher priority
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
79 log messages will be reported.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
80
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
81 You can get more control over logging by using the ``config``
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
82 setting in the tracker's ``config.ini``. Using a logging config
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
83 file overrides all the rest of the other logging settings in
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
84 ``config.ini``. You get more control over the logs by supplying
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
85 a log config file in ini or json (dictionary) format.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
86
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
87 Using this, you can set different levels by channel. For example
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
88 roundup.hyperdb can be set to WARNING while other Roundup log
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
89 channels are set to INFO and the roundup.mailgw channel logs at
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
90 the DEBUG level. You can also control the distribution of
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
91 logs. For example roundup.mailgw logs to syslog, other channels
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
92 log to an automatically rotating log file, or are submitted to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
93 your log aggregator over https.
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
94
8443
39a6825d10ca feat: allow admin to set logging format from config.ini
John Rouillard <rouilj@ieee.org>
parents: 8442
diff changeset
95 .. _logFormat:
39a6825d10ca feat: allow admin to set logging format from config.ini
John Rouillard <rouilj@ieee.org>
parents: 8442
diff changeset
96
39a6825d10ca feat: allow admin to set logging format from config.ini
John Rouillard <rouilj@ieee.org>
parents: 8442
diff changeset
97 Defining the Log Format
39a6825d10ca feat: allow admin to set logging format from config.ini
John Rouillard <rouilj@ieee.org>
parents: 8442
diff changeset
98 -----------------------
39a6825d10ca feat: allow admin to set logging format from config.ini
John Rouillard <rouilj@ieee.org>
parents: 8442
diff changeset
99
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
100 Starting with Roundup 2.6 you can specify the logging format in
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
101 config.ini. The ``logging`` -> ``format`` setting of config.ini
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
102 supports all of the `standard logging LogRecord attributes
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
103 <https://docs.python.org/3/library/logging.html#logrecord-attributes>`_
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
104 or Roundup logging attributes. However you must double any ``%``
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
105 format markers. The default value is::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
106
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
107 %%(asctime)s %%(trace_id)s %%(levelname)s %%(message)s
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
108
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
109 Roundup Logging Attributes
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
110 --------------------------
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
111
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
112 The `logging package has a number of attributes
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
113 <https://docs.python.org/3/library/logging.html#logrecord-attributes>`_
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
114 that can be expanded in the format template. In addition to the
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
115 ones supplied by Python's logging module, Roundup defines
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
116 additional attributes:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
117
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
118 trace_id
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
119 a unique string that is generated for each request. It is
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
120 unique per thread.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
121
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
122 trace_reason
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
123 a string describing the reason for the trace/request.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
124
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
125 * the URL for a web triggered (http, rest, xmlrpc) request
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
126 * the email message id for an email triggered request
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
127 * the roundup-admin os user and start of command. Only first
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
128 two words in command are printed so seting a password will
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
129 not be leaked to the logs.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
130
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
131 sinfo
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
132 the stack traceback information at the time the log call id
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
133 made.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
134
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
135 This must be intentionally activated by using the extras
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
136 parameter. For example calling::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
137
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
138 logging.get_logger('roundup.something').warning(
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
139 "I am here\n%(sinfo)s", extra={"sinfo": 2})
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
140
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
141 in the function confirmid() of the file detectors/reauth.py
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
142 in your demo tracker will print 2 items on the stack
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
143 including the log call. It results in the following (5 lines
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
144 total in the log file)::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
145
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
146 2025-09-14 23:07:58,668 Cm0ZPlBaklLZ3Mm6hAAgoC WARNING I am here
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
147 File "[...]/roundup/hyperdb.py", line 1924, in fireAuditors
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
148 audit(self.db, self, nodeid, newvalues)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
149 File "demo/detectors/reauth.py", line 7, in confirmid
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
150 logging.getLogger('roundup.something').warning(
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
151
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
152 Note that the output does not include the arguments to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
153 ``warning`` because they are on the following line. If you
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
154 want arguments to the log call included, they have to be on
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
155 the same line.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
156
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
157 Setting ``sinfo`` to an integer value N includes N lines up
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
158 the stack ending with the logging call. Setting it to 0
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
159 includes all the lines in the stack ending with the logging
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
160 call.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
161
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
162 If the value is less than 0, the stack dump doesn't end at
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
163 the logging call but continues to the function that
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
164 generates the stack report. So it includes functions inside
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
165 the logging module.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
166
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
167 Setting it to a number larger than the stack trace will
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
168 print the trace down to the log call. So using ``-1000``
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
169 will print up to 1000 stack frames and start at the function
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
170 that generates the stack report.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
171
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
172 Setting ``sinfo`` to a non-integer value ``{"sinfo": None}``
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
173 will produce 5 lines of the stack trace ending at the
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
174 logging call.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
175
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
176 pct_char
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
177 produces a single ``%`` sign in the log. The usual way of
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
178 embedding a percent sign in a formatted string is to double
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
179 it like: ``%%``. However when the format string is specified
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
180 in the config.ini file percent signs are manipulated. So
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
181 ``%%(pct_char)s`` can be used in config.ini to print a
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
182 percent sign.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
183
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
184 The default logging template is defined in config.ini in the
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
185 ``logging`` -> ``format`` setting. It includes the ``trace_id``.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
186 When searching logs, you can use the trace_id to see all the log
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
187 messages associated with a request.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
188
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
189 If you want to log from a detector, extension or other code, you
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
190 can use these tokens in your messages when calling the logging
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
191 functions. (Note that doubling ``%`` signs is only required when
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
192 defining the log format in a config file, not when defining a
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
193 msg.) For example::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
194
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
195 logging.getLogger('roundup.myextension').error('problem with '
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
196 '%(trace_reason)s')
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
197
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
198 will include the url in the message when triggered from the
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
199 web. This also works with other log methods: ``warning()``,
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
200 ``debug()``, ....
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
201
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
202 Note you must **not** use positional arguments in your
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
203 message. Using::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
204
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
205 logging.getLogger('roundup.myextension').error(
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
206 '%s problem with %(trace_reason)s', "a")
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
207
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
208 will not properly substitute the argument. You must use mapping
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
209 key based arguments and define the local values as part of the
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
210 extra dictionary. For example::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
211
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
212 logging.getLogger('roundup.myextension').error('%(article)s '
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
213 'problem with %(trace_reason)',
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
214 extra={"article": some_local_variable})
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
215
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
216 Also if you are logging any data supplied by a user, you must not
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
217 log it directly. If the variable ``url`` contains the url typed in
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
218 by the user, never use:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
219
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
220 logger.info(url)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
221
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
222 or
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
223
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
224 logger.info("Url is %s" % url)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
225
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
226 Use:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
227
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
228 logger.info("Url is %s", url)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
229
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
230 or
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
231
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
232 logger.info("Url is %(url)s", extra={"url": url)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
233
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
234 This prevents printf style tokens in ``url`` from being processed
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
235 where it can raise an exception. This could be used to prevent
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
236 the log message from being generated.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
237
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
238 More on trace_id
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
239 ~~~~~~~~~~~~~~~~
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
240
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
241 The trace_id provides a unique token (a UUID4 encoded to make it
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
242 shorter) for each transaction in the database. It is unique to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
243 each thread or transaction. A transaction:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
244
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
245 for the web interface is
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
246 each web, rest or xmlrpc request
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
247
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
248 for the email interface is
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
249 each email request. Using pipe mode will generate one
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
250 transaction. Using pop/imap etc can generate multiple
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
251 transactions, one for each email. Logging that occurs prior
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
252 to processing an email transaction has the default
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
253 ``not_set`` value for trace_id
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
254
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
255 for the roundup-admin interface is
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
256 each command in the interactive interface or on the command
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
257 line. Plus one transaction when/if a commit happens on
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
258 roundup-admin exit.
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
259
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
260 When creating scripts written using the roundup package the entry
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
261 point should use the ``@gen_trace_id`` decorator. For example to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
262 decorate the entry point that performs one transaction::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
263
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
264 from roundup.logcontext import gen_trace_id
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
265
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
266 # stuff ...
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
267
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
268 @gen_trace_id()
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
269 def main(...):
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
270 ...
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
271
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
272 If your script does multiple processing operations, decorate the entry
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
273 point for the processing operation::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
274
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
275 from roundup.logcontext import gen_trace_id
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
276
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
277 @gen_trace_id()
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
278 def process_one(thing):
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
279 ...
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
280
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
281 def main():
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
282 for thing in things:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
283 process_one(thing)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
284
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
285
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
286 Advanced Logging Setup
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
287 ----------------------
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
288
8443
39a6825d10ca feat: allow admin to set logging format from config.ini
John Rouillard <rouilj@ieee.org>
parents: 8442
diff changeset
289 If the settings in config.ini are not sufficient for your logging
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
290 requirements, you can specify a full logging configuration in one
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
291 of two formats:
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
292
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
293 * `dictConfig format
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
294 <https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig>`_
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
295 using json with comment support
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
296 * `fileConfig format
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
297 <https://docs.python.org/3/library/logging.config.html#logging.config.fileConfig>`_
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
298 in ini style
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
299
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
300 The dictConfig format allows more control over configuration
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
301 including loading your own log handlers and disabling existing
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
302 handlers. If you use the fileConfig format, the ``logging`` ->
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
303 ``disable_loggers`` flag in the tracker's config is used to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
304 enable/disable pre-existing loggers as there is no way to do this
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
305 in the logging config file.
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
306
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
307 .. _`dictLogConfig`:
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
308
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
309 dictConfig Based Logging Config
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
310 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
311
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
312 dictConfigs are specified in JSON format with support for
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
313 comments. The file name in the tracker's config for the
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
314 ``logging`` -> ``config`` setting must end with ``.json`` to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
315 choose the correct processing.
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
316
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
317 Comments have to be in one of two forms based on javascript line
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
318 comments:
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
319
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
320 1. A ``//`` possibly indented with whitespace on a line is
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
321 considereda a comment and is stripped from the file before
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
322 being passed to the json parser. This is a "line comment".
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
323
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
324 2. A ``//`` with at least three white space characters before it
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
325 is stripped from the end of the line before being passed to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
326 the json parser. This is an "inline comment".
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
327
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
328 Block style comments are not supported.
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
329
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
330 Other than this the file is a standard json file that matches the
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
331 `Configuration dictionary schema
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
332 <https://docs.python.org/3/library/logging.config.html#configuration-dictionary-schema>`_
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
333 defined in the Python documentation.
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
334
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
335
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
336 Example dictConfig Logging Config
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
337 .................................
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
338
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
339 Note that this file is not actually JSON format as it include
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
340 comments. However by using javascript style comments, some tools
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
341 that treat JSON like javascript (editors, linters, formatters)
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
342 might work with it. A command like::
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
343
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
344 sed -e 's#^\s*//.*##' -e 's#\s*\s\s\s//.*##' logging.json
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
345
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
346 can be used to strip comments for programs that need it.
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
347
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
348 The config below works with the `Waitress wsgi server
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
349 <https://github.com/Pylons/waitress>`_ configured to use the
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
350 roundup.wsgi channel. It also controls the `TransLogger
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
351 middleware <https://github.com/pasteorg/paste>`_ configured to
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
352 use roundup.wsgi.translogger, to produce httpd style combined
8477
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
353 logs.
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
354
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
355 The log file is specified relative to the current working
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
356 directory not the tracker home. The tracker home is the
8477
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
357 subdirectory demo under the current working directory.
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
358
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
359 The config also expects the ``python-json-logger`` package to be
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
360 installed so that it can produce a jsonl (json line) formatted
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
361 output log file. This format is useful for sending to log
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
362 management/observability platforms like elasticsearch, splunk,
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
363 logly, or honeycomb.
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
364
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
365 The commented config is::
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
366
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
367 {
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
368 "version": 1, // only supported version
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
369 "disable_existing_loggers": false, // keep the wsgi loggers
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
370
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
371 "formatters": {
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
372 // standard format for Roundup messages
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
373 "standard": {
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
374 "format": "%(asctime)s %(trace_id)s %(levelname)s %(name)s:%(module)s %(msg)s"
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
375 },
8477
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
376 // Used to dump all log requests in jsonl format.
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
377 // Each json object is on one line. Can be pretty printed
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
378 // using:
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
379 // python -m json.tool --json-lines --sort-keys < roundup.json.log
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
380 // jq --slurp --sort-keys . < roundup.json.log
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
381 // requires that you pip install python-json-logger
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
382 // * does not report the fields in reserved_attrs
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
383 // * example to remap a field in the log to traceID in
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
384 // the output json. (note trace_id_eg is not defined by
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
385 // logging
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
386 // * also adds the env atribute to json with the value of demo
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
387 "json": {
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
388 "()": "pythonjsonlogger.json.JsonFormatter",
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
389 "reserved_attrs": ["ROUNDUP_CONTEXT_FILTER_CALLED",
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
390 "msg", "pct_char", "relativeCreated"],
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
391 "rename_fields": {
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
392 "trace_id_eg": "traceID"
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
393 },
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
394 "static_fields": {
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
395 "env": "demo"
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
396 }
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
397 },
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
398 // used for waitress wsgi server to produce httpd style logs
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
399 "http": {
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
400 "format": "%(message)s %(trace_id)"
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
401
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
402 }
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
403 },
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
404 "handlers": {
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
405 // create an access.log style http log file
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
406 "access": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
407 "level": "INFO",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
408 "formatter": "http",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
409 "class": "logging.FileHandler",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
410 "filename": "demo/access.log"
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
411 },
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
412 // logging for roundup.* loggers
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
413 "roundup": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
414 "level": "DEBUG",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
415 "formatter": "standard",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
416 "class": "logging.FileHandler",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
417 "filename": "demo/roundup.log"
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
418 },
8477
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
419 // handler for json output log file
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
420 "roundup_json": {
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
421 "level": "DEBUG", // "DEBUG",
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
422 "formatter": "json",
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
423 "class": "logging.FileHandler",
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
424 "filename": "demo/roundup.json.log"
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
425 },
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
426 // print to stdout - fall through for other logging
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
427 "default": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
428 "level": "DEBUG",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
429 "formatter": "standard",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
430 "class": "logging.StreamHandler",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
431 "stream": "ext://sys.stdout"
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
432 }
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
433 },
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
434 "loggers": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
435 "": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
436 "handlers": [
8477
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
437 "default",
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
438 "roundup_json" // add json formatted logging
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
439 ],
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
440 "level": "DEBUG",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
441 "propagate": false
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
442 },
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
443 // used by roundup.* loggers
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
444 "roundup": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
445 "handlers": [
8477
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
446 "roundup",
d36bd4c521ac doc: add docs for producing jsonl formatted output
John Rouillard <rouilj@ieee.org>
parents: 8461
diff changeset
447 "roundup_json"
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
448 ],
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
449 "level": "DEBUG",
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
450 "propagate": false // note pytest testing with caplog requires
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
451 // this to be true
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
452 },
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
453 "roundup.hyperdb": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
454 "handlers": [
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
455 "roundup"
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
456 ],
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
457 "level": "INFO", // can be a little noisy use INFO for production
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
458 "propagate": false
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
459 },
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
460 "roundup.wsgi": { // using the waitress framework
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
461 "handlers": [
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
462 "roundup"
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
463 ],
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
464 "level": "DEBUG",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
465 "propagate": false
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
466 },
8433
de1dac9abcb6 feat: change comment in dictConfig json file to // from #
John Rouillard <rouilj@ieee.org>
parents: 8432
diff changeset
467 "roundup.wsgi.translogger": { // httpd style logging
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
468 "handlers": [
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
469 "access"
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
470 ],
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
471 "level": "DEBUG",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
472 "propagate": false
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
473 },
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
474 "root": {
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
475 "handlers": [
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
476 "default"
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
477 ],
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
478 "level": "DEBUG",
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
479 "propagate": false
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
480 }
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
481 }
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
482 }
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
483
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
484 fileConfig Based Logging Config
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
485 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
486
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
487 The file config is an older and more limited method of
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
488 configuring logging. It is described by the `Configuration file
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
489 format
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
490 <https://docs.python.org/3/library/logging.config.html#configuration-file-format>`_
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
491 in the Python documentation. The file name in the tracker's
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
492 config for the ``logging`` -> ``config`` setting must end with
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
493 ``.ini`` to choose the correct processing.
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
494
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
495 Example fileConfig LoggingConfig
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
496 ................................
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
497
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
498 This is an example .ini used with roundup-server configured to use
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
499 ``roundup.http`` channel. It also includes some custom logging
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
500 qualnames/tags/channels for logging schema/permission detector and
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
501 extension output::
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
502
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
503 [loggers]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
504 #other keys: roundup.hyperdb.backend
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
505 keys=root,roundup,roundup.http,roundup.hyperdb,actions,schema,extension,detector
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
506
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
507 [logger_root]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
508 #also for root where channlel is not set (NOTSET) aka all
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
509 level=DEBUG
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
510 handlers=rotate
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
511
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
512 [logger_roundup]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
513 # logger for all roundup.* not otherwise configured
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
514 level=DEBUG
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
515 handlers=rotate
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
516 qualname=roundup
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
517 propagate=0
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
518
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
519 [logger_roundup.http]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
520 level=INFO
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
521 handlers=rotate_weblog
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
522 qualname=roundup.http
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
523 propagate=0
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
524
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
525 [logger_roundup.hyperdb]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
526 level=WARNING
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
527 handlers=rotate
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
528 qualname=roundup.hyperdb
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
529 propagate=0
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
530
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
531 [logger_actions]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
532 level=INFO
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
533 handlers=rotate
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
534 qualname=actions
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
535 propagate=0
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
536
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
537 [logger_detector]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
538 level=INFO
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
539 handlers=rotate
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
540 qualname=detector
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
541 propagate=0
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
542
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
543 [logger_schema]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
544 level=DEBUG
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
545 handlers=rotate
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
546 qualname=schema
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
547 propagate=0
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
548
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
549 [logger_extension]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
550 level=INFO
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
551 handlers=rotate
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
552 qualname=extension
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
553 propagate=0
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
554
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
555 [handlers]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
556 keys=basic,rotate,rotate_weblog
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
557
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
558 [handler_basic]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
559 class=StreamHandler
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
560 args=(sys.stderr,)
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
561 formatter=basic
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
562
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
563 [handler_rotate]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
564 class=logging.handlers.RotatingFileHandler
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
565 args=('roundup.log','a', 5120000, 2)
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
566 formatter=basic
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
567
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
568 [handler_rotate_weblog]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
569 class=logging.handlers.RotatingFileHandler
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
570 args=('httpd.log','a', 1024000, 2)
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
571 formatter=plain
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
572
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
573 [formatters]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
574 keys=basic,plain
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
575
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
576 [formatter_basic]
8446
14c7c07b32d8 feature: add thread local trace_id and trace_reason to logging.
John Rouillard <rouilj@ieee.org>
parents: 8443
diff changeset
577 format=%(asctime)s %(trace_id)s %(process)d %(name)s:%(module)s.%(funcName)s,%(levelname)s: %(message)s
8423
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
578 datefmt=%Y-%m-%d %H:%M:%S
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
579
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
580 [formatter_plain]
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
581 format=%(process)d %(message)s
94eed885e958 feat: add support for using dictConfig to configure logging.
John Rouillard <rouilj@ieee.org>
parents: 8412
diff changeset
582
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
583
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
584 Configuring roundup-server
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
585 ==========================
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
586
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
587 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
588 ``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
589
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
590 [main]
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
591
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
592 # Host name of the Roundup web server instance.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
593 # If left unconfigured (no 'host' setting) the default
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
594 # will be used.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
595 # If empty, listen on all network interfaces.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
596 # If you want to explicitly listen on all
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
597 # network interfaces, the address 0.0.0.0 is a more
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
598 # explicit way to achieve this, the use of an empty
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
599 # string for this purpose is deprecated and will go away
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
600 # in a future release.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
601 # Default: localhost
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
602 host = localhost
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
603
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
604 # Port to listen on.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
605 # Default: 8080
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
606 port = 8017
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
607
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
608 # 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
609 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
610 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
611 # Default: favicon.ico
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
612 favicon = favicon.ico
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
613
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
614 # User ID as which the server will answer requests.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
615 # 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
616 # Availability: Unix.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
617 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
618 user = roundup
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
619
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
620 # Group ID as which the server will answer requests.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
621 # 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
622 # Availability: Unix.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
623 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
624 group =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
625
7387
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7385
diff changeset
626 # 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
627 # Default: 40
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7385
diff changeset
628 max_children = 40
46f92ac4e170 - issue2551275 - Allow configuring max_children in roundup-server.
John Rouillard <rouilj@ieee.org>
parents: 7385
diff changeset
629
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
630 # don't fork (this overrides the pidfile mechanism)'
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
631 # Allowed values: yes, no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
632 # Default: no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
633 nodaemon = no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
634
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
635 # Log client machine names instead of IP addresses (much slower)
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
636 # Allowed values: yes, no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
637 # Default: no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
638 log_hostnames = no
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
639
7332
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
640 # 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
641 # 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
642 # '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
643 # 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
644 # Allowed values: yes, no
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
645 # Default: no
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
646 loghttpvialogger = no
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
647
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
648 # 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
649 # 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
650 #
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
651 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
652 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
653 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
654 pidfile =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
655
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
656 # Log file path. If unset, log to stderr.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
657 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
658 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
659 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
660 logfile =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
661
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
662 # Set processing of each request in separate subprocess.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
663 # Allowed values: debug, none, thread, fork.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
664 # Default: fork
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
665 multiprocess = fork
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
666
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
667 # Tracker index template. If unset, built-in will be used.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
668 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
669 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
670 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
671 template =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
672
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
673 # Enable SSL support (requires pyopenssl)
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
674 # Allowed values: yes, no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
675 # Default: no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
676 ssl = no
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
677
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
678 # PEM file used for SSL. A temporary self-signed certificate
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
679 # will be used if left blank.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
680 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
681 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
682 # Default:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
683 pem =
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
684
7332
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
685 # 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
686 # 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
687 # 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
688 # 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
689 # 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
690 # 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
691 # Default:
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
692 include_headers =
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
693
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
694 # 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
695 # Default: HTTP/1.1
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
696 http_version = HTTP/1.1
09af33304790 Update roundup-server example config file example and docs
John Rouillard <rouilj@ieee.org>
parents: 7306
diff changeset
697
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
698 # Roundup trackers to serve.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
699 # Each option in this section defines single Roundup tracker.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
700 # Option name identifies the tracker and will appear in the URL.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
701 # Option value is tracker home directory path.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
702 # The path may be either absolute or relative
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
703 # to the directory containing this config file.
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
704 [trackers]
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
705
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
706 demo = /trackers/demo
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
707 sysadmin = /trackers/sysadmin
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
708
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
709 Additional notes for each keyword:
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
710
3880
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
711 **template**
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
712 Specifies a template used for displaying the tracker index when
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
713 multiple trackers are being used. It is processed by TAL and
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
714 the variable "trackers" is available to the template and is a
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
715 dict of all configured trackers.
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
716 **ssl**
6835
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
717 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
718 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
719 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
720 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
721 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
722 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
723 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
724 additional information.
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
725 **pem**
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
726 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
727 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
728 headers (e.g. ``-----BEGIN PRIVATE KEY-----``,
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
729 ``-----END PRIVATE KEY-----`` and
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
730 ``-----BEGIN CERTIFICATE-----``,
7a48f771cd4f Clean up docs on roundup-sever SSL use.
John Rouillard <rouilj@ieee.org>
parents: 6819
diff changeset
731 ``-----END CERTIFICATE-----``.
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
732 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
733 for use.
8297
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
734 **loghttpvialogger** section
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
735 If you:
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
736
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
737 * have **loghttpvialogger** enabled
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
738 * use **pidfile**
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
739 * 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
740
03513f5066f3 fix: issue2551238 - roundup-server should exit with error ...
John Rouillard <rouilj@ieee.org>
parents: 8262
diff changeset
741 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
742 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
743 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
744 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
745 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
746 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
747 to exit.
3465
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
748 **trackers** section
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
749 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
750 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
751 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
752
7333
b92ecb730510 Document how save-config replaces and backs up config.ini.
John Rouillard <rouilj@ieee.org>
parents: 7332
diff changeset
753 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
754 roundup-server command line use::
5102
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
755
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
756 roundup_server -p 8017 -u roundup --save-config demo=/trackers/demo \
96dc9f07340a issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents: 4891
diff changeset
757 sysadmin=/trackers/sysadmin
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
758
7334
a83c932a00dc reword doc update
John Rouillard <rouilj@ieee.org>
parents: 7333
diff changeset
759 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
760 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
761 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
762 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
763 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
764 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
765 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
766 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
767
7981
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
768 .. _configuring-compression:
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
769
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
770 Configuring Compression
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
771 =======================
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
772
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
773 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
774 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
775
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
776 [web]
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
777 ...
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
778 dynamic_compression = No
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
779
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
780 in the tracker's ``config.ini``. You should disable compression if
8461
1522e0e15903 doc: remove uWSGI references as it is in maint mode and not being updated
John Rouillard <rouilj@ieee.org>
parents: 8446
diff changeset
781 your proxy (e.g. nginx or apache) is configured
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
782 to compress responses on the fly. The python standard library includes
7385
87e9d761ecc6 fix typo
John Rouillard <rouilj@ieee.org>
parents: 7382
diff changeset
783 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
784 the `installation documentation`_ for details.
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
785
7853
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
786 .. 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
787
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
788 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
789 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
790 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
791 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
792
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
793 from roundup.cgi.client import Client
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
794
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
795 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
796
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
797 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
798
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
799 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
800 errors messages, short json responses).
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
801
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
802 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
803 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
804 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
805 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
806
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
807 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
808 ``@@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
809 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
810 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
811
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
812 [web]
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
813 ...
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
814 use_precompressed_files = Yes
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
815
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
816 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
817 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
818 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
819
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
820 tracker_home/html/library.js.gzip
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
821 tracker_home/html/library.js.br
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
822 tracker_home/html/library.js.zstd
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
823
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
824 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
825
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
826 gzip --keep --suffix .gzip library.js
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
827 brotli library.js
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
828 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
829
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
830 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
831 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
832 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
833
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
834 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
835 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
836 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
837 ``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
838 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
839 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
840
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
841 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
842 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
843 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
844 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
845 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
846 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
847 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
848
8039
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
849 .. _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
850
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
851 .. 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
852
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
853 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
854 ==============================================
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
855
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
856 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
857 <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
858 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
859 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
860 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
861
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
862 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
863 ``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
864 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
865 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
866 ``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
867 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
868
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
869 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
870 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
871 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
872 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
873 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
874 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
875
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
876 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
877 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
878
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
879 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
880 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
881
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
882 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
883
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
884 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
885 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
886
e1cff9745fb4 refactor: make mime_type_allowlist class prop to configure from interfaces.py
John Rouillard <rouilj@ieee.org>
parents: 8016
diff changeset
887 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
888 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
889
7853
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
890 .. 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
891
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
892 Configuring REST Maximum Result Limit
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
893 =====================================
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
894
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
895 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
896 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
897 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
898 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
899 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
900 ``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
901
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
902 # change max response rows
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
903 from roundup.rest import RestfulInstance
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
904 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
905
03c1b7ae3a68 issue2551328/issue2551264 unneeded next link and total_count incorrect
John Rouillard <rouilj@ieee.org>
parents: 7797
diff changeset
906 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
907 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
908 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
909 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
910 "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
911 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
912 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
913 ``@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
914
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
915 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
916 ==========================================
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
917
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
918 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
919 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
920 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
921 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
922 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
923 support for CSP in Roundup.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
924
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
925 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
926 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
927 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
928 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
929 configurations can be used.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
930
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
931 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
932 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
933 break functionality.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
934
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
935 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
936
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
937 1. a fixed CSP added by a server
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
938 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
939
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
940 Fixed CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
941 ---------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
942
8461
1522e0e15903 doc: remove uWSGI references as it is in maint mode and not being updated
John Rouillard <rouilj@ieee.org>
parents: 8446
diff changeset
943 If you are using a web server (Apache, Nginx) to run Roundup, you
1522e0e15903 doc: remove uWSGI references as it is in maint mode and not being updated
John Rouillard <rouilj@ieee.org>
parents: 8446
diff changeset
944 can add a ``Content-Security-Policy`` header using that
1522e0e15903 doc: remove uWSGI references as it is in maint mode and not being updated
John Rouillard <rouilj@ieee.org>
parents: 8446
diff changeset
945 server. WSGI middleware can be written to add headers. An example
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
946 header would look like::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
947
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
948 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
949
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
950 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
951 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
952 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
953 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
954 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
955 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
956 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
957 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
958 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
959
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
960 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
961 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
962 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
963 when invoked.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
964
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
965 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
966 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
967
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
968 .. _dynamic_csp:
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
969
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
970 Dynamic CSP
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
971 -----------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
972
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
973 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
974 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
975
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
976 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
977 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
978 by Roundup.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
979
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
980 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
981 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
982
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
983 default_security_headers = {
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
984 'Content-Security-Policy': (
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
985 "default-src 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
986 "base-uri 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
987 "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
988 "style-src 'self' 'nonce-{nonce}'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
989 "img-src 'self' data:; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
990 "frame-ancestors 'self'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
991 "object-src 'self' 'nonce-{nonce}'; "
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
992 ),
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
993 }
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
994
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
995
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
996 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
997 ''' 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
998
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
999 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
1000 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
1001
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1002 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
1003 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
1004
6ea309c6d17c docs: fix registerutilMethod docs, format for highlights.
John Rouillard <rouilj@ieee.org>
parents: 8297
diff changeset
1005 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
1006 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
1007 using registerUtil.
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1008 '''
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1009 try:
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1010 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
1011 # 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
1012 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
1013 except AttributeError:
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1014 # 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
1015 # 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
1016 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
1017
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1018 headers = default_security_headers.copy()
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1019 if isinstance(header_dict, dict):
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1020 headers.update(header_dict)
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1021
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1022 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
1023
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1024 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
1025 if value is None:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1026 continue
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1027 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
1028 nonce=self.client.client_nonce)
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1029
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1030 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
1031 # 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
1032 instance.registerUtilMethod('AddHtmlHeaders', AddHtmlHeaders)
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1033
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1034
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1035 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
1036 ``<html....`>`` tag::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1037
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1038 <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
1039
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1040 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
1041
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1042 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
1043 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
1044
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1045 <script src="javascript.js"></script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1046
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1047 to::
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1048
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1049 <script
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1050 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
1051 src="javascript.js"></script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1052
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1053 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
1054
8262
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1055 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
1056 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
1057 ``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
1058
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1059 def init(instance):
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1060 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
1061
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1062 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
1063 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
1064
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1065 # 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
1066 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
1067 ''' 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
1068
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1069 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
1070 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
1071
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1072 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
1073 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
1074 '''
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1075
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1076 ### 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
1077
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1078 try:
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1079 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
1080 # 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
1081 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
1082
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1083 ...
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1084
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1085 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
1086 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
1087
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1088 <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
1089
2a7c3eeaf167 feat: add templating utils method dynamically; method to set http code
John Rouillard <rouilj@ieee.org>
parents: 8096
diff changeset
1090
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1091 Remediating ``unsafe-inline``
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1092 -----------------------------
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1093 .. _remediating unsafe-inline:
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1094
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1095 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
1096 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
1097 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
1098 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
1099 enable a callback function.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1100
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1101 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
1102 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
1103
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1104 <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
1105 /* 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
1106 onsubmit (case insensitive) attribute */
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1107 forms = document.querySelectorAll(form[onsubmit])
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1108 for (let form of f) {
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1109 form.addEventListener('submit',
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1110 () => submit_once());
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1111 };
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1112 </script>
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1113
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1114 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
1115 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
1116 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
1117
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1118 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
1119 "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
1120 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
1121 handlers.
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1122
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1123 .. _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
1124
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1125 Classhelper Web Component
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1126 =========================
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1127
7974
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1128 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
1129 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
1130 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
1131
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1132 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
1133 <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
1134 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
1135 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
1136 documentation is copied/adapted below.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1137
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1138 File Installation
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1139 -----------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1140
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1141 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
1142 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
1143 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
1144 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
1145 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
1146 ``/path/to/template``, copy::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1147
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1148 /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
1149 /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
1150 /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
1151
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1152 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
1153
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1154 Wrapping the Classic Classhelper
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1155 --------------------------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1156
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1157 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
1158 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
1159 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
1160 code like::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1161
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1162 <th i18n:translate="">Superseder</th>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1163 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1164 <span tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1165 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
1166 <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
1167 tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1168 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
1169 property='superseder', pagesize=100)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1170 [...]
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1171 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1172
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1173 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
1174
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1175 <th i18n:translate="">Superseder</th>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1176 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1177 <span tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1178 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
1179 <roundup-classhelper
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1180 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
1181 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
1182 <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
1183 tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1184 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
1185 property='superseder', pagesize=100)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1186 </roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1187 [...]
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1188 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1189
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1190 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
1191
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1192 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
1193 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
1194 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
1195 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
1196 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
1197 page.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1198 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
1199 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
1200 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
1201
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1202 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
1203 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
1204 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
1205
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1206 <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
1207 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1208 <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
1209 <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
1210 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
1211 property='nosy', width='600'" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1212 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1213
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1214 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
1215
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1216 <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
1217 <td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1218 <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
1219 <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
1220 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
1221 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
1222 ','.join(search.split(',')[:-1])">
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1223 <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
1224 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
1225 property='nosy', width='600'" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1226 </roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1227 </td>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1228
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1229 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
1230 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
1231 role.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1232
7981
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1233 Loading the <roundup-classhelper> Script
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1234 ----------------------------------------
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1235
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1236 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
1237 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
1238 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
1239
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1240 <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
1241 </script>
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1242
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1243 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
1244 it available on all pages.
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1245
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1246 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
1247 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
1248 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
1249 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
1250 on every page.
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1251
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1252 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
1253 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
1254 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
1255 `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
1256 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
1257 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
1258 <configuring-compression>`.
eae83a32f564 docs: add section on loading classhelper.js script.
John Rouillard <rouilj@ieee.org>
parents: 7979
diff changeset
1259
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1260 <roundup-classhelper> configuration
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1261 -----------------------------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1262
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1263 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
1264
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1265 data-popup-title:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1266 * 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
1267 provided if it is missing.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1268 * 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
1269 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
1270 * ``{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
1271 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
1272 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
1273 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
1274
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1275 data-search-with:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1276 * 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
1277 panel is not created to allow the user to search within
16c2e2849fd6 doc: grammar fixup.
John Rouillard <rouilj@ieee.org>
parents: 7974
diff changeset
1278 the class.
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1279 * Adding ``data-search-with`` specifies the fields that can
7976
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
1280 be used for searching. For example when invoking the
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
1281 classhelper for the issue class, using
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
1282 ``data-search-with="title,status,keyword"`` wil enable
adc3db39cb53 docs: more cleanups
John Rouillard <rouilj@ieee.org>
parents: 7975
diff changeset
1283 three search fields.
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1284 * 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
1285
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1286 * 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
1287 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
1288 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
1289
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1290 <roundup-classhelper
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1291 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
1292 <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
1293 tal:replace="structure
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1294 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
1295 property='superseder', pagesize=100)" />
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1296 </roundup-classhelper>
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1297
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1298 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
1299 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
1300
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1301 * 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
1302 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
1303 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
1304 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
1305 ``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
1306 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
1307 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
1308
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1309 <roundup-classhelper> styling
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1310 -----------------------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1311
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1312 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
1313 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
1314 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
1315 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
1316 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
1317 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
1318
7977
d3c0d3c9f5e7 docs: update cache updating for css file.
John Rouillard <rouilj@ieee.org>
parents: 7976
diff changeset
1319 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
1320 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
1321 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
1322
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1323 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
1324 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
1325
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1326 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
1327 web browser.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1328
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1329 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
1330 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
1331 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
1332 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
1333 ``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
1334
8015
72fb18809559 docs: fix markup
John Rouillard <rouilj@ieee.org>
parents: 7981
diff changeset
1335 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
1336
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1337 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
1338 ``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
1339 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
1340 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
1341 server.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1342
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1343 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
1344 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
1345 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
1346 cases.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1347
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1348 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
1349 cache time
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1350 <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
1351 classhelper.css using something like::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1352
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1353 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
1354
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1355
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1356 Translations
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1357 ------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1358
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1359 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
1360 component, follow these steps.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1361
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1362 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
1363 ``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
1364 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
1365 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
1366 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
1367 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
1368 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
1369 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
1370 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
1371 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
1372 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
1373 (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
1374 to say ``Do It``.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1375
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1376 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
1377 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
1378 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
1379 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
1380 in German. Add::
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1381
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1382 msgid "submit"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1383 msgstr "gehen"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1384
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1385 msgid "next"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1386 msgstr "nächste"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1387
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1388 msgid "name"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1389 msgstr "name"
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1390
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1391 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
1392 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
1393 ``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
1394
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1395 4. Save the .po file.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1396
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1397 5. Restart your Roundup instance.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1398
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1399 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
1400 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
1401 developers documentation
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1402 <developers.html#extracting-translatable-messages>`_.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1403
7974
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1404 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
1405 the translation mechanism. Use the following::
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1406
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1407 msgid "Info on {className} - {itemDesignator} - Classhelper"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1408 msgstr "{itemDesignator} - info on {className}"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1409
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1410 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
1411 ``{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
1412
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1413 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
1414 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
1415 Using an example above::
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1416
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1417 msgid "Nosy List Classhelper - {itemDesignator}"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1418 msgstr "Nosy List Klassenhelfer - {itemDesignator}"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1419
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1420 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
1421
7971
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1422 Troubleshooting
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1423 ---------------
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1424
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1425 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
1426 classhelper if:
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1427
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1428 * 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
1429 * 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
1430
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1431 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
1432 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
1433 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
1434 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
1435
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1436 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
1437 ``#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
1438 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
1439
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1440 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
1441 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
1442 changes to your templates.
fe0348bbe45b issue2551353 - Add roundup-classhelper for 2.4.0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
1443
7974
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1444 Advanced Configuration
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1445 ----------------------
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1446
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1447 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
1448 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
1449 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
1450 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
1451 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
1452 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
1453 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
1454
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1455 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
1456
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1457 class RestfulInstance:
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1458
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1459 @Routing.route("/roles", 'GET')
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1460 @_data_decorator
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1461 def get_roles(self, input):
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1462 """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
1463 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
1464 to an actual Roles class.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1465 """
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1466 return 200, {"collection":
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1467 [{"id": rolename,"name": rolename}
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1468 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
1469
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1470
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1471 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
1472 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
1473
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1474 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
1475 the roles defined in the tracker.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1476
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1477 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
1478
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1479
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1480 const ALTERNATIVE_DROPDOWN_PATHNAMES = {
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1481 "roles": "/rest/data/user/roles"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1482 }
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1483
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1484 and change it to::
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1485
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1486 const ALTERNATIVE_DROPDOWN_PATHNAMES = {
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1487 "roles": "/rest/roles"
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1488 }
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1489
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1490 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
1491 on their system.
4dcc64d0138e doc: classhelper translation, advanced config w/ roles endpoint
John Rouillard <rouilj@ieee.org>
parents: 7971
diff changeset
1492
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1493 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
1494 =======================================
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1495
6612
d05800c6bdfa text change.
John Rouillard <rouilj@ieee.org>
parents: 6606
diff changeset
1496 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
1497 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
1498 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
1499
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1500 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
1501 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
1502 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
1503 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
1504 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
1505
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1506 SQLite details
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1507 --------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1508
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1509 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
1510 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
1511 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
1512 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
1513 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
1514 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
1515
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1516 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
1517 language described at:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1518 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
1519 supports:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1520
7593
7c3aee35a5ac docs: clarify sentence.
John Rouillard <rouilj@ieee.org>
parents: 7546
diff changeset
1521 * plain word search (joined by 'and', similar to other search methods)
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1522 * phrase search with terms enclosed in quotes (``"``)
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1523 * proximity search with varying distances using ``NEAR()``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1524 * boolean operations by grouping with parentheses and using ``AND``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1525 and ``OR``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1526 * exclusion using ``NOT``
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1527 * 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
1528
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1529 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
1530 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
1531 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
1532
6915
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
1533 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
1534 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
1535 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
1536 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
1537 return no results but "the book" will return
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
1538 results. Pre-filtering the stopwords when indexing would
9ff091537f43 postgresql native-fts; more indexer tests
John Rouillard <rouilj@ieee.org>
parents: 6835
diff changeset
1539 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
1540 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
1541
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1542 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
1543 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
1544 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
1545 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
1546 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
1547
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1548 PostgreSQL info
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1549 ---------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1550
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1551 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
1552 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
1553 languages are supported.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1554
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1555 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
1556 `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
1557
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1558 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
1559 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
1560
8073
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1561 .. _Parsing Queries:
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1562 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
1563
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1564 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
1565
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1566 * plain word search (stemmed in most cases)
6613
2eec7a500333 Doc updates for indexers.
John Rouillard <rouilj@ieee.org>
parents: 6612
diff changeset
1567 * 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
1568 * 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
1569 * 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
1570 * 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
1571
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1572 Tsquery supports:
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1573
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1574 * a strict query syntax
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1575 * plain word search
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1576 * 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
1577 ``'`` 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
1578 in the phrase).
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1579 * 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
1580 * 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
1581 and ``|``
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1582 * exclusion using ``!``
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1583 * 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
1584
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1585 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
1586 weighing is not used.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1587
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1588 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
1589 ``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
1590 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
1591 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
1592 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
1593 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
1594
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1595 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
1596 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
1597 ``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
1598 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
1599 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
1600
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1601 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
1602 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
1603 requires reindexing.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1605 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
1606 ``\dF`` command.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1607
8073
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1608 .. _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
1609 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
1610
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1611 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
1612 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
1613 ``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
1614 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
1615 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
1616 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
1617 exist``.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1618
8073
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1619 .. _own textsearch configuration:
57ef20b6c003 docs: fix some missing/broken links.
John Rouillard <rouilj@ieee.org>
parents: 8055
diff changeset
1620 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
1621
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1622 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
1623 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
1624 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
1625 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
1626 of your success.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1627
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1628 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
1629 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
1630 querying.
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1631
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1632 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
1633
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1634 * add stopwords
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1635 * override stemming for a term
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1636 * add synonyms (e.g. a search for "pg" can also match 'psql'
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1637 "postgresql")
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1638 * add terms that expand/contract the search space (Thesaurus
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1639 dictionary)
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
1640 * additional transforms
6604
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1641
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1642 .. _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
1643
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1644 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
1645 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
1646
7257
16d6d81b4565 update http to https url.
John Rouillard <rouilj@ieee.org>
parents: 7238
diff changeset
1647 * 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
1648
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1649 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
1650 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
1651
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1652 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
1653 ------------------------------
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1654
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1655 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
1656 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
1657 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
1658 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
1659 the following SQL commands::
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1660
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1661 delete from __words;
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1662 delete from __textids;
0d99ae7c8de6 Allow Roundup to use PostgreSQL database native full text search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
1663
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1664 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
1665 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
1666 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
1667 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
1668 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
1669 <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
1670
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1671 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
1672 =============================
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1673
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1674 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
1675 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
1676 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
1677
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1678 * 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
1679 * CSRF tokens,
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1680 * 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
1681 * 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
1682 * ...
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1683
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1684 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
1685 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
1686 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
1687 transaction rates.
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1688
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1689 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
1690 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
1691 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
1692
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1693 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
1694 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
1695
7886
2946354d6ccd doc: replace X by + to indicate compatible options.
John Rouillard <rouilj@ieee.org>
parents: 7853
diff changeset
1696 .. 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
1697 :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
1698
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1699 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1700 | | session db |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1701 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1702 |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
1703 +===============+========+========+=======+=======+============+
8016
098ceff38349 docs: escape + in table, prevent it from starting an unordered list
John Rouillard <rouilj@ieee.org>
parents: 8015
diff changeset
1704 |anydbm | D | | \+ | | |
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1705 +---------------+--------+--------+-------+-------+------------+
8016
098ceff38349 docs: escape + in table, prevent it from starting an unordered list
John Rouillard <rouilj@ieee.org>
parents: 8015
diff changeset
1706 |sqlite | \+ | D | \+ | | |
7381
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1707 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1708 |mysql | | | | D | |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1709 +---------------+--------+--------+-------+-------+------------+
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1710 |postgresql | | | | | D |
2884ff18c944 Change primary/session db compatibility table from ascii to real table
John Rouillard <rouilj@ieee.org>
parents: 7367
diff changeset
1711 +---------------+--------+--------+-------+-------+------------+
6814
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1712
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1713 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
1714 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
1715
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1716 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
1717 ---------------------------------
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1718
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1719 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
1720
6819
1319ab13f286 redis works with python 2.7 too.
John Rouillard <rouilj@ieee.org>
parents: 6814
diff changeset
1721 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
1722 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
1723 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
1724
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1725 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
1726 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
1727 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
1728 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
1729 ``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
1730 ``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
1731
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1732
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1733 For example::
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1734
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1735 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
1736
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1737 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
1738 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
1739 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
1740 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
1741 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
1742 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
1743 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
1744
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1745 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
1746 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
1747 ``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
1748 parameters::
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1749
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1750 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
1751
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1752 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
1753 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
1754
3f60a71b0812 Summary: Support selecion session/otk data store. Add redis as data store.
John Rouillard <rouilj@ieee.org>
parents: 6781
diff changeset
1755 .. _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
1756 .. _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
1757 .. _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
1758
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
1759
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1760 Users and Security
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1761 ==================
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1762
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1763 Roundup holds its own user database which primarily contains a username,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1764 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
1765 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
1766 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
1767 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
1768 :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
1769 `LDAP <https://wiki.roundup-tracker.org/LDAPLogin>`_, etc.)
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1770
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1771 Roundup identifies users in a number of ways:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1772
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1773 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
1774 Authentication or cookie authentication. If you are running the web
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1775 server (roundup-server) through another HTTP server (eg. apache or IIS)
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1776 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
1777 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
1778 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
1779 present, then Roundup defaults to using its own cookie-based login
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1780 mechanism.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1781 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
1782 From address in the message.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1783
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1784 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
1785 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
1786 tracker's ``schema.py`` module:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1787
6751
2f7b653b7d6f Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
1788 Web Access and Register
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1789 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
1790 register through the web.
6751
2f7b653b7d6f Replace old Web Registration/Email Registration with modern equiv.
John Rouillard <rouilj@ieee.org>
parents: 6727
diff changeset
1791 Email Access and Register
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1792 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
1793 will result in those users being registered with the tracker.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1794
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1795 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
1796 may be found in the `reference documentation`_.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1797
6436
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1798 Configuring Authentication Header/Variable
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1799 ------------------------------------------
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1800
7238
98d7936d97a3 Add section on configuring Content Security Policy (CSP)
John Rouillard <rouilj@ieee.org>
parents: 7093
diff changeset
1801 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
1802 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
1803 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
1804 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
1805 ``[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
1806 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
1807
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1808 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
1809 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
1810 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
1811 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
1812 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
1813 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
1814 roundup-server config file).
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1815
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1816 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
1817 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
1818 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
1819
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1820 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
1821
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1822 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
1823 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
1824 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
1825 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
1826 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
1827 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
1828
7594
c9180009a286 docs: fix sentence.
John Rouillard <rouilj@ieee.org>
parents: 7593
diff changeset
1829 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
1830 ``config.ini`` to read::
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1831
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1832 [web]
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1833 ...
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1834 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
1835
1f2f7c0b8968 issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents: 6344
diff changeset
1836 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
1837 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
1838 mailing list.
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
1839
7306
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1840
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1841 Securing Secrets
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1842 ================
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1843
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1844 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
1845 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
1846 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
1847 of the tracker home.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1848
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1849 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
1850 secrets management. This example config.ini configuration gets
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1851 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
1852
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1853 [rdbms]
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1854 # Database user password.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1855 # 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
1856 # path relative to the tracker home. Using 'file:///' defines
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1857 # 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
1858 # 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
1859 # 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
1860 # 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
1861 #
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1862 # Default: roundup
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1863 password = file:///run/secrets/db_password
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1864
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1865 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
1866 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
1867 Roundup service.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1868
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1869 Because environment variables can be inadvertently exposed in
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1870 logs or process listings, Roundup does not currently support
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1871 loading secrets from environment variables.
1aad478fc03f Add section on Securing Secrets
John Rouillard <rouilj@ieee.org>
parents: 7279
diff changeset
1872
8478
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1873 .. _pgpconfig:
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1874
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1875 Configuring PGP Email Support
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1876 =============================
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1877
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1878 .. note::
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1879 This section was written with the help of the Devin/DeepWiki AI.
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1880
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1881 You have to install the gpg module using pip. See :ref:`directions for
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1882 installing gpg <gpginstall>`
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1883 in the upgrading document for more information.
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1884
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1885 In your tracker's config.ini configure the following settings in the
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1886 ``[pgp]`` section::
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1887
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1888 enable = yes
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1889 homedir = /path/to/pgp/configdir
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1890 roles = admin
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1891
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1892 This will allow any user with the admin role to send signed pgp
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1893 email. If ``roles`` is not set, all users will need to use signed
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1894 emails. If it is not signed it will be rejected. Note that ``homedir``
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1895 must be an absolute path. Unlike other path settings, a relative path
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1896 is not interpreted relative to the tracker home. See the documentation
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1897 in config.ini for more information and other settings (e.g. to send
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1898 encrypted emails from the tracker).
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1899
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1900 When PGP is enabled and a message is signed with a valid signature,
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1901 the database transaction source (db.tx_Source) is set to
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1902 ``email-sig-openpgp`` instead of ``email``. This allows you to
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1903 restrict certain operations (e.g. changing a private flag) to
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1904 authenticated/signed emails.
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1905
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1906 Creating GPG Keys for the Tracker
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1907 ---------------------------------
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1908
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1909 To generate a keypair use::
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1910
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1911 gpg --homedir /path/to/pgp/configdir --gen-key
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1912
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1913 where the homedir directory matches the one you set in
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1914 config.ini. Note the gpg homedir must be created before you run the
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1915 command. You will be prompted for the full name of your tracker and
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1916 the email address for your tracker. You also need to do with as the
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1917 user who runs roundup (aka the roundup user) and the roundup email
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1918 gateway. Do not encrypt the key.
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1919
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1920 Roundup has no mechanism for reading the private key if it is
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1921 encrypted. So make sure the permissions on the homedir only allow the
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1922 roundup user to read the files.
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1923
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1924 You can export the public key for use by clients using::
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1925
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1926 gpg --homedir /path/to/pgp/configdir --export -a tracker@example.com > tracker-public.key
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1927
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1928 with homedir and email matching the values used to generate the
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1929 key. This will allow users to import the public key and encrypt emails
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1930 to the tracker.
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1931
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1932 The public gpg key for each user's email address must be imported. To
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1933 do this, obtain the user's public key for their primary email address
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1934 and import it using::
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1935
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1936 gpg --homedir /path/to/tracker/gpg --import user-public-key.asc
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1937
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1938 While Roundup supports multiple addresses for each user, only the
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1939 primary address supports PGP signed or encrypted messages.
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1940
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1941 .. comment:
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1942 Questions:
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1943
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1944 Can roundup send signed emails? (looks like no, why??)
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1945
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1946 Why are alternate addresses not supported for receiving PGP emails?
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1947
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1948 Does Roundup ever send an email to an alternate email address?
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1949
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1950 Should there be some way for a user to upload their own public key?
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1951 If so what ui (paste armored asci cert in textbox, upload ascii
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1952 file from user page and process)?
ed4ef394d5d6 doc: initial attempt to document setup of pgp support for email.
John Rouillard <rouilj@ieee.org>
parents: 8477
diff changeset
1953
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1954 Tasks
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1955 =====
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1956
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1957 Maintenance of Roundup can involve one of the following:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1958
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
1959 1. `tracker backup`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1960 2. `software upgrade`_
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1961 3. `migrating backends`_
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2003
diff changeset
1962 4. `moving a tracker`_
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
1963 5. `migrating from other software`_
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
1964 6. `adding a user from the command-line`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1965
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1966
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1967 Tracker Backup
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1968 --------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1969
3959
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1970 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
1971 performing backup.
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1972
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1973 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
1974 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
1975 This means using
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
1976 *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
1977 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
1978 it to be elsewhere) will then complete the backup.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1979
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1980
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1981 Software Upgrade
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1982 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1983
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1984 .. _make a backup: #tracker-backup
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1985
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1986 Always `make a backup`_ of your tracker before upgrading software.
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
1987 Steps you may take:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1988
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1989 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
1990 (using your preferred python version)::
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
1991
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1992 pip2 install pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1993 python2 -m pytest test/
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1994
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1995
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1996 pip3 install pytest
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 6265
diff changeset
1997 python3 -m pytest test/
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
1998
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
1999 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
2000 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
2001 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
2002 (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
2003 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
2004 environment::
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
2005
8041
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
2006 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
2007 . /path/to/env/bin/activate
704757c71b84 docs: use virtual env for upgrade; stop cron jobs.
John Rouillard <rouilj@ieee.org>
parents: 8039
diff changeset
2008 python3 pip install roundup
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
2009
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
2010 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
2011 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
2012
6781
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
2013 Usually you should run `roundup_admin -i <tracker_home> migrate`
b3d4b25b4922 Add links some updates.
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
2014 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
2015
3230f9c88086 Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents: 3959
diff changeset
2016 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
2017 habit.
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
2018 7. Restart your tracker web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2019
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
2020 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
2021 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
2022
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
2023 python setup.py install
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
2024
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
2025 .. 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
2026 single: roundup-admin; import and export
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
2027
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2028 Migrating Backends
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2029 ------------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2030
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2031 1. Stop the existing tracker web and email frontends (preventing changes).
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2032 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
2033 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
2034 `issue1441336 <https://issues.roundup-tracker.org/issue1441336>`_
4f74b97dddcd Doc how to export on windows.
John Rouillard <rouilj@ieee.org>
parents: 5300
diff changeset
2035 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
2036 export data.)
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2037 3. Copy the tracker home to a new directory.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2038 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
2039 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
2040 section of the tracker's ``config.ini`` file.
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2041 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
2042 the new tracker home. If non-interactively::
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2043
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2044 roundup-admin -i <tracker home> import <tracker export dir>
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2045
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4489
diff changeset
2046 If interactively, enter 'commit' before exiting.
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2047 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
2048 backend.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2049 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
2050 move the new tracker home into its place.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
2051 9. Restart web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2052
7668
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
2053 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
2054 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
2055 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
2056 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
2057
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
2058 pragma savepoint_limit=20000
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
2059
5b41018617f2 fix: out of memory error when importing under postgresql
John Rouillard <rouilj@ieee.org>
parents: 7667
diff changeset
2060 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
2061 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
2062 set on the roundup-admin command line as described below.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2063
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2064 Moving a Tracker
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2065 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2066
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2067 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
2068
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2069 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
2070 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2071 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
2072 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
2073
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2074 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
2075 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
2076 moved using the above steps) then you'll need to:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2077
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2078 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
2079 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2080 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
2081 the existing tracker,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2082 4. copy the export to the new machine,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2083 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
2084 machine, and
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2085 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
2086
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
2087 .. index::
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
2088 pair: roundup; migrate from other bugtracker software
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2089
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2090 Migrating From Other Software
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2091 -----------------------------
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2092
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2093 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
2094 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
2095 directly. The latter is almost always simpler -- see the "scripts"
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2096 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
2097
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
2098 "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
2099 directory containing files with the following format:
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2100
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2101 - 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
2102 named <classname>.csv
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2103 - one colon-separated-values file per Class with journal information,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2104 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
2105 - 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
2106 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
2107 structure::
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2108
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2109 <classname>-files/<N>/<designator>
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2110
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2111 where ``<designator>`` is the item's ``<classname><id>`` combination.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2112 The ``<N>`` value is ``int(<id> / 1000)``.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2113
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
2114
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
2115 .. index:: pair: roundup-admin; managing users
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5902
diff changeset
2116
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2117 Adding A User From The Command-Line
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2118 -----------------------------------
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2119
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2120 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
2121 database. To create a new user, use::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2122
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2123 roundup-admin create user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2124
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2125 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
2126 you can just display another user::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2127
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2128 roundup-admin list user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2129
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2130 (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
2131
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
2132 roundup-admin filter user username=richard
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2133
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
2134 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
2135 commands, you may display the user's details::
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2136
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
2137 roundup-admin display <designator>
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2138
6176
d25638d1826c Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents: 6175
diff changeset
2139 where designator is ``user5``.
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
2140
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2141 Running the Servers
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2142 ===================
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2143
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2144 Unix
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2145 ----
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2146
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2147 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
2148 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
2149 to reflect your specific installation.
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2150
6344
c63df349f319 issue2551117 - add example systemd config
John Rouillard <rouilj@ieee.org>
parents: 6297
diff changeset
2151 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
2152 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
2153 point for your setup.
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2154
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2155 Windows
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2156 -------
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2157
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
2158 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
2159 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
2160 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
2161 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
2162 service directly:
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2163
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2164 **install the service**
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3465
diff changeset
2165 ``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
2166 **start the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2167 ``roundup-server -c start``
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2168 **stop the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2169 ``roundup-server -c stop``
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2170
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2171 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
2172
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2173 Windows 2000 and later
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2174 Start/Control Panel/Administrative Tools/Services
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2175 Windows NT4
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
2176 Start/Control Panel/Services
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
2177
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
2178 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
2179 `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
2180 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
2181 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
2182
2203
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2183 Running the Mail Gateway Script
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2185
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2186 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
2187 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
2188 solution to this is to:
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2189
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2190 1. Create a new local account on the Roundup server
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2191 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
2192 of your normal login
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
2193
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2194 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
2195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2196
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2197 Usage::
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2198
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2199 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
2200 [-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
2201 [-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
2202 [args ...]
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2203
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2204
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2205 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
2206
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
2207 - without arguments. Then the env var ROUNDUP_INSTANCE will be tried.
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
2208 - with an instance home as the only argument,
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
2209 - with both an instance home and a mail spool file, or
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
2210 - 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
2211
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2212 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
2213 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
2214 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
2215 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
2216 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
2217 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
2218 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
2219 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
2220
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2221 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
2222 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
2223 settings.
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2224
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2225 PIPE:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2226 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
2227 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
2228 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
2229
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2230 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
2231 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
2232 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
2233 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
2234 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
2235
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2236 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
2237
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2238 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
2239 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
2240 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
2241 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
2242 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
2243
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2244 POP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2245 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
2246 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
2247 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
2248
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2249 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
2250
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2251 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
2252
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2253 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
2254 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
2255
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2256 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
2257
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2258 POPS:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2259 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
2260 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
2261
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2262 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
2263
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2264 APOP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2265 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
2266
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2267 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
2268
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2269 IMAP:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2270 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
2271 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
2272
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2273 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
2274
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2275 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
2276 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
2277
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2278 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
2279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2280 IMAPS:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2281 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
2282 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
2283
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2284 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
2285
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2286 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
2287 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
2288 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
2289
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2290 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
2291
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2292 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
2293 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
2294 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
2295 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
2296 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
2297 ``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
2298 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
2299 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
2300 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
2301 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
2302 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
2303 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
2304
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2305 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
2306
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2307 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
2308 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
2309 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
2310
7503
7b6278da3faa Update roundup-mailgw install with other methods; formatting
John Rouillard <rouilj@ieee.org>
parents: 7499
diff changeset
2311 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
2312
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2313 .. _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
2314
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2315 .. 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
2316 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
2317 single: roundup-admin; data formats
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2318 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
2319 pair: roundup-admin; designator
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2320
8412
0663a7bcef6c feat: finish reauth docs, enhance code.
John Rouillard <rouilj@ieee.org>
parents: 8352
diff changeset
2321 .. _`roundup-admin templates`:
0663a7bcef6c feat: finish reauth docs, enhance code.
John Rouillard <rouilj@ieee.org>
parents: 8352
diff changeset
2322
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2323 Using roundup-admin
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2324 ===================
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2325
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2326 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
2327 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
2328 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
2329 tracker.
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2330
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2331 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
2332
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
2333 * install and initialize a new tracker
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
2334 * export/import tracker data for migrating between backends
7477
f40626db85dd typo fix.
John Rouillard <rouilj@ieee.org>
parents: 7454
diff changeset
2335 * creating a new user from the command line
7367
602cc42f9edd Unident lists.
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
2336 * list/find users in the tracker
6173
82f58ae89142 Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
2337
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
2338 The basic usage is:
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
2339
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
2340 .. 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
2341
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2342 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
2343
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2344 Options:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2345 -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
2346 -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
2347 -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
2348 -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
2349 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
2350 -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
2351 -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
2352 Same as '-S " "'.
7546
534f8bdb8f94 Add -P pragma=value command line option to roundup-admin.
John Rouillard <rouilj@ieee.org>
parents: 7503
diff changeset
2353 -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
2354 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
2355 -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
2356 -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
2357
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2358 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
2359
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2360 Help:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2361 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
2362 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
2363 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
2364 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
2365
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2366 Commands:
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2367 commit
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2368 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
2369 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
2370 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
2371 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
2372 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
2373 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
2374 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
2375 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
2376 help topic
7797
8bdf0484215c Summary: feat: roundup-admin history command has human interpretable output
John Rouillard <rouilj@ieee.org>
parents: 7795
diff changeset
2377 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
2378 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
2379 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
2380 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
2381 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
2382 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
2383 migrate
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2384 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
2385 perftest [mode] [arguments]*
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
2386 pragma setting=value | 'list'
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
2387 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
2388 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
2389 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
2390 rollback
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2391 security [Role name]
7395
312d52305583 - issue2551190 - Allow roundup-admin reindex to work in batches.
John Rouillard <rouilj@ieee.org>
parents: 7387
diff changeset
2392 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
2393 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
2394 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
2395 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
2396 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
2397 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
2398 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
2399
8435
1a93dc58f975 feat: add 'q' as alias to quit to exit interactive roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8433
diff changeset
2400 In interactive mode entering: ``q``, ``quit``, or ``exit`` alone on a
1a93dc58f975 feat: add 'q' as alias to quit to exit interactive roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8433
diff changeset
2401 line will exit the program.
1a93dc58f975 feat: add 'q' as alias to quit to exit interactive roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8433
diff changeset
2402
7093
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
2403 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
2404 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
2405 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
2406 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
2407 config.ini.
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
2408
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
2409 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
2410 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
2411 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
2412 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
2413 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
2414 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
2415 command line access to a tracker.
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
2416
f72ce883e677 Mitigation for issue2551246 -u opton to roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 6915
diff changeset
2417 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
2418
7404
1642a7b501df Add additional command that do not require a tracker home.
John Rouillard <rouilj@ieee.org>
parents: 7395
diff changeset
2419 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
2420 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
2421 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
2422 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
2423 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
2424 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
2425 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
2426
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2427 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
2428 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
2429 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
2430
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2431 - 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
2432 - 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
2433 - 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
2434 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
2435 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
2436
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2437 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
2438 "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
2439 "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
2440 "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
2441 "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
2442 "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
2443 "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
2444 "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
2445 "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
2446 "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
2447 "." "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
2448
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2449 - 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
2450 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
2451 - 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
2452 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
2453 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
2454 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
2455
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2456 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
2457 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
2458 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
2459 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
2460 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
2461
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2462 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
2463 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
2464
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2465 - ``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
2466 - 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
2467
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2468 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
2469 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
2470
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2471 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
2472 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
2473 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
2474 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
2475 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
2476
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2477 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
2478 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
2479 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
2480 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
2481 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
2482 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
2483 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
2484
7454
76b2f3c95c03 Add anchor for init section.
John Rouillard <rouilj@ieee.org>
parents: 7404
diff changeset
2485 .. _initpw:
76b2f3c95c03 Add anchor for init section.
John Rouillard <rouilj@ieee.org>
parents: 7404
diff changeset
2486
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2487 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
2488 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
2489 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
2490 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
2491 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
2492 exposing the password, create a file (e.g init_tracker) set to mode
8432
7f7749d86da8 doc: add disable saving roundup-admin history file for password changes
John Rouillard <rouilj@ieee.org>
parents: 8423
diff changeset
2493 600 (so only the owner can read it) with the contents::
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2494
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2495 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
2496
8432
7f7749d86da8 doc: add disable saving roundup-admin history file for password changes
John Rouillard <rouilj@ieee.org>
parents: 8423
diff changeset
2497 and feed it to roundup-admin on standard input. E.G.::
7f7749d86da8 doc: add disable saving roundup-admin history file for password changes
John Rouillard <rouilj@ieee.org>
parents: 8423
diff changeset
2498
7f7749d86da8 doc: add disable saving roundup-admin history file for password changes
John Rouillard <rouilj@ieee.org>
parents: 8423
diff changeset
2499 cat init_tracker | roundup-admin -i tracker_dir -P history_features=2
7f7749d86da8 doc: add disable saving roundup-admin history file for password changes
John Rouillard <rouilj@ieee.org>
parents: 8423
diff changeset
2500
7f7749d86da8 doc: add disable saving roundup-admin history file for password changes
John Rouillard <rouilj@ieee.org>
parents: 8423
diff changeset
2501 setting the pragma ``history_features=2`` prevents storing the command
7f7749d86da8 doc: add disable saving roundup-admin history file for password changes
John Rouillard <rouilj@ieee.org>
parents: 8423
diff changeset
2502 in the user's history file.
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2503
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2504 (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
2505
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2506 .. 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
2507
7795
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2508 Using Interactively
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2509 -------------------
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2510
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2511 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
2512 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
2513 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
2514 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
2515 package (see `installation documentation`_).
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2516
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2517 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
2518 for just one session.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2519
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2520 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
2521 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
2522 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
2523 (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
2524
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2525 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
2526 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
2527 persistently set the history size using ``history size
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2528 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
2529 ``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
2530 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
2531
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2532 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
2533 directory (for windows usually ``\Users\<username>``.
d7d68da9878f save roundup-admin history between sessions.
John Rouillard <rouilj@ieee.org>
parents: 7668
diff changeset
2534
8439
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2535 In Roundup 2.6.0 and newer, you can use the ``readline`` command to
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2536 make changes on the fly.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2537
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2538 * ``readline vi`` - change input mode to use vi key binding when
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2539 editing. It starts in entry mode.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2540 * ``readline emacs`` - change input mode to emacs key bindings when
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2541 editing. This is also the default.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2542 * ``readline reload`` - reloads the ``~/.roundup_admin_rlrc`` file so
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2543 you can test and use changes.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2544 * ``readline history`` - dumps the history buffer and numbers all
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2545 commands.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2546 * ``readline .inputrc_command_line`` can be used to make on the fly
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2547 key and key sequence bindings to readline commands. It can also be
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2548 used to change the internal readline settings using a set
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2549 command. For example::
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2550
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2551 readline set bell-style none
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2552
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2553 will turn off a ``visible`` or ``audible`` bell. Single character
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2554 keybindings::
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2555
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2556 readline Control-o: dump-variables
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2557
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2558 to list all the variables that can be set are supported. As are
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2559 multi-character bindings::
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2560
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2561 readline "\C-o1": "commit"
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2562
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2563 will put "commit" on the input line when you type Control-o followed
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2564 by 1. See the `readline manual for details
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2565 <https://tiswww.cwru.edu/php/chet/readline/rluserman.html#Readline-Init-File-Syntax-1>`_
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2566 on the command lines that can be used.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2567
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2568 Also a limited form of ``!`` (bang) history reference was added. The
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2569 reference must be at the start of the line. Typing ``!23`` will rerun
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2570 command number 23 from your history.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2571
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2572 Typing ``!23:p`` will load command 23 into the buffer so you can edit
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2573 and submit it. Using the bang feature will append the command to the
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2574 end of the history list.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2575
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2576 Pyreadline3 users can use ``readline history`` and the
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2577 bang commands (including ``:p``). Single character bindings can be
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2578 done. For example::
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2579
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2580 readline Control-w: history-search-backward
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2581
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2582 The commands that are available are limited compared to Unix's
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2583 readline or libedit. Setting variables or entry mode (emacs,
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2584 vi) switching do not work in testing.
3bdae15252c6 feat: add support for ! history and readline command in roundup-admin
John Rouillard <rouilj@ieee.org>
parents: 8435
diff changeset
2585
7279
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2586 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
2587 --------------------
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2588
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2589 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
2590 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
2591
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2592 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
2593 "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
2594 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
2595
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2596 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
2597 > 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
2598 > done
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2599 msg23
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2600 msg49
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2601 msg50
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2602 msg61
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2603 shell%
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2604
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2605 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
2606
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2607 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
2608 \`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
2609 msg23
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2610 msg49
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2611 msg50
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2612 msg61
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2613 shell%
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2614
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2615 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
2616
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2617 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
2618 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
2619 files: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2620 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
2621 recipients: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2622 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
2623 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
2624 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
2625 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
2626 files: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2627 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
2628 recipients: []
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2629 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
2630 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
2631 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
2632 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
2633
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2634 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
2635
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2636 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
2637 -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
2638 unread
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2639 deferred
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2640
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2641 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
2642
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2643 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
2644 -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
2645 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
2646
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2647 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
2648
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2649 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
2650 -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
2651 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
2652
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2653 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
2654
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2655 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
2656 `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
2657 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
2658 chatting
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2659 chatting
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2660
0bf616cfa178 Move mail gateway and roundup-admin doc to admin guide from user guide
John Rouillard <rouilj@ieee.org>
parents: 7257
diff changeset
2661 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
2662 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
2663
7667
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2664 A Note on Import and Export
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2665 ---------------------------
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2666
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2667 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
2668 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
2669
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2670 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
2671 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
2672
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2673 For example::
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2674
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2675 $ 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
2676 Exporting priority - 5
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2677 Exporting Journal for priority
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2678 Exporting status - 1
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2679 Exporting Journal for status
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2680 [...]
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2681
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2682
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2683 $ 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
2684 Importing priority - 7
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2685 setting priority 8
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2686 Importing status - 8
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2687 setting status 9
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2688 [...]
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2689
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2690 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
2691 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
2692 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
2693
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2694 ``Exporting issue - XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2695
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2696 ``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
2697 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
2698 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
2699 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
2700 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
2701
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2702 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
2703 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
2704 processing at the time.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2705
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2706 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
2707 when sorted alphabetically by name.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2708
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2709 ``Importing <class> - XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2710
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2711 ``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
2712 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
2713 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
2714 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
2715 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
2716 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
2717 the line at XXX+1.
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2718
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2719 ``setting <class> XXX``:
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2720
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2721 ``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
2722 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
2723 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
2724 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
2725
08e4399c3ae4 doc: document the messages generated from import/export
John Rouillard <rouilj@ieee.org>
parents: 7615
diff changeset
2726 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
2727 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
2728 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
2729 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
2730
8096
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2731 Interactive Help
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2732 ----------------
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2733
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2734 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
2735
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2736
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2737 .. raw:: html
ea1f377c87d6 docs: add roundup-admin interactive help output to admin_guide.txt
John Rouillard <rouilj@ieee.org>
parents: 8073
diff changeset
2738 :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
2739
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2740 .. _`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
2741 .. _`reference documentation`: reference.html
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
2742 .. _`upgrading documentation`: upgrading.html
6458
8f1b91756457 issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents: 6436
diff changeset
2743 .. _`installation documentation`: installation.html
Roundup Issue Tracker: http://roundup-tracker.org/