diff --git a/docs/firefly-manual.xml b/docs/firefly-manual.xml new file mode 100644 index 00000000..3fb79982 --- /dev/null +++ b/docs/firefly-manual.xml @@ -0,0 +1,205 @@ + + +
+ Firefly Media Server Manual + +
+ Overview + + The Firefly Media Server is an open-source media server for the Roku + SoundBridge and iTunes. Generally, it supports the following + features: + + + + Integrates with iTunes, reading playlists even when iTunes is + not running + + + + Runs in the background, without requiring user login + (unix/windows) + + + + System tray (Windows)/Preference Pane (ouMac) allows for quick + and easy configuration + + + + Web-based interface allows for more advanced + configuration + + + + Support transcoding of many audio formats, including AAC, ALAC, + WMA, FLAC, and Ogg/Vorbis. (Supported formats vary by platform) + + + + Cross platform, running on Windows, Mac, and Linux + + + + Actively developed + + + + Full details of configuring and installing Firefly to take advantage + of these features are detailed below. +
+ +
+ Installation + + Firefly Media Server can be downloaded from the project web site at + http://www.fireflymediaserver.org. This manual describes the + current stable version: svn-1359. + + If you anticipate using a Roku SoundBridge as a client to the + Firefly Media Server, please consider upgrading the Roku firmware to + version 2.5.173 or later. To check your software version and to upgrade, + use your SoundBridge remote to go to Change Library or + Configuration->System Configuration->Software Version and Updates. + Follow the on screen instructions to check for newer software and to + upgrade. + + Details of installing the Firefly Media Server vary by platform. + Please read the detailed installation instructions for the platform you + use. + +
+ Windows Installation + + The Firefly Media Server will run on Windows 2000 or Window XP + workstations. Please follow the steps below to install the Firefly Media + Server. + + + + Download and install Apple's Bonjour for Windows. At the time + of this writing, this can be found at the following location: + http://www.apple.com/support/downloads/bonjourforwindows103.html. + + + + If you wish to transcode WMA files, including WMA Lossless, + please download and install Microsoft's Windows Media Player 10 or + later. + + + + Download and install svn-1359 from the Firefly Media Server + site at http://www.fireflymediaserver.org + + + + After following the directions in the installer, the Firefly + server should start automatically and being indexing music files. Once + the files are indexed (at approximately 5000 songs per minute), the + Firefly server should appear in iTunes or the Roku SoundBridge. If it + does not, please refer to the troubleshooting section. +
+ +
+ Mac Installation + + The instructions for the Mac installation are contained in the + README file in the Mac disk image. + + + + Download the current Mac disk image from + http://www.fireflymediaserver.org + + + + Mount the .dmg file by double-clicking on it + + + + Follow the instructions in the README file + + + + Once installed, use the Preference Pane just installed to start + the Firefly Server. The initial startup will take some time, as the + server must index all existing songs. One the server has finished + indexing the files, it should appear in iTunes, or in the Roku + SoundBridge library browser. If it does not, please refer to the + troubleshooting section. + + +
+
+ +
+ Configuration + + There are generally three ways to configure the Firefly Media + Server: Using the tray applet/prefs panel on Windows and Mac, by editing + the configuration file directly, or by using the web-based configuration + interface. + +
+ General + + +
+ +
+ Windows Tray Applet + + +
+ +
+ Mac Preference Panel + + +
+ +
+ Config File Editing + + +
+ +
+ Web Interface Configuration + + +
+
+ +
+ Resources + + + +
+ Playlists + + +
+ +
+ XML-RPC Guide + + +
+ +
+ Troubleshooting + + +
+ +
+ FAQ + + +
+
+
\ No newline at end of file