annotate MIGRATION.txt @ 639:2f3e82a69eb5

docco
author Richard Jones <richard@users.sourceforge.net>
date Thu, 21 Feb 2002 07:21:38 +0000
parents edd210915e64
children 07abfe8f0c01
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:
615
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
8 0.4.0 -> 0.4.1
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
9 0.3.x -> 0.4.x
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
10 0.2.x -> 0.3.x
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
615
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
13 Migrating from 0.4.0 to 0.4.1
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
14 =============================
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
15
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
16 Configuration
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
17 -------------
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
18
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
19 To allow more fine-grained access control, the variable used to check
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
20 permission to auto-register users in the mail gateway is now called
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
21 ANONYMOUS_REGISTER_MAIL rather than overloading ANONYMOUS_REGISTER. If the
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
22 variable doesn't exist, then ANONYMOUS_REGISTER is tested as before.
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
23
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
24
617
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
25 Alternate E-Mail Addresses
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
26 --------------------------
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
27
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
28 If you add the property "alternate_addresses" to your user class, your users
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
29 will be able to register alternate email addresses that they may use to
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
30 communicate with roundup as. All email from roundup will continue to be sent
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
31 to their primary address.
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
32
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
33 If you have not edited the dbinit.py file in your instance home directory,
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
34 you may simply copy the new dbinit.py file from the core code. If you used
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
35 the classic schema, the interfaces file is in:
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
36
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
37 <roundup source>/roundup/templates/classic/dbinit.py
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
38
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
39 If you used the extended schema, the file is in:
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
40
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
41 <roundup source>/roundup/templates/extended/dbinit.py
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
42
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
43 If you have modified your dbinit.py file, you need to edit the dbinit.py
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
44 file in your instance home directory. Find the lines which define the user
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
45 class:
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
46
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
47 user = Class(db, "msg",
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
48 username=String(), password=Password(),
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
49 address=String(), realname=String(),
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
50 phone=String(), organisation=String(),
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
51 alternate_addresses=String())
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
52
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
53 You will also want to add the property to the user's details page. The
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
54 template for this is the "user.item" file in your instance home "html"
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
55 directory. Similar to above, you may copy the file from the roundup source if
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
56 you haven't modified it. Otherwise, add the following to the template:
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
57
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
58 <display call="multiline('alternate_addresses')">
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
59
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
60 with appropriate labelling etc. See the standard template for an idea.
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
61
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
62
615
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
63
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
64 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
65 =============================
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
66
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
67 Message-ID and In-Reply-To addition
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
68 -----------------------------------
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
69 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
70 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
71 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
72 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
73 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
74 classic schema, the interfaces file is in:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
75
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
76 <roundup source>/roundup/templates/classic/dbinit.py
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
77
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
78 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
79
503
25f2a3405739 Fix requirements in INSTALL.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 475
diff changeset
80 <roundup source>/roundup/templates/extended/dbinit.py
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
81
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
82 If you have modified your dbinit.py file, you need to edit the dbinit.py
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
83 file in your instance home directory. Find the lines which define the msg
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
84 class:
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
85
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
86 msg = FileClass(db, "msg",
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
87 author=Link("user"), recipients=Multilink("user"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
88 date=Date(), summary=String(),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
89 files=Multilink("file"))
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
90
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
91 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
92
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
93 msg = FileClass(db, "msg",
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
94 author=Link("user"), recipients=Multilink("user"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
95 date=Date(), summary=String(),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
96 files=Multilink("file"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
97 messageid=String(), inreplyto=String())
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
98
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
99 Also, configuration is being cleaned up. This means that your dbinit.py will
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
100 also need to be changed in the open function. If you haven't changed your
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
101 dbinit.py, the above copy will be enough. If you have, you'll need to change
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
102 the line (round line 50):
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
103
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
104 db = Database(instance_config.DATABASE, name)
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
105
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
106 to:
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
107
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
108 db = Database(instance_config, name)
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
109
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
110
511
623f3d0cb180 mention new variables in the instance_config.py
Richard Jones <richard@users.sourceforge.net>
parents: 504
diff changeset
111 Configuration
623f3d0cb180 mention new variables in the instance_config.py
Richard Jones <richard@users.sourceforge.net>
parents: 504
diff changeset
112 -------------
623f3d0cb180 mention new variables in the instance_config.py
Richard Jones <richard@users.sourceforge.net>
parents: 504
diff changeset
113 INSTANCE_NAME and EMAIL_SIGNATURE_POSITION have been added to the
591
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
114 instance_config.py. The simplest solution is to copy the default values
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
115 from template in the core source.
511
623f3d0cb180 mention new variables in the instance_config.py
Richard Jones <richard@users.sourceforge.net>
parents: 504
diff changeset
116
533
09eb8d264b1d [SF#503330] ANONYMOUS_REGISTER now applies to mail
Richard Jones <richard@users.sourceforge.net>
parents: 524
diff changeset
117 The mail gateway now checks ANONYMOUS_REGISTER to see if unknown users are to
09eb8d264b1d [SF#503330] ANONYMOUS_REGISTER now applies to mail
Richard Jones <richard@users.sourceforge.net>
parents: 524
diff changeset
118 be automatically registered with the tracker. If it is set to "deny" then
09eb8d264b1d [SF#503330] ANONYMOUS_REGISTER now applies to mail
Richard Jones <richard@users.sourceforge.net>
parents: 524
diff changeset
119 unknown users will not have access. If it is set to "allow" they will be
09eb8d264b1d [SF#503330] ANONYMOUS_REGISTER now applies to mail
Richard Jones <richard@users.sourceforge.net>
parents: 524
diff changeset
120 automatically registered with the tracker.
09eb8d264b1d [SF#503330] ANONYMOUS_REGISTER now applies to mail
Richard Jones <richard@users.sourceforge.net>
parents: 524
diff changeset
121
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122
512
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
123 CGI script roundup.cgi
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
124 ----------------------
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
125 The CGI script has been updated with some features and a bugfix, so you should
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
126 copy it from the roundup cgi-bin source directory again. Make sure you update
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
127 the ROUNDUP_INSTANCE_HOMES after the copy.
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
128
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
129
519
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
130 Nosy reactor
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
131 ------------
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
132 The nosy reactor has also changed - copy the nosyreactor.py file from the core
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
133 source roundup/templates/[schema]/detectors/nosyreactor.py to your instance
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
134 home "detectors" directory.
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
135
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
136
591
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
137 HTML templating
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
138 ---------------
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
139 The field() function was incorrectly implemented - links and multilinks now
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
140 display as text fields when rendered using field(). To display a menu (drop-
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
141 down or select box) you need to use the menu() function.
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
142
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
143
512
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
144
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
145 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
146 =============================
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
147
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
148 Cookie Authentication changes
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
149 -----------------------------
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
150 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
151 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
152 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
153
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
154 <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
155
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
156 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
157
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
158 <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
159
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
160 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
161 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
162 (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
163 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
164
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
165
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
166 Password encoding
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
167 -----------------
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
168 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
169 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
170 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
171 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
172
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
173 <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
174
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
175 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
176
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
177 <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
178
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
179
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
180 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
181
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
182 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
183 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
184
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
185 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
186
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
187 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
188
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
189 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
190
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
191 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
192
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
193 user = Class(db, "user",
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
194 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
195 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
196 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
197 user.setkey("username")
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
198
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
199 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
200
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
201 user = Class(db, "user",
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
202 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
203 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
204 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
205 user.setkey("username")
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
206
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
207 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
208 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
209 changed immediately:
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
210
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
211 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
212
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
213
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
214 Configuration
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
215 -------------
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
216 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
217 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
218 template in the core source.
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
219
337
8cd545738d8e Features:
Richard Jones <richard@users.sourceforge.net>
parents: 334
diff changeset
220 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
221 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
222 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
223 dbinit.py in your instance home.
337
8cd545738d8e Features:
Richard Jones <richard@users.sourceforge.net>
parents: 334
diff changeset
224
356
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
225
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
226 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
227 ----------------------
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
228 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
229 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
230 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
231 copy.
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
232
394
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
233
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
234

Roundup Issue Tracker: http://roundup-tracker.org/