Import ezmlm-idx 0.40
[ezmlm] / UPGRADE.idx
1 $Id: UPGRADE.idx,v 1.39 1999/12/19 16:47:30 lindberg Exp $
2 $Name: ezmlm-idx-040 $
3
4 Like any other piece of software (and information generally), ezmlm-idx
5 comes with NO WARRANTY.
6
7 This file is for upgrading from earlier version of ezmlm-idx/mod. If you use
8 ezmlm-0.53 but have not installed a previous version of ezmlm-idx,
9 see INSTALL.idx. For details on what's new in this version, see CHANGES.idx.
10
11 1. Proceed as per INSTALL.idx.
12 NOTE: If you follow the test instructions in INSTALL of ezmlm-0.53 after
13 adding ezmlm-idx, step 6 will fail. Before this step, edit
14 ~/testlist/editor and remove the ezmlm-reject line.
15
16
17 Steps required for upgrading from ezmlm-idx-0.31x/32x
18 -----------------------------------------------------
19 In the unlikely event that you have lists that have been manually configured
20 to use ezmlm-gate (sender check/moderation combination) using only a single
21 directory, add the same directory to the command line a second time. If you
22 do not do this, all messages will be moderated, i.e. no major problem. No
23 other changes are required, but you may want to use some of the new features
24 (see CHANGES.idx).
25
26 See below to migrate customized ezmlmrc files.
27
28 Run ezmlm-idx on your lists. The index file format has changed. The old
29 format will still work, but only the new format can be used with WWW archive
30 access.
31
32 To enable WWW archive access for your list(s) see the "Optional" section in
33 INSTALL.idx.
34
35 If you used MySQL support, you need to update the tables. A few new fields
36 have been added for performance moitoring and billing. sub_mysql/to40x will
37 generate the necessary SQL. For each list, do:
38
39 sh sub_mysql/to40x list | mysql ...
40
41 where ``list'' is the tableroot for the list.
42
43 Additional steps for upgrading from ezmlm-idx-0.30x
44 ---------------------------------------------------
45
46 If your old lists use SENDER restriction on posts with aliases (DIR/extra)
47 and blacklisted addresses (DIR/blacklist) you need to change the name of
48 these directories to DIR/allow and DIR/deny, respectively, and rebuild the list
49 (see below). Without this change the list will still function normally, but
50 addresses cannot be added/removed from these addresses remotely (e.g. via
51 list-allow-subscribe). Other than this, your lists will function without
52 modifications if you are upgrading from ezmlm-idx>=0.30.
53
54 See below for changing the names of the extra databases.
55
56
57 Additional steps for upgrading from ezmlm-idx<0.30
58 --------------------------------------------------
59 1. Reindex the subject index for existing lists:
60
61 % ezmlm-idx DIR
62
63 for each list directory 'DIR'.
64
65 2. For existing digest lists, assuming the list "joe-sos" and the digest list
66 "joe-sos-digest".
67
68 a. Remove links to the digest list:
69
70 % rm -f ~joe/.qmail-sos-digest*
71
72 b. edit the main list to include a digest list:
73
74 % ezmlm-make -edxxx ~joe/SOS ~joe/.qmail joe-sos id.com gaga
75
76 where 'xxx' are switches used in creating the original list. For lists
77 created with ezmlm-idx-0.23 or later, the arguments after the list
78 directory may be omitted.
79
80 c. Move the digest subscriber info:
81
82 % mv ~joe/SOS-digest/subscribers/* ~joe/SOS/digest/subscribers
83
84 The digest list bounce info will be lost, as the key used for the new
85 digest is the same as for the list, and different for that from the old
86 digest. At worst, this will make the info for a digest user on missed
87 digests incomplete. It may also slightly delay the removal
88 of a permanently bouncing subscriber addresses.
89
90
91 Additional steps for upgrading from ezmlm-idx<0.23x
92 ---------------------------------------------------
93 For subscription-moderated lists created with ezmlm-idx<0.23:
94
95 1. If you have subscription moderated lists created with ezmlm-idx<0.23,
96 they likely lack dir/text/mod-sub-confirm and dir/text/mod-unsub-confirm.
97 Ezmlm-idx-0.23 substituted dir/text/(un)sub-confirm if the above files were
98 missing, but ezmlm-idx>=0.30 will not work without these files. Again,
99 ezmlm-make -e is the easiest way to update the list. Alternatively,
100 just copy dir/text/(un)sub-confirm to dir/text/mod-(un)sub-confirm.
101
102 ------------------------------------------------------------------------------
103 That's it! To report success (this helps to track platform-specific problems):
104
105 % ( echo 'First M. Last'; cat `cat SYSDEPS` ) \
106 | mail cfl-src@id.wustl.edu
107
108 Replace First M. Last with your name.
109
110 Send bugs reports, ideally with patch, to 'lindberg@id.wustl.edu'.
111
112
113 ------------------------------------------------------------------------------
114
115
116 Additional information
117 ------------------------
118
119 Migrating customized ezmlmrc files
120 ==================================
121
122 ezmlmrc is upgraded from ezmlm-idx-0.31x/32x, but the changes are not required
123 for using the list.
124
125 The changes from ezmlm-0.30x are minimal, but fix a couple of bugs, see
126 CHANGES.idx). If you have custom ezmlmrc files and wish to update them,
127 do the following:
128
129 First create a diff between the old ezmlmrc distribution and the
130 custom ezmlmrc file:
131
132 % cp /usr/local/bin/ezmlm/ezmlmrc ~/ezmlmrc.orig
133 % cp ~/.ezmlmrc ~/ezmlmrc
134 % diff -c ~/ezmlmrc.orig ~/ezmlmrc ~/ezmlmrc.diff
135
136 Next, apply the changes to the new ezmlmrc:
137
138 % cp .../ezmlm-idx-0.33/ezmlmrc ~/ezmlmrc
139 % patch ~/ezmlmrc < ~/ezmlmrc.diff
140
141 Next check for rejected parts (you need to apply them manually):
142
143 % cat ~/ezmlmrc.rej
144
145 Any existing list can be edited with 'ezmlm-make -e dir dot local host [code]'
146 with the appropriate switches to take advantage of new ezmlm functions. If
147 you make ezmlmrc files in other languages, please make them public domain and
148 mail them to lindberg@id.wustl.edu for inclusion in future versions of
149 ezmlm-idx.
150
151 Adjusting the name of the extra databases (from ezmlm-idx<0.30):
152 ===============================================================
153
154 % mv DIR/extra DIR/allow
155 % mv DIR/blacklist DIR/deny
156 % ezmlm-make -+ DIR
157
158 Additional steps required when upgrading from ezmlm-idx<0.30:
159
160 1. Reindex the subject index for existing lists:
161
162 % ezmlm-idx DIR
163
164 for each list directory 'DIR'.
165
166 2. For existing digest lists, assuming the list "joe-sos" and the digest list
167 "joe-sos-digest".
168
169 a. Remove links to the digest list:
170
171 % rm -f ~joe/.qmail-sos-digest*
172
173 b. edit the main list to include a digest list:
174
175 % ezmlm-make -edxxx ~joe/SOS ~joe/.qmail joe-sos id.com gaga
176
177 where 'xxx' are switches used in creating the original list. For lists
178 created with ezmlm-idx-0.23 or later, the arguments after the list
179 directory may be omitted.
180
181 c. Move the digest subscriber info:
182
183 % mv ~joe/SOS-digest/subscribers/* ~joe/SOS/digest/subscribers
184
185 The digest list bounce info will be lost, as the key used for the new
186 digest is the same as for the list, and different for that from the old
187 digest. At worst, this will make the info for a digest user on missed
188 digests incomplete. It may also slightly delay the removal
189 of a permanently bouncing subscriber addresses.
190