X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/01f400edd61968a9e7df3d1aff11bc67039317a2..27ed5a6987fc300f25569628e9152fafcf34c49f:/README?ds=sidebyside diff --git a/README b/README index 9d80eb4..774d95d 100644 --- a/README +++ b/README @@ -8,16 +8,20 @@ DisOrder is a multi-user software jukebox. * 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 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 @@ -40,23 +44,12 @@ Build dependencies: "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 @@ -64,6 +57,8 @@ Mailing lists: http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce - announcements of new versions of DisOrder +Developers should read README.developers. + Installation ============ @@ -71,19 +66,21 @@ 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. -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! +Debian/Ubuntu: steps 1 to 6 are dealt with automatically if you use the .deb +files. + +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: @@ -94,6 +91,9 @@ skip steps 1 to 6 and configure it via debconf. This is strongly recommended! 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 @@ -101,6 +101,9 @@ skip steps 1 to 6 and configure it via debconf. This is strongly recommended! 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. Check that this user can read your music files and write to the audio @@ -117,11 +120,12 @@ skip steps 1 to 6 and configure it via debconf. This is strongly recommended! 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. @@ -163,13 +167,16 @@ skip steps 1 to 6 and configure it via debconf. This is strongly recommended! 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: @@ -183,8 +190,10 @@ Web Interface "Thought I was a gonner baby, but I'm bullet proof" -As above, if you install from a .deb, much of the work will be done -automatically. +Debian/Ubuntu: the .deb files will do the setup here automatically. + +OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup +here automatically. You need to configure a number of things to make this work: @@ -201,6 +210,8 @@ You need to configure a number of things to make this work: smtp_server mail.example.com + Use 'disorder reconfigure' to make sure the server knows these settings. + 2. The web interface depends on a 'guest' user existing. You can create this with the following command: @@ -224,7 +235,7 @@ You need to configure a number of things to make this work: 4. Install disorder.cgi in an appropriate location. Remember to make it executable. Example: - install -m 755 clients/disorder.cgi /usr/lib/cgi-bin/disorder + install -m 755 server/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 @@ -256,7 +267,7 @@ 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/