Mercurial > p > roundup > code
annotate doc/admin_guide.txt @ 6586:24e2eeb2ed9a
Add meta description to some doc pages.
Try to improve SEO a bit. Get more users/contributors.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Fri, 21 Jan 2022 14:29:46 -0500 |
| parents | 8f1b91756457 |
| children | 0d99ae7c8de6 |
| rev | line source |
|---|---|
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
1 .. meta:: |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6458
diff
changeset
|
2 :description language=en: |
|
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 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
22 standard Python mechanism called "distutils" and thus Roundup's core code, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
23 executable scripts and support data files are installed in Python's |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
24 directories. On Windows, this is typically: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
25 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
26 Scripts |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
27 ``<python dir>\scripts\...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
28 Core code |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
29 ``<python dir>\lib\site-packages\roundup\...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
30 Support files |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
31 ``<python dir>\share\roundup\...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
32 |
|
2005
fc52d57c6c3e
documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
33 and on Unix-like systems (eg. Linux): |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
34 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
35 Scripts |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
36 ``<python root>/bin/...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
37 Core code |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
38 ``<python root>/lib-<python version>/site-packages/roundup/...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
39 Support files |
|
2068
65b5297b488f
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2005
diff
changeset
|
40 ``<python root>/share/roundup/...`` |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
41 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
42 2. The installation of a specific tracker. When invoking the roundup-admin |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
43 "inst" (and "init") commands, you're creating a new Roundup tracker. This |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
44 installs configuration files, HTML templates, detector code and a new |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
45 database. You have complete control over where this stuff goes through |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
46 both choosing your "tracker home" and the ``main`` -> ``database`` variable |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
47 in the tracker's config.ini. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
48 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
49 |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
50 Configuring Roundup's Logging of Messages For Sysadmins |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
51 ======================================================= |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
52 |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
53 You may configure where Roundup logs messages in your tracker's config.ini |
|
4786
6018617c55ab
Removing remains of "rlog" module, fixes db unit test debug logging via environment variable.
Bernhard Reiter <bernhard@intevation.de>
parents:
4567
diff
changeset
|
54 file. Roundup will use the standard Python (2.3+) logging implementation. |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
55 |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
56 Configuration for standard "logging" module: |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
57 - tracker configuration file specifies the location of a logging |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
58 configration file as ``logging`` -> ``config`` |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
59 - ``roundup-server`` specifies the location of a logging configuration |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
60 file on the command line |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
61 Configuration for "BasicLogging" implementation: |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
62 - tracker configuration file specifies the location of a log file |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
63 ``logging`` -> ``filename`` |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
64 - tracker configuration file specifies the level to log to as |
|
2921
ad4fb8a14a97
more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents:
2632
diff
changeset
|
65 ``logging`` -> ``level`` |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
66 - ``roundup-server`` specifies the location of a log file on the command |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
67 line |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
68 - ``roundup-server`` specifies the level to log to on the command line |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
69 |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
70 (``roundup-mailgw`` always logs to the tracker's log file) |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
71 |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
72 In both cases, if no logfile is specified then logging will simply be sent |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
73 to sys.stderr with only logging of ERROR messages. |
|
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
74 |
| 3250 | 75 |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
76 Configuring roundup-server |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
77 ========================== |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
78 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
79 The basic configuration file is as follows (taken from the |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
80 ``roundup-server.ini.example`` file in the "doc" directory):: |
|
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
81 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
82 [main] |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
83 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
84 # Host name of the Roundup web server instance. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
85 # If left unconfigured (no 'host' setting) the default |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
86 # will be used. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
87 # If empty, listen on all network interfaces. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
88 # If you want to explicitly listen on all |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
89 # network interfaces, the address 0.0.0.0 is a more |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
90 # explicit way to achieve this, the use of an empty |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
91 # string for this purpose is deprecated and will go away |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
92 # in a future release. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
93 # Default: localhost |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
94 host = localhost |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
95 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
96 # Port to listen on. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
97 # Default: 8080 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
98 port = 8017 |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
99 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
100 # Path to favicon.ico image file. If unset, built-in favicon.ico is used. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
101 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
102 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
103 # Default: favicon.ico |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
104 favicon = favicon.ico |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
105 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
106 # User ID as which the server will answer requests. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
107 # In order to use this option, the server must be run initially as root. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
108 # Availability: Unix. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
109 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
110 user = roundup |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
111 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
112 # Group ID as which the server will answer requests. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
113 # In order to use this option, the server must be run initially as root. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
114 # Availability: Unix. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
115 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
116 group = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
117 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
118 # don't fork (this overrides the pidfile mechanism)' |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
119 # Allowed values: yes, no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
120 # Default: no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
121 nodaemon = no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
122 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
123 # Log client machine names instead of IP addresses (much slower) |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
124 # Allowed values: yes, no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
125 # Default: no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
126 log_hostnames = no |
|
2632
9c55f2bc5961
roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents:
2572
diff
changeset
|
127 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
128 # File to which the server records the process id of the daemon. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
129 # If this option is not set, the server will run in foreground |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
130 # |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
131 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
132 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
133 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
134 pidfile = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
135 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
136 # Log file path. If unset, log to stderr. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
137 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
138 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
139 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
140 logfile = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
141 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
142 # Set processing of each request in separate subprocess. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
143 # Allowed values: debug, none, thread, fork. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
144 # Default: fork |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
145 multiprocess = fork |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
146 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
147 # Tracker index template. If unset, built-in will be used. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
148 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
149 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
150 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
151 template = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
152 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
153 # Enable SSL support (requires pyopenssl) |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
154 # Allowed values: yes, no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
155 # Default: no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
156 ssl = no |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
157 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
158 # PEM file used for SSL. A temporary self-signed certificate |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
159 # will be used if left blank. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
160 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
161 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
162 # Default: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
163 pem = |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
164 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
165 # Roundup trackers to serve. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
166 # Each option in this section defines single Roundup tracker. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
167 # Option name identifies the tracker and will appear in the URL. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
168 # Option value is tracker home directory path. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
169 # The path may be either absolute or relative |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
170 # to the directory containing this config file. |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
171 [trackers] |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
172 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
173 demo = /trackers/demo |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
174 sysadmin = /trackers/sysadmin |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
175 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
176 Additional notes for each keyword: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
177 |
|
3880
2359d6304a4f
Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3781
diff
changeset
|
178 **template** |
|
2359d6304a4f
Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3781
diff
changeset
|
179 Specifies a template used for displaying the tracker index when |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
180 multiple trackers are being used. It is processed by TAL and |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
181 the variable "trackers" is available to the template and is a |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
182 dict of all configured trackers. |
|
3883
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
183 **ssl** |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
184 Enables the use of SSL to secure the connection to the roundup-server. |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
185 If you enable this, ensure that your tracker's config.ini specifies |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
186 an *https* URL. |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
187 **pem** |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
188 If specified, the SSL PEM file containing the private key and certificate. |
|
679118b572d5
add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents:
3880
diff
changeset
|
189 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
|
190 for use. |
|
3465
81542d49c8cb
fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents:
3341
diff
changeset
|
191 **trackers** section |
|
81542d49c8cb
fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents:
3341
diff
changeset
|
192 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
|
193 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
|
194 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
|
195 |
|
5102
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
196 To generate a config.ini in the current directory (note it will |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
197 overwrite an existing file) from the roundup-server command line use:: |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
198 |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
199 roundup_server -p 8017 -u roundup --save-config demo=/trackers/demo \ |
|
96dc9f07340a
issue2161722: oudated docs
John Rouillard <rouilj@ieee.org>
parents:
4891
diff
changeset
|
200 sysadmin=/trackers/sysadmin |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
201 |
|
6458
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
202 Configuring Compression |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
203 ======================= |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
204 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
205 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
|
206 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
|
207 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
208 [web] |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
209 ... |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
210 dynamic_compression = No |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
211 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
212 in the tracker's ``config.ini``. You should disable compression if |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
213 your proxy (e.g. nginx or apache) or wsgi server (uwsgi) is configured |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
214 to compress responses on the fly. The python standard library includes |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
215 gzip support. For brotli or zstd you will need to install packges. See |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
216 the `installation documentation`_ for details. |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
217 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
218 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
|
219 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
|
220 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
|
221 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
|
222 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
223 from roundup.cgi.client import Client |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
224 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
225 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
|
226 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
227 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
|
228 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
229 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
|
230 errors messages, short json responses). |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
231 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
232 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
|
233 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
|
234 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
|
235 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
|
236 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
237 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
|
238 ``@@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
|
239 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
|
240 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
|
241 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
242 [web] |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
243 ... |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
244 use_precompressed_files = Yes |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
245 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
246 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
|
247 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
|
248 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
|
249 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
250 tracker_home/html/library.js.gzip |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
251 tracker_home/html/library.js.br |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
252 tracker_home/html/library.js.zstd |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
253 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
254 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
|
255 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
256 gzip --keep --suffix .gzip library.js |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
257 brotli library.js |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
258 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
|
259 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
260 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
|
261 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
|
262 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
|
263 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
264 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
|
265 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
|
266 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
|
267 ``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
|
268 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
|
269 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
|
270 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
271 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
|
272 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
|
273 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
|
274 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
|
275 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
|
276 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
|
277 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
|
278 |
|
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
279 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
280 Users and Security |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
281 ================== |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
282 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
283 Roundup holds its own user database which primarily contains a username, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
284 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
|
285 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
|
286 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
|
287 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
|
288 :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
|
289 `LDAP <https://wiki.roundup-tracker.org/LDAPLogin>`_, etc.) |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
290 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
291 Roundup identifies users in a number of ways: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
292 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
293 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
|
294 Authentication or cookie authentication. If you are running the web |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
295 server (roundup-server) through another HTTP server (eg. apache or IIS) |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
296 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
|
297 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
|
298 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
|
299 present, then Roundup defaults to using its own cookie-based login |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
300 mechanism. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
301 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
|
302 From address in the message. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
303 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
304 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
|
305 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
|
306 tracker's ``schema.py`` module: |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
307 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
308 Web Registration |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
309 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
|
310 register through the web. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
311 Email Registration |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
312 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
|
313 will result in those users being registered with the tracker. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
314 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
315 More information about how to customise your tracker's security settings |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
316 may be found in the `customisation documentation`_. |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
317 |
|
6436
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
318 Configuring Authentication Header/Variable |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
319 ------------------------------------------ |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
320 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
321 The front end server running roundup can perform the user |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
322 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
|
323 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
|
324 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
|
325 ``[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
|
326 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
|
327 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
328 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
|
329 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
|
330 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
|
331 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
|
332 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
|
333 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
|
334 roundup-server config file). |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
335 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
336 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
|
337 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
|
338 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
|
339 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
340 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
|
341 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
342 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
|
343 server. It is **not** prefixed with ``HTTP_`` like other headers since |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
344 you are explicitly whitelisting the header. Multiple comma separated |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
345 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
|
346 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
|
347 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
|
348 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
349 To make the tracker honor the new variable changing the tracker |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
350 ``config.ini`` to read:: |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
351 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
352 [web] |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
353 ... |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
354 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
|
355 |
|
1f2f7c0b8968
issue2550837 - New option for web auth (also http header passing)
John Rouillard <rouilj@ieee.org>
parents:
6344
diff
changeset
|
356 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
|
357 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
|
358 mailing list. |
|
2572
d15b71b8a85a
more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents:
2479
diff
changeset
|
359 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
360 Tasks |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
361 ===== |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
362 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
363 Maintenance of Roundup can involve one of the following: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
364 |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
365 1. `tracker backup`_ |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
366 2. `software upgrade`_ |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
367 3. `migrating backends`_ |
|
2005
fc52d57c6c3e
documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents:
2003
diff
changeset
|
368 4. `moving a tracker`_ |
| 3250 | 369 5. `migrating from other software`_ |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
370 6. `adding a user from the command-line`_ |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
371 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
372 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
373 Tracker Backup |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
374 -------------- |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
375 |
|
3959
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
376 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
|
377 performing backup. |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
378 |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
379 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
|
380 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
|
381 This means using |
|
f764931f2c67
more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents:
3883
diff
changeset
|
382 *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
|
383 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
|
384 it to be elsewhere) will then complete the backup. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
385 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
386 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
387 Software Upgrade |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
388 ---------------- |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
389 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
390 Always make a backup of your tracker before upgrading software. Steps you may |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
391 take: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
392 |
|
6297
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
393 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
|
394 (using your preferred python version):: |
| 2474 | 395 |
|
6297
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
396 pip2 install pytest |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
397 python2 -m pytest test/ |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
398 |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
399 |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
400 pip3 install pytest |
|
a635a60ffb84
Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
401 python3 -m pytest test/ |
| 2474 | 402 |
|
2387
4962f99aaa27
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2203
diff
changeset
|
403 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
|
404 3. Make a backup of the tracker home itself. |
|
3ab2b91cdd2c
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2474
diff
changeset
|
405 4. Stop the tracker web and email frontends. |
|
4014
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
406 5. Install the new version of the software:: |
|
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
407 |
|
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
408 python setup.py install |
|
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
409 |
|
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
410 6. Follow the steps in the `upgrading documentation`_ for the new version of |
|
2387
4962f99aaa27
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2203
diff
changeset
|
411 the software in the copied. |
|
3963
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
412 |
|
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
413 Usually you will be asked to run `roundup_admin migrate` on your tracker |
|
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
414 before you allow users to start accessing the tracker. |
|
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
415 |
|
3230f9c88086
Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents:
3959
diff
changeset
|
416 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
|
417 habit. |
|
4014
b80224c1f4e3
fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents:
3963
diff
changeset
|
418 7. Restart your tracker web and email frontends. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
419 |
| 2474 | 420 If something bad happens, you may reinstate your backup of the tracker and |
| 421 reinstall the older version of the sofware using the same install command:: | |
| 422 | |
| 423 python setup.py install | |
| 424 | |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
425 |
| 6163 | 426 .. 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
|
427 single: roundup-admin; import and export |
| 6163 | 428 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
429 Migrating Backends |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
430 ------------------ |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
431 |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
432 1. Stop the existing tracker web and email frontends (preventing changes). |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
433 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
|
434 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
|
435 `issue1441336 <https://issues.roundup-tracker.org/issue1441336>`_ |
|
4f74b97dddcd
Doc how to export on windows.
John Rouillard <rouilj@ieee.org>
parents:
5300
diff
changeset
|
436 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
|
437 export data.) |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
438 3. Copy the tracker home to a new directory. |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
439 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
|
440 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
|
441 section of the tracker's ``config.ini`` file. |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
442 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
|
443 the new tracker home. If non-interactively:: |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
444 |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
445 roundup-admin -i <tracker home> import <tracker export dir> |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
446 |
|
4567
32b24abfe98e
Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents:
4489
diff
changeset
|
447 If interactively, enter 'commit' before exiting. |
|
3781
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
448 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
|
449 backend. |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
450 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
|
451 move the new tracker home into its place. |
|
e03014a96a95
doc improvement
Richard Jones <richard@users.sourceforge.net>
parents:
3780
diff
changeset
|
452 9. Restart web and email frontends. |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
453 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
454 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
455 Moving a Tracker |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
456 ---------------- |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
457 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
458 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
|
459 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
460 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
|
461 2. stop the existing tracker web and email frontends (preventing changes), |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
462 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
|
463 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
|
464 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
465 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
|
466 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
|
467 moved using the above steps) then you'll need to: |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
468 |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
469 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
|
470 2. stop the existing tracker web and email frontends (preventing changes), |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
471 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
|
472 the existing tracker, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
473 4. copy the export to the new machine, |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
474 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
|
475 machine, and |
|
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
476 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
|
477 |
| 6163 | 478 .. index:: |
| 479 pair: roundup; migrate from other bugtracker software | |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
480 |
| 3250 | 481 Migrating From Other Software |
| 482 ----------------------------- | |
| 483 | |
| 484 You have a couple of choices. You can either use a CSV import into Roundup, | |
| 485 or you can write a simple Python script which uses the Roundup API | |
| 486 directly. The latter is almost always simpler -- see the "scripts" | |
| 487 directory in the Roundup source for some example uses of the API. | |
| 488 | |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
489 "roundup-admin import" will import data into your tracker from a |
| 3250 | 490 directory containing files with the following format: |
| 491 | |
| 492 - one colon-separated-values file per Class with columns for each property, | |
| 493 named <classname>.csv | |
| 494 - one colon-separated-values file per Class with journal information, | |
| 495 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
|
496 - if the Class is a FileClass, you may have the "content" property |
| 3250 | 497 stored in separate files from the csv files. This goes in a directory |
| 498 structure:: | |
| 499 | |
| 500 <classname>-files/<N>/<designator> | |
| 501 | |
| 502 where ``<designator>`` is the item's ``<classname><id>`` combination. | |
| 503 The ``<N>`` value is ``int(<id> / 1000)``. | |
| 504 | |
| 505 | |
| 6163 | 506 .. index:: pair: roundup-admin; managing users |
| 507 | |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
508 Adding A User From The Command-Line |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
509 ----------------------------------- |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
510 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
511 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
|
512 database. To create a new user, use:: |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
513 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
514 roundup-admin create user |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
515 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
516 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
|
517 you can just display another user:: |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
518 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
519 roundup-admin list user |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
520 |
|
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
521 (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
|
522 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
523 roundup-admin filter user username=richard |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
524 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
525 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
|
526 commands, you may display the user's details:: |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
527 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
528 roundup-admin display <designator> |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
529 |
|
6176
d25638d1826c
Add roundup-admin filter command; fix bad doc example; add tests
John Rouillard <rouilj@ieee.org>
parents:
6175
diff
changeset
|
530 where designator is ``user5``. |
|
3341
df693c0aaba9
more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents:
3282
diff
changeset
|
531 |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
532 Running the Servers |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
533 =================== |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
534 |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
535 Unix |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
536 ---- |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
537 |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
538 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
|
539 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
|
540 to reflect your specific installation. |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
541 |
|
6344
c63df349f319
issue2551117 - add example systemd config
John Rouillard <rouilj@ieee.org>
parents:
6297
diff
changeset
|
542 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
|
543 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
|
544 point for your setup. |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
545 |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
546 Windows |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
547 ------- |
|
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
548 |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
549 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
|
550 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
|
551 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
|
552 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
|
553 service directly: |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
554 |
|
2405
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
555 **install the service** |
|
3779
ee73abcc95d2
Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents:
3465
diff
changeset
|
556 ``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
|
557 **start the service** |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
558 ``roundup-server -c start`` |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
559 **stop the service** |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
560 ``roundup-server -c stop`` |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
561 |
|
2405
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
562 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
|
563 |
|
2405
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
564 Windows 2000 and later |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
565 Start/Control Panel/Administrative Tools/Services |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
566 Windows NT4 |
|
1736886eefb3
more windows info
Richard Jones <richard@users.sourceforge.net>
parents:
2387
diff
changeset
|
567 Start/Control Panel/Services |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
568 |
|
3780
158e31bbf86a
recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents:
3779
diff
changeset
|
569 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
|
570 `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
|
571 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
|
572 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
|
573 |
|
2203
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
574 Running the Mail Gateway Script |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
576 |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
577 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
|
578 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
|
579 solution to this is to: |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
580 |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
581 1. Create a new local account on the Roundup server |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
582 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
|
583 of your normal login |
|
4a157c198585
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2177
diff
changeset
|
584 |
|
6173
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
585 .. index:: ! roundup-admin |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
586 single: roundup-admin; man page reference |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
587 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
588 Using roundup-admin |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
589 =================== |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
590 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
591 Part of the installation includes a man page for roundup-admin. Ypu |
| 6175 | 592 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
|
593 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
|
594 tracker. |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
595 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
596 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
|
597 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
598 * install and initialize a new tracker |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
599 * export/import tracker data for migrating between backends |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
600 * creating a new user fom the command line |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
601 * list/find users in the tracker |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
602 |
| 6175 | 603 A brief (incomplete) summary is:: |
|
6173
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
604 |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
605 roundup-admin help |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
606 roundup-admin -i <tracker_dir> get [-list] designator[, designator,...] propname |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
607 roundup-admin -i <tracker_dir> set designator[, designator,...] propname=value ... |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
608 roundup-admin -i <tracker_dir> find [-list] classname propname=value ... |
|
82f58ae89142
Add new section onroundup-admin. Ad indexing.
John Rouillard <rouilj@ieee.org>
parents:
6163
diff
changeset
|
609 |
| 6175 | 610 Run ``roundup-admin help commands`` for a complete list of subcommands. |
|
2177
a276e2531321
info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents:
2068
diff
changeset
|
611 |
|
2003
a291bf753037
maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
612 .. _`customisation documentation`: customizing.html |
|
2387
4962f99aaa27
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
2203
diff
changeset
|
613 .. _`upgrading documentation`: upgrading.html |
|
6458
8f1b91756457
issue2551147 - Enable compression of http responses in roundup.
John Rouillard <rouilj@ieee.org>
parents:
6436
diff
changeset
|
614 .. _`installation documentation`: installation.html |