chiark / gitweb /
remove obsolete debian web config stuff
[disorder] / README.upgrades
1 * Upgrading DisOrder
2
3 The general procedure is:
4
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
12
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
16 all 1.1.x versions.
17
18 * 2.0 -> 2.1
19
20 ** Authentication
21
22 Users are now stored in the database rather than in 'allow' directives in a
23 private configuration file.  'allow' is still understood in this version, but
24 is only used to populate the database on startup.  After the first (successful)
25 run of the server the remaining 'allow' directives should be deleted.
26
27 'restrict' and 'trust' are replaced by a system of per-user rights.  The
28 default user rights are based on the 'restrict' setting, and the rights of
29 users created frow 'allow' directives preserve the meaning of 'trust', but
30 after the first run you should remove these directives and (optionally) add a
31 'default_rights' directive.
32
33 'allow', 'restrict' and 'trust' will stop working entirely in a future version
34 but for now they will generate harmless error messages.
35
36 ** Web Interface
37
38 The web interface no longer uses HTTP basic authentication and the web server
39 configuration imposing access control on it should be removed.  Users now log
40 in using their main DisOrder password and the one in the htpassed file is now
41 obsolete.
42
43 * 1.4/1.5 -> 2.0
44
45 ** 'transform' and 'namepart' directives
46
47 'transform' has moved from the web options to the main configuration file, so
48 that they can be used by other interfaces.  The syntax and semantics are
49 unchanged.
50
51 More importantly however both 'transform' and 'namepart' are now optional, with
52 sensible defaults being built in.  So if you were already using the default
53 values you can just delete all instances of both.
54
55 See disorder_config(5) for the default values.  Hopefuly they will be suitable
56 for many configurations.  Please do send feedback.
57
58 ** 'enabled' and 'random_enabled' directives
59
60 These have been removed.  Instead the state persists from one run of the server
61 to the next.  If they appear in your configuration file they must be removed;
62 the server will not start if they are present.
63
64 ** Database upgrade
65
66 It is strongly recommended that you back up your database before performing the
67 upgrade.  For example, as root, with the server STOPPED:
68   cd /var/disorder
69   mkdir BACKUP
70   cp -p * BACKUP
71
72 To restore, again as root:
73   cd /var/disorder
74   rm *
75   cp -p BACKUP/* .
76
77 The first thing the server does when upgrading from 1.5 is run the
78 disorder-dbupgrade program.  This is necessary to modify any non-ASCII track
79 names to meet the latest version's stricter normalization practices.  The
80 upgrade should succeed automatically; if not it should leave an error message
81 in syslog.
82
83 * 1.3 -> 1.4
84
85 ** Raw Format Decoders
86
87 You will probably want reconfigure your install to use the new facilities
88 (although the old way works fine).  See the example configuration file and
89 README.raw for more details.
90
91 Depending on how your system is configured you may need to link the disorder
92 libao driver into the right directory:
93
94    ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
95
96 * 1.2 -> 1.3
97
98 ** Server Environment
99
100 It is important that $sbindir is on the server's path.  The example init script
101 guarantees this.  You may need to modify the installed one.  You will get
102 "deadlock manager unexpectedly terminated" if you get this wrong.
103
104 ** namepart directives
105
106 These have changed in three ways.
107
108 Firstly they have changed to substitute in a more convenient way.  Instead of
109 matches for the regexp being substituted back into the original track name, the
110 replacement string now completely replaces it.  Given the usual uses of
111 namepart, this is much more convenient.  If you've stuck with the defaults no
112 changes should be needed for this.
113
114 Secondly they are matched against the track name with the collection root
115 stripped off.
116
117 Finally you will need to add an extra line to your config file as follows for
118 the new track aliasing mechanisms to work properly:
119
120 namepart        ext     "(\\.[a-zA-Z0-9]+)$"                   "$1"    *
121
122 * 1.1 -> 1.2
123
124 ** Web Interface Changes
125
126 The web interface now includes static content as well as templates.
127 The static content must be given a name visible to HTTP clients which
128 maps to its location in the real filesystem.
129
130 The README suggests using a rule in httpd.conf to make /static in the
131 HTTP namespace point to /usr/local/share/disorder/static, which is
132 where DisOrder installs its static content (by default).
133 Alternatively you can set the url.static label to the base URL of the
134 static content.
135
136 ** Configuration File Changes
137
138 The trackname-part web interface directive has now gone, and the
139 options.trackname file with it.
140
141 It is replaced by a new namepart directive in the main configuration
142 file.  This has exactly the same syntax as trackname-part, only the
143 name and location have changed.
144
145 The reason for the change is to allow track name parsing to be
146 centrally configured, rather than every interface to DisOrder having
147 to implement it locally.
148
149 If you do not install new namepart directives into the main
150 configuration file then track titles will show up blank.
151
152 If you do not remove the trackname-part directives from the web
153 interface configuration then you will get error messages in the web
154 server's error log.
155
156 Local Variables:
157 mode:outline
158 fill-column:79
159 End: