Changeset 2e8b589 for gutenbach/debian/lib/README

Timestamp:

Jun 24, 2010, 1:27:07 AM (14 years ago)

Author:

Jessica B. Hamrick <jhamrick@…>

Branches:

master, debian, mac, no-cups, nodebathena, web

Children:

d988d9d

Parents:

e5529cd

git-author:

Jessica B. Hamrick <jhamrick@…> (12/12/09 18:08:33)

git-committer:

Jessica B. Hamrick <jhamrick@…> (06/24/10 01:27:07)

Message:

Updated paths and filenames to the correct values for the gutenbach package.

File:

• gutenbach/debian/lib/README (modified) (18 diffs)

gutenbach/debian/lib/README

@@ -1 @@
-sipbmp3
+gutenbach
     The SIPB MP3 Music Spooler
 
 We would love you forever if you took this README/INSTALL document and made
 a Debian package out of it.  That would be uber-awesome.  But otherwise, we're
-assuming that you just want to get sipbmp3 up and running on your own
+assuming that you just want to get gutenbach up and running on your own
 system.  Well, maybe we shouldn't assume that.
 
 
-What does sipbmp3 do?
+What does gutenbach do?
 ---------------------
 
-sipbmp3 is a music spooler.  As it turns out, streaming music is a hard
+gutenbach is a music spooler.  As it turns out, streaming music is a hard
 problem, with lots of proprietary protocols, client and server software.
 All of these jiggety bits are kind of a pain to get working correctly,
-so, we built sipbmp3 on top of... a printer system.  It's very simple:
+so, we built gutenbach on top of... a printer system.  It's very simple:
 you print an mp3 file to a special "printer", and it gets played on
 whatever speakers you're hooked up to.
@@ -27 +27 @@
 
 
-Installing sipbmp3
+Installing gutenbach
 ------------------
 
@@ -33 +33 @@
 1. Configuring your sound
 
-If you're installing sipbmp3 on a server environment, it's highly likely
+If you're installing gutenbach on a server environment, it's highly likely
 that you have a bare bones audio setup and everything is muted.  Make sure
 your sound works!  One common problem is that the daemon user (the user which
@@ -48 +48 @@
 2. Install some prerequisite software
 
-On a vanilla Ubuntu server install, sipbmp3 will also need the following
+On a vanilla Ubuntu server install, gutenbach will also need the following
 packages to work properly:
 
@@ -57 +57 @@
 
 
-3. Setup sipbmp3
-
-The Git repository for sipbmp3 is located in:
-
-    /afs/sipb/project/sipbmp3/sipbmp3.git
-
-Place this in /root/sipbmp3; the remctl scripts will assume that the
+3. Setup gutenbach
+
+The Git repository for gutenbach is located in:
+
+    /afs/sipb/project/sipbmp3/gutenbach.git
+
+Place this in /root/gutenbach; the remctl scripts will assume that the
 scripts can be found in this location.
 
 
-4. Configure sipbmp3
-
-sipbmp3 will send zephyrs during playback start and end.  Since you don't
+4. Configure gutenbach
+
+gutenbach will send zephyrs during playback start and end.  Since you don't
 want to be spamming sipb-auto (which is the default zephyr class these
 are sent to), you should create a configuration file:
 
-    /etc/sipbmp3-filter-config.pl
+    /etc/gutenbach-filter-config.pl
 
 That looks like:
@@ -84 +84 @@
 
 
-5. Configure sipbmp3 init scripts
-
-sipbmp3 will attempt to drop some information into /var/run/sipbmp3, which
+5. Configure gutenbach init scripts
+
+gutenbach will attempt to drop some information into /var/run/gutenbach, which
 needs to exist and you can't simply mkdir since /var/run on Ubuntu is
-a tempfs. Thus, add the following lines to a new file, /etc/init.d/sipbmp3:
+a tempfs. Thus, add the following lines to a new file, /etc/init.d/gutenbach:
 
 #!/bin/sh
-mkdir /var/run/sipbmp3
-touch /var/run/sipbmp3/status
-chmod 0777 /var/run/sipbmp3/status
+mkdir /var/run/gutenbach
+touch /var/run/gutenbach/status
+chmod 0777 /var/run/gutenbach/status
 
 You should also run these commands yourself. :-)
 
-XXX: Note from jhamrick: I would recomment actually setting this up as a nice startup script, with a switch case for {start|stop|restart} (where with stop you just remove the directory, and with restart you remove the directory and then recreate it).  Also, sipbmp3 won't actually run on startup unless there are scripts in the /etc/rc*.d directory, so we need to do:
-
-> ln -s ../init.d/sipbmp3 /etc/rc2.d/S61sipbmp3
-> ln -s ../init.d/sipbmp3 /etc/rc3.d/S61sipbmp3
-> ln -s ../init.d/sipbmp3 /etc/rc4.d/S61sipbmp3
-> ln -s ../init.d/sipbmp3 /etc/rc5.d/S61sipbmp3
-> ln -s ../init.d/sipbmp3 /etc/rc0.d/K39sipbmp3
-> ln -s ../init.d/sipbmp3 /etc/rc1.d/K39sipbmp3
-> ln -s ../init.d/sipbmp3 /etc/rc6.d/K39sipbmp3
+XXX: Note from jhamrick: I would recomment actually setting this up as a nice startup script, with a switch case for {start|stop|restart} (where with stop you just remove the directory, and with restart you remove the directory and then recreate it).  Also, gutenbach won't actually run on startup unless there are scripts in the /etc/rc*.d directory, so we need to do:
+
+> ln -s ../init.d/gutenbach /etc/rc2.d/S61gutenbach
+> ln -s ../init.d/gutenbach /etc/rc3.d/S61gutenbach
+> ln -s ../init.d/gutenbach /etc/rc4.d/S61gutenbach
+> ln -s ../init.d/gutenbach /etc/rc5.d/S61gutenbach
+> ln -s ../init.d/gutenbach /etc/rc0.d/K39gutenbach
+> ln -s ../init.d/gutenbach /etc/rc1.d/K39gutenbach
+> ln -s ../init.d/gutenbach /etc/rc6.d/K39gutenbach
 
 XXX: We need better permissions for status. Also, quentin wants to put this
