chiark - git - mdw - disorder/blob - disobedience/manual/intro.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <!--
   3 This file is part of DisOrder.
   4 Copyright (C) 2009 Richard Kettlewell
   5
   6 This program is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19 <html>
  20  <head>
  21    <title>Disobedience: Introduction</title>
  22    <link rel=stylesheet
  23          type="text/css"
  24          href="disobedience.css">
  25  </head>
  26  <body>
  27    <h1>1. Introduction</h1>
  28
  29    <p>This chapter covers the following topics:</p>
  30
  31    <ul>
  32      <li>What DisOrder and Disobedience are, and how to get them</li>
  33      <li>How to get a DisOrder login</li>
  34      <li>How to start Disobedience</li>
  35    </ul>
  36
  37    <h2><a name=whatis>1.1 What is DisOrder?</a></h2>
  38
  39    <p><a href="http://www.greenend.org.uk/rjk/disorder/">DisOrder</a>
  40    is a multi-user software jukebox.  It allows MP3s, OGGs, etc to be
  41    played either using a single sound card or over a network to many
  42    different computers, with multiple different people controlling
  43    what is played.</p>
  44
  45    <p>DisOrder has three main user interfaces.</p>
  46
  47    <ul>
  48      <li>It has a command-line interface, suitable for ad-hoc use and
  49      scripting.</li>
  50
  51      <li>It has a web interface, usable with graphical web browsers
  52      (Firefox, Internet Explorer etc).</li>
  53
  54      <li>It has a graphical client called Disobedience.</li>
  55    </ul>
  56
  57    <p>This manual is about Disobedience, so it does not really cover
  58    installation or management issues.  However in this chapter it will
  59    cover a few such topics as they are necessary to getting up and
  60    running with Disobedience.</p>
  61
  62    <p>This diagram shows an overview of one possible setup.</p>
  63
  64    <p class=image><img src="arch-simple.png"></p>
  65
  66    <p>The server and web interface run on one computer.  Disobedience
  67    runs on a desktop computer and accesses the server via the network.
  68    On another system the RTP player runs and plays sound received from
  69    the server via its local sound card.</p>
  70
  71    <p>Many other configurations are possible.  For instance the server
  72    could play directly to a local soundcard.  Also if Disobedience
  73    runs on the same computer as the RTP player then it can be used to
  74    stop and start the player.  Of course Disobedience can also be run
  75    on the same computer as the server provided it can run X11
  76    applications.</p>
  77
  78    <h2><a name=getting>1.2 Getting DisOrder</a></h2>
  79
  80    <p>There are two ways to get DisOrder.</p>
  81
  82    <p>If you have a Debian system you can download the <tt>.deb</tt>
  83    files <a href="http://www.greenend.org.uk/rjk/disorder/">from
  84    DisOrder's home page</a> and install those.  There are four
  85    packages to choose from:</p>
  86
  87    <ul>
  88      <li><tt>disorder.deb</tt> - the base package.  You should always
  89      install this.  It contains the command-line client.</li>
  90
  91      <li><tt>disorder-server.deb</tt> - the server and web interface.
  92      Only install this if you are setting up a totally new DisOrder
  93      installation.  If you just want to access an existing one, you
  94      don't need this package.</li>
  95
  96      <li><tt>disobedience.deb</tt> - the graphical client.  If you are
  97      reading this manual you want this package!</li>
  98
  99      <li><tt>disorder-rtp.deb</tt> - the network play client.  If your
 100      server is set up to transmit sound over the network you will need
 101      this.  If it uses a local sound card then this package won't be
 102      useful to you.</li>
 103
 104    </ul>
 105
 106    <p>(At the time of writing, DisOrder is not included as part of
 107    Debian.)</p>
 108
 109    <p>If you have another kind of Linux system, or a Mac, you must
 110    build from source code.  See the <tt>README</tt> file included in
 111    the source distribution for more details.  Note that to use
 112    Disobedience on a Mac, you will need X11.app.</p>
 113
 114    <p>There is no Windows support (although the web interface can be
 115    used from Windows computers).</p>
 116
 117    <h2><a name=createloging>1.3 Getting a DisOrder login</a></h2>
 118
 119    <p>The easiest way to get a DisOrder login is to access the web
 120    interface and set one up using that.  To do this,
 121    visit <tt>http://HOSTNAME/cgi-bin/disorder</tt>,
 122    where <tt>HOSTNAME</tt> is the name of the server where DisOrder is
 123    installed.  You should then be able to select the <b>Login</b>
 124    option at the top of the screen.</p>
 125
 126    <p class=image><img src="disorder-web-login.png"></p>
 127
 128    <p>Go to the <b>New Users</b> form and enter the username you want
 129    to use, your email address, and a password.  The password must be
 130    entered twice to verify you did not mistype it (since it won't be
 131    displayed on the screen).  When you press <b>Register</b>, you will
 132    be sent an email requiring you to confirm your registration.</p>
 133
 134    <p class=image><img src="disorder-email-confirm.png"></p>
 135
 136    <p>Your login won't be active until you click on this URL.</p>
 137
 138    <p>(It might be that your installation isn't set up to allow
 139    automatic registration.  In that case the local sysadmin will have
 140    to create your login and set your initial password by hand.)</p>
 141
 142    <p>Having done this you could of course just use the web interface.
 143    But since this is the manual for Disobedience, it is assumed that
 144    you want to take advantage of its more convenient design and extra
 145    features.</p>
 146
 147    <h2><a name=starting>1.4 Starting Disobedience</a></h2>
 148
 149    <p>On Debian systems it should be possible to find Disobedience in
 150    the menu system:</p>
 151
 152    <p class=image><img src="disobedience-debian-menu.png"></p>
 153
 154    <p>On other systems you will have to start it from the command line
 155    by typing its name at a command prompt.  You can (optionally) use
 156    an <tt>&amp;</tt> suffix to stop it tying up your terminal.</p>
 157
 158    <p class=image><img src="disobedience-terminal.png"></p>
 159
 160    <p>(Please note that Disobedience shouldn't write any messages to
 161    the terminal.  If it does that probably indicates a bug, which
 162    should <a href="http://code.google.com/p/disorder/issues/list">be
 163    reported</a>.)</p>
 164
 165    <h2><a name=login>1.5 Initial Login</a></h2>
 166
 167    <p>The first time you run Disobedience it won't know what server to
 168    connect to, your username or your password, and will therefore
 169    display a login box.</p>
 170
 171    <p class=image><img src="login.png"></p>
 172
 173    <p>If Disobedience is running on a different computer to the
 174    server, then you should make sure the <b>Remote</b> box is ticked
 175    and fill in the host name (or IP address) and port number
 176    (&ldquo;Service&rdquo;).  If you don't know what values to use
 177    here, ask your local sysadmin.  If, on the other hand, Disobedience
 178    is running on the <i>same</i> computer as the server then you can
 179    leave the <b>Remote</b> box clear and it should be able to connect
 180    to it without using the network.</p>
 181
 182    <p>In any case, you will need to enter your username and
 183    password, as set up earlier.</p>
 184
 185    <p>Once you have logged in successfuly, Disobedience will remember
 186    these login settings, so it should not be necessary to enter them
 187    again.  If you need to change them for any reason, you can either
 188    select the <b>Server > Login</b> option to bring the login window
 189    back, or (if you prefer), edit the file <tt>~/.disorder/passwd</tt>
 190    directly.</p>
 191
 192    <hr>
 193
 194    <a href="index.html">Back to contents</a>
 195
 196  </body>
 197 </html>