Mercurial > p > roundup > code

annotate MIGRATION.txt @ 502:531f4e46a818

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
crying out for real configuration handling... :(
author Richard Jones <richard@users.sourceforge.net>
date Tue, 08 Jan 2002 11:57:12 +0000
parents a1a44636bace
children 25f2a3405739 c242455d9b46
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 Migrating to newer versions of Roundup
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 ======================================
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
4 Please read each section carefully and edit your instance home files
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
5 accordingly.
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
6
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
7 This file contains information for users upgrading from:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
8 0.3.x -> 0.4.x
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
9 0.2.x -> 0.3.x
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
10
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
11
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
12 Migrating from 0.3.x to 0.4.x
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
13 =============================
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
14
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
15 Message-ID and In-Reply-To addition
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
16 -----------------------------------
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
17 0.4.0 adds the tracking of messages by message-id and allows threading
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
18 using in-reply-to. Most e-mail clients support threading using this
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
19 feature, and we hope to add support for it to the web gateway. If you
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
20 have not edited the dbinit.py file in your instance home directory, you may
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
21 simply copy the new dbinit.py file from the core code. If you used the
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
22 classic schema, the interfaces file is in:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
23
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
24 <roundup source>/roundup/templates/classic/dbinit.py
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
25
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
26 If you used the extended schema, the file is in:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
27
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
28 <roundup source>/roundup/templates/extended/dbinit.pybinit.py needs updating from the original.
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
29
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
30 If you have modified your dbinit.py file, you may use encoded passwords:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
31
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
32 1. Edit the dbinit.py file in your instance home directory. Find the lines
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
33 which define the msg class:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
34
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
35 msg = FileClass(db, "msg",
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
36 author=Link("user"), recipients=Multilink("user"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
37 date=Date(), summary=String(),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
38 files=Multilink("file"))
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
39
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
40 and add the messageid and inreplyto properties like so:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
41
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
42 msg = FileClass(db, "msg",
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
43 author=Link("user"), recipients=Multilink("user"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
44 date=Date(), summary=String(),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
45 files=Multilink("file"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
46 messageid=String(), inreplyto=String())
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
47
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
48
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
50 Migrating from 0.2.x to 0.3.x
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
51 =============================
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
53 Cookie Authentication changes
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
54 -----------------------------
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 0.3.0 introduces cookie authentication - you will need to copy the
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56 interfaces.py file from the roundup source to your instance home to enable
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 authentication. If you used the classic schema, the interfaces file is in:
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 <roundup source>/roundup/templates/classic/interfaces.py
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 If you used the extended schema, the file is in:
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 <roundup source>/roundup/templates/extended/interfaces.py
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
65 If you have modified your interfaces.Client class, you will need to take
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
66 note of the login/logout functionality provided in roundup.cgi_client.Client
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
67 (classic schema) or roundup.cgi_client.ExtendedClient (extended schema) and
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
68 modify your instance code apropriately.
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
70
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
71 Password encoding
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
72 -----------------
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
73 This release also introduces encoding of passwords in the database. If you
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
74 have not edited the dbinit.py file in your instance home directory, you may
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
75 simply copy the new dbinit.py file from the core code. If you used the
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
76 classic schema, the interfaces file is in:
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
77
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
78 <roundup source>/roundup/templates/classic/dbinit.py
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
79
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
80 If you used the extended schema, the file is in:
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
81
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
82 <roundup source>/roundup/templates/extended/dbinit.py
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
83
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
84
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
85 If you have modified your dbinit.py file, you may use encoded passwords:
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
86
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87 1. Edit the dbinit.py file in your instance home directory
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
88 1a. At the first code line of the open() function:
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 from roundup.hyperdb import String, Date, Link, Multilink
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 alter to include Password, as so:
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94 from roundup.hyperdb import String, Password, Date, Link, Multilink
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
96 1b. Where the password property is defined (around line 66):
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
98 user = Class(db, "user",
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99 username=String(), password=String(),
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
100 address=String(), realname=String(),
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
101 phone=String(), organisation=String())
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
102 user.setkey("username")
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
104 alter the "password=String()" to "password=Password()":
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
106 user = Class(db, "user",
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107 username=String(), password=Password(),
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
108 address=String(), realname=String(),
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
109 phone=String(), organisation=String())
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
110 user.setkey("username")
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112 2. Any existing passwords in the database will remain cleartext until they
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113 are edited. It is recommended that at a minimum the admin password be
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114 changed immediately:
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116 roundup-admin -i <instance home> set user1 password=<new password>
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
118
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
119 Configuration
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
120 -------------
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
121 FILTER_POSITION, ANONYMOUS_ACCESS, ANONYMOUS_REGISTER have been added to
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
122 the instance_config.py. Simplest solution is to copy the default values from
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
123 template in the core source.
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
124
337
8cd545738d8e Features:
Richard Jones <richard@users.sourceforge.net>
parents: 334
diff changeset
125 MESSAGES_TO_AUTHOR has been added to the IssueClass in dbinit.py. Set to 'yes'
8cd545738d8e Features:
Richard Jones <richard@users.sourceforge.net>
parents: 334
diff changeset
126 to send nosy messages to the author. Default behaviour is to not send nosy
394
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
127 messages to the author. You will need to add MESSAGES_TO_AUTHOR to your
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
128 dbinit.py in your instance home.
337
8cd545738d8e Features:
Richard Jones <richard@users.sourceforge.net>
parents: 334
diff changeset
129
356
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
130
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
131 CGI script roundup.cgi
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
132 ----------------------
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
133 There have been some structural changes to the roundup.cgi script - you will
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
134 need to install it again from the cgi-bin directory of the source
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
135 distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
136 copy.
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
137
394
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
138
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
139
Roundup Issue Tracker: http://roundup-tracker.org/