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