chiark / gitweb /
word break now comes from the table
[disorder] / README.upgrades
CommitLineData
460b9539 1* Upgrading DisOrder
2
3The general procedure is:
4
5 * stop the old daemon, e.g. with
6 /etc/init.d/disorder stop
7 * build and install the new version as described in the README
8 * update the configuration files (see below)
9 * start the new daemon, e.g. with
10 /etc/init.d/disorder start
11
12The rest of this file describes things you must pay attention to when
13upgrading between particular versions. Minor versions are not
14explicitly mentioned; a version number like 1.1 implicitly includes
15all 1.1.x versions.
16
17* 1.5 -> 1.6
18
19** 'transform' and 'namepart' directives
20
21'transform' has moved from the web options to the main configuration file, so
22that they can be used by other interfaces. The syntax and semantics are
23unchanged.
24
25More importantly however both 'transform' and 'namepart' are now optional, with
26sensible defaults being built in. So if you were already using the default
27values you can just delete all instances of both.
28
29** enabled' and 'random_enabled' directives
30
31These have been removed. Instead the state persists from one run of the server
32to the next.
33
34* 1.3 -> 1.4
35
36** Raw Format Decoders
37
38You will probably want reconfigure your install to use the new facilities
39(although the old way works fine). See the example configuration file and
40README.raw for more details.
41
42Depending on how your system is configured you may need to link the disorder
43libao driver into the right directory:
44
45 ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
46
47* 1.2 -> 1.3
48
49** Server Environment
50
51It is important that $sbindir is on the server's path. The example init script
52guarantees this. You may need to modify the installed one. You will get
53"deadlock manager unexpectedly terminated" if you get this wrong.
54
55** namepart directives
56
57These have changed in three ways.
58
59Firstly they have changed to substitute in a more convenient way. Instead of
60matches for the regexp being substituted back into the original track name, the
61replacement string now completely replaces it. Given the usual uses of
62namepart, this is much more convenient. If you've stuck with the defaults no
63changes should be needed for this.
64
65Secondly they are matched against the track name with the collection root
66stripped off.
67
68Finally you will need to add an extra line to your config file as follows for
69the new track aliasing mechanisms to work properly:
70
71namepart ext "(\\.[a-zA-Z0-9]+)$" "$1" *
72
73* 1.1 -> 1.2
74
75** Web Interface Changes
76
77The web interface now includes static content as well as templates.
78The static content must be given a name visible to HTTP clients which
79maps to its location in the real filesystem.
80
81The README suggests using a rule in httpd.conf to make /static in the
82HTTP namespace point to /usr/local/share/disorder/static, which is
83where DisOrder installs its static content (by default).
84Alternatively you can set the url.static label to the base URL of the
85static content.
86
87** Configuration File Changes
88
89The trackname-part web interface directive has now gone, and the
90options.trackname file with it.
91
92It is replaced by a new namepart directive in the main configuration
93file. This has exactly the same syntax as trackname-part, only the
94name and location have changed.
95
96The reason for the change is to allow track name parsing to be
97centrally configured, rather than every interface to DisOrder having
98to implement it locally.
99
100If you do not install new namepart directives into the main
101configuration file then track titles will show up blank.
102
103If you do not remove the trackname-part directives from the web
104interface configuration then you will get error messages in the web
105server's error log.
106
107Local Variables:
108mode:outline
109fill-column:79
110End: