[disorder] / disobedience / manual / intro.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
 <head>
   <title>Disobedience: Introduction</title>
   <link rel=stylesheet
         type="text/css"
         href="disorder.css">
 </head>
 <body>
   <h1>1. Introduction</h1>

   <p>This chapter covers the following topics:</p>

   <ul>
     <li>What DisOrder and Disobedience are, and how to get them</li>
     <li>How to get a DisOrder login</li>
     <li>How to start Disobedience</li>
   </ul>

   <h2>1.1 What is DisOrder?</h2>

   <p><a href="http://www.greenend.org.uk/rjk/disorder/">DisOrder</a>
   is a multi-user software jukebox.  It allows MP3s, OGGs, etc to be
   played either using a single sound card or over a network to many
   different computers, with multiple different people controlling
   what is played.</p>

   <p>DisOrder has three main user interfaces.</p>

   <ul>
     <li>It has a command-line interface, suitable for ad-hoc use and
     scripting.</li>

     <li>It has a web interface, usable with graphical web browsers
     (Firefox, Internet Explorer etc).</li>

     <li>It has a graphical client called Disobedience.</li>
   </ul>

   <p>This manual is about Disobedience, so it does not really cover
   installation or management issues.  However in this chapter it will
   cover a few such topics as they are necessary to getting up and
   running with Disobedience.</p>

   <p>This diagram shows an overview of one possible setup.</p>

   <p align=middle><img src="arch-simple.png"></p>

   <p>The server and web interface run on one computer.  Disobedience
   runs on a desktop computer and accesses the server via the network.
   On another system the RTP player runs and plays sound received from
   the server via its local sound card.</p>

   <p>Many other configurations are possible.  For instance the server
   could play directly to a local soundcard.  Also if Disobedience
   runs on the same computer as the RTP player then it can be used to
   stop and start the player.  Of course Disobedience can also be run
   on the same computer as the server provided it can run X11
   applications.</p>

   <h2>1.2 Getting DisOrder</h2>

   <p>There are two ways to get DisOrder.</p>

   <p>If you have a Debian system you can download the <tt>.deb</tt>
   files <a href="http://www.greenend.org.uk/rjk/disorder/">from
   DisOrder's home page</a> and install those.  There are four
   packages to choose from:</p>

   <ul>
     <li><tt>disorder.deb</tt> - the base package.  You should always
     install this.  It contains the command-line client.</li>

     <li><tt>disorder-server.deb</tt> - the server and web interface.
     Only install this if you are setting up a totally new DisOrder
     installation.  If you just want to access an existing one, you
     don't need this package.</li>

     <li><tt>disobedience.deb</tt> - the graphical client.  If you are
     reading this manual you want this package!</li>

     <li><tt>disorder-rtp.deb</tt> - the network play client.  If your
     server is set up to transmit sound over the network you will need
     this.  If it uses a local sound card then this package won't be
     useful to you.</li>

   </ul>

   <p>(At the time of writing, DisOrder is not included as part of
   Debian.)</p>

   <p>If you have another kind of Linux system, or a Mac, you must
   build from source code.  See the <tt>README</tt> file included in
   the source distribution for more details.  Note that to use
   Disobedience on a Mac, you will need X11.app.</p>

   <p>There is no Windows support (although the web interface can be
   used from Windows computers).</p>

   <h2>1.3 Getting a DisOrder login</h2>

   <p>The easiest way to get a DisOrder login is to access the web
   interface and set one up using that.  To do this,
   visit <tt>http://HOSTNAME/cgi-bin/disorder</tt>,
   where <tt>HOSTNAME</tt> is the name of the server where DisOrder is
   installed.  You should then be able to select the <b>Login</b>
   option at the top of the screen.</p>

   <p align=middle><img src="disorder-web-login.png"></p>

   <p>Go to the <b>New Users</b> form and enter the username you want
   to use, your email address, and a password.  The password must be
   entered twice to verify you did not mistype it (since it won't be
   displayed on the screen).  When you press <b>Register</b>, you will
   be sent an email requiring you to confirm your registration.</p>

   <p align=middle><img src="disorder-email-confirm.png"></p>

   <p>Your login won't be active until you click on this URL.</p>

   <p>(It might be that your installation isn't set up to allow
   automatic registration.  In that case the local sysadmin will have
   to create your login and set your initial password by hand.)</p>

   <p>Having done this you could of course just use the web interface.
   But since this is the manual for Disobedience, it is assumed that
   you want to take advantage of its more convenient design and extra
   features.</p>

   <h2>1.4 Starting Disobedience</h2>

   <p>On Debian systems it should be possible to find Disobedience in
   the menu system:</p>

   <p align=middle><img src="disobedience-debian-menu.png"></p>

   <p>On other systems you will have to start it from the command line
   by typing its name at a command prompt.  You can (optionally) use
   an <tt>&amp;</tt> suffix to stop it tying up your terminal.</p>

   <p align=middle><img src="disobedience-terminal.png"></p>

   <p>(Please note that Disobedience shouldn't write any messages to
   the terminal.  If it does that probably indicates a bug, which
   should <a href="http://code.google.com/p/disorder/issues/list">be
   reported</a>.)</p>

   <h2>1.5 Initial Login</h2>

   <p>The first time you run Disobedience it won't know what server to
   connect to, your username or your password, and will therefore
   display a login box.</p>

   <p align=middle><img src="login.png"></p>

   <p>If Disobedience is running on a different computer to the
   server, then you should make sure the <b>Remote</b> box is ticked
   and fill in the host name (or IP address) and port number
   (&ldquo;Service&rdquo;).  If you don't know what values to use
   here, ask your local sysadmin.  If, on the other hand, Disobedience
   is running on the <i>same</i> computer as the server then you can
   leave the <b>Remote</b> box clear and it should be able to connect
   to it without using the network.</p>

   <p>In any case, you will need to enter your username and
   password, as set up earlier.</p>

   <p>Once you have logged in successfuly, Disobedience will remember
   these login settings, so it should not be necessary to enter them
   again.  If you need to change them for any reason, you can either
   select the Server > Login option to bring the login window back, or
   (if you prefer), edit the file <tt>~/.disorder/passwd</tt>
   directly.</p>

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