@@ -116 +116 @@
 running a printer! The magic lines are:
 
-    :if=|/path/to/sipbmp3-filter
+    :if=|/path/to/gutenbach-filter
     :lp=/dev/null
 
-Which mean that we pipe the mp3 files through sipbmp3-filter (which does
+Which mean that we pipe the mp3 files through gutenbach-filter (which does
 the actual playing), and then dump the rest of the output into /dev/null,
 since we don't actually care about it.
@@ -129 +129 @@
   :cm=Human Readable Printer Name
   :lp=/dev/null
-  :if=|/path/to/sipbmp3-filter
+  :if=|/path/to/gutenbach-filter
   :sd=/var/spool/lpd/printername
   :ml=0:mx=0:sh:sf
@@ -148 +148 @@
 in the future.
 
-WARNING: On a cluster machine, get_hesiod_pcap will clobber sipbmp3
-because it sets all:all=someotherprinter, making lpr not see sipbmp3.
+WARNING: On a cluster machine, get_hesiod_pcap will clobber gutenbach
+because it sets all:all=someotherprinter, making lpr not see gutenbach.
 There are two ways of fixing this:
 
@@ -190 +190 @@
 properly, so removing the REJECT line is a must!
 
-XXXXXX: sipbmp3 accepts no responsibility for social faux pas that may
+XXXXXX: gutenbach accepts no responsibility for social faux pas that may
 be committed with this system.  It is consider good etiquette, however,
 to clear the status file if you're on zsr.
@@ -206 +206 @@
 7. Test, round one
 
-The first test you should do to make sure sipbmp3 is configured properly is
+The first test you should do to make sure gutenbach is configured properly is
 to attempt to play an mp3 file locally, via lpr.  The command you should use
 is:
@@ -258 +258 @@
 further:
 
-    * Check the zephyr logs of the class sipbmp3 was configured to
+    * Check the zephyr logs of the class gutenbach was configured to
       send messages to:
 
@@ -269 +269 @@
           *software* volume.
 
-        - If you see a blank zephyr, that means that sipbmp3-filter died
-          trying to get a handle to /var/run/sipbmp3/status and failing.
+        - If you see a blank zephyr, that means that gutenbach-filter died
+          trying to get a handle to /var/run/gutenbach/status and failing.
           Check if you created the file correctly, and that daemon has
           permissions to write to it. If you rebooted recently, check if
@@ -281 +281 @@
           exiftools is not installed.
 
-    * Otherwise, double check the userland code in sipbmp3-filter. XXX: There
+    * Otherwise, double check the userland code in gutenbach-filter. XXX: There
       are some edge-cases that don't give nice error messages, for example
-      the failed write to /var/run/sipbmp3/status
+      the failed write to /var/run/gutenbach/status
 
 
@@ -292 +292 @@
 In order to do this, you will need to ask IS&T for a Moira pcap entry
 request.  Send mail to hesreq@mit.edu, specifying that you are setting
-up a sipbmp3 clone, that you want a Moira pcap entry, the printer name
+up a gutenbach clone, that you want a Moira pcap entry, the printer name
 and server name of your queue, and that you want hwtype=LOCAL,ka=1. It wouldn't
 hurt to also tell them where your print queue is, and a contact list.
@@ -326 +326 @@
 Finally, edit /etc/printcap and give it information about the Kerberos:
 
-sipbmp3: server
+gutenbach: server
     :cm=SIPB MP3 Spooler
     ...
@@ -351 +351 @@
 You will probably need to apt-get install remctl-server. Then, replace
 the /etc/remctl/conf.d directory with a Git checkout of
-/afs/sipb/project/sipbmp3/sipbmp3-remctl.git.
+/afs/sipb/project/sipbmp3/gutenbach-remctl.git.
 
 Please note that remctl will NOT work without a keytab setup.
 
 
-X. Deploying sipbmp3web
+X. Deploying gutenbachweb
 ------------------------
 
-sipbmp3 web provides a nice and user-friendly interface for some common
+gutenbach web provides a nice and user-friendly interface for some common
 tasks. XXX: It is currently not portable beyond zsr. Stay tuned!
 
@@ -367 +367 @@
 If things are broken on a reboot, make sure you're running:
 
-    /etc/init.d/{sipbmp3,zhm,debatehna-lprng}
+    /etc/init.d/{gutenbach,zhm,debatehna-lprng}