doc/disorder-gstdecode.8.in: Typeset option dashes correctly.

[disorder] / README

diff --git a/README b/README
index 350d7a274a5accb57417eca6fb9a9a11994c09d6..92a3774cc539808c141853c29f736fb89e892c70 100644 (file)
--- a/README
+++ b/README
@@ -1,54 +1,65 @@
 DisOrder
 ========
 
 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.
-
-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:
+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 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.html for details of recent changes to DisOrder and
+README.upgrades.html for upgrade instructions.
+
+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:
 
 Build dependencies:

-  Name             Tested              Notes
-  libdb            4.3.29              4.2 and earlier won't work
+  Name             Tested      Notes
+  libdb            4.5.20      not 4.6; 4.[78] seem to be ok

   libgc            6.8
   libgc            6.8

-  libvorbisfile    1.1.2
-  libpcre          6.7                 need UTF-8 support
+  libvorbisfile    1.2.0
+  libpcre          7.6         need UTF-8 support

   libmad           0.15.1b
   libmad           0.15.1b

-  libgcrypt        1.2.3
-  libao            0.8.6
-  libasound        1.0.13
-  libFLAC          1.1.2
-  GNU C            4.1.2
-  GNU Make         3.81
-  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)
+  libgcrypt        1.4.1
+  libasound        1.0.16
+  libFLAC          1.2.1
+  libsamplerate    0.1.4       currently optional but strongly recommended
+  GStreamer        0.10        currently optional
+  GNU C            4.2.1       }
+  GNU Make         3.81        } Non-GNU versions will NOT work
+  GNU Sed          4.1.5       }
+  Python           2.5.2       (optional; 2.4 won't work)
+  GTK+             2.12.12     (for the GTK+ client; 2.10 & older will NOT work)
+  GLIB             2.16.6      (for the GTK+ client)

 
 "Tested" means I've built against that version; earlier or later versions will
 often work too.
 
 
 "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)
+If you don't have libsamplerate then DisOrder will try to run sox(1) to do
+sample-rate and channel conversion.  Unfortunately, sox has a tendency to
+change its command-line options incompatibly every few years.  Rather than
+chase this moving target by supporting the new options introduced in 14.2,
+I'm declaring DisOrder's sox support to be deprecated -- though (unlike
+sox's policy) it won't actually go away until the next major version.
+Alternatives include building against libsamplerate, or using GStreamer's
+audio decoding instead of DisOrder's built-in decoders.

 
 

-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)
+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.

 
 

-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:
+  https://github.com/ewxrjk/disorder

 
 Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss
 
 Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-discuss


@@ -56,6 +67,8 @@ Mailing lists:
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
    - announcements of new versions of DisOrder
 
   http://www.chiark.greenend.org.uk/mailman/listinfo/sgo-software-announce
    - announcements of new versions of DisOrder
 

+Developers should read README.developers.
+

 
 Installation
 ============
 
 Installation
 ============


@@ -63,16 +76,22 @@ Installation
    "This place'd be a paradise tomorrow, if every department had a supervisor
    with a machine-gun"
 
    "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.html.
+
+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:
 
 
 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:
 
    If you only want to build a subset of DisOrder, specify one or more of the
    following options:


@@ -80,19 +99,23 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
      --without-gtk          Don't build GTK+ client (Disobedience)
      --without-python       Don't build Python support
 
      --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 cgiexecdir=/whatever/cgi-bin httpdir=/whatever/htdocs
+

    See README.client for setting up a standalone client (or read the
    disobedience man page).
 
    See README.client for setting up a standalone client (or read the
    disobedience man page).
 

-   The server is only built by default under Linux.  See README.mac concerning
-   its use under OS X.
+   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
 
 
 2. Install it.  Most of the installation is done via the install target:
 
      make installdirs install
 

-   The CGI interface has to be installed separately:
-
-     install -m 755 clients/disorder.cgi /usr/local/lib/cgi-bin/disorder
+   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.
 
 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.


@@ -104,49 +127,36 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
    specifically for DisOrder.
 
 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it
    specifically for DisOrder.
 
 4. Create /etc/disorder/config.  Start from examples/config.sample and adapt it

-   to your own requirements.  In particular, you should:
-    * add 'player' commands for any file formats not supported natively
+   to your own requirements.  The things you MUST do are:

     * 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
       error here can be painful (see BUGS).
     * 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
       error here can be painful (see BUGS).

+   Optionally you may also want to do the following:
+    * 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).
     * 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.
-    * 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.
 
 
    See disorder_config(5) for more details.
 

-   See README.raw for details on setting up "raw format" players, which allow
-   for pausing and gapless play.
-
-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 disorder(3) 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.  If you
+   want additional formats to be supported natively please point the author at
+   a GPL-compatible library that can decode them.

 
 

-6. Make sure the server is started at boot time.
+5. 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.
 
 
    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.
 

-7. Start the server.
+6. Start the server.

 
    On Linux systems with sysv-style init:
 
 
    On Linux systems with sysv-style init:
 


@@ -157,40 +167,35 @@ NOTE: If you are upgrading from an earlier version, see README.upgrades.
    start up correctly there should be an error message.  Correct the problem
    and try again.
 
    start up correctly there should be an error message.  Correct the problem
    and try again.
 

