doc/maintenance.txt

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