| 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 | <!-- |
| 63 | |
| 64 | <p>This diagram shows an overview of one possible setup.</p> |
| 65 | |
| 66 | <p class=image><img src="arch-simple.png"></p> |
| 67 | |
| 68 | <p>The server and web interface run on one computer. Disobedience |
| 69 | runs on a desktop computer and accesses the server via the network. |
| 70 | On another system the RTP player runs and plays sound received from |
| 71 | the server via its local sound card.</p> |
| 72 | |
| 73 | <p>Many other configurations are possible. For instance the server |
| 74 | could play directly to a local soundcard. Also if Disobedience |
| 75 | runs on the same computer as the RTP player then it can be used to |
| 76 | stop and start the player. Of course Disobedience can also be run |
| 77 | on the same computer as the server provided it can run X11 |
| 78 | applications.</p> |
| 79 | |
| 80 | --> |
| 81 | |
| 82 | <h2><a name=getting>1.2 Getting DisOrder</a></h2> |
| 83 | |
| 84 | <p>There are two ways to get DisOrder.</p> |
| 85 | |
| 86 | <p>If you have a Debian system you can download the <tt>.deb</tt> |
| 87 | files <a href="http://www.greenend.org.uk/rjk/disorder/">from |
| 88 | DisOrder's home page</a> and install those. There are four |
| 89 | packages to choose from:</p> |
| 90 | |
| 91 | <ul> |
| 92 | <li><tt>disorder.deb</tt> - the base package. You should always |
| 93 | install this. It contains the command-line client.</li> |
| 94 | |
| 95 | <li><tt>disorder-server.deb</tt> - the server and web interface. |
| 96 | Only install this if you are setting up a totally new DisOrder |
| 97 | installation. If you just want to access an existing one, you |
| 98 | don't need this package.</li> |
| 99 | |
| 100 | <li><tt>disobedience.deb</tt> - the graphical client. If you are |
| 101 | reading this manual you want this package!</li> |
| 102 | |
| 103 | <li><tt>disorder-rtp.deb</tt> - the network play client. If your |
| 104 | server is set up to transmit sound over the network you will need |
| 105 | this. If it uses a local sound card then this package won't be |
| 106 | useful to you.</li> |
| 107 | |
| 108 | </ul> |
| 109 | |
| 110 | <p>(At the time of writing, DisOrder is not included as part of |
| 111 | Debian.)</p> |
| 112 | |
| 113 | <p>If you have another kind of Linux system, or a Mac, you must |
| 114 | build from source code. See the <tt>README</tt> file included in |
| 115 | the source distribution for more details. Note that to use |
| 116 | Disobedience on a Mac, you will need X11.app.</p> |
| 117 | |
| 118 | <p>There is no Windows support (although the web interface can be |
| 119 | used from Windows computers).</p> |
| 120 | |
| 121 | <h2><a name=createlogin>1.3 Getting a DisOrder login</a></h2> |
| 122 | |
| 123 | <p>The easiest way to get a DisOrder login is to access the web |
| 124 | interface and set one up using that. To do this, |
| 125 | visit <tt>http://HOSTNAME/cgi-bin/disorder</tt>, |
| 126 | where <tt>HOSTNAME</tt> is the name of the server where DisOrder is |
| 127 | installed. You should then be able to select the <b>Login</b> |
| 128 | option at the top of the screen.</p> |
| 129 | |
| 130 | <p class=image><img src="disorder-web-login.png"></p> |
| 131 | |
| 132 | <p>Go to the <b>New Users</b> form and enter the username you want |
| 133 | to use, your email address, and a password. The password must be |
| 134 | entered twice to verify you did not mistype it (since it won't be |
| 135 | displayed on the screen). When you press <b>Register</b>, you will |
| 136 | be sent an email requiring you to confirm your registration.</p> |
| 137 | |
| 138 | <p class=image><img src="disorder-email-confirm.png"></p> |
| 139 | |
| 140 | <p>Your login won't be active until you click on this URL.</p> |
| 141 | |
| 142 | <p>(It might be that your installation isn't set up to allow |
| 143 | automatic registration. In that case the local sysadmin will have |
| 144 | to create your login and set your initial password by hand.)</p> |
| 145 | |
| 146 | <p>Having done this you could of course just use the web interface. |
| 147 | But since this is the manual for Disobedience, it is assumed that |
| 148 | you want to take advantage of its more convenient design and extra |
| 149 | features.</p> |
| 150 | |
| 151 | <h2><a name=starting>1.4 Starting Disobedience</a></h2> |
| 152 | |
| 153 | <p>On Debian systems it should be possible to find Disobedience in |
| 154 | the menu system:</p> |
| 155 | |
| 156 | <p class=image><img src="disobedience-debian-menu.png"></p> |
| 157 | |
| 158 | <p>On other systems you will have to start it from the command line |
| 159 | by typing its name at a command prompt. You can (optionally) use |
| 160 | an <tt>&</tt> suffix to stop it tying up your terminal.</p> |
| 161 | |
| 162 | <p class=image><img src="disobedience-terminal.png"></p> |
| 163 | |
| 164 | <p>(Please note that Disobedience shouldn't write any messages to |
| 165 | the terminal. If it does that probably indicates a bug, which |
| 166 | should <a href="http://code.google.com/p/disorder/issues/list">be |
| 167 | reported</a>.)</p> |
| 168 | |
| 169 | <h2><a name=login>1.5 Initial Login</a></h2> |
| 170 | |
| 171 | <p>The first time you run Disobedience it won't know what server to |
| 172 | connect to, your username or your password, and will therefore |
| 173 | display a login box.</p> |
| 174 | |
| 175 | <p class=image><img src="login.png"></p> |
| 176 | |
| 177 | <p>If Disobedience is running on a different computer to the |
| 178 | server, then you should make sure the <b>Remote</b> box is ticked |
| 179 | and fill in the host name (or IP address) and port number |
| 180 | (“Service”). If you don't know what values to use |
| 181 | here, ask your local sysadmin. If, on the other hand, Disobedience |
| 182 | is running on the <i>same</i> computer as the server then you can |
| 183 | leave the <b>Remote</b> box clear and it should be able to connect |
| 184 | to it without using the network.</p> |
| 185 | |
| 186 | <p>In any case, you will need to enter your username and |
| 187 | password, as set up earlier.</p> |
| 188 | |
| 189 | <p>Once you have logged in successfuly, Disobedience will remember |
| 190 | these login settings, so it should not be necessary to enter them |
| 191 | again. If you need to change them for any reason, you can either |
| 192 | select the <b>Server > Login</b> option to bring the login window |
| 193 | back, or (if you prefer), edit the file <tt>~/.disorder/passwd</tt> |
| 194 | directly.</p> |
| 195 | |
| 196 | <hr> |
| 197 | |
| 198 | <a href="index.html">Back to contents</a> |
| 199 | |
| 200 | </body> |
| 201 | </html> |