X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/b64c2805b65538c7ad9a8b373e00060bbe453b8c..a767291ce9d525f0077463643efc896d79428fcf:/README diff --git a/README b/README index 19a9a72..a80c1cc 100644 --- a/README +++ b/README @@ -181,31 +181,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: +1. If you want online registration to work then you 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, deliberable email + address then the results are not likely to reliable. - - 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/ - + mail_sender webmaster@example.com - /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. + 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: - Don't forget to reload Apache after modifying its configuration. - - 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,35 +206,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/ + + Alternatively you could use a symlink from the right location in your + document root, provided your web server is configured to follow them. + + cd /var/www + ln -s /usr/local/share/disorder/static disorder -3. Install disorder.cgi in an appropriate location. Remember to make it - executable. For example: +4. Install disorder.cgi in an appropriate location. Remember to make it + executable. Example: - install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi + install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder -4. Try it out. You should be able to perform read-only operations straight +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. -5. 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. +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. -6. 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 +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 - 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 =========