Mercurial > p > roundup > code
annotate doc/upgrading.txt @ 1770:d97e8f4989b6 maint-0.6
merge from HEAD
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 28 Aug 2003 05:09:53 +0000 |
| parents | bbb1d2752edc |
| children | a3b1b1dcf639 9560e94beeea |
| 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 | |
|
1741
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
44 See the customisation doc section on `Form Values`__ for documentation of the |
| 1638 | 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 |
|
1741
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
47 __ customizing.html#form-values |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
48 |
| 1423 | 49 |
|
1388
cd28e3b5db2e
small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents:
1386
diff
changeset
|
50 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
|
51 ---------------------------------------- |
|
1363
f41360211819
oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents:
1308
diff
changeset
|
52 |
| 1638 | 53 Added internationalization support. This is done via encoding all data |
| 54 stored in roundup database to utf-8 (unicode encoding). To support utf-8 in | |
| 55 web interface you should add the folowing line to your tracker's html/page | |
| 56 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
|
57 |
|
7ca01821df2c
notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1381
diff
changeset
|
58 <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
|
59 |
| 1638 | 60 Since latin characters in utf-8 have the same codes as in ASCII table, this |
| 61 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
|
62 |
| 1638 | 63 After this modification, you will be able to see and enter any world |
| 64 character via web interface. Data received via mail interface also converted | |
| 65 to utf-8, however only new messages will be converted. If your roundup | |
| 66 database contains some of non-ASCII characters in one of 8-bit encoding, | |
| 67 they will not be visible in new unicode environment. Some of such data (e.g. | |
| 68 user names, keywords, etc) can be edited by administrator, the others | |
| 69 (e.g. messages' contents) is not editable via web interface. Currently there | |
| 70 is no tool for converting such data, the only solution is to close | |
| 71 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
|
72 |
| 1638 | 73 0.6.0 User timezone support |
| 74 --------------------------- | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
75 |
| 1638 | 76 From version 0.6.0 roundup supports displaying of Date data in user' local |
| 77 timezone if he/she has provided timezone information. To make it possible | |
| 78 some modification to tracker's schema and HTML templates are required. | |
|
1770
d97e8f4989b6
merge from HEAD
Richard Jones <richard@users.sourceforge.net>
parents:
1759
diff
changeset
|
79 First you must add string property 'timezone' to user class in dbinit.py |
| 1638 | 80 like this:: |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
81 |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
82 user = Class(db, "user", |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
83 username=String(), password=Password(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
84 address=String(), realname=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
85 phone=String(), organisation=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
86 alternate_addresses=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
87 queries=Multilink('query'), roles=String(), |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
88 timezone=String()) |
|
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
89 |
| 1638 | 90 And second - html interface. Add following lines to |
| 91 $TRACKER_HOME/html/user.item template:: | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
92 |
| 1560 | 93 <tr> |
| 94 <th>Timezone</th> | |
| 95 <td tal:content="structure context/timezone/field">timezone</td> | |
| 96 </tr> | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
97 |
| 1638 | 98 After that all users should be able to provide their timezone information. |
| 99 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
|
100 |
| 1638 | 101 After providing timezone, roundup will show all dates values, found in web |
| 102 and mail interfaces in local time. It will also accept any Date info in | |
| 103 local time, convert and store it in GMT. | |
|
1402
27586da5557c
Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1388
diff
changeset
|
104 |
|
1741
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
105 0.6.0 Search page structure |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
106 --------------------------- |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
107 |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
108 In order to accomodate query editing the search page has been restructured. If |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
109 you want to provide your users with query editing, you should update your |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
110 search page using the macros detailed in the customisation doc section |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
111 `Searching on categories`__. |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
112 |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
113 __ customizing.html#searching-on-categories |
|
3d4ad125662b
Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1638
diff
changeset
|
114 |
|
1759
bbb1d2752edc
Merged back piece about removing '?' from url.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1741
diff
changeset
|
115 Also, the url field in the query class no longer starts with a '?'. You'll need |
|
bbb1d2752edc
Merged back piece about removing '?' from url.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1741
diff
changeset
|
116 to remove this question mark from the url field to support queries. |
|
bbb1d2752edc
Merged back piece about removing '?' from url.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents:
1741
diff
changeset
|
117 |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
118 |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
119 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
|
120 ------------------------------------- |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
121 |
| 1638 | 122 Roundup 0.6.0 introduced searching on ranges of dates and intervals. To |
| 123 support it, some modifications to interval storing routine were made. So if | |
| 124 your tracker uses metakit backend and your db schema contains intervals | |
| 125 property, searches on that property will not be accurate for db items that | |
| 126 was stored before roundup' upgrade. However all new records should be | |
| 127 searchable on intervals. | |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
128 |
| 1638 | 129 It is possible to convert your database to new format: you can export and |
| 130 import back all your data (consult "Migrating backends" in "Maintenance" | |
| 131 documentation). After this operation all your interval properties should | |
| 132 become searchable. | |
|
1596
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
133 |
| 1638 | 134 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
|
135 |
|
33a0d94c7658
searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents:
1560
diff
changeset
|
136 |
|
825
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
137 Migrating from 0.4.x to 0.5.0 |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
138 ============================= |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
139 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
140 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
|
141 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
142 1. Brand new, much more powerful, flexible, tasty and nutritious templating. |
| 1091 | 143 Unfortunately, this means all your current templates are useless. Hopefully |
| 144 the new documentation and examples will be enough to help you make the | |
| 145 transition. Please don't hesitate to ask on roundup-users for help (or | |
| 146 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
|
147 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
|
148 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
|
149 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
|
150 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
|
151 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
|
152 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
|
153 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
|
154 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
|
155 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
|
156 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
|
157 learning curve/impact for new users. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
158 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
|
159 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
|
160 |
| 1091 | 161 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
|
162 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
|
163 tracker to somewhere safe. |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
164 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
165 |
|
825
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
166 0.5.0 Configuration |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
167 ------------------- |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
168 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
169 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
|
170 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
171 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
|
172 like this:: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
173 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
174 from instance_config import * |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
175 try: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
176 from dbinit import * |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
177 except ImportError: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
178 pass # in installdir (probably :) |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
179 from interfaces import * |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
180 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
181 and it needs to be:: |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
182 |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
183 import config |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
184 from dbinit import open, init |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
185 from interfaces import Client, MailGW |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
186 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
187 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
|
188 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
|
189 used: |
|
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 - HEADER_INDEX_LINKS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
192 - HEADER_ADD_LINKS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
193 - HEADER_SEARCH_LINKS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
194 - SEARCH_FILTERS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
195 - DEFAULT_INDEX |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
196 - UNASSIGNED_INDEX |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
197 - USER_INDEX |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
198 - ISSUE_FILTER |
|
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 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
|
201 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
|
202 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
203 - ANONYMOUS_ACCESS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
204 - ANONYMOUS_REGISTER |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
205 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
206 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
|
207 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
|
208 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
209 - NEW_WEB_USER_ROLES |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
210 - NEW_EMAIL_USER_ROLES |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
211 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
212 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
|
213 ``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
|
214 "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
|
215 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
|
216 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
|
217 documentation`_ for more information. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
218 |
|
1096
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
219 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
|
220 |
|
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
221 - 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
|
222 - 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
|
223 - 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
|
224 - 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
|
225 |
|
1008
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 0.5.0 Schema Specification |
|
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 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
230 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
|
231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
232 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
233 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
|
234 to contain:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
235 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
236 # 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
|
237 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
|
238 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
239 it must now contain:: |
|
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 # 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
|
242 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
|
243 |
|
1051
a0c7df67dd9c
Allow a page request to include a :contentonly variable.
Richard Jones <richard@users.sourceforge.net>
parents:
1034
diff
changeset
|
244 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
|
245 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
|
246 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
|
247 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
|
248 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
249 import instance_config |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
250 from roundup import roundupdb |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
251 from select_db import Database |
|
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 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
|
254 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
255 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
|
256 ''' Creates a hybrid database from: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
257 . 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
|
258 . the roundup extensions from roundupdb |
|
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 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
261 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
262 class IssueClass(roundupdb.IssueClass): |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
263 ''' issues need the email information |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
264 ''' |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
265 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
266 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
267 to:: |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
268 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
269 import config |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
270 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
|
271 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
272 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
|
273 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
|
274 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
275 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
|
276 rename them ``config``. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
277 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
278 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
279 0.5.0 Journalling changes |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
280 ~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
281 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
282 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
|
283 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
|
284 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
|
285 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
|
286 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
|
287 probably looks like this:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
288 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
289 msg = FileClass(db, "msg", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
290 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
|
291 date=Date(), summary=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
292 files=Multilink("file"), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
293 messageid=String(), inreplyto=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
294 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
295 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
|
296 ``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
|
297 like so:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
298 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
299 msg = FileClass(db, "msg", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
300 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
|
301 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
|
302 date=Date(), summary=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
303 files=Multilink("file"), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
304 messageid=String(), inreplyto=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
305 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
306 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
|
307 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
|
308 definition from:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
309 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
310 issue = IssueClass(db, "issue", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
311 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
|
312 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
|
313 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
314 to:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
315 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
316 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
|
317 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
|
318 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
|
319 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
320 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
|
321 |
|
1009
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
322 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
323 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
|
324 ~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
325 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
326 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
|
327 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
|
328 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
329 user = Class(db, "user", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
330 username=String(), password=Password(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
331 address=String(), realname=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
332 phone=String(), organisation=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
333 alternate_addresses=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
334 user.setkey("username") |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
335 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
336 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
|
337 like so:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
338 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
339 query = Class(db, "query", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
340 klass=String(), name=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
341 url=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
342 query.setkey("name") |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
343 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
344 # 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
|
345 user = Class(db, "user", |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
346 username=String(), password=Password(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
347 address=String(), realname=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
348 phone=String(), organisation=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
349 alternate_addresses=String(), |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
350 queries=Multilink('query'), roles=String()) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
351 user.setkey("username") |
|
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 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
|
354 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
|
355 Settings`_. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
356 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
357 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
358 0.5.0 Security Settings |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
359 ~~~~~~~~~~~~~~~~~~~~~~~ |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
360 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
361 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
|
362 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
|
363 process: |
|
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 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
|
366 they're specific to, |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
367 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
|
368 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
|
369 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
|
370 (like editing issues). |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
371 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
372 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
|
373 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
|
374 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
|
375 ends with:: |
|
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 import detectors |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
378 detectors.init(db) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
379 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
380 return db |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
381 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
382 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
|
383 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
|
384 these lines:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
385 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
386 # |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
387 # SECURITY SETTINGS |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
388 # |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
389 # new permissions for this schema |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
390 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
|
391 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
|
392 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
|
393 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
|
394 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
|
395 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
396 # 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
|
397 # to regular users now |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
398 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
|
399 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
|
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 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
|
402 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
403 # 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
|
404 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
|
405 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
406 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
|
407 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
408 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
409 # 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
|
410 # 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
|
411 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
|
412 db.security.addPermissionToRole('User', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
413 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
414 # 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
|
415 # Role. Choices here are: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
416 # - 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
|
417 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
|
418 db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
419 # - 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
|
420 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
|
421 db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
422 # - 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
|
423 # 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
|
424 # 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
|
425 #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
|
426 #db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
427 # - 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
|
428 # 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
|
429 # 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
|
430 #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
|
431 #db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
432 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
433 # 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
|
434 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
|
435 db.security.addPermissionToRole('Anonymous', p) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
436 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
437 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
|
438 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
|
439 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
|
440 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
|
441 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
|
442 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
|
443 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
444 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
|
445 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
|
446 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
|
447 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
448 import detectors |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
449 detectors.init(db) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
450 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
451 # 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
|
452 db.post_init() |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
453 return db |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
454 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
455 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
|
456 "``roundup-admin security``" command. |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
457 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
458 |
|
1009
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
459 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
|
460 ~~~~~~~~~~~~~~~~~~ |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
461 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
462 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
|
463 a little too, to: |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
464 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
465 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
|
466 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
|
467 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
|
468 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
469 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
|
470 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
471 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
|
472 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
473 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
|
474 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
|
475 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
|
476 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
|
477 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
|
478 |
| 1271 | 479 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
|
480 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
481 |
|
fc55426544b5
more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents:
1008
diff
changeset
|
482 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
483 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
|
484 --------------------------- |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
485 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
486 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
|
487 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
|
488 changing from:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
489 |
|
1308
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 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
|
491 from roundup.i18n import _ |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
492 |
|
1308
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
493 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
|
494 ''' 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
|
495 with any specific extensions |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
496 ''' |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
497 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
498 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
499 to:: |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
500 |
|
1308
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
501 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
|
502 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
|
503 |
|
1308
bd71c43f0911
fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents:
1271
diff
changeset
|
504 class Client(client.Client): |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
505 ''' 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
|
506 with any specific extensions |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
507 ''' |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
508 pass |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
509 |
|
1034
6afef8529d6c
mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents:
1009
diff
changeset
|
510 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
|
511 cgi-bin directory if you're using it. |
|
6afef8529d6c
mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents:
1009
diff
changeset
|
512 |
|
6afef8529d6c
mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents:
1009
diff
changeset
|
513 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
514 0.5.0 HTML templating |
|
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 You'll want to make a backup of your current tracker html directory. You |
| 1091 | 518 should then copy the html directory from the Roundup source "classic" template |
| 519 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
|
520 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
521 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
|
522 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
|
523 sourceforge, http://roundup.sf.net/) |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
524 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
525 |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
526 0.5.0 Detectors |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
527 --------------- |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
528 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
1051
diff
changeset
|
529 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
|
530 "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
|
531 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
|
532 |
|
0779ea9f1f18
More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents:
798
diff
changeset
|
533 |
|
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
|
534 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
|
535 ============================= |
|
6f6eb43d9d86
Moved the 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 |
|
6f6eb43d9d86
Moved the 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 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
|
538 ------------------- |
|
6f6eb43d9d86
Moved the 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 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
|
540 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
|
541 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
|
542 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
|
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 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
|
545 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
546 - 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
|
547 - 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
|
548 - 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
|
549 |
|
798
faf164ab8ed9
Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents:
782
diff
changeset
|
550 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
|
551 |
|
6f6eb43d9d86
Moved the 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 <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
|
553 |
|
6f6eb43d9d86
Moved the 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 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
|
555 |
|
6f6eb43d9d86
Moved the 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 <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
|
557 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
558 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
|
559 |
|
6f6eb43d9d86
Moved the 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 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
|
562 -------------------------- |
|
6f6eb43d9d86
Moved the 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 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
|
564 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
|
565 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
|
566 |
|
6f6eb43d9d86
Moved the 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 <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
|
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 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
|
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 <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
|
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 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
|
574 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
|
575 |
|
6f6eb43d9d86
Moved the 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 - 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
|
577 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
|
578 - 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
|
579 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
|
580 |
|
6f6eb43d9d86
Moved the 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 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
|
582 |
|
6f6eb43d9d86
Moved the 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 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
|
584 ----------------------------- |
|
6f6eb43d9d86
Moved the 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 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
|
586 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
|
587 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
|
588 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
|
589 |
|
6f6eb43d9d86
Moved the 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 <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
|
591 <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
|
592 <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
|
593 <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
|
594 <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
|
595 </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
|
596 </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
|
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 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
|
599 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
|
600 |
|
6f6eb43d9d86
Moved the 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 <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
|
602 |
|
6f6eb43d9d86
Moved the 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 |
|
6f6eb43d9d86
Moved the 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 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
|
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 |
|
6f6eb43d9d86
Moved the 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 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
|
609 ------------------- |
|
6f6eb43d9d86
Moved the 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 |
|
6f6eb43d9d86
Moved the 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 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
|
612 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
|
613 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
|
614 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
|
615 |
|
6f6eb43d9d86
Moved the 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 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
|
617 ------------------- |
|
6f6eb43d9d86
Moved the 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 |
|
6f6eb43d9d86
Moved the 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 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
|
620 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
|
621 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
|
622 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
|
623 |
|
6f6eb43d9d86
Moved the 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 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
|
625 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
|
626 |
|
6f6eb43d9d86
Moved the 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 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
|
628 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
|
629 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
|
630 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
|
631 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
|
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 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
|
634 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
|
635 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
|
636 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
|
637 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
|
638 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
|
639 |
|
6f6eb43d9d86
Moved the 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 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
|
641 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
|
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 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
|
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 |
|
6f6eb43d9d86
Moved the 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 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
|
647 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
|
648 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
|
649 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
|
650 |
|
6f6eb43d9d86
Moved the 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 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
|
652 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
|
653 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
|
654 |
|
6f6eb43d9d86
Moved the 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 <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
|
656 |
|
6f6eb43d9d86
Moved the 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 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
|
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 <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
|
660 |
|
6f6eb43d9d86
Moved the 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 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
|
662 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
|
663 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
|
664 |
|
6f6eb43d9d86
Moved the 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 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
|
666 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
|
667 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
|
668 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
|
669 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
|
670 |
|
6f6eb43d9d86
Moved the 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 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
|
672 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
|
673 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
|
674 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
|
675 |
|
6f6eb43d9d86
Moved the 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 <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
|
677 |
|
6f6eb43d9d86
Moved the 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 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
|
679 |
|
6f6eb43d9d86
Moved the 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 |
|
6f6eb43d9d86
Moved the 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 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
|
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 |
|
6f6eb43d9d86
Moved the 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 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
|
686 ----------------------------------------- |
|
6f6eb43d9d86
Moved the 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 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
|
688 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
|
689 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
|
690 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
|
691 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
|
692 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
|
693 |
|
6f6eb43d9d86
Moved the 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 <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
|
695 |
|
6f6eb43d9d86
Moved the 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 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
|
697 |
|
6f6eb43d9d86
Moved the 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 <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
|
699 |
|
6f6eb43d9d86
Moved the 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 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
|
701 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
|
702 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
|
703 |
|
6f6eb43d9d86
Moved the 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 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
|
705 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
|
706 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
|
707 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
|
708 |
|
6f6eb43d9d86
Moved the 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 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
|
710 |
|
6f6eb43d9d86
Moved the 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 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
|
712 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
|
713 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
|
714 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
|
715 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
|
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 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
|
718 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
|
719 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
|
720 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
|
721 |
|
6f6eb43d9d86
Moved the 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 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
|
723 |
|
6f6eb43d9d86
Moved the 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 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
|
725 |
|
6f6eb43d9d86
Moved the 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 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
|
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 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
|
730 -------------------- |
|
1096
fa7df238e2d4
More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents:
1091
diff
changeset
|
731 ``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
|
732 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
|
733 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
|
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 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
|
736 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
|
737 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
|
738 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
|
739 |
|
6f6eb43d9d86
Moved the 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 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
|
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 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
|
744 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
|
745 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
|
746 |
|
6f6eb43d9d86
Moved the 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 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
|
749 ------------------ |
|
6f6eb43d9d86
Moved the 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 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
|
751 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
|
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 <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
|
754 |
|
6f6eb43d9d86
Moved the 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 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
|
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 |
|
6f6eb43d9d86
Moved the 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 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
|
759 --------------------- |
|
6f6eb43d9d86
Moved the 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 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
|
761 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
|
762 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
|
763 |
|
6f6eb43d9d86
Moved the 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 |
|
6f6eb43d9d86
Moved the 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 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
|
767 ============================= |
|
6f6eb43d9d86
Moved the 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 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
|
770 ----------------------------------- |
|
6f6eb43d9d86
Moved the 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 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
|
772 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
|
773 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
|
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 <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
|
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 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
|
778 |
|
6f6eb43d9d86
Moved the 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 <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
|
780 |
|
6f6eb43d9d86
Moved the 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 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
|
782 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
|
783 (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
|
784 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
|
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 |
|
6f6eb43d9d86
Moved the 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 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
|
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 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
|
790 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
|
791 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
|
792 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
|
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 <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
|
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 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
|
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 <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
|
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 |
|
6f6eb43d9d86
Moved the 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 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
|
802 |
|
6f6eb43d9d86
Moved the 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 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
|
804 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
|
805 |
|
6f6eb43d9d86
Moved the 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 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
|
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 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
|
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 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
|
811 |
|
6f6eb43d9d86
Moved the 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 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
|
813 |
|
6f6eb43d9d86
Moved the 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 = 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
|
815 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
|
816 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
|
817 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
|
818 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
|
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 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
|
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 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
|
823 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
|
824 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
|
825 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
|
826 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
|
827 |
|
6f6eb43d9d86
Moved the 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 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
|
829 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
|
830 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
|
831 |
|
6f6eb43d9d86
Moved the 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 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
|
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 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
|
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 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
|
838 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
|
839 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
|
840 |
|
6f6eb43d9d86
Moved the 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 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
|
842 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
|
843 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
|
844 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
|
845 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
846 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
847 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
|
848 ---------------------------- |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
849 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
|
850 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
|
851 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
|
852 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
|
853 |
|
6f6eb43d9d86
Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
854 |
|
1008
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
855 .. _`customisation documentation`: customizing.html |
|
10ed4791f969
Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents:
979
diff
changeset
|
856 .. _`security documentation`: security.html |
