Skip to content

Configuration

Before you can use juicenet, you'll have to configure it. This is a one time thing after which you can pretty much forget about it.

Reference

juicenet requires you to put your configuration in a file called juicenet.yaml.

Required keys

Key Description
NYUU_CONFIG_PRIVATE Path to a valid Nyuu configuration file
NZB_OUTPUT_PATH Path to a directory where juicenet will store it's output

Optional keys

Key Description Default
PARPAR The path to the ParPar binary PATH
NYUU The path to the Nyuu binary PATH
NYUU_CONFIG_PUBLIC The path to the public Nyuu configuration file NYUU_CONFIG_PRIVATE
EXTENSIONS The list of file extensions to be processed ["mkv"]
RELATED_EXTENSIONS The list of file extensions associated with an input file. For example, if you have a file named Big Buck Bunny The Movie (2023).mkv, another file named Big Buck Bunny The Movie (2023).srt is considered related ["ass", "srt"]
PARPAR_ARGS The arguments to be passed to the ParPar binary --overwrite -s700k --slice-size-multiple=700K --max-input-slices=4000 -r1n*1.2 -R
USE_TEMP_DIR Whether or not to use a temporary directory for processing True
TEMP_DIR_PATH Path to a specific temporary directory if USE_TEMP_DIR is True %Temp% or /tmp/
APPDATA_DIR_PATH The path to the folder where juicenet will store its data ~/.juicenet

Example configuration file

# Do not quote your paths. Paste them as is
PARPAR: C:\Users\user\bin\parpar.exe
NYUU: C:\Users\user\bin\nyuu.exe

# https://juicenet.ravencentric.cc/nyuu-config-files/
NYUU_CONFIG_PRIVATE: C:\Users\user\nyuu\config-private.json

NZB_OUTPUT_PATH: D:\output\nzbs
EXTENSIONS: ["mkv", "epub", "cbr", "cbz", "cb7", "cbt"]

# Use %Temp% on Windows or /tmp on Unix for temporary files.
# Setting it to False will generate temporary files right next to the input files
USE_TEMP_DIR: True

# Advanced Setting (Only modify if you know what you're doing)
# Do NOT pass -o, --filepath-format, and --filepath-base. They are handled by the script.
PARPAR_ARGS: ["--overwrite", "-s700k", "--slice-size-multiple=700K", "--max-input-slices=4000", "-r1n*1.2", "-R"]

Loading the config file

Now that you've got your juicenet.yaml ready, you have to pass it to juicenet. This can be achieved in one of three ways:

  • Using the command-line argument

    juicenet --config "path/to/juicenet.yaml" [OPTIONS] <path>

  • Setting an environment variable named JUICENET_CONFIG with the full path to your juicenet.yaml. If you do this, it'll never fall back to using juicenet.yaml from current working directory. This is also convenient since you no longer have to pass --config everytime.

  • Placing the configuration file in the current working directory as juicenet.yaml

Note

The order of precedence, if all three are present, is: command-line argument > environment variable > local file in the current working directory