Mercurial > p > roundup > code

annotate MIGRATION.txt @ 731:684b4378eec8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Handle migration
author Richard Jones <richard@users.sourceforge.net>
date Tue, 21 May 2002 06:08:10 +0000
parents ae3df5685619
children a55c0622dced
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
646
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
12 From CVS
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
13 ========
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
14
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
15 Files storage
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
16 -------------
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
17
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
18 Messages and files from newly created issues will be put into subdierectories
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
19 in thousands e.g. msg123 will be put into files/msg/0/msg123, file2003
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
20 will go into files/file/2/file2003. Previous messages are still found, but
07abfe8f0c01 use blobfiles in back_anydbm which is used in back_bsddb.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 617
diff changeset
21 could be put into this structure.
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
22
615
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
23 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
24 =============================
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
25
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
26 Configuration
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
27 -------------
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
28
731
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
29 The USER_INDEX definition introduced in 0.4.1 was too restrictive in its
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
30 allowing replacement of 'assignedto' with the user's userid. Users must change
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
31 the None value of 'assignedto' to 'CURRENT USER' (the string, in quotes) for
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
32 the replacement behaviour to occur now.
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
33
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
34
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
35 Migrating from 0.4.0 to 0.4.1
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
36 =============================
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
37
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
38 Configuration
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
39 -------------
684b4378eec8 Handle migration
Richard Jones <richard@users.sourceforge.net>
parents: 663
diff changeset
40
615
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
41 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
42 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
43 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
44 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
45
662
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
46 Configuring the links in the web header is now easier too. The following
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
47 variables have been added to the classic instance_config.py:
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
48
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
49 HEADER_INDEX_LINKS - defines the "index" links to be made available
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
50 HEADER_ADD_LINKS - defines the "add" links
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
51 DEFAULT_INDEX - specifies the index view for DEFAULT
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
52 UNASSIGNED_INDEX - specifies the index view for UNASSIGNED
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
53 USER_INDEX - specifies the index view for USER
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
54
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
55 See the <roundup source>/roundup/templates/classic/instance_config.py for more
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
56 information - including how the variables are to be set up. Most users will
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
57 just be able to copy the variables from the source to their instance home. If
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
58 you've modified the header by changing the source of the interfaces.py file in
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
59 the instance home, you'll need to remove that customisation and move it into
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
60 the appropriate variables in instance_config.py.
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
61
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
62 The extended schema has similar variables added too - see the source for more
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
63 info.
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
64
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
65
615
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
66
617
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
67 Alternate E-Mail Addresses
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
68 --------------------------
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
69
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
70 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
71 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
72 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
73 to their primary address.
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
74
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
75 If you have not edited the dbinit.py file in your instance home directory,
663
ae3df5685619 vim-fart
Richard Jones <richard@users.sourceforge.net>
parents: 662
diff changeset
76 you may simply copy the new dbinit.py file from the core code. If you used
617
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
77 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
78
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
79 <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
80
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
81 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
82
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
83 <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
84
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
85 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
86 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
87 class:
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
88
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
89 user = Class(db, "msg",
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
90 username=String(), password=Password(),
662
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
91 address=String(), realname=String(),
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
92 phone=String(), organisation=String(),
5631c5347427 Migration note for the new config vars.
Richard Jones <richard@users.sourceforge.net>
parents: 646
diff changeset
93 alternate_addresses=String())
617
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
94
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
95 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
96 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
97 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
98 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
99
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
100 <display call="multiline('alternate_addresses')">
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
101
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
102 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
103
edd210915e64 Alternate email addresses are now available for users.
Richard Jones <richard@users.sourceforge.net>
parents: 615
diff changeset
104
615
7c2c4840db6a [SF#516883] mail interface + ANONYMOUS_REGISTER
Richard Jones <richard@users.sourceforge.net>
parents: 591
diff changeset
105
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
106 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
107 =============================
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
108
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
109 Message-ID and In-Reply-To addition
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
110 -----------------------------------
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
111 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
112 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
113 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
114 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
115 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
116 classic schema, the interfaces file is in:
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
117
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
118 <roundup source>/roundup/templates/classic/dbinit.py
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
119
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
120 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
121
503
25f2a3405739 Fix requirements in INSTALL.
Engelbert Gruber <grubert@users.sourceforge.net>
parents: 475
diff changeset
122 <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
123
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
124 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
125 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
126 class:
475
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
127
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
128 msg = FileClass(db, "msg",
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
129 author=Link("user"), recipients=Multilink("user"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
130 date=Date(), summary=String(),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
131 files=Multilink("file"))
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
132
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
133 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
134
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
135 msg = FileClass(db, "msg",
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
136 author=Link("user"), recipients=Multilink("user"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
137 date=Date(), summary=String(),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
138 files=Multilink("file"),
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
139 messageid=String(), inreplyto=String())
a1a44636bace Fix breakage caused by transaction changes.
Richard Jones <richard@users.sourceforge.net>
parents: 402
diff changeset
140
524
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
141 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
142 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
143 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
144 the line (round line 50):
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
145
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
146 db = Database(instance_config.DATABASE, name)
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
147
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
148 to:
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
149
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
150 db = Database(instance_config, name)
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
151
dce4c75bef5a changed all config accesses...
Richard Jones <richard@users.sourceforge.net>
parents: 519
diff changeset
152
511
623f3d0cb180 mention new variables in the instance_config.py
Richard Jones <richard@users.sourceforge.net>
parents: 504
diff changeset
153 Configuration
623f3d0cb180 mention new variables in the instance_config.py
Richard Jones <richard@users.sourceforge.net>
parents: 504
diff changeset
154 -------------
623f3d0cb180 mention new variables in the instance_config.py
Richard Jones <richard@users.sourceforge.net>
parents: 504
diff changeset
155 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
156 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
157 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
158
533
09eb8d264b1d [SF#503330] ANONYMOUS_REGISTER now applies to mail
Richard Jones <richard@users.sourceforge.net>
parents: 524
diff changeset
159 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
160 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
161 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
162 automatically registered with the tracker.
09eb8d264b1d [SF#503330] ANONYMOUS_REGISTER now applies to mail
Richard Jones <richard@users.sourceforge.net>
parents: 524
diff changeset
163
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
164
512
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
165 CGI script roundup.cgi
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
166 ----------------------
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
167 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
168 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
169 the ROUNDUP_INSTANCE_HOMES after the copy.
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
170
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
171
519
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
172 Nosy reactor
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
173 ------------
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
174 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
175 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
176 home "detectors" directory.
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
177
2dd8571ca738 fixes to migration text
Richard Jones <richard@users.sourceforge.net>
parents: 516
diff changeset
178
591
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
179 HTML templating
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
180 ---------------
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
181 The field() function was incorrectly implemented - links and multilinks now
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
182 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
183 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
184
4d509f01d336 pre-release stuff
Richard Jones <richard@users.sourceforge.net>
parents: 533
diff changeset
185
512
cda2b7c74102 and a note about cgi too
Richard Jones <richard@users.sourceforge.net>
parents: 511
diff changeset
186
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
187 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
188 =============================
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
189
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
190 Cookie Authentication changes
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
191 -----------------------------
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
192 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
193 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
194 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
195
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
196 <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
197
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
198 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
199
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
200 <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
201
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
202 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
203 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
204 (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
205 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
206
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
207
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
208 Password encoding
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
209 -----------------
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
210 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
211 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
212 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
213 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
214
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
215 <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
216
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
217 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
218
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
219 <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
220
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
221
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
222 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
223
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
224 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
225 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
226
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
227 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
228
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
229 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
230
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
231 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
232
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
233 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
234
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
235 user = Class(db, "user",
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
236 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
237 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
238 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
239 user.setkey("username")
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
240
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
241 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
242
276
9fa86988375f More info for 0.2.x -> 0.3.0 migration
Richard Jones <richard@users.sourceforge.net>
parents: 272
diff changeset
243 user = Class(db, "user",
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
244 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
245 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
246 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
247 user.setkey("username")
272
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
248
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
249 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
250 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
251 changed immediately:
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
252
5f400caecaad Steps to follow when migrating between versions of roundup.
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
253 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
254
334
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
255
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
256 Configuration
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
257 -------------
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
258 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
259 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
260 template in the core source.
256776bfdfc5 fixed [SF#474749] Indentations lost
Richard Jones <richard@users.sourceforge.net>
parents: 276
diff changeset
261
337
8cd545738d8e Features:
Richard Jones <richard@users.sourceforge.net>
parents: 334
diff changeset
262 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
263 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
264 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
265 dbinit.py in your instance home.
337
8cd545738d8e Features:
Richard Jones <richard@users.sourceforge.net>
parents: 334
diff changeset
266
356
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
267
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
268 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
269 ----------------------
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
270 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
271 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
272 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
273 copy.
3aee8a37afeb Fixed HTTP headers for top-level index in CGI script
Richard Jones <richard@users.sourceforge.net>
parents: 337
diff changeset
274
394
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
275
f43af1e97fdd Added a target version field to the extended issue schema
Richard Jones <richard@users.sourceforge.net>
parents: 356
diff changeset
276
Roundup Issue Tracker: http://roundup-tracker.org/