* It supports both ALSA and OSS and can also broadcast an RTP stream over a
LAN; a player for the latter is included.
* Tracks may be selected either via a hierarchical interface or by a fast
- word search.
+ word or tag search.
* It has a web interface (allowing access from graphical web browsers) and a
GTK+ interface that runs on Linux and Mac systems.
* Playing tracks can be paused or cancelled ("scratched").
-See CHANGES for details of recent changes to DisOrder.
+See CHANGES.html for details of recent changes to DisOrder and README.upgrades
+for upgrade instructions.
-The server supports Linux and can be made to work on a Mac (see README.mac).
-The clients work on both Linux and the Mac. It could probably be ported to
-some other UNIX variants without too much effort. Things you will need:
+Platform support:
+ Linux Well tested on Debian
+ Mac OS X Disobedience well tested, server somewhat tested; use fink
+ FreeBSD Scantily tested; use ports for dependencies
+It could probably be ported to some other UNIX variants without too much
+effort.
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
"Tested" means I've built against that version; earlier or later versions will
often work too.
-Runtime dependencies:
- * Web server:
- + Apache 1.3.x works for me, but anything that supports CGI and
- authentication should be suitable.
- * Separate player programs are no longer required (but may still be used)
+For the web interface to work you will additionally need a web server. I've
+had both Apache 1.3.x and 2.x working. Anything that supports CGI should be
+OK.
-Development dependencies (only developers will need these):
- Automake 1.10 AM_PATH_PYTHON not good enough in 1.7
- Autoconf 2.61
- Libtool 1.5.22 1.4 not good enough
- Bazaar (bzr)
-
-On Debian you might ensure you have the required packages as follows:
- apt-get install gcc libc-dev automake autoconf libtool libgtk2.0-dev \
- libgc-dev libgcrypt-dev libpcre3-dev libvorbis-dev \
- libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
- libflac-dev
+Bug tracker, etc:
+ http://code.google.com/p/disorder/
Mailing lists:
http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
- announcements of new versions of DisOrder
+Developers should read README.developers.
+
Installation
============
"This place'd be a paradise tomorrow, if every department had a supervisor
with a machine-gun"
-NOTE: If you are upgrading from an earlier version, see README.upgrades.
+IMPORTANT: If you are upgrading from an earlier version, see README.upgrades.
+
+Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb
+files.
-On a Debian system, if you install from .deb files then you should be able to
-skip steps 1 to 6 and configure it via debconf. This is strongly recommended!
+OX X/FreeBSD/other Linux: after installation (step 1 and 2), running
+'sudo bash scripts/setup' will cover steps 3 to 6. If it doesn't work on your
+platform, please get in touch.
1. Build the software. Do something like this:
- ./configure --sysconfdir=/etc --localstatedir=/var
- make
+ ./configure
+ make # on FreeBSD use gmake
- See INSTALL for more details about driving configure. The precise set of
- options you pass to configure is up to you, if you like configuration being
- in /usr/local/etc or wherever then that should work.
+ See INSTALL or ./configure --help for more details about driving configure.
If you only want to build a subset of DisOrder, specify one or more of the
following options:
--without-gtk Don't build GTK+ client (Disobedience)
--without-python Don't build Python support
+ If configure cannot guess where your web server keeps its HTML documents and
+ CGI programs, you may have to tell it, for instance:
+
+ ./configure cgidir=/whatever/cgi-bin httpdir=/whatever/htdocs
+
See README.client for setting up a standalone client (or read the
disobedience man page).
+ To build .debs on Debian/Ubuntu, use:
+ fakeroot debian/rules binary
+
2. Install it. Most of the installation is done via the install target:
make installdirs install
- The CGI interface has to be installed separately; see under 'Web Interface'
- below.
+ NB steps 3 to 6 are covered by scripts/setup. It should work on FreeBSD, OS
+ X and Linux and could be adapted to other platforms.
3. Create a 'jukebox' user and group, with the jukebox group being the default
group of the jukebox user. The server will run as this user and group.
filenames, which you should be sure to get right as recovery from an
error here can be painful (see BUGS).
Optionally you may also want to do the following:
- * add 'player' commands for any file formats not supported natively
+ * add 'player' and 'tracklength' commands for any file formats not
+ supported natively
* edit the 'scratch' commands to supply scratch sounds (or delete them if
you don't want any).
- * add or remove 'stopword' entries as necessary (these words won't take
- part in track name searches from the web interface).
+ * add extra 'stopword' entries as necessary (these words won't take part in
+ track name searches from the web interface).
See disorder_config(5) for more details.
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.
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
disorder authorize USERNAME
This will automatically choose a random password and create
- /etc/disorder/config.USERNAME.
+ ~USERNAME/.disorder/passwd.
Those users should now be able to access the server from the same host as it
runs on, either via the disorder command or Disobedience. To run
Disobedience from some other host, File->Login allows hostnames, passwords
etc to be configured.
+ Alternatively, after setting up the web interface (below), it's possible to
+ allow users to register themselves without operator involvement.
+
9. Optionally source completion.bash from /etc/profile or similar, for
example:
"Thought I was a gonner baby, but I'm bullet proof"
-These instructions assumes you are using Apache 1.3.x.
-
-You need to configure a number of things to make this work:
-
-1. The web interface depends on a 'guest' user existing. You can create this
- with the following command:
-
- disorder setup-guest
-
- If you don't want to allow online registration instead use:
-
- disorder -- setup-guest --no-online-registration
+Debian/Ubuntu: the .deb files will do the setup here automatically.
-2a. If you want to have a 'jukebox' virtual host, modify the DNS accordingly
- and use a fragment such as this one:
+OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
+here automatically.
- <VirtualHost HOSTNAME>
- 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/
- </VirtualHost>
-
- Don't forget to reload Apache after modifying its configuration.
+You need to configure a number of things to make this work:
- You must tell the web interface how to find its icons and stylesheet:
+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.
- echo label url.static /static/ >> /etc/disorder/options.user
- echo label links.css /static/disorder.css >> /etc/disorder/options.user
+ mail_sender webmaster@example.com
-2b. If you don't want a virtual host then you must still make sure that
- DisOrder can find its icons and stylesheet. For example in your web server
- configuration:
+ By default the web interface sends mail via the system sendmail executable
+ (typically /usr/sbin/sendmail or /usr/lib/sendmail). You can override this
+ with the sendmail directive, for example:
- Alias /disorder/ /usr/local/share/disorder/static/
+ sendmail /usr/sbin/my-sendmail
- Alternatively you could use a symlink from the right location in your
- document root, provided your web server is configured to follow them.
+ The executable you choose must support the -bs option. Alternatively you
+ can tell it to connect to an SMTP server via TCP, with the smtp_server
+ directive. For example:
- Also you must tell the web interface how to find them:
+ smtp_server mail.example.com
- echo label url.static /disorder/ >> /etc/disorder/options.user
- echo label links.css /disorder/disorder.css >> /etc/disorder/options.user
+ Use 'disorder reconfigure' to make sure the server knows these settings.
-3. Install disorder.cgi in an appropriate location. Remember to make it
- executable. For example assuming a virtual host as above (2a):
+2. The web interface depends on a 'guest' user existing. You can create this
+ with the following command:
- install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
+ disorder setup-guest
- or not (2b):
+ If you don't want to allow online registration instead use:
- install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder
+ disorder setup-guest --no-online-registration
-4. Try it out. You should be able to perform read-only operations straight
+3. 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
+4. 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
+5. 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
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
=========
"Nothing but another drug, a licence that you buy and sell"
DisOrder - select and play digital audio files
-Copyright (C) 2003-2007 Richard Kettlewell
+Copyright (C) 2003-2008 Richard Kettlewell
Portions copyright (C) 2007 Ross Younger
Portions copyright (C) 2007 Mark Wooding
Portions extracted from MPG321, http://mpg321.sourceforge.net/
Copyright (C) 2001 Joe Drew
Copyright (C) 2000-2001 Robert Leslie
+Portions Copyright (C) 1997-2006 Free Software Foundation, Inc.
Binaries may derive extra copyright owners through linkage (binary distributors
are expected to do their own legwork)
~mdw / disorder / blobdiff