chiark / gitweb /
Move track sorting to its own function. Only choose_populate() uses
[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
77e6d01a
RK
20* 3.0 -> 3.1
21
22If you customized any of the templates, you will pretty much have to start from
23scratch as the web interface has been rewritten. See disorder.cgi(8) for a
24starting point.
25
26The 'gap' directive will no longer work. You must delete it from any
27configuration files that contain it.
28
29You may prefer to remove any 'smtp_server' directive you have, as the web
30interface will now use the local sendmail executable if available.
31
32If you want to be able to do use management over non-local connections (thereby
33potentially exposing passwords!) you must set 'remote_userman' to 'yes'.
34
5aff007d 35* 2.0 -> 3.0
f0feb22e
RK
36
37** Authentication
38
39Users are now stored in the database rather than in 'allow' directives in a
40private configuration file. 'allow' is still understood in this version, but
41is only used to populate the database on startup. After the first (successful)
04e1fa7c 42run of the server the remaining 'allow' directives should be deleted.
f0feb22e 43
04e1fa7c
RK
44'restrict' and 'trust' are replaced by a system of per-user rights. The
45default user rights are based on the 'restrict' setting, and the rights of
46users created frow 'allow' directives preserve the meaning of 'trust', but
47after the first run you should remove these directives and (optionally) add a
48'default_rights' directive.
49
50'allow', 'restrict' and 'trust' will stop working entirely in a future version
1cf4ef2f
RK
51but for now they will generate harmless error messages. Remove them and the
52error messages will go away.
53
ad884aa5 54See README for new setup instructions for the web interface.
55
1cf4ef2f
RK
56** Other Server Configuration
57
58Sensible defaults for 'stopword', 'player' and 'tracklength' are now built into
59the server. If you haven't modified the values from the example or Debian
60configuration files then you can remove them.
61
62'gap' now defaults to 0 seconds instead of 2.
f0feb22e 63
ad884aa5 64The 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
66change your 'mixer' and 'channel' settings.
67
d84bf422 68** Web Interface
69
70The web interface no longer uses HTTP basic authentication and the web server
71configuration imposing access control on it should be removed. Users now log
72in using their main DisOrder password and the one in the htpassed file is now
1cf4ef2f
RK
73obsolete. You should revisit the web interface setup instructions in README
74from scratch.
d84bf422 75
ad884aa5 76** Checklist
77
78 * delete default 'stopword', 'player' and 'tracklength' directives
79 * set 'gap' if you want a non-0 inter-track gap
80 * set 'api' and maybe 'mixer' and 'channel'
81 * perhaps add 'default_rights' directive
82 * delete 'allow', 'restrict' and 'trust' directives after first run
83 * follow new web interface setup in README
84
5f5fc693 85* 1.4/1.5 -> 2.0
92afc09e 86
5f5fc693 87** 'transform' and 'namepart' directives
92afc09e 88
5f5fc693
RK
89'transform' has moved from the web options to the main configuration file, so
90that they can be used by other interfaces. The syntax and semantics are
91unchanged.
92
93More importantly however both 'transform' and 'namepart' are now optional, with
94sensible defaults being built in. So if you were already using the default
95values you can just delete all instances of both.
96
97See disorder_config(5) for the default values. Hopefuly they will be suitable
98for many configurations. Please do send feedback.
99
100** 'enabled' and 'random_enabled' directives
101
102These have been removed. Instead the state persists from one run of the server
103to the next. If they appear in your configuration file they must be removed;
104the server will not start if they are present.
105
106** Database upgrade
92afc09e
RK
107
108It is strongly recommended that you back up your database before performing the
109upgrade. For example, as root, with the server STOPPED:
110 cd /var/disorder
111 mkdir BACKUP
112 cp -p * BACKUP
113
114To restore, again as root:
115 cd /var/disorder
116 rm *
117 cp -p BACKUP/* .
460b9539 118
5f5fc693
RK
119The first thing the server does when upgrading from 1.5 is run the
120disorder-dbupgrade program. This is necessary to modify any non-ASCII track
121names to meet the latest version's stricter normalization practices. The
122upgrade should succeed automatically; if not it should leave an error message
123in syslog.
460b9539 124
125* 1.3 -> 1.4
126
127** Raw Format Decoders
128
129You will probably want reconfigure your install to use the new facilities
130(although the old way works fine). See the example configuration file and
131README.raw for more details.
132
133Depending on how your system is configured you may need to link the disorder
134libao driver into the right directory:
135
136 ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
137
138* 1.2 -> 1.3
139
140** Server Environment
141
142It is important that $sbindir is on the server's path. The example init script
143guarantees this. You may need to modify the installed one. You will get
144"deadlock manager unexpectedly terminated" if you get this wrong.
145
146** namepart directives
147
148These have changed in three ways.
149
150Firstly they have changed to substitute in a more convenient way. Instead of
151matches for the regexp being substituted back into the original track name, the
152replacement string now completely replaces it. Given the usual uses of
153namepart, this is much more convenient. If you've stuck with the defaults no
154changes should be needed for this.
155
156Secondly they are matched against the track name with the collection root
157stripped off.
158
159Finally you will need to add an extra line to your config file as follows for
160the new track aliasing mechanisms to work properly:
161
162namepart ext "(\\.[a-zA-Z0-9]+)$" "$1" *
163
164* 1.1 -> 1.2
165
166** Web Interface Changes
167
168The web interface now includes static content as well as templates.
169The static content must be given a name visible to HTTP clients which
170maps to its location in the real filesystem.
171
172The README suggests using a rule in httpd.conf to make /static in the
173HTTP namespace point to /usr/local/share/disorder/static, which is
174where DisOrder installs its static content (by default).
175Alternatively you can set the url.static label to the base URL of the
176static content.
177
178** Configuration File Changes
179
180The trackname-part web interface directive has now gone, and the
181options.trackname file with it.
182
183It is replaced by a new namepart directive in the main configuration
184file. This has exactly the same syntax as trackname-part, only the
185name and location have changed.
186
187The reason for the change is to allow track name parsing to be
188centrally configured, rather than every interface to DisOrder having
189to implement it locally.
190
191If you do not install new namepart directives into the main
192configuration file then track titles will show up blank.
193
194If you do not remove the trackname-part directives from the web
195interface configuration then you will get error messages in the web
196server's error log.
197
198Local Variables:
199mode:outline
200fill-column:79
201End: