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 may use encoded passwords:
  31
  32  1. Edit the dbinit.py file in your instance home directory. Find the lines
  33  which define the msg class:
  34
  35     msg = FileClass(db, "msg",
  36                     author=Link("user"), recipients=Multilink("user"),
  37                     date=Date(),         summary=String(),
  38                     files=Multilink("file"))
  39
  40  and add the messageid and inreplyto properties like so:
  41
  42     msg = FileClass(db, "msg",
  43                     author=Link("user"), recipients=Multilink("user"),
  44                     date=Date(),         summary=String(),
  45                     files=Multilink("file"),
  46                     messageid=String(),  inreplyto=String())
  47
  48 Configuration
  49 -------------
  50 INSTANCE_NAME and EMAIL_SIGNATURE_POSITION have been added to the
  51 instance_config.py. Simplest solution is to copy the default values from
  52 template in the core source.
  53
  54 INSTANCE_NAME needs to be added to the Client class in your interfaces.py
  55 file. INSTANCE_NAME and ANONYMOUS_REGISTER need to be added to the MailGW
  56 class in your interfaces.py file. In both cases if might be easier to just
  57 copy the file from the core source (roundup/templates/[schema]/interfaces.py)
  58 where schema is "classic" or "extended".
  59
  60
  61 CGI script roundup.cgi
  62 ----------------------
  63 The CGI script has been updated with some features and a bugfix, so you should
  64 copy it from the roundup cgi-bin source directory again. Make sure you update
  65 the ROUNDUP_INSTANCE_HOMES after the copy.
  66
  67
  68
  69 Migrating from 0.2.x to 0.3.x
  70 =============================
  71
  72 Cookie Authentication changes
  73 -----------------------------
  74 0.3.0 introduces cookie authentication - you will need to copy the
  75 interfaces.py file from the roundup source to your instance home to enable
  76 authentication. If you used the classic schema, the interfaces file is in:
  77
  78  <roundup source>/roundup/templates/classic/interfaces.py
  79
  80 If you used the extended schema, the file is in:
  81
  82  <roundup source>/roundup/templates/extended/interfaces.py
  83
  84 If you have modified your interfaces.Client class, you will need to take
  85 note of the login/logout functionality provided in roundup.cgi_client.Client
  86 (classic schema) or roundup.cgi_client.ExtendedClient (extended schema) and
  87 modify your instance code apropriately.
  88
  89
  90 Password encoding
  91 -----------------
  92 This release also introduces encoding of passwords in the database. If you
  93 have not edited the dbinit.py file in your instance home directory, you may
  94 simply copy the new dbinit.py file from the core code. If you used the
  95 classic schema, the interfaces file is in:
  96
  97  <roundup source>/roundup/templates/classic/dbinit.py
  98
  99 If you used the extended schema, the file is in:
 100
 101  <roundup source>/roundup/templates/extended/dbinit.py
 102
 103
 104 If you have modified your dbinit.py file, you may use encoded passwords:
 105
 106  1. Edit the dbinit.py file in your instance home directory
 107  1a. At the first code line of the open() function:
 108
 109     from roundup.hyperdb import String, Date, Link, Multilink
 110
 111       alter to include Password, as so:
 112
 113     from roundup.hyperdb import String, Password, Date, Link, Multilink
 114
 115  1b. Where the password property is defined (around line 66):
 116
 117     user = Class(db, "user",
 118                     username=String(),   password=String(),
 119                     address=String(),    realname=String(),
 120                     phone=String(),      organisation=String())
 121     user.setkey("username")
 122
 123       alter the "password=String()" to "password=Password()":
 124
 125     user = Class(db, "user",
 126                     username=String(),   password=Password(),
 127                     address=String(),    realname=String(),
 128                     phone=String(),      organisation=String())
 129     user.setkey("username")
 130
 131  2. Any existing passwords in the database will remain cleartext until they
 132     are edited. It is recommended that at a minimum the admin password be
 133     changed immediately:
 134
 135       roundup-admin -i <instance home> set user1 password=<new password>
 136
 137
 138 Configuration
 139 -------------
 140 FILTER_POSITION, ANONYMOUS_ACCESS, ANONYMOUS_REGISTER have been added to
 141 the instance_config.py. Simplest solution is to copy the default values from
 142 template in the core source.
 143
 144 MESSAGES_TO_AUTHOR has been added to the IssueClass in dbinit.py. Set to 'yes'
 145 to send nosy messages to the author. Default behaviour is to not send nosy
 146 messages to the author. You will need to add MESSAGES_TO_AUTHOR to your
 147 dbinit.py in your instance home.
 148
 149
 150 CGI script roundup.cgi
 151 ----------------------
 152 There have been some structural changes to the roundup.cgi script - you will
 153 need to install it again from the cgi-bin directory of the source
 154 distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the
 155 copy.
 156
 157
 158