MIGRATION.txt

   1 Migrating to newer versions of Roundup
   2 ======================================
   3
   4 Please read each section carefully and edit your instance home files
   5 accordingly.
   6
   7 This file contains information for users upgrading from:
   8   0.3.x -> 0.4.x
   9   0.2.x -> 0.3.x
  10
  11
  12 Migrating from 0.3.x to 0.4.x
  13 =============================
  14
  15 Message-ID and In-Reply-To addition
  16 -----------------------------------
  17 0.4.0 adds the tracking of messages by message-id and allows threading
  18 using in-reply-to. Most e-mail clients support threading using this
  19 feature, and we hope to add support for it to the web gateway. If you
  20 have not edited the dbinit.py file in your instance home directory, you may
  21 simply copy the new dbinit.py file from the core code. If you used the
  22 classic schema, the interfaces file is in:
  23
  24  <roundup source>/roundup/templates/classic/dbinit.py
  25
  26 If you used the extended schema, the file is in:
  27
  28  <roundup source>/roundup/templates/extended/dbinit.py
  29
  30 If you have modified your dbinit.py file, you need to edit the dbinit.py
  31 file in your instance home directory. Find the lines which define the msg
  32 class:
  33
  34     msg = FileClass(db, "msg",
  35                     author=Link("user"), recipients=Multilink("user"),
  36                     date=Date(),         summary=String(),
  37                     files=Multilink("file"))
  38
  39  and add the messageid and inreplyto properties like so:
  40
  41     msg = FileClass(db, "msg",
  42                     author=Link("user"), recipients=Multilink("user"),
  43                     date=Date(),         summary=String(),
  44                     files=Multilink("file"),
  45                     messageid=String(),  inreplyto=String())
  46
  47 Also, configuration is being cleaned up. This means that your dbinit.py will
  48 also need to be changed in the open function. If you haven't changed your
  49 dbinit.py, the above copy will be enough. If you have, you'll need to change
  50 the line (round line 50):
  51
  52     db = Database(instance_config.DATABASE, name)
  53
  54 to:
  55
  56     db = Database(instance_config, name)
  57
  58
  59 Configuration
  60 -------------
  61 INSTANCE_NAME and EMAIL_SIGNATURE_POSITION have been added to the
  62 instance_config.py. Simplest solution is to copy the default values from
  63 template in the core source.
  64
  65
  66 CGI script roundup.cgi
  67 ----------------------
  68 The CGI script has been updated with some features and a bugfix, so you should
  69 copy it from the roundup cgi-bin source directory again. Make sure you update
  70 the ROUNDUP_INSTANCE_HOMES after the copy.
  71
  72
  73 Nosy reactor
  74 ------------
  75 The nosy reactor has also changed - copy the nosyreactor.py file from the core
  76 source roundup/templates/[schema]/detectors/nosyreactor.py to your instance
  77 home "detectors" directory.
  78
  79
  80
  81 Migrating from 0.2.x to 0.3.x
  82 =============================
  83
  84 Cookie Authentication changes
  85 -----------------------------
  86 0.3.0 introduces cookie authentication - you will need to copy the
  87 interfaces.py file from the roundup source to your instance home to enable
  88 authentication. If you used the classic schema, the interfaces file is in:
  89
  90  <roundup source>/roundup/templates/classic/interfaces.py
  91
  92 If you used the extended schema, the file is in:
  93
  94  <roundup source>/roundup/templates/extended/interfaces.py
  95
  96 If you have modified your interfaces.Client class, you will need to take
  97 note of the login/logout functionality provided in roundup.cgi_client.Client
  98 (classic schema) or roundup.cgi_client.ExtendedClient (extended schema) and
  99 modify your instance code apropriately.
 100
 101
 102 Password encoding
 103 -----------------
 104 This release also introduces encoding of passwords in the database. If you
 105 have not edited the dbinit.py file in your instance home directory, you may
 106 simply copy the new dbinit.py file from the core code. If you used the
 107 classic schema, the interfaces file is in:
 108
 109  <roundup source>/roundup/templates/classic/dbinit.py
 110
 111 If you used the extended schema, the file is in:
 112
 113  <roundup source>/roundup/templates/extended/dbinit.py
 114
 115
 116 If you have modified your dbinit.py file, you may use encoded passwords:
 117
 118  1. Edit the dbinit.py file in your instance home directory
 119  1a. At the first code line of the open() function:
 120
 121     from roundup.hyperdb import String, Date, Link, Multilink
 122
 123       alter to include Password, as so:
 124
 125     from roundup.hyperdb import String, Password, Date, Link, Multilink
 126
 127  1b. Where the password property is defined (around line 66):
 128
 129     user = Class(db, "user",
 130                     username=String(),   password=String(),
 131                     address=String(),    realname=String(),
 132                     phone=String(),      organisation=String())
 133     user.setkey("username")
 134
 135       alter the "password=String()" to "password=Password()":
 136
 137     user = Class(db, "user",
 138                     username=String(),   password=Password(),
 139                     address=String(),    realname=String(),
 140                     phone=String(),      organisation=String())
 141     user.setkey("username")
 142
 143  2. Any existing passwords in the database will remain cleartext until they
 144     are edited. It is recommended that at a minimum the admin password be
 145     changed immediately:
 146
 147       roundup-admin -i <instance home> set user1 password=<new password>
 148
 149
 150 Configuration
 151 -------------
 152 FILTER_POSITION, ANONYMOUS_ACCESS, ANONYMOUS_REGISTER have been added to
 153 the instance_config.py. Simplest solution is to copy the default values from
 154 template in the core source.
 155
 156 MESSAGES_TO_AUTHOR has been added to the IssueClass in dbinit.py. Set to 'yes'
 157 to send nosy messages to the author. Default behaviour is to not send nosy
 158 messages to the author. You will need to add MESSAGES_TO_AUTHOR to your
 159 dbinit.py in your instance home.
 160
 161
 162 CGI script roundup.cgi
 163 ----------------------
 164 There have been some structural changes to the roundup.cgi script - you will
 165 need to install it again from the cgi-bin directory of the source
 166 distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the
 167 copy.
 168
 169
 170