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 If you customized any of the templates, you will pretty much have to start from
23 scratch as the web interface has been rewritten. See disorder.cgi(8) for a
26 The 'gap' directive will no longer work. You must delete it from any
27 configuration files that contain it.
29 You may prefer to remove any 'smtp_server' directive you have, as the web
30 interface will now use the local sendmail executable if available.
32 If you want to be able to do use management over non-local connections (thereby
33 potentially exposing passwords!) you must set 'remote_userman' to 'yes'.
39 Users are now stored in the database rather than in 'allow' directives in a
40 private configuration file. 'allow' is still understood in this version, but
41 is only used to populate the database on startup. After the first (successful)
42 run of the server the remaining 'allow' directives should be deleted.
44 'restrict' and 'trust' are replaced by a system of per-user rights. The
45 default user rights are based on the 'restrict' setting, and the rights of
46 users created frow 'allow' directives preserve the meaning of 'trust', but
47 after the first run you should remove these directives and (optionally) add a
48 'default_rights' directive.
50 'allow', 'restrict' and 'trust' will stop working entirely in a future version
51 but for now they will generate harmless error messages. Remove them and the
52 error messages will go away.
54 See README for new setup instructions for the web interface.
56 ** Other Server Configuration
58 Sensible defaults for 'stopword', 'player' and 'tracklength' are now built into
59 the server. If you haven't modified the values from the example or Debian
60 configuration files then you can remove them.
62 'gap' now defaults to 0 seconds instead of 2.
64 The sound output API is now configured with the 'api' command although
65 'speaker_backend' still works. If you use 'api alsa' then you may need to
66 change your 'mixer' and 'channel' settings.
70 The web interface no longer uses HTTP basic authentication and the web server
71 configuration imposing access control on it should be removed. Users now log
72 in using their main DisOrder password and the one in the htpassed file is now
73 obsolete. You should revisit the web interface setup instructions in README
76 As part of this, the DisOrder URL has changed from (e.g.)
78 http://yourserver/cgi-bin/disorder/disorder
82 http://yourserver/cgi-bin/disorder
86 * delete default 'stopword', 'player' and 'tracklength' directives
87 * set 'gap' if you want a non-0 inter-track gap
88 * set 'api' and maybe 'mixer' and 'channel'
89 * perhaps add 'default_rights' directive
90 * delete 'allow', 'restrict' and 'trust' directives after first run
91 * follow new web interface setup in README
95 ** 'transform' and 'namepart' directives
97 'transform' has moved from the web options to the main configuration file, so
98 that they can be used by other interfaces. The syntax and semantics are
101 More importantly however both 'transform' and 'namepart' are now optional, with
102 sensible defaults being built in. So if you were already using the default
103 values you can just delete all instances of both.
105 See disorder_config(5) for the default values. Hopefuly they will be suitable
106 for many configurations. Please do send feedback.
108 ** 'enabled' and 'random_enabled' directives
110 These have been removed. Instead the state persists from one run of the server
111 to the next. If they appear in your configuration file they must be removed;
112 the server will not start if they are present.
116 It is strongly recommended that you back up your database before performing the
117 upgrade. For example, as root, with the server STOPPED:
122 To restore, again as root:
127 The first thing the server does when upgrading from 1.5 is run the
128 disorder-dbupgrade program. This is necessary to modify any non-ASCII track
129 names to meet the latest version's stricter normalization practices. The
130 upgrade should succeed automatically; if not it should leave an error message
135 ** Raw Format Decoders
137 You will probably want reconfigure your install to use the new facilities
138 (although the old way works fine). See the example configuration file and
139 README.raw for more details.
141 Depending on how your system is configured you may need to link the disorder
142 libao driver into the right directory:
144 ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
148 ** Server Environment
150 It is important that $sbindir is on the server's path. The example init script
151 guarantees this. You may need to modify the installed one. You will get
152 "deadlock manager unexpectedly terminated" if you get this wrong.
154 ** namepart directives
156 These have changed in three ways.
158 Firstly they have changed to substitute in a more convenient way. Instead of
159 matches for the regexp being substituted back into the original track name, the
160 replacement string now completely replaces it. Given the usual uses of
161 namepart, this is much more convenient. If you've stuck with the defaults no
162 changes should be needed for this.
164 Secondly they are matched against the track name with the collection root
167 Finally you will need to add an extra line to your config file as follows for
168 the new track aliasing mechanisms to work properly:
170 namepart ext "(\\.[a-zA-Z0-9]+)$" "$1" *
174 ** Web Interface Changes
176 The web interface now includes static content as well as templates.
177 The static content must be given a name visible to HTTP clients which
178 maps to its location in the real filesystem.
180 The README suggests using a rule in httpd.conf to make /static in the
181 HTTP namespace point to /usr/local/share/disorder/static, which is
182 where DisOrder installs its static content (by default).
183 Alternatively you can set the url.static label to the base URL of the
186 ** Configuration File Changes
188 The trackname-part web interface directive has now gone, and the
189 options.trackname file with it.
191 It is replaced by a new namepart directive in the main configuration
192 file. This has exactly the same syntax as trackname-part, only the
193 name and location have changed.
195 The reason for the change is to allow track name parsing to be
196 centrally configured, rather than every interface to DisOrder having
197 to implement it locally.
199 If you do not install new namepart directives into the main
200 configuration file then track titles will show up blank.
202 If you do not remove the trackname-part directives from the web
203 interface configuration then you will get error messages in the web