3 The general procedure is:
5 * stop the old daemon: /etc/init.d/disorder stop
6 * back up your database directory (example below)
7 * build and install the new version as described in the README. Remember to
8 install the new version of the web interface too.
9 * update the configuration files (see below)
10 * start the new daemon, e.g. with
11 /etc/init.d/disorder start
13 The rest of this file describes things you must pay attention to when
14 upgrading between particular versions. Minor versions are not
15 explicitly mentioned; a version number like 1.1 implicitly includes
18 If you install from .deb files then much of this work is automated.
22 The syntax of confirmation strings for online registrations has changed and old
23 ones no longer work. This only affects users who registered before the upgrade
24 but have not yet confirmed their login. You can delete such half-created users
25 with 'disorder deluser USERNAME' (as an administrative user, for instance as
26 root on the server) and they can start the registration process again.
30 If you customized any of the templates, you will pretty much have to start from
31 scratch as the web interface has been rewritten. See disorder.cgi(8) for a
34 The 'gap' directive will no longer work. You must delete it from any
35 configuration files that contain it.
37 You may prefer to remove any 'smtp_server' directive you have, as the web
38 interface will now use the local sendmail executable if available.
40 If you want to be able to do use management over non-local connections (thereby
41 potentially exposing passwords!) you must set 'remote_userman' to 'yes'.
47 Users are now stored in the database rather than in 'allow' directives in a
48 private configuration file. 'allow' is still understood in this version, but
49 is only used to populate the database on startup. After the first (successful)
50 run of the server the remaining 'allow' directives should be deleted.
52 'restrict' and 'trust' are replaced by a system of per-user rights. The
53 default user rights are based on the 'restrict' setting, and the rights of
54 users created frow 'allow' directives preserve the meaning of 'trust', but
55 after the first run you should remove these directives and (optionally) add a
56 'default_rights' directive.
58 'allow', 'restrict' and 'trust' will stop working entirely in a future version
59 but for now they will generate harmless error messages. Remove them and the
60 error messages will go away.
62 See README for new setup instructions for the web interface.
64 ** Other Server Configuration
66 Sensible defaults for 'stopword', 'player' and 'tracklength' are now built into
67 the server. If you haven't modified the values from the example or Debian
68 configuration files then you can remove them.
70 'gap' now defaults to 0 seconds instead of 2.
72 The sound output API is now configured with the 'api' command although
73 'speaker_backend' still works. If you use 'api alsa' then you may need to
74 change your 'mixer' and 'channel' settings.
78 The web interface no longer uses HTTP basic authentication and the web server
79 configuration imposing access control on it should be removed. Users now log
80 in using their main DisOrder password and the one in the htpassed file is now
81 obsolete. You should revisit the web interface setup instructions in README
84 As part of this, the DisOrder URL has changed from (e.g.)
86 http://yourserver/cgi-bin/disorder/disorder
90 http://yourserver/cgi-bin/disorder
94 * delete default 'stopword', 'player' and 'tracklength' directives
95 * set 'gap' if you want a non-0 inter-track gap
96 * set 'api' and maybe 'mixer' and 'channel'
97 * perhaps add 'default_rights' directive
98 * delete 'allow', 'restrict' and 'trust' directives after first run
99 * follow new web interface setup in README
103 ** 'transform' and 'namepart' directives
105 'transform' has moved from the web options to the main configuration file, so
106 that they can be used by other interfaces. The syntax and semantics are
109 More importantly however both 'transform' and 'namepart' are now optional, with
110 sensible defaults being built in. So if you were already using the default
111 values you can just delete all instances of both.
113 See disorder_config(5) for the default values. Hopefuly they will be suitable
114 for many configurations. Please do send feedback.
116 ** 'enabled' and 'random_enabled' directives
118 These have been removed. Instead the state persists from one run of the server
119 to the next. If they appear in your configuration file they must be removed;
120 the server will not start if they are present.
124 It is strongly recommended that you back up your database before performing the
125 upgrade. For example, as root, with the server STOPPED:
130 To restore, again as root:
135 The first thing the server does when upgrading from 1.5 is run the
136 disorder-dbupgrade program. This is necessary to modify any non-ASCII track
137 names to meet the latest version's stricter normalization practices. The
138 upgrade should succeed automatically; if not it should leave an error message
143 ** Raw Format Decoders
145 You will probably want reconfigure your install to use the new facilities
146 (although the old way works fine). See the example configuration file and
147 README.raw for more details.
149 Depending on how your system is configured you may need to link the disorder
150 libao driver into the right directory:
152 ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
156 ** Server Environment
158 It is important that $sbindir is on the server's path. The example init script
159 guarantees this. You may need to modify the installed one. You will get
160 "deadlock manager unexpectedly terminated" if you get this wrong.
162 ** namepart directives
164 These have changed in three ways.
166 Firstly they have changed to substitute in a more convenient way. Instead of
167 matches for the regexp being substituted back into the original track name, the
168 replacement string now completely replaces it. Given the usual uses of
169 namepart, this is much more convenient. If you've stuck with the defaults no
170 changes should be needed for this.
172 Secondly they are matched against the track name with the collection root
175 Finally you will need to add an extra line to your config file as follows for
176 the new track aliasing mechanisms to work properly:
178 namepart ext "(\\.[a-zA-Z0-9]+)$" "$1" *
182 ** Web Interface Changes
184 The web interface now includes static content as well as templates.
185 The static content must be given a name visible to HTTP clients which
186 maps to its location in the real filesystem.
188 The README suggests using a rule in httpd.conf to make /static in the
189 HTTP namespace point to /usr/local/share/disorder/static, which is
190 where DisOrder installs its static content (by default).
191 Alternatively you can set the url.static label to the base URL of the
194 ** Configuration File Changes
196 The trackname-part web interface directive has now gone, and the
197 options.trackname file with it.
199 It is replaced by a new namepart directive in the main configuration
200 file. This has exactly the same syntax as trackname-part, only the
201 name and location have changed.
203 The reason for the change is to allow track name parsing to be
204 centrally configured, rather than every interface to DisOrder having
205 to implement it locally.
207 If you do not install new namepart directives into the main
208 configuration file then track titles will show up blank.
210 If you do not remove the trackname-part directives from the web
211 interface configuration then you will get error messages in the web