mirror of
https://github.com/clinton-hall/nzbToMedia.git
synced 2025-08-21 22:03:13 -07:00
Darn formatting + more descriptions
This commit is contained in:
parent
33ccc32c91
commit
d132c6935a
1 changed files with 154 additions and 12 deletions
150
README.md
150
README.md
|
@ -52,13 +52,21 @@ Installation
|
|||
fields as they apply to your installation.
|
||||
|
||||
host: Set this to "localhost" if CouchPotatoServer and your download client are on the same system. otherwise enter the ipaddress of the system SickBeard is insatlled on.
|
||||
|
||||
port: Set this to the port that CouchPotatoServer is running on.
|
||||
|
||||
username: Set this to the user name required to log on to the CouchPotatoServer web GUI. (optional)
|
||||
|
||||
password: Set this to the password required to log on to the CouchPotatoServer web GUI. (optional)
|
||||
|
||||
web_root: Set this to the web_root value specified in CouchPotatoServer for Apache Reverse Proxy. (optional)
|
||||
|
||||
ssl: Set this to "1" if you access CouchPotatoServer via ssl (https) otherwise leave this as "0" for http.
|
||||
|
||||
Delay: Delay must be a minimum of 60 seconds for the renamer.scan to run successfully. CouchPotatoServer performs a test to ensure files/folder are not newer than 1 minute to prevent renaming of files that are still extracting.
|
||||
|
||||
apikey: Enter the api key used for CouchPotatoServer. Found in CouchPotatoServer->settings->general (addvanced setting)
|
||||
|
||||
Method: Method "renamer" is the default which will cause CouchPotatoserver to move and rename downloaded files as specified in the CouchPotatoServer renamer settings.
|
||||
This will also add the movie to the manage list and initiate any configured notifications.
|
||||
In this case your nzb client must extract the files to the "from" folder as specified in your CouchPotatoServer renamer settings. Renamer must be enabled but automatic scan can be disabled by setting "Run Every" to "0".
|
||||
|
@ -75,26 +83,41 @@ Installation
|
|||
The following must be configured in SickBeard:
|
||||
|
||||
1. Config -> Search Settings -> NZB Search
|
||||
|
||||
i. NZB Method = Either SABnzbd or NZBget as appropriate
|
||||
|
||||
ii. NZBget HOST:PORT - SABnzbd URL = the url/host and port for your download client.
|
||||
|
||||
iii. SABnzbd Username = The username required to log in to sabnzbd web GUI
|
||||
|
||||
iv. NZBget Password - SABnzbd Passowrd = The password required to log in to your download client's web GUI.
|
||||
|
||||
v. SABnzbd API Key = The api key used by SABnzbd (Found in sabnzbd -> config -> general -> SABnzbd Web Server)
|
||||
|
||||
vi. NZBGet Category - SABnzbd Category = A category that is used by your download client (e.g. "TV", or "SickBeard")
|
||||
|
||||
2. Settings -> Post Processing -> Post Processing
|
||||
|
||||
i. TV Download Dir = blank
|
||||
|
||||
ii. Keep Original Files = user choice. (option)
|
||||
|
||||
iii. Move Associated Files = user choice. (option)
|
||||
|
||||
iv. Rename Episodes = must be ticked.
|
||||
|
||||
v. Scan and Process = must be unticked.
|
||||
|
||||
3. Settings -> Post Processing -> Naming
|
||||
|
||||
The naming must be specified as per user choice.
|
||||
|
||||
This naming will be applied to all shows processed via the postprocess script.
|
||||
|
||||
4. Settings -> Post Processing -> Metadata
|
||||
|
||||
The metadata wanted must be specified as per user choice.
|
||||
|
||||
This metadata creationg will be applied to all shows processed via the postprocess script.
|
||||
|
||||
### CouchPotatoServer
|
||||
|
@ -104,19 +127,29 @@ The following must be configured in CouchPotatoServer:
|
|||
1. Settings -> Downloaders -> Sabnzbd (or NZBGet)
|
||||
|
||||
i. Host = The url/host and port for your download client.
|
||||
|
||||
ii. Api Key = The api key used by SABnzbd (Sabnzbd only: Found in sabnzbd -> config -> general -> SABnzbd Web Server)
|
||||
|
||||
iii. Password = The password required to log in to NZBget's web GUI. (NZBget only)
|
||||
|
||||
iv. Category = A category that is used by your downlaod client (e.g. "movies", or "CouchPotato")
|
||||
|
||||
v. Delete Failed = Should be unticked (Sabnzbd only)
|
||||
|
||||
2. Settings -> Renamer -> "Rename downloaded movies" should be checked and the settings below applied:
|
||||
|
||||
i. From = Must be set to the full path to your completed download movies (including any additional category paths)
|
||||
|
||||
e.g. %sabnzbd_download_complete/movies
|
||||
|
||||
ii. To = Must be set to the folder where you want your movie library to be kept. this would also usually be added to manage.
|
||||
|
||||
iii. Run Every = Should be set to a high interval (e.g. 1440 = 24 hours) or disabled by setting "0"
|
||||
|
||||
iv. Force Every = Should be set to a high interval (e.g 24 hours) or disabled by setting "0"
|
||||
|
||||
v. Next On_failed = Should be unticked.
|
||||
|
||||
> These last 3 settings are "advanced settings" so to change these you will need to select the option "show advanced settings" on the top right of all settings pages.
|
||||
|
||||
### SABnzbd
|
||||
|
@ -148,11 +181,120 @@ If you are using NZBGet perform the following steps to configure postprocessing
|
|||
|
||||
1. Replace the config files with the ones from the included "nzbget-postprocessing-files" according to the version you are using (0.8.0 or 9.0):
|
||||
|
||||
These files enable additional postprocessing settings for CouchPotato (and SickBeard as well) in the NZBGet webinterface.
|
||||
These files enable additional postprocessing settings for CouchPotato and SickBeard, as well as a "Custom" postprocess script, in the NZBGet webinterface.
|
||||
If NZBGet is running either restart (0.8.0) or reload (9.0) to activate the changes after you have replaced the files.
|
||||
To be on the safe side, don't forget to make a backup of the existing files!
|
||||
|
||||
2. In NZBGet go to "POSTPROCESSING SCRIPT" -> "PATHS" and apply the option "NzbToCouchpotato" according to your environment,
|
||||
this setting configures the path where NZBGet has to look for "nzbToCouchpotato.py".
|
||||
2. In NZBGet go to "POSTPROCESSING SCRIPT" -> "PATHS" and change as needed:
|
||||
|
||||
3. Then go to "POSTPROCESSING SCRIPT" -> "OPTIONS" and set there the category which you want to use for CouchPotato post-processing.
|
||||
i. Set the full path to python if it is not in your PATH.
|
||||
|
||||
PythonCmd=/usr/local/python/bin/python
|
||||
|
||||
ii. Set the full path to sabToSickBeard.py for SickBeard's postprocessing.
|
||||
|
||||
NzbToSickBeard=/usr/local/nzbget/var/nzbToSickBeard.py
|
||||
|
||||
iii. Set the full path where completed movies should be placed before SickBeard's Renamer is called (option)
|
||||
|
||||
TvDownloadDir=
|
||||
|
||||
iv. Set the full path to nzbToCouchpotato.py for Couchpotato's postprocessing
|
||||
|
||||
NzbToCouchPotato=/usr/local/nzbget/var/nzbToCouchPotato.py
|
||||
|
||||
v. Set the full path where completed movies should be placed before CouchPotato's Renamer is called (option)
|
||||
|
||||
MoviesDownloadDir=
|
||||
|
||||
vi. Set the full path to any dependency required for your Custom Postprocess script if it is not in your PATH.
|
||||
|
||||
CustomCmd=/usr/local/python/bin/python
|
||||
|
||||
vii. Set the full path to the Custom Postprocess script. (option)
|
||||
|
||||
CustomScript=
|
||||
|
||||
viii.Set the full path where completed downloads should be placed before the Custom postprocess is called (option)
|
||||
|
||||
CustomDownloadDir=
|
||||
|
||||
3. Then go to "POSTPROCESSING SCRIPT" -> "OPTIONS" and set:
|
||||
|
||||
i. Perform SickBeard's postprocessing (yes, no).
|
||||
|
||||
SickBeard=yes
|
||||
|
||||
ii. Category for SickBeard's postprocessing.
|
||||
|
||||
SickBeardCategory=tv
|
||||
|
||||
iii. Perform Couchpotato's postprocessing (yes, no).
|
||||
|
||||
CouchPotato=yes
|
||||
|
||||
iv. Category for Couchpotato's postprocessing. (option)
|
||||
|
||||
CouchPotatoCategory=movies
|
||||
|
||||
v. Perform Custom postprocessing (yes, no). (option)
|
||||
|
||||
Custom=
|
||||
|
||||
vi. Category for Custom postprocessing (eg. movies) (option)
|
||||
|
||||
CustomCategory=
|
||||
|
||||
4. Then go to "POSTPROCESSING SCRIPT" -> "EMAIL-PARAMETERS" and set:
|
||||
|
||||
i. Specify if you want emails to be sent for successful downloads.
|
||||
|
||||
Email_successful=yes
|
||||
|
||||
ii. Specify if you want emails to be sent for failed downloads.
|
||||
|
||||
Email_failed=yes
|
||||
|
||||
iii. Set the full path and file name for sendEmail application (as supplied in this repository).
|
||||
|
||||
sendEmail=/usr/local/nzbget/var/sendEmail/sendEmail
|
||||
|
||||
iv. Enter the email address you want this email to be sent from.
|
||||
|
||||
Email_From=nzbget@nas.home
|
||||
|
||||
v. Enter the email address you want this email to be sent to.
|
||||
|
||||
Email_To=me@home.net
|
||||
|
||||
vi. Enter smtp server and port. eg smtp.live.com:25
|
||||
|
||||
Email_Server=smtp.live.com:25
|
||||
|
||||
vii. Enter your smtp server user name (if required)
|
||||
|
||||
Email_User=
|
||||
|
||||
viii.Enter your smtp server password (if required)
|
||||
|
||||
Email_Pass=
|
||||
|
||||
ix. Enter your email subject in quotes.
|
||||
|
||||
Use <status> to add 'completed'/'failed'
|
||||
|
||||
Use <name> to add the nzb name
|
||||
|
||||
Use <cat> to add the download categoty.
|
||||
|
||||
Use <script> to name the external script used.
|
||||
|
||||
Email_Subject="The Download of <name> has <status>"
|
||||
|
||||
x. Enter your email message in quotes.
|
||||
|
||||
Use the same substitutes as described above.
|
||||
|
||||
Use /n for new line.
|
||||
|
||||
Email_Message="The download of <name> has <status> /n This has been processed by the script <script> for category <cat>"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue