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