Mercurial > p > roundup > code
annotate doc/upgrading.txt @ 1640:d0b29215aa44
pre-release stuff
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 09 May 2003 05:04:34 +0000 |
| parents | 4a47eb555e51 |
| children | 3d4ad125662b |
| rev | line source |
|---|---|
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
1 ====================================== |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 Upgrading to newer versions of Roundup |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 ====================================== |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
5 Please read each section carefully and edit your tracker home files |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
6 accordingly. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
7 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 .. contents:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
9 |
|
1363
f41360211819
oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents:
1308
diff
changeset
|
10 Migrating from 0.5 to 0.6 |
|
f41360211819
oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents:
1308
diff
changeset
|
11 ========================= |
|
f41360211819
oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents:
1308
diff
changeset
|
12 |
|
1388
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
13 0.6.0 Configuration |
|
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
14 ------------------- |
|
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
15 |
| 1638 | 16 Introduced EMAIL_FROM_TAG config variable. This value is inserted into |
| 17 the From: line of nosy email. If the sending user is "Foo Bar", the | |
| 18 From: line is usually:: | |
|
1388
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
19 |
|
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
20 "Foo Bar" <issue_tracker@tracker.example> |
|
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
21 |
| 1638 | 22 the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:: |
|
1388
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
23 |
|
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
24 "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example> |
|
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
25 |
|
1455
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
26 I've altered the mechanism in the detectors __init__.py module so that it |
|
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
27 doesn't cross-import detectors from other trackers (if you run more than one |
|
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
28 in a single roundup-server). This change means that you'll need to copy the |
|
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
29 __init__.py from roundup/templates/classic/detectors/__init__.py to your |
|
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
30 <tracker home>/detectors/__init__.py. Don't worry, the "classic" __init__ is a |
|
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
31 one-size-fits-all, so it'll work even if you've added/removed detectors. |
|
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
32 |
|
436eb851045a
*** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents:
1439
diff
changeset
|
33 |
| 1423 | 34 0.6.0 Form handling changes |
| 35 --------------------------- | |
| 36 | |
| 1638 | 37 Roundup's form handling capabilities have been significantly expanded. This |
| 38 should not affect users of 0.5 installations - but if you find you're | |
| 39 getting errors from form submissions, please ask for help on the Roundup | |
| 40 users mailing list: | |
| 1423 | 41 |
| 1638 | 42 http://lists.sourceforge.net/lists/listinfo/roundup-users |
| 43 | |
| 44 See the customisation doc section on "Form Values" for documentation of the | |
| 45 new form variables possible. | |
|
1439
0634f815b90c
rfc2822-ify the tracker name in mail headers
Richard Jones <richard@users.sourceforge.net>
parents:
1423
diff
changeset
|
46 |
| 1423 | 47 |
|
1388
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
48 0.6.0 Multilingual character set support |
|
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
49 ---------------------------------------- |
|
1363
f41360211819
oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents:
1308
diff
changeset
|
50 |
| 1638 | 51 Added internationalization support. This is done via encoding all data |
| 52 stored in roundup database to utf-8 (unicode encoding). To support utf-8 in | |
| 53 web interface you should add the folowing line to your tracker's html/page | |
| 54 and html/_generic.help files inside <head> tag:: | |
|
1386
7ca01821df2c
notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1381
diff
changeset
|
55 |
|
7ca01821df2c
notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1381
diff
changeset
|
56 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
|
7ca01821df2c
notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1381
diff
changeset
|
57 |
| 1638 | 58 Since latin characters in utf-8 have the same codes as in ASCII table, this |
| 59 modification is optional for users who use only plain latin characters. | |
|
1386
7ca01821df2c
notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1381
diff
changeset
|
60 |
| 1638 | 61 After this modification, you will be able to see and enter any world |
| 62 character via web interface. Data received via mail interface also converted | |
| 63 to utf-8, however only new messages will be converted. If your roundup | |
| 64 database contains some of non-ASCII characters in one of 8-bit encoding, | |
| 65 they will not be visible in new unicode environment. Some of such data (e.g. | |
| 66 user names, keywords, etc) can be edited by administrator, the others | |
| 67 (e.g. messages' contents) is not editable via web interface. Currently there | |
| 68 is no tool for converting such data, the only solution is to close | |
| 69 appropriate old issues and create new ones with the same content. | |
|
1386
7ca01821df2c
notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1381
diff
changeset
|
70 |
| 1638 | 71 0.6.0 User timezone support |
| 72 --------------------------- | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
73 |
| 1638 | 74 From version 0.6.0 roundup supports displaying of Date data in user' local |
| 75 timezone if he/she has provided timezone information. To make it possible | |
| 76 some modification to tracker's schema and HTML templates are required. | |
| 77 First you should add string property 'timezone' to user class in dbinit.py | |
| 78 like this:: | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
79 |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
80 user = Class(db, "user", |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
81 username=String(), password=Password(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
82 address=String(), realname=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
83 phone=String(), organisation=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
84 alternate_addresses=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
85 queries=Multilink('query'), roles=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
86 timezone=String()) |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
87 |
| 1638 | 88 And second - html interface. Add following lines to |
| 89 $TRACKER_HOME/html/user.item template:: | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
90 |
| 1560 | 91 <tr> |
| 92 <th>Timezone</th> | |
| 93 <td tal:content="structure context/timezone/field">timezone</td> | |
| 94 </tr> | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
95 |
| 1638 | 96 After that all users should be able to provide their timezone information. |
| 97 Timezone should be a positive or negative integer - offset from GMT. | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
98 |
| 1638 | 99 After providing timezone, roundup will show all dates values, found in web |
| 100 and mail interfaces in local time. It will also accept any Date info in | |
| 101 local time, convert and store it in GMT. | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
102 |
| 1638 | 103 However you are not forced to make these modifications. By default roundup |
| 104 will assume timezone=0 and will work as previous versions did. | |
|
1363
f41360211819
oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents:
1308
diff
changeset
|
105 |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
106 |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
107 0.6.0 Notes for metakit backend users |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
108 ------------------------------------- |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
109 |
| 1638 | 110 Roundup 0.6.0 introduced searching on ranges of dates and intervals. To |
| 111 support it, some modifications to interval storing routine were made. So if | |
| 112 your tracker uses metakit backend and your db schema contains intervals | |
| 113 property, searches on that property will not be accurate for db items that | |
| 114 was stored before roundup' upgrade. However all new records should be | |
| 115 searchable on intervals. | |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
116 |
| 1638 | 117 It is possible to convert your database to new format: you can export and |
| 118 import back all your data (consult "Migrating backends" in "Maintenance" | |
| 119 documentation). After this operation all your interval properties should | |
| 120 become searchable. | |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
121 |
| 1638 | 122 Users of backends others than metakit should not worry about this issue. |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
123 |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
124 |
|
825
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
125 Migrating from 0.4.x to 0.5.0 |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
126 ============================= |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
127 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
128 This has been a fairly major revision of Roundup: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
129 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
130 1. Brand new, much more powerful, flexible, tasty and nutritious templating. |
| 1091 | 131 Unfortunately, this means all your current templates are useless. Hopefully |
| 132 the new documentation and examples will be enough to help you make the | |
| 133 transition. Please don't hesitate to ask on roundup-users for help (or | |
| 134 complete conversions if you're completely stuck)! | |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
135 2. The database backed got a lot more flexible, allowing Metakit and SQL |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
136 databases! The only decent SQL database implemented at present is sqlite, |
|
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
137 but others shouldn't be a whole lot more work. |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
138 3. A brand new, highly flexible and much more robust security system including |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
139 a system of Permissions, Roles and Role assignments to users. You may now |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
140 define your own Permissions that may be checked in CGI transactions. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
141 4. Journalling has been made less storage-hungry, so has been turned on |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
142 by default *except* for author, recipient and nosy link/unlink events. You |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
143 are advised to turn it off in your trackers too. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
144 5. We've changed the terminology from "instance" to "tracker", to ease the |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
145 learning curve/impact for new users. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
146 6. Because of the above changes, the tracker configuration has seen some |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
147 major changes. See below for the details. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
148 |
| 1091 | 149 Please, **back up your database** before you start the migration process. This |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
150 is as simple as copying the "db" directory and all its contents from your |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
151 tracker to somewhere safe. |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
152 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
153 |
|
825
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
154 0.5.0 Configuration |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
155 ------------------- |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
156 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
157 First up, rename your ``instance_config.py`` file to just ``config.py``. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
158 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
159 Then edit your tracker's ``__init__.py`` module. It'll currently look |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
160 like this:: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
161 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
162 from instance_config import * |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
163 try: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
164 from dbinit import * |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
165 except ImportError: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
166 pass # in installdir (probably :) |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
167 from interfaces import * |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
168 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
169 and it needs to be:: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
170 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
171 import config |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
172 from dbinit import open, init |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
173 from interfaces import Client, MailGW |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
174 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
175 Due to the new templating having a top-level ``page`` that defines links for |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
176 searching, indexes, adding items etc, the following variables are no longer |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
177 used: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
178 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
179 - HEADER_INDEX_LINKS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
180 - HEADER_ADD_LINKS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
181 - HEADER_SEARCH_LINKS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
182 - SEARCH_FILTERS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
183 - DEFAULT_INDEX |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
184 - UNASSIGNED_INDEX |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
185 - USER_INDEX |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
186 - ISSUE_FILTER |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
187 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
188 The new security implementation will require additions to the dbinit module, |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
189 but also removes the need for the following tracker config variables: |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
190 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
191 - ANONYMOUS_ACCESS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
192 - ANONYMOUS_REGISTER |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
193 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
194 but requires two new variables which define the Roles assigned to users who |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
195 register through the web and e-mail interfaces: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
196 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
197 - NEW_WEB_USER_ROLES |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
198 - NEW_EMAIL_USER_ROLES |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
199 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
200 in both cases, 'User' is a good initial setting. To emulate |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
201 ``ANONYMOUS_ACCESS='deny'``, remove all "View" Permissions from the |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
202 "Anonymous" Role. To emulate ``ANONYMOUS_REGISTER='deny'``, remove the "Web |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
203 Registration" and/or the "Email Registration" Permission from the "Anonymous" |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
204 Role. See the section on customising security in the `customisation |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
205 documentation`_ for more information. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
206 |
|
1096
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
207 Finally, the following config variables have been renamed to make more sense: |
|
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
208 |
|
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
209 - INSTANCE_HOME -> TRACKER_HOME |
|
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
210 - INSTANCE_NAME -> TRACKER_NAME |
|
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
211 - ISSUE_TRACKER_WEB -> TRACKER_WEB |
|
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
212 - ISSUE_TRACKER_EMAIL -> TRACKER_EMAIL |
|
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
213 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
214 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
215 0.5.0 Schema Specification |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
216 -------------------------- |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
217 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
218 0.5.0 Database backend changes |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
220 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
221 Your select_db module in your tracker has changed a fair bit. Where it used |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
222 to contain:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
223 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
224 # WARNING: DO NOT EDIT THIS FILE!!! |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
225 from roundup.backends.back_anydbm import Database |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
226 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
227 it must now contain:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
228 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
229 # WARNING: DO NOT EDIT THIS FILE!!! |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
230 from roundup.backends.back_anydbm import Database, Class, FileClass, IssueClass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
231 |
|
1051
a0c7df67dd9c
Allow a page request to include a :contentonly variable.
Richard Jones <richard@users.sourceforge.net>
parents:
1034
diff
changeset
|
232 Yes, I realise the irony of the "DO NOT EDIT THIS FILE" statement :) |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
233 Note the addition of the Class, FileClass, IssueClass imports. These are very |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
234 important, as they're going to make the next change work too. You now need to |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
235 modify the top of the dbinit module in your tracker from:: |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
236 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
237 import instance_config |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
238 from roundup import roundupdb |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
239 from select_db import Database |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
240 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
241 from roundup.roundupdb import Class, FileClass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
242 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
243 class Database(roundupdb.Database, select_db.Database): |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
244 ''' Creates a hybrid database from: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
245 . the selected database back-end from select_db |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
246 . the roundup extensions from roundupdb |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
247 ''' |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
248 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
249 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
250 class IssueClass(roundupdb.IssueClass): |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
251 ''' issues need the email information |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
252 ''' |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
253 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
254 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
255 to:: |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
256 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
257 import config |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
258 from select_db import Database, Class, FileClass, IssueClass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
259 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
260 Yes, remove the Database and IssueClass definitions and those other imports. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
261 They're not needed any more! |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
262 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
263 Look for places in dbinit.py where ``instance_config`` is used too, and |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
264 rename them ``config``. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
265 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
266 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
267 0.5.0 Journalling changes |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
268 ~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
269 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
270 Journalling has been optimised for storage. Journalling of links has been |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
271 turned back on by default. If your tracker has a large user base, you may wish |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
272 to turn off journalling of nosy list, message author and message recipient |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
273 link and unlink events. You do this by adding ``do_journal='no'`` to the Class |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
274 initialisation in your dbinit. For example, your *msg* class initialisation |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
275 probably looks like this:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
276 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
277 msg = FileClass(db, "msg", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
278 author=Link("user"), recipients=Multilink("user"), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
279 date=Date(), summary=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
280 files=Multilink("file"), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
281 messageid=String(), inreplyto=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
282 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
283 to turn off journalling of author and recipient link events, add |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
284 ``do_journal='no'`` to the ``author=Link("user")`` part of the statement, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
285 like so:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
286 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
287 msg = FileClass(db, "msg", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
288 author=Link("user", do_journal='no'), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
289 recipients=Multilink("user", do_journal='no'), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
290 date=Date(), summary=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
291 files=Multilink("file"), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
292 messageid=String(), inreplyto=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
293 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
294 Nosy list link event journalling is actually turned off by default now. If you |
|
1227
92d8e1aad2e9
added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents:
1096
diff
changeset
|
295 want to turn it on, change to your issue class' nosy list, change its |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
296 definition from:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
297 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
298 issue = IssueClass(db, "issue", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
299 assignedto=Link("user"), topic=Multilink("keyword"), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
300 priority=Link("priority"), status=Link("status")) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
301 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
302 to:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
303 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
304 issue = IssueClass(db, "issue", nosy=Multilink("user", do_journal='yes'), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
305 assignedto=Link("user"), topic=Multilink("keyword"), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
306 priority=Link("priority"), status=Link("status")) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
307 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
308 noting that your definition of the nosy Multilink will override the normal one. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
309 |
|
1009
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
310 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
311 0.5.0 User schema changes |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
312 ~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
313 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
314 Users have two more properties, "queries" and "roles". You'll have something |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
315 like this in your dbinit module now:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
316 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
317 user = Class(db, "user", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
318 username=String(), password=Password(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
319 address=String(), realname=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
320 phone=String(), organisation=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
321 alternate_addresses=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
322 user.setkey("username") |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
323 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
324 and you'll need to add the new properties and the new "query" class to it |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
325 like so:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
326 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
327 query = Class(db, "query", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
328 klass=String(), name=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
329 url=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
330 query.setkey("name") |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
331 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
332 # Note: roles is a comma-separated string of Role names |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
333 user = Class(db, "user", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
334 username=String(), password=Password(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
335 address=String(), realname=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
336 phone=String(), organisation=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
337 alternate_addresses=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
338 queries=Multilink('query'), roles=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
339 user.setkey("username") |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
340 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
341 The "queries" property is used to store off the user's favourite database |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
342 queries. The "roles" property is explained below in `0.5.0 Security |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
343 Settings`_. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
344 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
345 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
346 0.5.0 Security Settings |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
347 ~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
348 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
349 See the `security documentation`_ for an explanation of how the new security |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
350 system works. In a nutshell though, the security is handled as a four step |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
351 process: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
352 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
353 1. Permissions are defined as having a name and optionally a hyperdb class |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
354 they're specific to, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
355 2. Roles are defined that have one or more Permissions, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
356 3. Users are assigned Roles in their "roles" property, and finally |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
357 4. Roundup checks that users have appropriate Permissions at appropriate times |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
358 (like editing issues). |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
359 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
360 Your tracker dbinit module's *open* function now has to define any |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
361 Permissions that are specific to your tracker, and also the assignment |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
362 of Permissions to Roles. At the moment, your open function |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
363 ends with:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
364 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
365 import detectors |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
366 detectors.init(db) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
367 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
368 return db |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
369 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
370 and what we need to do is insert some commands that will set up the security |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
371 parameters. Right above the ``import detectors`` line, you'll want to insert |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
372 these lines:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
373 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
374 # |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
375 # SECURITY SETTINGS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
376 # |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
377 # new permissions for this schema |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
378 for cl in 'issue', 'file', 'msg', 'user': |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
379 db.security.addPermission(name="Edit", klass=cl, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
380 description="User is allowed to edit "+cl) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
381 db.security.addPermission(name="View", klass=cl, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
382 description="User is allowed to access "+cl) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
383 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
384 # Assign the access and edit permissions for issue, file and message |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
385 # to regular users now |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
386 for cl in 'issue', 'file', 'msg': |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
387 p = db.security.getPermission('View', cl) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
388 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
389 p = db.security.getPermission('Edit', cl) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
390 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
391 # and give the regular users access to the web and email interface |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
392 p = db.security.getPermission('Web Access') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
393 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
394 p = db.security.getPermission('Email Access') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
395 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
396 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
397 # May users view other user information? Comment these lines out |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
398 # if you don't want them to |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
399 p = db.security.getPermission('View', 'user') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
400 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
401 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
402 # Assign the appropriate permissions to the anonymous user's Anonymous |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
403 # Role. Choices here are: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
404 # - Allow anonymous users to register through the web |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
405 p = db.security.getPermission('Web Registration') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
406 db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
407 # - Allow anonymous (new) users to register through the email gateway |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
408 p = db.security.getPermission('Email Registration') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
409 db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
410 # - Allow anonymous users access to the "issue" class of data |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
411 # Note: this also grants access to related information like files, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
412 # messages, statuses etc that are linked to issues |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
413 #p = db.security.getPermission('View', 'issue') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
414 #db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
415 # - Allow anonymous users access to edit the "issue" class of data |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
416 # Note: this also grants access to create related information like |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
417 # files and messages etc that are linked to issues |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
418 #p = db.security.getPermission('Edit', 'issue') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
419 #db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
420 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
421 # oh, g'wan, let anonymous access the web interface too |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
422 p = db.security.getPermission('Web Access') |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
423 db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
424 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
425 Note in the comments there the places where you might change the permissions |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
426 to restrict users or grant users more access. If you've created additional |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
427 classes that users should be able to edit and view, then you should add them |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
428 to the "new permissions for this schema" section at the start of the security |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
429 block. Then add them to the "Assign the access and edit permissions" section |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
430 too, so people actually have the new Permission you've created. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
431 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
432 One final change is needed that finishes off the security system's |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
433 initialisation. We need to add a call to ``db.post_init()`` at the end of the |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
434 dbinit open() function. Add it like this:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
435 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
436 import detectors |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
437 detectors.init(db) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
438 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
439 # schema is set up - run any post-initialisation |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
440 db.post_init() |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
441 return db |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
442 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
443 You may verify the setup of Permissions and Roles using the new |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
444 "``roundup-admin security``" command. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
445 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
446 |
|
1009
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
447 0.5.0 User changes |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
448 ~~~~~~~~~~~~~~~~~~ |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
449 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
450 To support all those schema changes, you'll need to massage your user database |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
451 a little too, to: |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
452 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
453 1. make sure there's an "anonymous" user - this user is mandatory now and is |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
454 the one that unknown users are logged in as. |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
455 2. make sure all users have at least one Role. |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
456 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
457 If you don't have the "anonymous" user, create it now with the command:: |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
458 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
459 roundup-admin create user username=anonymous roles=Anonymous |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
460 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
461 making sure the capitalisation is the same as above. Once you've done that, |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
462 you'll need to set the roles property on all users to a reasonable default. |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
463 The admin user should get "Admin", the anonymous user "Anonymous" |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
464 and all other users "User". The ``fixroles.py`` script in the tools directory |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
465 will do this. Run it like so (where python is your python 2+ binary):: |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
466 |
| 1271 | 467 python tools/fixroles.py -i <tracker home> fixroles |
|
1009
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
468 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
469 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
470 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
471 0.5.0 CGI interface changes |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
472 --------------------------- |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
473 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
474 The CGI interface code was completely reorganised and largely rewritten. The |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
475 end result is that this section of your tracker interfaces module will need |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
476 changing from:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
477 |
|
1308
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
478 from roundup import cgi_client, mailgw |
|
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
479 from roundup.i18n import _ |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
480 |
|
1308
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
481 class Client(cgi_client.Client): |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
482 ''' derives basic CGI implementation from the standard module, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
483 with any specific extensions |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
484 ''' |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
485 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
486 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
487 to:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
488 |
|
1308
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
489 from roundup import mailgw |
|
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
490 from roundup.cgi import client |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
491 |
|
1308
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
492 class Client(client.Client): |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
493 ''' derives basic CGI implementation from the standard module, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
494 with any specific extensions |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
495 ''' |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
496 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
497 |
|
1034
6afef8529d6c
mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents:
1009
diff
changeset
|
498 You will also need to install the new version of roundup.cgi from the source |
|
6afef8529d6c
mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents:
1009
diff
changeset
|
499 cgi-bin directory if you're using it. |
|
6afef8529d6c
mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents:
1009
diff
changeset
|
500 |
|
6afef8529d6c
mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents:
1009
diff
changeset
|
501 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
502 0.5.0 HTML templating |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
503 --------------------- |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
504 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
505 You'll want to make a backup of your current tracker html directory. You |
| 1091 | 506 should then copy the html directory from the Roundup source "classic" template |
| 507 and modify it according to your local schema changes. | |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
508 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
509 If you need help with the new templating system, please ask questions on the |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
510 roundup-users mailing list (available through the roundup project page on |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
511 sourceforge, http://roundup.sf.net/) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
512 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
513 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
514 0.5.0 Detectors |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
515 --------------- |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
516 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
517 The nosy reactor has been updated to handle the tracker not having an |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
518 "assignedto" property on issues. You may want to copy it into your tracker's |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
519 detectors directory. Chances are you've already fixed it though :) |
|
825
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
520 |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
521 |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
522 Migrating from 0.4.1 to 0.4.2 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
523 ============================= |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
524 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
525 0.4.2 Configuration |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
526 ------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
527 The USER_INDEX definition introduced in 0.4.1 was too restrictive in its |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
528 allowing replacement of 'assignedto' with the user's userid. Users must change |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
529 the None value of 'assignedto' to 'CURRENT USER' (the string, in quotes) for |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
530 the replacement behaviour to occur now. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
531 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
532 The new configuration variables are: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
533 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
534 - EMAIL_KEEP_QUOTED_TEXT |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
535 - EMAIL_LEAVE_BODY_UNCHANGED |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
536 - ADD_RECIPIENTS_TO_NOSY |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
537 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
538 See the sample configuration files in:: |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
539 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
540 <roundup source>/roundup/templates/classic/instance_config.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
541 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
542 and:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
543 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
544 <roundup source>/roundup/templates/extended/instance_config.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
545 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
546 and the `customisation documentation`_ for information on how they're used. |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
547 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
548 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
549 0.4.2 Changes to detectors |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
550 -------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
551 You will need to copy the detectors from the distribution into your instance |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
552 home "detectors" directory. If you used the classic schema, the detectors |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
553 are in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
554 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
555 <roundup source>/roundup/templates/classic/detectors/ |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
556 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
557 If you used the extended schema, the detectors are in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
558 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
559 <roundup source>/roundup/templates/extended/detectors/ |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
560 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
561 The change means that schema-specific code has been removed from the |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
562 mail gateway and cgi interface and made into auditors: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
563 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
564 - nosyreactor.py has now got an updatenosy auditor which updates the nosy |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
565 list with author, recipient and assignedto information. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
566 - statusauditor.py makes the unread or resolved -> chatting changes and |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
567 presets the status of an issue to unread. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
568 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
569 There's also a bug or two fixed in the nosyreactor code. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
570 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
571 0.4.2 HTML templating changes |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
572 ----------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
573 The link() htmltemplate function now has a "showid" option for links and |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
574 multilinks. When true, it only displays the linked item id as the anchor |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
575 text. The link value is displayed as a tooltip using the title anchor |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
576 attribute. To use in eg. the superseder field, have something like this:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
577 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
578 <td> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
579 <display call="field('superseder', showid=1)"> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
580 <display call="classhelp('issue', 'id,title', label='list', width=500)"> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
581 <property name="superseder"> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
582 <br>View: <display call="link('superseder', showid=1)"> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
583 </property> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
584 </td> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
585 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
586 The stylesheets have been cleaned up too. You may want to use the newer |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
587 versions in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
588 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
589 <roundup source>/roundup/templates/<template>/html/default.css |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
590 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
591 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
592 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
593 Migrating from 0.4.0 to 0.4.1 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
594 ============================= |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
595 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
596 0.4.1 Files storage |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
597 ------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
598 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
599 Messages and files from newly created issues will be put into subdierectories |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
600 in thousands e.g. msg123 will be put into files/msg/0/msg123, file2003 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
601 will go into files/file/2/file2003. Previous messages are still found, but |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
602 could be put into this structure. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
603 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
604 0.4.1 Configuration |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
605 ------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
606 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
607 To allow more fine-grained access control, the variable used to check |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
608 permission to auto-register users in the mail gateway is now called |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
609 ANONYMOUS_REGISTER_MAIL rather than overloading ANONYMOUS_REGISTER. If the |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
610 variable doesn't exist, then ANONYMOUS_REGISTER is tested as before. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
611 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
612 Configuring the links in the web header is now easier too. The following |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
613 variables have been added to the classic instance_config.py:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
614 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
615 HEADER_INDEX_LINKS - defines the "index" links to be made available |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
616 HEADER_ADD_LINKS - defines the "add" links |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
617 DEFAULT_INDEX - specifies the index view for DEFAULT |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
618 UNASSIGNED_INDEX - specifies the index view for UNASSIGNED |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
619 USER_INDEX - specifies the index view for USER |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
620 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
621 See the <roundup source>/roundup/templates/classic/instance_config.py for more |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
622 information - including how the variables are to be set up. Most users will |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
623 just be able to copy the variables from the source to their instance home. If |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
624 you've modified the header by changing the source of the interfaces.py file in |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
625 the instance home, you'll need to remove that customisation and move it into |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
626 the appropriate variables in instance_config.py. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
627 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
628 The extended schema has similar variables added too - see the source for more |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
629 info. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
630 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
631 0.4.1 Alternate E-Mail Addresses |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
632 -------------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
633 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
634 If you add the property "alternate_addresses" to your user class, your users |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
635 will be able to register alternate email addresses that they may use to |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
636 communicate with roundup as. All email from roundup will continue to be sent |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
637 to their primary address. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
638 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
639 If you have not edited the dbinit.py file in your instance home directory, |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
640 you may simply copy the new dbinit.py file from the core code. If you used |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
641 the classic schema, the interfaces file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
642 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
643 <roundup source>/roundup/templates/classic/dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
644 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
645 If you used the extended schema, the file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
646 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
647 <roundup source>/roundup/templates/extended/dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
648 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
649 If you have modified your dbinit.py file, you need to edit the dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
650 file in your instance home directory. Find the lines which define the user |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
651 class:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
652 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
653 user = Class(db, "msg", |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
654 username=String(), password=Password(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
655 address=String(), realname=String(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
656 phone=String(), organisation=String(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
657 alternate_addresses=String()) |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
658 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
659 You will also want to add the property to the user's details page. The |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
660 template for this is the "user.item" file in your instance home "html" |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
661 directory. Similar to above, you may copy the file from the roundup source if |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
662 you haven't modified it. Otherwise, add the following to the template:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
663 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
664 <display call="multiline('alternate_addresses')"> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
665 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
666 with appropriate labelling etc. See the standard template for an idea. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
667 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
668 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
669 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
670 Migrating from 0.3.x to 0.4.0 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
671 ============================= |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
672 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
673 0.4.0 Message-ID and In-Reply-To addition |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
674 ----------------------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
675 0.4.0 adds the tracking of messages by message-id and allows threading |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
676 using in-reply-to. Most e-mail clients support threading using this |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
677 feature, and we hope to add support for it to the web gateway. If you |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
678 have not edited the dbinit.py file in your instance home directory, you may |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
679 simply copy the new dbinit.py file from the core code. If you used the |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
680 classic schema, the interfaces file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
681 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
682 <roundup source>/roundup/templates/classic/dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
683 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
684 If you used the extended schema, the file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
685 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
686 <roundup source>/roundup/templates/extended/dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
687 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
688 If you have modified your dbinit.py file, you need to edit the dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
689 file in your instance home directory. Find the lines which define the msg |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
690 class:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
691 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
692 msg = FileClass(db, "msg", |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
693 author=Link("user"), recipients=Multilink("user"), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
694 date=Date(), summary=String(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
695 files=Multilink("file")) |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
696 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
697 and add the messageid and inreplyto properties like so:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
698 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
699 msg = FileClass(db, "msg", |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
700 author=Link("user"), recipients=Multilink("user"), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
701 date=Date(), summary=String(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
702 files=Multilink("file"), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
703 messageid=String(), inreplyto=String()) |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
704 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
705 Also, configuration is being cleaned up. This means that your dbinit.py will |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
706 also need to be changed in the open function. If you haven't changed your |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
707 dbinit.py, the above copy will be enough. If you have, you'll need to change |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
708 the line (round line 50):: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
709 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
710 db = Database(instance_config.DATABASE, name) |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
711 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
712 to:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
713 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
714 db = Database(instance_config, name) |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
715 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
716 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
717 0.4.0 Configuration |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
718 -------------------- |
|
1096
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
719 ``TRACKER_NAME`` and ``EMAIL_SIGNATURE_POSITION`` have been added to the |
|
782
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
720 instance_config.py. The simplest solution is to copy the default values |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
721 from template in the core source. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
722 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
723 The mail gateway now checks ``ANONYMOUS_REGISTER`` to see if unknown users |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
724 are to be automatically registered with the tracker. If it is set to "deny" |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
725 then unknown users will not have access. If it is set to "allow" they will be |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
726 automatically registered with the tracker. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
727 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
728 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
729 0.4.0 CGI script roundup.cgi |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
730 ---------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
731 The CGI script has been updated with some features and a bugfix, so you should |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
732 copy it from the roundup cgi-bin source directory again. Make sure you update |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
733 the ROUNDUP_INSTANCE_HOMES after the copy. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
734 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
735 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
736 0.4.0 Nosy reactor |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
737 ------------------ |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
738 The nosy reactor has also changed - copy the nosyreactor.py file from the core |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
739 source:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
740 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
741 <roundup source>/roundup/templates/<template>/detectors/nosyreactor.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
742 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
743 to your instance home "detectors" directory. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
744 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
745 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
746 0.4.0 HTML templating |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
747 --------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
748 The field() function was incorrectly implemented - links and multilinks now |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
749 display as text fields when rendered using field(). To display a menu (drop- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
750 down or select box) you need to use the menu() function. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
751 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
752 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
753 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
754 Migrating from 0.2.x to 0.3.x |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
755 ============================= |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
756 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
757 0.3.x Cookie Authentication changes |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
758 ----------------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
759 0.3.0 introduces cookie authentication - you will need to copy the |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
760 interfaces.py file from the roundup source to your instance home to enable |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
761 authentication. If you used the classic schema, the interfaces file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
762 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
763 <roundup source>/roundup/templates/classic/interfaces.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
764 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
765 If you used the extended schema, the file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
766 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
767 <roundup source>/roundup/templates/extended/interfaces.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
768 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
769 If you have modified your interfaces.Client class, you will need to take |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
770 note of the login/logout functionality provided in roundup.cgi_client.Client |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
771 (classic schema) or roundup.cgi_client.ExtendedClient (extended schema) and |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
772 modify your instance code apropriately. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
773 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
774 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
775 0.3.x Password encoding |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
776 ----------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
777 This release also introduces encoding of passwords in the database. If you |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
778 have not edited the dbinit.py file in your instance home directory, you may |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
779 simply copy the new dbinit.py file from the core code. If you used the |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
780 classic schema, the interfaces file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
781 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
782 <roundup source>/roundup/templates/classic/dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
783 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
784 If you used the extended schema, the file is in:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
785 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
786 <roundup source>/roundup/templates/extended/dbinit.py |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
787 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
788 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
789 If you have modified your dbinit.py file, you may use encoded passwords: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
790 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
791 1. Edit the dbinit.py file in your instance home directory |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
792 a. At the first code line of the open() function:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
793 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
794 from roundup.hyperdb import String, Date, Link, Multilink |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
795 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
796 alter to include Password, as so:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
797 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
798 from roundup.hyperdb import String, Password, Date, Link, Multilink |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
799 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
800 b. Where the password property is defined (around line 66):: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
801 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
802 user = Class(db, "user", |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
803 username=String(), password=String(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
804 address=String(), realname=String(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
805 phone=String(), organisation=String()) |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
806 user.setkey("username") |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
807 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
808 alter the "password=String()" to "password=Password()":: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
809 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
810 user = Class(db, "user", |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
811 username=String(), password=Password(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
812 address=String(), realname=String(), |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
813 phone=String(), organisation=String()) |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
814 user.setkey("username") |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
815 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
816 2. Any existing passwords in the database will remain cleartext until they |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
817 are edited. It is recommended that at a minimum the admin password be |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
818 changed immediately:: |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
819 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
820 roundup-admin -i <instance home> set user1 password=<new password> |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
821 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
822 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
823 0.3.x Configuration |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
824 ------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
825 FILTER_POSITION, ANONYMOUS_ACCESS, ANONYMOUS_REGISTER have been added to |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
826 the instance_config.py. Simplest solution is to copy the default values from |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
827 template in the core source. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
828 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
829 MESSAGES_TO_AUTHOR has been added to the IssueClass in dbinit.py. Set to 'yes' |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
830 to send nosy messages to the author. Default behaviour is to not send nosy |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
831 messages to the author. You will need to add MESSAGES_TO_AUTHOR to your |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
832 dbinit.py in your instance home. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
833 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
834 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
835 0.3.x CGI script roundup.cgi |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
836 ---------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
837 There have been some structural changes to the roundup.cgi script - you will |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
838 need to install it again from the cgi-bin directory of the source |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
839 distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
840 copy. |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
841 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
842 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
843 .. _`customisation documentation`: customizing.html |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
844 .. _`security documentation`: security.html |