Mercurial > p > roundup > code

annotate doc/admin_guide.txt @ 4786:6018617c55ab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removing remains of "rlog" module, fixes db unit test debug logging via environment variable.
author Bernhard Reiter <bernhard@intevation.de>
date Sun, 05 May 2013 00:21:27 +0200
parents 32b24abfe98e
children 609edf9de0a5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 ====================
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 Administration Guide
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 ====================
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 .. contents::
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 What does Roundup install?
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 ==========================
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 There's two "installations" that we talk about when using Roundup:
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 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
13 standard Python mechanism called "distutils" and thus Roundup's core code,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 executable scripts and support data files are installed in Python's
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 directories. On Windows, this is typically:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 Scripts
2068
65b5297b488f *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2005
diff changeset
18 ``<python dir>\scripts\...``
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 Core code
2068
65b5297b488f *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2005
diff changeset
20 ``<python dir>\lib\site-packages\roundup\...``
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 Support files
2068
65b5297b488f *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2005
diff changeset
22 ``<python dir>\share\roundup\...``
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2003
diff changeset
24 and on Unix-like systems (eg. Linux):
2003
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 root>/bin/...``
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 root>/lib-<python version>/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 root>/share/roundup/...``
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 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
34 "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
35 installs configuration files, HTML templates, detector code and a new
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 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
37 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
38 in the tracker's config.ini.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
41 Configuring Roundup's Logging of Messages For Sysadmins
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
42 =======================================================
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
43
2921
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2632
diff changeset
44 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
45 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
46
2921
ad4fb8a14a97 more doc updates, not so many TODOs any more
Richard Jones <richard@users.sourceforge.net>
parents: 2632
diff changeset
47 Configuration for standard "logging" module:
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
48 - 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
49 configration file as ``logging`` -> ``config``
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
50 - ``roundup-server`` specifies the location of a logging configuration
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
51 file on the command line
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
52 Configuration for "BasicLogging" implementation:
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
53 - 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
54 ``logging`` -> ``filename``
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
55 - 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
56 ``logging`` -> ``level``
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
57 - ``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
58 line
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
59 - ``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
60
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
61 (``roundup-mailgw`` always logs to the tracker's log file)
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
62
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
63 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
64 to sys.stderr with only logging of ERROR messages.
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
65
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
66
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
67 Configuring roundup-server
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
68 ==========================
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
69
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
70 The basic configuration file layout is as follows (take from the
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
71 ``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
72
3465
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
73 [main]
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
74 port = 8080
4489
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
75 ;host =
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
76 ;user =
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
77 ;group =
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
78 ;log_ip = yes
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
79 ;pidfile =
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
80 ;logfile =
3880
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
81 ;template =
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
82 ;ssl = no
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
83 ;pem =
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
84
3465
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
85 [trackers]
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
86 ; Add one of these per tracker being served
3465
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
87 name = /path/to/tracker/name
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
88
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
89 Values ";commented out" are optional. The meaning of the various options
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
90 are as follows:
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
91
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
92 **port**
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
93 Defines the local TCP port to listen for clients on.
4489
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
94 **host**
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
95 Defines the hostname or IP number to listen for clients on. Only
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
96 required if `localhost` is not sufficient. If left empty (as opposed
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
97 to no `host` keyword in the config-file) this will listen to all
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
98 network interfaces and is equivalent to an explicit address `0.0.0.0`.
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
99 The use of an empty string to listen to all interfaces is deprecated
47bd330e3d17 Fix documentation for roundup-server about the 'host' parameter...
Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net>
parents: 4036
diff changeset
100 and will go away in a future version.
2632
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
101 **user** and **group**
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
102 Defines the Unix user and group to run the server as. Only work if the
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
103 server is started as root.
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
104 **log_ip**
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
105 If ``yes`` then we log IP addresses against accesses. If ``no`` then we
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
106 log the hostname of the client. The latter can be much slower.
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
107 **pidfile**
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
108 If specified, the server will fork at startup and write its new PID to
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
109 the file.
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
110 **logfile**
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
111 Any unhandled exception messages or other output from Roundup will be
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
112 written to this file. It must be specified if **pidfile** is specified.
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
113 If per-tracker logging is specified, then very little will be written to
9c55f2bc5961 roundup-server now has a configuration file (-C option)
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
114 this file.
3880
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
115 **template**
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
116 Specifies a template used for displaying the tracker index when
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
117 multiple trackers are being used. The variable "trackers" is available
2359d6304a4f Allow template for tracker index page
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3781
diff changeset
118 to the template and is a dict of all configured trackers.
3883
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
119 **ssl**
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
120 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
121 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
122 an *https* URL.
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
123 **pem**
679118b572d5 add SSL to roundup-server via pyopenssl
Justus Pendleton <jpend@users.sourceforge.net>
parents: 3880
diff changeset
124 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
125 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
126 for use.
3465
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
127 **trackers** section
81542d49c8cb fix admin doc description of roundup-server config file
Richard Jones <richard@users.sourceforge.net>
parents: 3341
diff changeset
128 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
129 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
130 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
131
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
132
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
133 Users and Security
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
134 ==================
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
135
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
136 Roundup holds its own user database which primarily contains a username,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
137 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
138 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
139 relatively simple exercise to update this listing on a regular basis, or on
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
140 demand, so that it matches an external listing (eg. unix passwd file, LDAP,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
141 etc.)
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
142
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
143 Roundup identifies users in a number of ways:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
144
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
145 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
146 Authentication or cookie authentication. If you are running the web
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
147 server (roundup-server) through another HTTP server (eg. apache or IIS)
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
148 then that server may require HTTP Basic Authentication, and it will pass
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
149 the ``REMOTE_USER`` variable through to Roundup. If this variable is not
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
150 present, then Roundup defaults to using its own cookie-based login
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
151 mechanism.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
152 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
153 From address in the message.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
154
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
155 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
156 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
157 tracker's ``schema.py`` module:
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
158
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
159 Web Registration
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
160 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
161 register through the web.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
162 Email Registration
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
163 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
164 will result in those users being registered with the tracker.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
165
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
166 More information about how to customise your tracker's security settings
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
167 may be found in the `customisation documentation`_.
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
168
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2479
diff changeset
169
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
170 Tasks
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
171 =====
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
172
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
173 Maintenance of Roundup can involve one of the following:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
174
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
175 1. `tracker backup`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
176 2. `software upgrade`_
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
177 3. `migrating backends`_
2005
fc52d57c6c3e documentation cleanup
Richard Jones <richard@users.sourceforge.net>
parents: 2003
diff changeset
178 4. `moving a tracker`_
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
179 5. `migrating from other software`_
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
180 6. `adding a user from the command-line`_
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
181
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
182
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
183 Tracker Backup
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
184 --------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
185
3959
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
186 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
187 performing backup.
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
188
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
189 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
190 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
191 This means using
f764931f2c67 more words about backing up
Richard Jones <richard@users.sourceforge.net>
parents: 3883
diff changeset
192 *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
193 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
194 it to be elsewhere) will then complete the backup.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
195
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
196
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
197 Software Upgrade
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
198 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
199
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
200 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
201 take:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
202
2478
3ab2b91cdd2c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2474
diff changeset
203 1. Ensure that the unit tests run on your system::
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
204
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
205 python run_tests.py
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
206
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
207 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
208 3. Make a backup of the tracker home itself.
3ab2b91cdd2c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2474
diff changeset
209 4. Stop the tracker web and email frontends.
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
210 5. Install the new version of the software::
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
211
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
212 python setup.py install
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
213
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
214 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
215 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
216
3230f9c88086 Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents: 3959
diff changeset
217 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
218 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
219
3230f9c88086 Fix race condition for key properties in rdbms backends [SF#1876683]
Richard Jones <richard@users.sourceforge.net>
parents: 3959
diff changeset
220 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
221 habit.
4014
b80224c1f4e3 fix poor docs
Richard Jones <richard@users.sourceforge.net>
parents: 3963
diff changeset
222 7. Restart your tracker web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
223
2474
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
224 If something bad happens, you may reinstate your backup of the tracker and
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
225 reinstall the older version of the sofware using the same install command::
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
226
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
227 python setup.py install
591e3cfe622a more detail
Richard Jones <richard@users.sourceforge.net>
parents: 2405
diff changeset
228
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
229
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
230 Migrating Backends
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
231 ------------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
232
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
233 1. Stop the existing tracker web and email frontends (preventing changes).
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
234 2. Use the roundup-admin tool "export" command to export the contents of
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
235 your tracker to disk.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
236 3. Copy the tracker home to a new directory.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
237 4. Delete the "db" directory from the new directory.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
238 5. Enter the new backend name in the tracker home ``db/backend_name`` file.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
239 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
240 the new tracker home. If non-interactively::
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
241
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
242 roundup-admin -i <tracker home> import <tracker export dir>
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
243
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4489
diff changeset
244 If interactively, enter 'commit' before exiting.
3781
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
245 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
246 backend.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
247 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
248 move the new tracker home into its place.
e03014a96a95 doc improvement
Richard Jones <richard@users.sourceforge.net>
parents: 3780
diff changeset
249 9. Restart web and email frontends.
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
250
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
251
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
252 Moving a Tracker
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
253 ----------------
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
254
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
255 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
256
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
257 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
258 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
259 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
260 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
261
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
262 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
263 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
264 moved using the above steps) then you'll need to:
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
265
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
266 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
267 2. stop the existing tracker web and email frontends (preventing changes),
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
268 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
269 the existing tracker,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
270 4. copy the export to the new machine,
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
271 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
272 machine, and
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
273 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
274
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
275
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
276 Migrating From Other Software
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
277 -----------------------------
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
278
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
279 You have a couple of choices. You can either use a CSV import into Roundup,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
280 or you can write a simple Python script which uses the Roundup API
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
281 directly. The latter is almost always simpler -- see the "scripts"
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
282 directory in the Roundup source for some example uses of the API.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
283
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
284 "roundup-admin import" will import data into your tracker from a
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
285 directory containing files with the following format:
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
286
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
287 - one colon-separated-values file per Class with columns for each property,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
288 named <classname>.csv
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
289 - one colon-separated-values file per Class with journal information,
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
290 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
291 - if the Class is a FileClass, you may have the "content" property
3250
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
292 stored in separate files from the csv files. This goes in a directory
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
293 structure::
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
294
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
295 <classname>-files/<N>/<designator>
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
296
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
297 where ``<designator>`` is the item's ``<classname><id>`` combination.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
298 The ``<N>`` value is ``int(<id> / 1000)``.
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
299
8634ea9b2d1c doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 3089
diff changeset
300
3341
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
301 Adding A User From The Command-Line
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
302 -----------------------------------
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
303
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
304 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
305 database. To create a new user, use::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
306
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
307 roundup-admin create user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
308
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
309 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
310 you can just display another user::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
311
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
312 roundup-admin list user
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
313
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
314 (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
315
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
316 roundup-admin find username=richard
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
317
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
318 then using the user id you get from one of the above commands, you may
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
319 display the user's details::
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
320
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
321 roundup-admin display <userid>
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
322
df693c0aaba9 more admin guide goodness
Richard Jones <richard@users.sourceforge.net>
parents: 3282
diff changeset
323
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
324 Running the Servers
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
325 ===================
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
326
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
327 Unix
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
328 ----
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
329
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
330 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
331 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
332 to reflect your specific installation.
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
333
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
334
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
335 Windows
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
336 -------
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
337
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
338 On Windows, the roundup-server program runs as a Windows Service, and
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
339 therefore may be controlled through the Services control panel. The
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
340 roundup-server program may also control the service directly:
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
341
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
342 **install the service**
3779
ee73abcc95d2 Sorry, another mega-patch:
Richard Jones <richard@users.sourceforge.net>
parents: 3465
diff changeset
343 ``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
344 **start the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
345 ``roundup-server -c start``
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
346 **stop the service**
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
347 ``roundup-server -c stop``
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
348
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
349 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
350
2405
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
351 Windows 2000 and later
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
352 Start/Control Panel/Administrative Tools/Services
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
353 Windows NT4
1736886eefb3 more windows info
Richard Jones <richard@users.sourceforge.net>
parents: 2387
diff changeset
354 Start/Control Panel/Services
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
355
3780
158e31bbf86a recent patch had lines longer than 80 chars - rewrap; trim trailing spaces
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 3779
diff changeset
356 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
357 `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
358 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
359 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
360
2203
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
361 Running the Mail Gateway Script
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
362 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
363
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
364 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
365 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
366 solution to this is to:
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
367
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
368 1. Create a new local account on the Roundup server
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
369 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
370 of your normal login
4a157c198585 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2177
diff changeset
371
2177
a276e2531321 info about running roundup-server... more needed :)
Richard Jones <richard@users.sourceforge.net>
parents: 2068
diff changeset
372
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
373 .. _`customisation documentation`: customizing.html
2387
4962f99aaa27 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2203
diff changeset
374 .. _`upgrading documentation`: upgrading.html
Roundup Issue Tracker: http://roundup-tracker.org/