-8. 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 short while it should start to play something.  Try scratching it
+   (as root):

 
      disorder scratch
 
    The track should stop playing, and (if you set any up) a scratch sound play.
 
 
      disorder scratch
 
    The track should stop playing, and (if you set any up) a scratch sound play.
 

-9. 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 (still as
+   root):

 
 

-     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 create
+   ~USERNAME/.disorder/passwd.

 
 

-   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.
+   Alternatively, after setting up the web interface (below), it's possible to
+   allow users to register themselves without operator involvement.

 
 

-   You can use 'disorder authorize' to automatically pick passwords and
-   create these files.
+9. Optionally source completion.bash from /etc/profile or similar, for
+   example:

 
 

-10. Optionally source completion.bash from /etc/profile or similar, for
-    example:
+     . /usr/local/share/disorder/completion.bash

 
 

-      . /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
 
 
 Web Interface


@@ -198,115 +203,70 @@ Web Interface
 
    "Thought I was a gonner baby, but I'm bullet proof"
 
 
    "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. If you want to have a 'jukebox' virtual host, modify the DNS (or hosts file
-   if you are somehow reading this in the 1980s) accordingly and use a fragment
-   such as this one:
-
-     <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>
-
-   /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.
+Debian/Ubuntu: the .deb files will do the setup here automatically.

 
 

-   Don't forget to reload Apache after modifying its configuration.
+OS X/FreeBSD/other Linux: scripts/setup as referred to above will do the setup
+here automatically.

 
 

-   Separate logging is not required but I find it convenient.  Up to you.
-
-2. disorder.cgi assumes it is subject to access control (and in particular uses
-   the username to report who did what).  Here's how I configured Apache, given
-   the above VirtualHost settings:
-
-     <Directory /home/jukebox>
-     Require valid-user
-     AuthType basic
-     AuthName jukebox
-     AuthUserFile /home/jukebox/http.users
-     </Directory>
-
-   Adjust this according to wherever you're going to install disorder.cgi and
-   its expected URL.
-
-   Don't forget to reload apache after modifying its configuration.  If you got
-   it wrong, fix it and restart Apache.
-
-3. Create the password file configured above.  Something like this:
+You need to configure a number of things to make this work:

 
 

-     # htpasswd -b -c /home/jukebox/http.users myusername mypassword
-     Adding password for user myusername
-     # htpasswd -b /home/jukebox/http.users othername otherpass
-     Adding password for user othername
+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.

 
 

-4. The jukebox must be configured to trust the web user.  I added the following
-   line to my /etc/disorder/config:
+     mail_sender webmaster@example.com

 
 

-     trust www-data
+   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:

 
 

-   This might not be the same on your system!  You have to specify the user
-   that the CGI script runs as, whatever that is.
+     sendmail /usr/sbin/my-sendmail

 
 

-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.
+   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:

 
 

-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
-   owned by root:jukebox.  The line should look something like this:
+     smtp_server mail.example.com

 
 

-     allow www-data MYPASSWORD
+   Use 'disorder reconfigure' to make sure the server knows these settings.

 
 

-   After editing the config file, you must make the daemon re-read it:
+2. The web interface depends on a 'guest' user existing.  You can create this
+   with the following command:

 
 

-     disorder reconfigure
+     disorder setup-guest

 
 

-7. Teach www-data its password, by putting it in /etc/disorder/config.www-data.
-   This file should be mode 640 and owned by root:www-data.
+   If you don't want to allow online registration instead use:

 
 

-     password MYPASSWORD
+     disorder setup-guest --no-online-registration

 
 

-   (You could also use ~www-data/.disorder/passwd for this but on some systems
-   the web server user's home directory is inside the document root, which
-   would have rather unfortunate consequences.)
+3. Try it out.  The url will be (something like):

 
 

-8. Try it out.  You should be asked for a username and password that you
-   configured earlier, and be shown details of what is playing and what other
-   tracks have been configured for future play.
+     http://localhost/cgi-bin/disorder

 
 

-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.
+   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.

 
 

-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.
+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.

 
 

-11. 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
+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

 
 

-    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
 =========
 
 Copyright
 =========


@@ -314,25 +274,29 @@ Copyright
   "Nothing but another drug, a licence that you buy and sell"
 
 DisOrder - select and play digital audio files
   "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-2013 Richard Kettlewell
+Portions copyright (C) 2007 Ross Younger
+Portions copyright (C) 2007, 2013, 2015-2016 Mark Wooding

 Portions extracted from MPG321, http://mpg321.sourceforge.net/
   Copyright (C) 2001 Joe Drew
   Copyright (C) 2000-2001 Robert Leslie
 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.
+Portions Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>

 Binaries may derive extra copyright owners through linkage (binary distributors
 are expected to do their own legwork)
 
 Binaries may derive extra copyright owners through linkage (binary distributors
 are expected to do their own legwork)
 

-This program is free software; you can redistribute it and/or modify it under
-the terms of the GNU General Public License as published by the Free Software
-Foundation; either version 2 of the License, or (at your option) any later
-version.
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.

 
 

-This program is distributed in the hope that it will be useful, but WITHOUT ANY
-WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.

 
 

-You should have received a copy of the GNU General Public License along with
-this program; if not, write to the Free Software Foundation, Inc., 59 Temple
-Place, Suite 330, Boston, MA 02111-1307 USA
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

 
 Local Variables:
 mode:text
 
 Local Variables:
 mode:text