annotate doc/maintenance.txt @ 1810:1a8dffd48c1c

Add a test for looking up alternate adresses and case-insensitivity.
author Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
date Mon, 15 Sep 2003 19:35:53 +0000
parents 2219893cb787
children 43e1f2457bf2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 ============================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 Maintaining Roundup Trackers
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 ============================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
1397
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
5 :Version: $Revision: 1.2 $
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 .. contents::
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 :depth: 1
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 Tasks
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 =====
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 Maintenance of Roundup can involve one of the following:
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 1. `tracker backup`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 2. `software upgrade`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 3. `migrating backends`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 Tracker Backup
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 ==============
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 Stop the web and email frontends and to copy the contents of the tracker home
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 directory to some other place using standard backup tools.
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 Software Upgrade
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 ================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 Always make a backup of your tracker before upgrading software. Steps you may
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 take:
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 1. ensure that the unit tests run on your system
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 2. copy your tracker home to a new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 3. follow the steps in the upgrading documentation for the new version of
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 4. test each of the admin tool, web interface and mail gateway using the new
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 version of the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 5. stop the production web and email frontends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 6. perform the upgrade steps on the existing tracker directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 7. upgrade the software
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 8. restart your tracker
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 Migrating Backends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 ==================
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 1. stop the existing tracker web and email frontends (preventing changes)
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 2. use the roundup-admin tool "export" command to export the contents of
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 your tracker to disk
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 3. copy the tracker home to a new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 4. change the backend used in the tracker home ``select_db.py`` file
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 5. delete the "db" directory from the new directory
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53 6. use the roundup-admin "import" command to import the previous export with
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 the new tracker home
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 7. test each of the admin tool, web interface and mail gateway using the new
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56 backend
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 8. move the old tracker home out of the way (rename to "tracker.old") and
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 move the new tracker home into its place
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 9. restart web and email frontends
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61
1397
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
62 Moving a Tracker
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
63 ================
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
64
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
65 If you're moving the tracker to a similar machine, you should:
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
66
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
67 1. install Roundup on the new machine and test that it works there,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
68 2. stop the existing tracker web and email frontends (preventing changes),
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
69 3. copy the tracker home directory over to the new machine, and
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
70 4. start the tracker web and email frontends on the new machine.
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
71
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
72 Most of the backends are actually portable across platforms (ie. from Unix to
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
73 Windows to Mac). If this isn't the case (ie. the tracker doesn't work when
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
74 moved using the above steps) then you'll need to:
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
75
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
76 1. install Roundup on the new machine and test that it works there,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
77 2. stop the existing tracker web and email frontends (preventing changes),
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
78 3. use the roundup-admin tool "export" command to export the contents of
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
79 the existing tracker,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
80 4. copy the export to the new machine,
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
81 5. use the roundup-admin "import" command to import the tracker on the new
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
82 machine, and
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
83 6. start the tracker web and email frontends on the new machine.
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
84
2219893cb787 info about moving trackers
Richard Jones <richard@users.sourceforge.net>
parents: 1218
diff changeset
85
1218
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86 -------------------
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 Back to `Table of Contents`_
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 .. _`Table of Contents`: index.html
4c9882cb16a3 more docco work
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91

Roundup Issue Tracker: http://roundup-tracker.org/