X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=INSTALL;h=31bc112a06eee11ccc4661fe4d49be6015176afd;hp=adb75c5c6e02c0f8528485d3fa3d959762b1e801;hb=2bb9fcbfa99cf30a6f46ba33fd95c0a456a225cc;hpb=856d16551da3cc1903406f329c4686e26280b08e diff --git a/INSTALL b/INSTALL index adb75c5c..31bc112a 100644 --- a/INSTALL +++ b/INSTALL @@ -1,30 +1,51 @@ -Paraslash install notes -======================= +INSTALL +======= +---- Any knowledge of how to work with mouse and icons is not required. +--------------------------- Install all needed packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~ -See README for a list of required software. Don't be afraid of the long -list of unusal libraries: Most of them are only needed for optional -programs. Autoconf will detect what is installed on your system and -will only build those executables that can be built with your setup. - - +--------------------------- +See +<< + REQUIREMENTS +>> +for a list of required software. You don't need everything listed +there. In particular, mp3, ogg vorbis and aac, ortp support is +optional. Autoconf will detect what is installed on your system +and will only try to build those executables that can be built with +your setup. + +Note that no special library (not even the mp3 decoding library libmad) +is needed for para_server if you only want to stream mp3 files. +Also, it's fine to use para_server on a box without sound card as +para_server only sends the audio stream to connected clients. + +------------------------- Install server and client -~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------- + Install the package on all machines, you'd like this software to run on: (./configure && make) > /dev/null -There should be no errors (but probably many warnings about missing -software). Then, as root, +There should be no errors but probably some warnings about missing +software packages which usually implies that not all audio formats will +be supported. If headers or libs are installed at unusual locations +you might need to tell the configure script to find them. Try - make install + ./configure --help +to see a list of options. If the paraslash package was compiled +successfully, execute as root, + make install + +----------------------------------- Setup user list and create rsa keys -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------------- + If you already have your rsa keys, skip this step. If you are new to paraslash, you have to generate an rsa key pair for each user you want to allow to connect. You need at least one user. @@ -37,11 +58,11 @@ following commands: target=~/.paraslash/server.users key=~/.paraslash/key.pub.bar - perms=DB_READ,DB_WRITE,AFS_READ,AFS_WRITE + perms=AFS_READ,AFS_WRITE,VSS_READ,VSS_WRITE mkdir -p ~/.paraslash echo "user bar $key $perms" >> $target -This gives bar full privileges. +This gives "bar" the full privileges. Change to the bar account on client_host and generate the key-pair with the commands @@ -63,16 +84,17 @@ server_host=client_host): Finally, tell para_client to connect to server_host: - echo 'hostname server_host' > ~/.paraslash/client.conf + conf=~/.paraslash/client.conf + echo 'hostname server_host' > $conf +----------------- Start para_server -~~~~~~~~~~~~~~~~~ -For the first try, we'll use the default audio file selector, the -"random" selector which chooses audio files from the given directory -by random. You have to tell para_server via the --random_dir command -line option where this selector should look for audio files. +----------------- - para_server --random_dir=/my/mp3/directory +For this first try, we'll use a debug level of two to make the +output of para_server more verbose. + + para_server -l 2 Now you can use para_client to connect to the server and issue commands. Open a new shell (as "bar" on "client_host" in the above @@ -82,82 +104,106 @@ example) and try para_client si to retrieve the list of available commands and some server info. +Don't proceed if this doesn't work. -Start streaming manually -~~~~~~~~~~~~~~~~~~~~~~~~ +------------------- +Create the database +------------------- - para_client play - para_client stat 2 + para_client init -This starts streaming and dumps some information on the current song -to stdout. +This creates some empty tables under ~/.paraslash/afs_database. +You normally don't need to look at these tables, but it's good +to know that you can start from scratch with -You should now be able to listen to the stream with any player -capable of reading from stdin. To check this, try the following -on client_host: + rm -rf ~/.paraslash/afs_database - mp3: +in case something went wrong. - para_recv -r 'http -i server_host' | para_filter -f mp3dec -f wav | para_write -w alsa - or - mpg123 http://server_host:8000/ - or - xmms http://server_host:8000/ +Next, you need to fill the audio file table of that database with +contents so that para_server knows about your audio files. Choose an +absolute path to a directory containing some audio files and add them +to the audio file table: - ogg: + para_client add /my/mp3/dir - para_recv -r 'http -i server_host' | para_filter -f oggdec -f wav | para_write -w alsa +This might take a while, so it is a good idea to start with a directory +containing not too many audio files. Note that the table only contains +data about the audio files found, not the files themselves. -If this works, proceed. Otherwise doublecheck what is logged by -para_server and use the --loglevel option of para_recv, para_filter -to increase verbosity. +Print a list of all audio files found with -Choose an audio file selector -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -paraslash has three different audio file selectors: random (default), -playlist and mysql. + para_client ls - The random selector chooses files randomly from the given - directory. +------------------------ +Start streaming manually +------------------------ - The playlist selector allows to send a playlist to para_server - via the lpl (load playlist) command. para_server will choose - files from the loaded playlist in sequential order. + para play + para stat 2 - The mysql selector stores information about your audio - files in a mysql database. It is much more involved than - the other two selectors and lets you chose files in many - interesting ways. If you like to use the mysql selector, - read README.mysql and follow the instructions given there. - Return to this document when ready. +This starts streaming and dumps some information about the current +audio file to stdout. -The current audio file selector can be changed at runtime via +You should now be able to receive the stream and listen to it. If +you have mpg123 or xmms handy, execute on client_host - para_client chs new_selector + mpg123 http://server_host:8000/ +or + xmms http://server_host:8000/ + +Paraslash comes with its own receiving and playing software, which +will be described next. Try the following on client_host (assuming +Linux/ALSA and an mp3 stream): + para_recv -l 2 -r 'http -i server_host' > file.mp3 + # (interrupt with CTRL+C after a few seconds) + ls -l file.mp3 # should not be empty + para_filter -f mp3dec -f wav < file.mp3 > file.wav + ls -l file.wav # should be much bigger than file.mp3 + para_write -w alsa < file.wav + +If this works, proceed. Otherwise double check what is logged by +para_server and use the --loglevel option of para_recv, para_filter +and para_write to increase verbosity. +Next, put the pieces together: + + para_recv -r 'http -i server_host' \ + | para_filter -f mp3dec -f wav \ + | para_write -w alsa + +--------------------- Configure para_audiod -~~~~~~~~~~~~~~~~~~~~~ +--------------------- + In order to automatically start the right decoder at the right time and to offer to the clients some information on the current audio stream and on paraslash's internal state, you should run the local -audio daemon, para_audiod, on every machine that is supposed to play -the audio stream. Try +audio daemon, para_audiod, on every machine in your network which is +supposed to play the audio stream. Try para_audiod -h -for help. Usually you have to specify at least server_host as the -receiver specifier, like this: +for help. Usually you have to specify only server_host as the receiver +specifier for each supported audio format, like this: - -r 'mp3:http -i server_host' + para_audiod -l 2 -r 'mp3:http -i server_host' -The prefered way to use para_audiod is to run it once at system start +The preferred way to use para_audiod is to run it once at system start as an unprivileged user. para_audiod needs to create a "well-known" -socket for the clients to connect to. If you want to change the -default socket (e.g. because you do not have write access for the -directory where the socket resides), use the -s option or the config -file to change the default. Note that in this case you'll also have -to specify the same value for para_audioc's -s option. +socket for the clients to connect to. The default path for this +socket is + + /var/paraslash/audiod_socket.$HOSTNAME + +so the /var/paraslash directory should be writable for the user who +runs para_audiod. + +If you want to change the location of the socket, use the -s option +for para_audiod or the config file ~/.paraslash/audiod.conf to change +the default. Note that in this case you'll also have to specify the +same value for para_audioc's -s option. If para_server is playing, you should be able to listen to the audio stream as soon as para_audiod is started. Once it is running, try @@ -172,43 +218,29 @@ That should dump some information to stdout. Other commands include para_audioc term para_audioc cycle - +-------------- Start para_gui -~~~~~~~~~~~~~~ +-------------- + para_gui reads the output of "para_audioc stat" and displays that information in a curses window. It also allows you to bind keys to arbitrary commands. There are several flavours of key-bindings: - o internal: These are the built-in commands that can not be - changed (help, quit, loglevel, version...). - - o external: Shutdown curses before launching the given command. - Useful for starting other ncurses programs from within - para_gui, e.g. aumix or para_dbadm. Or, use - - para_client mbox - - to write a mailbox containing one mail for each file - in the mysql database and start mutt from within para_gui - to browse your collection! - - o display: Launch the command and display its stdout in - para_gui's bottom window. - - o para: Like display, but start "para_client " instead of "". - - -That's all, congratulations. Check out all the other optional gimmics! - -Troubles? -~~~~~~~~~ -If something went wrong, look at the output. If that does not give -you a clue, use loglevel one (option -l 1 for most commands) to show -debugging info. Almost all paraslash executables have a brief online -help which is displayed by using the -h switch. - -Still not working? Mail the author Andre Noll -(english, german, or spanish language). Please provide enough info -such as the version of paraslash you are using and relevant parts of -the logs. + - internal: These are the built-in commands that can not be + changed (help, quit, loglevel, version...). + - external: Shutdown curses before launching the given command. + Useful for starting other ncurses programs from within + para_gui, e.g. aumix or dialog scripts. Or, use the mbox + output format to write a mailbox containing one mail for each + (admissible) file the audio file selector knows about. Then + start mutt from within para_gui to browse your collection! + - display: Launch the command and display its stdout in + para_gui's bottom window. + - para: Like display, but start "para_client " instead of "". + +This concludes the installation notes. Next thing you might to have a look +at is how to use paraslash's audio file selector. See +<< + README.afs +>>