chiark / gitweb /
Trivial resampler fixes
[disorder] / README.upgrades
CommitLineData
460b9539 1* Upgrading DisOrder
2
3The general procedure is:
4
5f5fc693
RK
5 * stop the old daemon: /etc/init.d/disorder stop
6 * back up your database directory (example below)
d84bf422 7 * build and install the new version as described in the README. Remember to
8 install the new version of the web interface too.
460b9539 9 * update the configuration files (see below)
10 * start the new daemon, e.g. with
11 /etc/init.d/disorder start
12
13The rest of this file describes things you must pay attention to when
14upgrading between particular versions. Minor versions are not
15explicitly mentioned; a version number like 1.1 implicitly includes
16all 1.1.x versions.
17
ad884aa5 18If you install from .deb files then much of this work is automated.
19
7e4d1dfa
RK
20* 4.x -> 5.0
21
22** Web Confirmation Strings
53710d44
RK
23
24The syntax of confirmation strings for online registrations has changed and old
25ones no longer work. This only affects users who registered before the upgrade
26but have not yet confirmed their login. You can delete such half-created users
27with 'disorder deluser USERNAME' (as an administrative user, for instance as
28root on the server) and they can start the registration process again.
29
7e4d1dfa
RK
30** Handling Of Configuration Changes
31
32There is a new mechanism to ensure that the search database and aliases are
33reconstructed if any options that affect them change. Unfortunately this means
34that the reconstruction step always takes place on upgrade from 4.3 or earlier,
35as those versions don't record sufficient information for the server to tell
36whether it needs to reconstruct or not.
37
38The result will be a log message of the form:
39
40new database parameter string dbparams-0-sha256:61609f3e6395ec8dee317ee216fe2848d70c249d347dd03c6a219441a13dd456 - removing old data
41
42...and a slower rescan on startup. Subsequent restarts should not have this
43problem (unless of course you change a relevant option).
44
45** Deprecation Notices
46
8c37e83b
RK
47The player --wait-for-device option is deprecated and will be removed in a
48future version.
49
7e4d1dfa
RK
50The 'lock' option no longer does anything. You must delete it from any
51configuration files that contain it.
52
cc6241b2 53* 3.0 -> 4.x
77e6d01a
RK
54
55If you customized any of the templates, you will pretty much have to start from
56scratch as the web interface has been rewritten. See disorder.cgi(8) for a
57starting point.
58
59The 'gap' directive will no longer work. You must delete it from any
60configuration files that contain it.
61
62You may prefer to remove any 'smtp_server' directive you have, as the web
63interface will now use the local sendmail executable if available.
64
65If you want to be able to do use management over non-local connections (thereby
66potentially exposing passwords!) you must set 'remote_userman' to 'yes'.
67
5aff007d 68* 2.0 -> 3.0
f0feb22e
RK
69
70** Authentication
71
72Users are now stored in the database rather than in 'allow' directives in a
73private configuration file. 'allow' is still understood in this version, but
74is only used to populate the database on startup. After the first (successful)
04e1fa7c 75run of the server the remaining 'allow' directives should be deleted.
f0feb22e 76
04e1fa7c
RK
77'restrict' and 'trust' are replaced by a system of per-user rights. The
78default user rights are based on the 'restrict' setting, and the rights of
79users created frow 'allow' directives preserve the meaning of 'trust', but
80after the first run you should remove these directives and (optionally) add a
81'default_rights' directive.
82
83'allow', 'restrict' and 'trust' will stop working entirely in a future version
1cf4ef2f
RK
84but for now they will generate harmless error messages. Remove them and the
85error messages will go away.
86
ad884aa5 87See README for new setup instructions for the web interface.
88
1cf4ef2f
RK
89** Other Server Configuration
90
91Sensible defaults for 'stopword', 'player' and 'tracklength' are now built into
92the server. If you haven't modified the values from the example or Debian
93configuration files then you can remove them.
94
95'gap' now defaults to 0 seconds instead of 2.
f0feb22e 96
ad884aa5 97The sound output API is now configured with the 'api' command although
98'speaker_backend' still works. If you use 'api alsa' then you may need to
99change your 'mixer' and 'channel' settings.
100
d84bf422 101** Web Interface
102
103The web interface no longer uses HTTP basic authentication and the web server
104configuration imposing access control on it should be removed. Users now log
105in using their main DisOrder password and the one in the htpassed file is now
1cf4ef2f
RK
106obsolete. You should revisit the web interface setup instructions in README
107from scratch.
d84bf422 108
4fb2cada
RK
109As part of this, the DisOrder URL has changed from (e.g.)
110
111 http://yourserver/cgi-bin/disorder/disorder
112
113to just
114
115 http://yourserver/cgi-bin/disorder
116
ad884aa5 117** Checklist
118
119 * delete default 'stopword', 'player' and 'tracklength' directives
120 * set 'gap' if you want a non-0 inter-track gap
121 * set 'api' and maybe 'mixer' and 'channel'
122 * perhaps add 'default_rights' directive
123 * delete 'allow', 'restrict' and 'trust' directives after first run
124 * follow new web interface setup in README
125
5f5fc693 126* 1.4/1.5 -> 2.0
92afc09e 127
5f5fc693 128** 'transform' and 'namepart' directives
92afc09e 129
5f5fc693
RK
130'transform' has moved from the web options to the main configuration file, so
131that they can be used by other interfaces. The syntax and semantics are
132unchanged.
133
134More importantly however both 'transform' and 'namepart' are now optional, with
135sensible defaults being built in. So if you were already using the default
136values you can just delete all instances of both.
137
138See disorder_config(5) for the default values. Hopefuly they will be suitable
139for many configurations. Please do send feedback.
140
141** 'enabled' and 'random_enabled' directives
142
143These have been removed. Instead the state persists from one run of the server
144to the next. If they appear in your configuration file they must be removed;
145the server will not start if they are present.
146
147** Database upgrade
92afc09e
RK
148
149It is strongly recommended that you back up your database before performing the
150upgrade. For example, as root, with the server STOPPED:
151 cd /var/disorder
152 mkdir BACKUP
153 cp -p * BACKUP
154
155To restore, again as root:
156 cd /var/disorder
157 rm *
158 cp -p BACKUP/* .
460b9539 159
5f5fc693
RK
160The first thing the server does when upgrading from 1.5 is run the
161disorder-dbupgrade program. This is necessary to modify any non-ASCII track
162names to meet the latest version's stricter normalization practices. The
163upgrade should succeed automatically; if not it should leave an error message
164in syslog.
460b9539 165
166* 1.3 -> 1.4
167
168** Raw Format Decoders
169
170You will probably want reconfigure your install to use the new facilities
171(although the old way works fine). See the example configuration file and
172README.raw for more details.
173
174Depending on how your system is configured you may need to link the disorder
175libao driver into the right directory:
176
177 ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
178
179* 1.2 -> 1.3
180
181** Server Environment
182
183It is important that $sbindir is on the server's path. The example init script
184guarantees this. You may need to modify the installed one. You will get
185"deadlock manager unexpectedly terminated" if you get this wrong.
186
187** namepart directives
188
189These have changed in three ways.
190
191Firstly they have changed to substitute in a more convenient way. Instead of
192matches for the regexp being substituted back into the original track name, the
193replacement string now completely replaces it. Given the usual uses of
194namepart, this is much more convenient. If you've stuck with the defaults no
195changes should be needed for this.
196
197Secondly they are matched against the track name with the collection root
198stripped off.
199
200Finally you will need to add an extra line to your config file as follows for
201the new track aliasing mechanisms to work properly:
202
203namepart ext "(\\.[a-zA-Z0-9]+)$" "$1" *
204
205* 1.1 -> 1.2
206
207** Web Interface Changes
208
209The web interface now includes static content as well as templates.
210The static content must be given a name visible to HTTP clients which
211maps to its location in the real filesystem.
212
213The README suggests using a rule in httpd.conf to make /static in the
214HTTP namespace point to /usr/local/share/disorder/static, which is
215where DisOrder installs its static content (by default).
216Alternatively you can set the url.static label to the base URL of the
217static content.
218
219** Configuration File Changes
220
221The trackname-part web interface directive has now gone, and the
222options.trackname file with it.
223
224It is replaced by a new namepart directive in the main configuration
225file. This has exactly the same syntax as trackname-part, only the
226name and location have changed.
227
228The reason for the change is to allow track name parsing to be
229centrally configured, rather than every interface to DisOrder having
230to implement it locally.
231
232If you do not install new namepart directives into the main
233configuration file then track titles will show up blank.
234
235If you do not remove the trackname-part directives from the web
236interface configuration then you will get error messages in the web
237server's error log.
238
239Local Variables:
240mode:outline
241fill-column:79
242End: