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