From 22c2694c360fa560fefc899d75a38431ae0b2e3a Mon Sep 17 00:00:00 2001 From: rembo10 Date: Fri, 22 Jul 2011 18:29:20 -0700 Subject: [PATCH] Created Usage Guide (markdown) --- Usage-Guide.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 Usage-Guide.md diff --git a/Usage-Guide.md b/Usage-Guide.md new file mode 100644 index 0000000..2a7cfa8 --- /dev/null +++ b/Usage-Guide.md @@ -0,0 +1,52 @@ +## Getting Started + +The first thing you'll probably want to do when starting up Headphones is modify the settings and then import your music library. This guide will show you how to do that - and more. If you haven't already gotten it running, see [this guide](https://github.com/rembo10/headphones/wiki/Installation) on getting it installed. + +Once the web interface has launched, and you see the following screen, you can get started: + +(http://img705.imageshack.us/img705/3177/screenshot20110722at602.png) + +## Modifying Settings + +Click on 'Settings' in the tab. That will bring you to a screen where you can configure Headphones to correctly on your system. + +The first thing you may want to modify is the network settings. This includes the host, port, username and password, and whether or not you want a browser to launch when Headphones starts. + +### Web Interface +(http://img593.imageshack.us/img593/3177/screenshot20110722at602.png) +You probably won't need to modify the host or the port, but if you have something else running on port 8181, change the 'HTTP Port' setting to something else. + +If you want to secure access to Headphones, set a username and password. You will be prompted to enter this information after a restart. + +If you want to start Headphones without a browser launching each time, uncheck the 'Launch Browser on Startup' option. + +Now, we'll configure the download settings. + +### Download Settings +(http://img849.imageshack.us/img849/3177/screenshot20110722at602.png) + +Currently there are two ways to download NZBs: either send them directly to SABnzbd, or download them to a "black hole" directory. + +If you already have SABnzbd up and running, enter your SAB details in the relevant spots, including your username and password if you set one up. Make sure your SAB host is something like 'localhost:8080' and not 'http://localhost:8080'. + +If you prefer to download the NZB files directly to a folder, check the 'Use Black Hole' option (note: if you have SABnzbd details filled out, and have the 'Use Black Hole' option checked, Headphones will default to the black hole method). Enter the full path to where you want your NZBs to go in the 'Black Hole Directory' box. + +Enter your servers retention in the last box and scroll down to the next section. + +### Search Providers +(http://img856.imageshack.us/img856/9828/screenshot20110722at603.png) +Enter all your relevant search providers information here. Make sure to check the boxes for the providers you want to use. If you're using Newznab, enter the hostname such as 'http://nzb.su' + +### Quality & Post Processing +(http://img263.imageshack.us/img263/9828/screenshot20110722at603.png) +There are four options for album quality choice when downloading: + +1. Highest Quality excluding Lossless: This option will download the highest quality mp3 versions of the albums you want. +2. Highest Quality including Lossless: This option will try to download a FLAC version of the albums you want, but if it can't find them, it will download the mp3 version. +3. Lossless Only: This option will look only look for FLAC versions, and won't download anything less! +4. Preferred Bitrate: You can set a target bitrate (good for those who like VBR!) and it will find the version of the album that is as close to the right size as possible, based on the duration of the particular album. If you check 'Auto-Detect bitrate', Headphones will try to figure out what bitrate your music collection is in during the next music scan (we'll get to that later) + +Post-Processing doesn't work yet so we'll skip that for now. + +Enter the full path to where you store your music and you're done! Click 'Save changes', and restart if you made any changes to the Web Interface settings. You may need to point your browser to the new port if you changed that. You may also be prompted for a username and password if you enabled them. +