DisOrder
========
-This program is used to play random and chosen tracks from a collection of
-digital audio files (for instance MP3 and OGG files). If you just set it going
-it plays random tracks from your collection, but you can also ask for specific
-tracks to be played, either via a command line program or a web interface, and
-you can 'scratch' the current track.
+DisOrder is a multi-user software jukebox.
+ * It can play either selected tracks or pick tracks at random.
+ * It supports OGG, MP3, FLAC and WAV files, and can be configured to support
+ anything you can supply a player for (up to a point).
+ * 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.
+ * 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.
-Currently it only runs on Linux. It could probably be ported to other UNIX
-variants in some cases without too much effort. Things you will need:
+The server supports Linux and can be made to 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:
Build dependencies:
Name Tested Notes
- libdb 4.3.21 4.2 and earlier won't work
- libgc 6.3
- libvorbisfile 1.0.1
- libpcre 4.5 need UTF-8 support
+ libdb 4.3.29 4.2 and earlier won't work
+ libgc 6.8
+ libvorbisfile 1.1.2
+ libpcre 6.7 need UTF-8 support
libmad 0.15.1b
- libgcrypt 1.2.0
+ libgcrypt 1.2.3
libao 0.8.6
- libasound 1.0.8
- Python 2.3 (optional)
- GNU C 3.3, 3.4
+ libasound 1.0.13
+ libFLAC 1.1.2
+ GNU C 4.1.2
+ GNU Make 3.81
+ GNU Sed 4.1.5
+ Python 2.4.4 (optional)
+ GTK+ 2.8.20 (if you want the GTK+ client)
+ GLIB 2.12.4 (if you want the GTK+ client)
"Tested" means I've built against that version; earlier or later versions will
often work too.
Runtime dependencies:
- * Players:
- + ogg123 and mpg321 work for me, but you could potentially use others.
* 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)
Development dependencies (only developers will need these):
- Automake 1.9.4 AM_PATH_PYTHON not good enough in 1.7
- Autoconf 2.59
- Libtool 1.5.6 1.4 not good enough
+ 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 libdb-dev
+ libao-dev libmad0-dev libasound2-dev libdb4.3-dev \
+ libflac-dev
Mailing lists:
http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
--without-gtk Don't build GTK+ client (Disobedience)
--without-python Don't build Python support
- See README.client for setting up a standalone client.
+ See README.client for setting up a standalone client (or read the
+ disobedience man page).
2. Install it. Most of the installation is done via the install target:
make installdirs install
- The CGI interface has to be installed separately, and you must use Libtool
- to install it. For instance:
-
- ./libtool --mode=install install -m 755 progs/disorder.cgi /usr/local/lib/cgi-bin/disorder
-
- Depending on how your system is configured you may need to link the disorder
- libao driver into the right directory:
-
- ln -s /usr/local/lib/ao/plugins-2/libdisorder.so /usr/lib/ao/plugins-2/.
+ The CGI interface has to be installed separately; see under 'Web Interface'
+ below.
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.
4. Create /etc/disorder/config. Start from examples/config.sample and adapt it
to your own requirements. In particular, you should:
- * edit the 'player' commands to reflect the software you have installed.
+ * add 'player' commands for any file formats not supported natively
* edit the 'collection' command to identify the location(s) of your own
digital audio files. These commands also specify the encoding of
filenames, which you should be sure to get right as recovery from an
* edit the 'scratch' commands to supply scratch sounds (or delete them if
you don't want any).
* edit the 'trust' command to reflect the user the web interface will
- eventually run as.
- * edit the 'url' command to give the URL of the web interface.
+ eventually run as (see below).
+ * edit the 'url' command to give the URL of the web interface (see below).
* add or remove '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.
-5. Create /etc/disorder/config.private. This should be readable only by the
- jukebox group:
-
- touch /etc/disorder/config.private
- chown root:jukebox /etc/disorder/config.private
- chmod 640 /etc/disorder/config.private
-
- Set up a username and password for root, for example with line like this:
-
- allow root somepassword
-
- Use (for instance) pwgen(1) to create the password. DO NOT use your root
- password - this is a password to give root access to the server, not to give
- access to the root login.
+ See README.streams for how to set up network play.
- See disorderd(8) and 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.
-6. Make sure the server is started at boot time. On many Linux systems,
- examples/disorder.init should be more or less suitable; install it in
- /etc/init.d, adapting it as necessary, and make appropriate links from
- /etc/rc[0-6].d. If you have a BSD style init then you are on your own.
+5. Make sure the server is started at boot time.
-7. Make sure the state directory (/var/disorder or /usr/local/var/disorder or
- as determined by configure) exists and is writable by the jukebox user.
+ On many Linux systems, examples/disorder.init should be more or less
+ suitable; install it in /etc/init.d, adapting it as necessary, and make
+ appropriate links from /etc/rc[0-6].d.
- mkdir -m 755 /var/disorder
- chown disorder:root /var/disorder
+6. Start the server.
-8. Start the server, for instance:
+ On Linux systems with sysv-style init:
/etc/init.d/disorder start
start up correctly there should be an error message. Correct the problem
and try again.
-9. After a minute it should start to play something. Try scratching it, as any
- of the users you set up in step 5:
+7. After a minute it should start to play something. Try scratching it:
disorder scratch
The track should stop playing, and (if you set any up) a scratch sound play.
-10. Add any other users you want to config.private. Each user's password
- should be stored in a file in their home directory, ~/.disorder/passwd,
- which should be readable only by them, and should take the form of a single
- line:
+8. Add any other users you want. These easiest way to do this is:
- password MYPASSWORD
+ disorder authorize USERNAME
- (root doesn't need this as the client can read it out of config.private
- when running as root.)
+ This will automatically choose a random password and add new line to
+ /etc/disorder/config.private and create /etc/disorder/config.USERNAME.
- Note that the server must be reloaded (e.g. by 'disorder reconfigure')
- when new users are added.
+ 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 the administrator can create /etc/disorder/config.USERNAME
- containing the same thing as above. It can either be owned by the user and
- mode 400, or owned by root and the user's group (if you have per-user
- groups) and mode 440.
+9. Optionally source completion.bash from /etc/profile or similar, for
+ example:
- You can use 'disorder authorize' to automatically pick passwords and
- create these files.
+ . /usr/local/share/disorder/completion.bash
-11. Optionally source completion.bash from /etc/profile or similar, for
- example:
-
- . /usr/local/share/disorder/completion.bash
-
- This provides completion over disorder command and option names.
+ This provides completion over disorder command and option names.
Web Interface
# htpasswd -b /home/jukebox/http.users othername otherpass
Adding password for user othername
-4. The jukebox must be configured to trust the web user. I added the following
- line to my /etc/disorder/config:
-
- trust www-data
-
- This might not be the same on your system! You have to specify the user
- that the CGI script runs as, whatever that is.
+4. The jukebox must be configured to trust the web user. The example
+ configuration assumes that this is www-data, but it might be something else
+ on your system. Edit the 'trust' line if necessary.
5. Install disorder.cgi in an appropriate location. Remember to make it
- executable. With the above configuration I installed it as
- ~jukebox/public_html/index.cgi.
+ executable. For example:
+
+ install -m 755 clients/disorder.cgi ~jukebox/public_html/index.cgi
6. Give www-data (or whatever user it is) a password and edit
/etc/disorder/config.private accordingly. This file should be mode 640 and
configured earlier, and be shown details of what is playing and what other
tracks have been configured for future play.
-9. Some features take time to start working, for instance those involving
- reporting the length of tracks. This is because the server starts up as
- quickly as possible even if the full track data has not yet been gathered;
- the track data is then calculated in the background.
-
-10. 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.
+9. 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.
-11. If you have a huge number of top level directories, then you might find
+10. 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
~mdw / disorder / blobdiff