X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/d84bf4223d7bda2b5a465d7a37de3b269de0184a..0581deeae30cae3eacf6b3a30b980c84f21b083f:/README diff --git a/README b/README index e62945d..9d80eb4 100644 --- a/README +++ b/README @@ -21,7 +21,7 @@ some other UNIX variants without too much effort. Things you will need: Build dependencies: Name Tested Notes - libdb 4.3.29 4.2 and earlier won't work + libdb 4.3.29 not 4.2.x; 4.4+ might work. libgc 6.8 libvorbisfile 1.1.2 libpcre 6.7 need UTF-8 support @@ -129,7 +129,9 @@ skip steps 1 to 6 and configure it via debconf. This is strongly recommended! If adding new 'player' commands, see README.raw for details on setting up "raw format" players. Non-raw players are still supported but not in all - configurations and they cannot support pausing and gapless play. + configurations and they cannot support pausing and gapless play. If you + want additional formats to be supported natively please point the author at + a GPL-compatible library that can decode them. 5. Make sure the server is started at boot time. @@ -148,8 +150,8 @@ skip steps 1 to 6 and configure it via debconf. This is strongly recommended! start up correctly there should be an error message. Correct the problem and try again. -7. After a minute it should start to play something. Try scratching it (as - root): +7. After a short while it should start to play something. Try scratching it + (as root): disorder scratch @@ -181,31 +183,23 @@ Web Interface "Thought I was a gonner baby, but I'm bullet proof" -These instructions assumes you are using Apache 1.3.x. +As above, if you install from a .deb, much of the work will be done +automatically. You need to configure a number of things to make this work: -1. If you want to have a 'jukebox' virtual host, modify the DNS accordingly and - use a fragment such as this one: - - - DocumentRoot /home/jukebox/public_html - ServerName jukebox.DOMAIN - ServerAlias jukebox - ServerAdmin webmaster@DOMAIN - ErrorLog /var/log/apache/jukebox/error.log - TransferLog /var/log/apache/jukebox/access.log - Alias /static/ /usr/local/share/disorder/static/ - +1. If you want online registration to work then set mail_sender in + /etc/disorder/config to the email address that communications from the web + interface will appear to be sent. If this is not a valid, deliverable email + address then the results are not likely to be reliable. - /static/ should point to the 'static' directory installed by DisOrder. If - you don't want to use the name 'static' then you can change the url.static - label in the web interface configuration to your preferred URL; see - disorder_config(5) for details. + mail_sender webmaster@example.com - Don't forget to reload Apache after modifying its configuration. + By default the web interface sends mail by connecting to the SMTP port of + 127.0.0.1. You can override this with the smtp_server directive, for + exampler: - Separate logging is not required but I find it convenient. Up to you. + smtp_server mail.example.com 2. The web interface depends on a 'guest' user existing. You can create this with the following command: @@ -214,39 +208,47 @@ You need to configure a number of things to make this work: If you don't want to allow online registration instead use: - disorder -- setup-guest --no-online-registration + disorder setup-guest --no-online-registration + +3. Make sure that DisOrder can find its icons and stylesheet. For example in + your web server configuration: + + Alias /disorder/ /usr/local/share/disorder/static/ -3. Install disorder.cgi in an appropriate location. Remember to make it - executable. For example: + Alternatively you could use a symlink from the right location in your + document root, provided your web server is configured to follow them. - install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi + cd /var/www + ln -s /usr/local/share/disorder/static disorder -4. The config file must list the URL of the web interface explicitly: +4. Install disorder.cgi in an appropriate location. Remember to make it + executable. Example: - url http://jukebox.DOMAIN/ + install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder 5. Try it out. You should be able to perform read-only operations straight away, and after visiting the 'Login' page to authenticate, perform other operations like adding a track to the queue. 6. If you run into problems, always look at the appropriate error log; the - message you see in your web browser will usually not be sufficient to - diagnose the problem all by itself. + message you see in your web browser will usually not be sufficient to + diagnose the problem all by itself. 7. If you have a huge number of top level directories, then you might find - that the 'Choose' page is unreasonably large. If so add the following line - to /etc/disorder/options.user: - label sidebar.choosewhich choosealpha + that the 'Choose' page is unreasonably large. If so add the following line + to /etc/disorder/options.user: + label sidebar.choosewhich choosealpha - This will make 'Choose' be a link for each letter of the 26-letter Roman - alphabet; follow the link and you just get the directories which start with - that letter. The "*" link at the end gives you directories which don't - start with a letter. + This will make 'Choose' be a link for each letter of the 26-letter Roman + alphabet; follow the link and you just get the directories which start with + that letter. The "*" link at the end gives you directories which don't + start with a letter. - You can copy choosealpha.html to /etc/disorder and edit it to change the - set of initial choices to anything that can be expressed with regexps. The - regexps must be URL-encoded UTF-8 PCRE regexps. + You can copy choosealpha.html to /etc/disorder and edit it to change the + set of initial choices to anything that can be expressed with regexps. The + regexps must be URL-encoded UTF-8 PCRE regexps. +If you want to give DisOrder its own virtual host, see README.vhost. Copyright =========