Home - Tensai75/nzb-monkey-go GitHub Wiki

Installation

  1. Download the correpsonding binary from the Releases page.
  2. Extract the zip file or install the deb package.
  3. For MacOS only: make an exception for the unsigned binary to run.
  4. Run the program

Windows/MacOS: With the first run a configuration file config.txt will be generated in the same folder where the binary is located.

Linux: With the first run a configuration file nzb-monkey-go.conf will be generated in the folder ~/.config.

The configuration file needs to be edited according to your requirements. See further information below.

For Windows & Linux also the NZBLNK URI protocol is automatically registered to NZB Monkey Go during this first program run. For MacOS some solutions on how to register the protocol for the original NZB Monkey have been discussed on the NZB Monkey Github Issues page which should work for the NZB Monkey Go as well.

If the NZBLNK URI protocol gets de-registered from NZB Monkey Go, it can be re-registered by renameing or removing the configuration file and running the binary again. Alternative the protocol can be registered using the --register option argument in the command line (see below).

Configuration

Detailed information about the options in the different sections of config.txt or nzb-monkey-go.conf respectively can be found here:

GENERAL(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BGENERAL%5D)

CATEGORIZER(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BCATEGORIZER%5D)

EXECUTE(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BEXECUTE%5D)

SABNZBD(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BSABNZBD%5D)

NZBGET(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BNZBGET%5D)

SYNOLOGYDLS(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BSYNOLOGYDLS%5D)

NZBCheck(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BNZBCheck%5D)

CATEGORIZER(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BCATEGORIZER%5D)

SEARCHENGINES(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BSEARCHENGINES%5D)

DIRECTSEARCH(https://github.com/Tensai75/nzb-monkey-go/wiki/%5BDIRECTSEARCH%5D)

Command line usage

NZB Monkey Go can be used with flags and parameters via command line, e.g. for scripting usage.

Usage

nzb-monkey-go.exe [--subject SUBJECT] [--title TITLE] [--password PASSWORD] [--group GROUP] [--date DATE] [--category CATEGORY] [--config CONFIG] [--debug] [--register] [NZBLNK]

Positional arguments:

  • NZBLNK

    A qualified NZBLNK URI (nzblnk://?h=...).

Option arguments:

  • --subject SUBJECT, -s SUBJECT

    The header/subject to search for. Equivalent to parameter h in a nzblnk.

  • --title TITLE, -t TITLE

    The title/tag for the NZB file. Equivalent to parameter t in a nzblnk.

  • --password PASSWORD, -p PASSWORD

    The password to extract the download. Equivalent to parameter p in a nzblnk.

  • --group GROUP, -g GROUP

    The group(s) to search in (several groups seperated with space). Equivalent to parameter g in a nzblnk.

  • --date DATE, -d DATE

    The date the upload was posted to Usenet (either in the format DD.MM.YYYY or as a Unix timestamp). Equivalent to parameter d in a nzblnk.

  • --category CATEGORY, -c CATEGORY

    Force the category to be use for the target (if supportet by the target).

  • --config CONFIG

    Path to the config file. This option can be used to have different config files for different purposes.

  • --debug

    Log debug output to log file logfile.txt (Windows/MacOs) or /tmp/nzb-monkey-go.log (Linux).

  • --register

    Register the NZBLNK protocol. Can be used to re-register the config file without haveing to delete/rename the config.txt or nzb-monkey-go.conf file.

  • --help, -h

    Display a help text and exit.

  • --version

    Display the program version and exit.

A NZBLNK and arguments can be passed in parallel. Parameters that are passed as arguments have precedence over the parameters of the NZBLNK.