Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- # Sample configuration file for NZBGet
- #
- # On POSIX put this file to one of the following locations:
- # ~/.nzbget
- # /etc/nzbget.conf
- # /usr/etc/nzbget.conf
- # /usr/local/etc/nzbget.conf
- # /opt/etc/nzbget.conf
- #
- # On Windows put this file in program's directory.
- #
- # You can also put the file into any location, if you specify the path to it
- # using switch "-c", e.g:
- # nzbget -c /home/user/myconfig.txt
- # For quick start change the option MainDir and configure one news-server
- ##############################################################################
- ### PATHS ###
- # Root directory for all tasks.
- #
- # On POSIX you can use "~" as alias for home directory (e.g. "~/download").
- # On Windows use absolute paths (e.g. "C:\Download").
- MainDir=/media/HDD1/Downloads/NZBs/NZBget
- # Destination directory for downloaded files.
- #
- # If you want to distinguish between partially downloaded files and
- # completed downloads, use also option <InterDir>.
- DestDir=/media/HDD1/Downloads/Completed
- # Directory to store intermediate files.
- #
- # If this option is set (not empty) the files are downloaded into
- # this directory first. After successful download of nzb-file (possibly
- # after par-repair) the files are moved to destination directory
- # (option <DestDir>). If download or unpack fail the files remain in
- # intermediate directory.
- #
- # Using of intermediate directory can significantly improve unpack
- # performance if you can put intermediate directory (option <InterDir>)
- # and destination directory (option <DestDir>) on separate physical
- # hard drives.
- #
- # NOTE: If the option <InterDir> is set to empty value the downloaded
- # files are put directly to destination directory (option <DestDir>).
- InterDir=/media/HDD1/Downloads/NZBs/NZBget/interdir
- # Directory to monitor for incoming nzb-jobs.
- #
- # Can have subdirectories.
- # A nzb-file queued from a subdirectory will be automatically assigned to
- # category with the directory-name.
- NzbDir=/media/HDD1/Downloads/NZBs/NZBget/nzb
- # Directory to store download queue.
- QueueDir=/media/HDD1/Downloads/NZBs/NZBget/queue
- # Directory to store temporary files.
- TempDir=/media/HDD1/Downloads/NZBs/NZBget/tmp
- # Lock-file for daemon-mode, POSIX only.
- #
- # If the option is not empty, NZBGet creates the file and writes process-id
- # (PID) into it. That info can be used in shell scripts.
- LockFile=/media/HDD1/Downloads/NZBs/NZBget/nzbget.lock
- # Where to store log file, if it needs to be created.
- #
- # NOTE: See also option <CreateLog>.
- LogFile=/media/HDD1/Downloads/NZBs/NZBget/dst/nzbget.log
- # Directory with web-interface files.
- #
- # Example: "WebDir=/usr/local/share/nzbget/webui".
- #
- # NOTE: To disable web-interface set the option to an empty value.
- # This however doesn't disable the built-in web-server completely because
- # it is also used to serve JSON-/XML-RPC requests.
- WebDir=/usr/local/share/nzbget/webui
- ##############################################################################
- ### NEWS-SERVERS ###
- # This section defines which servers NZBGet should connect to.
- #
- # The servers should be numbered subsequently without holes.
- # For example if you configure three servers you should name them as Server1,
- # Server2 and Server3. If you need to delete Server2 later you should also
- # change the name of Server3 to Server2. Otherwise it will not be properly
- # read from the config file. Server number doesn't affect its priority (level).
- # Level (priority) of news server (0-99).
- #
- # The servers are ordered by their level. NZBGet first tries to download
- # an article from one (any) of level-0-servers. If that server fails,
- # NZBGet tries all other level-0-servers. If all servers fail, it proceeds
- # with the level-1-servers, etc.
- #
- # Put your major download servers at level 0 and your fill servers at
- # levels 1, 2, etc..
- #
- # Several servers with the same level may be defined, they have
- # the same priority.
- Server1.Level=0
- # Group of news server (0-99).
- #
- # If you have multiple accounts with same conditions (retention, etc.)
- # on the same news server, set the same group (greater than 0) for all
- # of them. If download fails on one news server, NZBGet does not try
- # other servers from the same group.
- #
- # Value "0" means no group defined (default).
- Server1.Group=0
- # Host name of news server.
- Server1.Host=news.newshosting.com
- # Port to connect to (1-65535).
- Server1.Port=119
- # User name to use for authentication.
- Server1.Username=t800mc
- # Password to use for authentication.
- Server1.Password=9218mc
- # Server requires "Join Group"-command (yes, no).
- Server1.JoinGroup=yes
- # Encrypted server connection (TLS/SSL) (yes, no).
- #
- # NOTE: By changing this option you should also change the option <ServerX.Port>
- # accordingly because unsecure and encrypted connections use different ports.
- Server1.Encryption=no
- # Cipher to use for encrypted server connection.
- #
- # By default (when the option is empty) the underlying encryption library
- # chooses the cipher automatically. To achieve the best performance
- # however you can manually select a faster cipher.
- #
- # See http://nzbget.sourceforge.net/Choosing_a_cipher for details.
- #
- # NOTE: One of the fastest cipher is RC4, it also provides strong 128 bit
- # encryption. To select it use the cipher string "RC4-MD5" (if NZBGet was
- # configured to use OpenSSL) or "NONE:+VERS-TLS-ALL:+ARCFOUR-128:+RSA:+MD5:+COMP-ALL"
- # (if NZBGet was configured to use GnuTLS).
- #
- # NOTE: You may get a TLS handshake error if the news server does
- # not support the chosen cipher. You can also get an error "Could not
- # select cipher for TLS" if the cipher string is not valid.
- Server1.Cipher=
- # Maximal number of simultaneous connections to this server (0-999).
- Server1.Connections=5
- # Second server, on level 0.
- #Server2.Level=0
- #Server2.Host=my2.newsserver.com
- #Server2.Port=119
- #Server2.Username=me
- #Server2.Password=mypass
- #Server2.JoinGroup=yes
- #Server2.Connections=4
- # Third server, on level 1.
- #Server3.Level=1
- #Server3.Host=fills.newsserver.com
- #Server3.Port=119
- #Server3.Username=me2
- #Server3.Password=mypass2
- #Server3.JoinGroup=yes
- #Server3.Connections=1
- ##############################################################################
- ### REMOTE CONTROL ###
- # IP on which NZBGet server listen and which clients use to contact NZBGet.
- #
- # It could be a dns-hostname (e. g. "mypc") or an ip-address (e. g. "192.168.1.2" or
- # "127.0.0.1"). An IP-address is more effective because does not require dns-lookup.
- #
- # Your computer may have multiple network interfaces and therefore multiple IP
- # addresses. If you want NZBGet to listen to all interfaces and be available from
- # all IP-addresses use value "0.0.0.0".
- #
- # NOTE: When you start NZBGet as client (to send remote commands to NZBGet server) and
- # the option <ControlIP> is set to "0.0.0.0" the client will use IP "127.0.0.1".
- #
- # NOTE: If you set the option to "127.0.0.1" you will be able to connect to NZBGet
- # only from the computer running NZBGet. This restriction applies to web-interface too.
- ControlIP=0.0.0.0
- # Port which NZBGet server and remote client use (1-65535).
- #
- # NOTE: The communication via this port is not encrypted. For encrypted
- # communication see option <SecurePort>.
- ControlPort=6789
- # Password which NZBGet server and remote client use.
- #
- # For authorization to web-interface use predefined username "nzbget" (not configurable)
- # and the password defined here.
- ControlPassword=tegbzn6789
- # Secure control of NZBGet server (yes, no).
- #
- # Activate the option if you want to access NZBGet built-in web-server
- # via HTTPS (web-interface and RPC). You should also provide certificate
- # and key files, see option <SecureCert> and option <SecureKey>.
- SecureControl=no
- # Port which NZBGet server and remote client use for encrypted
- # communication (1-65535).
- SecurePort=6791
- # Full path to certificate file for encrypted communication.
- SecureCert=
- # Full path to key file for encrypted communication.
- SecureKey=
- ##############################################################################
- ### PERMISSIONS ###
- # User name for daemon-mode, POSIX only.
- #
- # Set the user that the daemon normally runs at (POSIX in daemon-mode only).
- # Set MainDir with an absolute path to be sure where it will write.
- # This allows NZBGet daemon to be launched in rc.local (at boot), and
- # download items as a specific user id.
- #
- # NOTE: This option has effect only if the program was started from
- # root-account, otherwise it is ignored and the daemon runs under
- # current user id.
- DaemonUserName=root
- # Specify default umask (affects file permissions) for newly created
- # files, POSIX only (000-1000).
- #
- # The value should be written in octal form (the same as for "umask" shell
- # command).
- # Empty value or value "1000" disable the setting of umask-mode; current
- # umask-mode (set via shell) is used in this case.
- UMask=1000
- ##############################################################################
- ### INCOMING NZBS ###
- # Create subdirectory with category-name in destination-directory (yes, no).
- AppendCategoryDir=yes
- # Create subdirectory with nzb-filename in destination-directory (yes, no).
- AppendNzbDir=yes
- # How often incoming-directory (option <NzbDir>) must be checked for new
- # nzb-files (seconds).
- #
- # Value "0" disables the check.
- NzbDirInterval=5
- # How old nzb-file should at least be for it to be loaded to queue (seconds).
- #
- # NZBGet checks if nzb-file was not modified in last few seconds, defined by
- # this option. That safety interval prevents the loading of files, which
- # were not yet completely saved to disk, for example if they are still being
- # downloaded in web-browser.
- NzbDirFileAge=60
- # Automatic merging of nzb-files with the same filename (yes, no).
- #
- # A typical scenario: you put nzb-file into incoming directory, NZBGet adds
- # file to queue. You find out, that the file doesn't have par-files. You
- # find required par-files, put nzb-file with the par-files into incoming
- # directory, NZBGet adds it to queue as a separate group. You want the second
- # file to be merged with the first for parchecking to work properly. With
- # option "MergeNzb" NZBGet can merge files automatically. You only need to
- # save the second file under the same filename as the first one.
- MergeNzb=no
- # Set path to program, that must be executed before any file in incoming
- # directory (option <NzbDir>) is processed.
- #
- # Example: "NzbProcess=~/nzbprocess.sh".
- #
- # That program can unpack archives which were put in incoming directory, make
- # filename cleanup, assign category and post-processing parameters to nzb-file
- # or do something else.
- #
- # INFO FOR DEVELOPERS:
- # NZBGet passes following arguments to nzbprocess-program as environment
- # variables:
- # NZBNP_DIRECTORY - path to directory, where file is located. It is a directory
- # specified by the option <NzbDir> or a subdirectory;
- # NZBNP_FILENAME - name of file to be processed;
- #
- # In addition to these arguments NZBGet passes all
- # nzbget.conf-options to nzbprocess-program as environment variables. These
- # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
- # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
- # The dots in option names are replaced with underscores, for example
- # "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
- # the values are passed always in lower case.
- #
- # The nzbprocess-script can assign category, priority and post-processing
- # parameters to the current nzb-file by printing special messages into
- # standard output (which is processed by NZBGet).
- #
- # To assign category use following syntax:
- # echo "[NZB] CATEGORY=my category";
- #
- # To assign priority:
- # echo "[NZB] PRIORITY=signed_integer_value";
- #
- # for example: to set priority higher than normal:
- # echo "[NZB] PRIORITY=50";
- #
- # another example: use a negative value for "lower than normal" priority:
- # echo "[NZB] PRIORITY=-100";
- #
- # To assign post-processing parameters:
- # echo "[NZB] NZBPR_myvar=my value";
- #
- # The prefix "NZBPR_" will be removed. In this example a post-processing
- # parameter with name "myvar" and value "my value" will be associated
- # with nzb-file.
- #
- # The nzbprocess-script can delete processed file, rename it or move somewhere.
- # After the calling of the script the file will be either added to queue
- # (if it was an nzb-file) or renamed by adding the extension ".processed".
- #
- # NOTE: Files with extensions ".processed", ".queued" and ".error" are skipped
- # during the directory scanning.
- #
- # NOTE: Files with extension ".nzb_processed" are not passed to
- # NzbProcess-script before adding to queue. This feature allows
- # NzbProcess-script to prevent the scanning of nzb-files extracted from
- # archives, if they were already processed by the script.
- NzbProcess=
- # Set path to program, that must be executed after a nzb-file is added
- # to queue.
- #
- # This program is called each time a new nzb-file is added to queue: from
- # nzb incoming directory, via command line call "nzbget -A filename.nzb",
- # via RPC-method "append" or from web-interface.
- #
- # Example: "NzbAddedProcess=~/nzbaddedprocess.sh".
- #
- # That program can modify the files in download queue (for example
- # delete or pause all nfo, sfv, sample files) or do something else.
- #
- # INFO FOR DEVELOPERS:
- # NZBGet passes following arguments to nzbaddedprocess-program as environment
- # variables:
- # NZBNA_NZBNAME - name of nzb-group. This name can be used in calls
- # to nzbget edit-command using subswitch "-GN name";
- # NZBNA_FILENAME - filename of the nzb-file. If the file was added
- # from nzb-directory this is the fullname with path.
- # If the file was added via web-interface it contains
- # only filename without path;
- # NZBNA_CATEGORY - category of nzb-file (if assigned);
- # NZBNA_LASTID - the id of the last file in the nzb-file. This ID can
- # be used with calls to nzbget edit-command;
- # NZBNA_PRIORITY - priority (default is 0).
- #
- # In addition to these arguments NZBGet passes all
- # nzbget.conf-options to nzbaddedprocess-program as environment variables. These
- # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
- # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
- # The dots in option names are replaced with underscores, for example
- # "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
- # the values are passed always in lower case.
- #
- # Examples:
- # 1) pausing nzb-file using file-id:
- # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E G P $NZBNA_LASTID
- #
- # 2) setting category using nzb-name:
- # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E GN K "my cat" "$NZBNA_NZBNAME"
- #
- # 3) pausing files with extension "nzb":
- # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E FR P "$NZBNA_NAME/.*\.nzb"
- NzbAddedProcess=
- # Check for duplicate files (yes, no).
- #
- # If this option is enabled the program checks by adding of a new nzb-file:
- # 1) if nzb-file contains duplicate entries. This check aims on detecting
- # of reposted files (if first file was not fully uploaded);
- # If the program find two files with identical names, only the
- # biggest of these files will be added to queue;
- # 2) if download queue already contains file with the same name;
- # 3) if destination file on disk already exists.
- # In last two cases: if the file exists it will not be added to queue;
- #
- # If this option is disabled, all files are downloaded and duplicate files
- # are renamed to "filename_duplicate1".
- # Existing files are never deleted or overwritten.
- DupeCheck=yes
- ##############################################################################
- ### DOWNLOAD QUEUE ###
- # Save download queue to disk (yes, no).
- #
- # This allows to reload it on next start.
- SaveQueue=yes
- # Reload download queue on start, if it exists (yes, no).
- ReloadQueue=yes
- # Reload url-queue on start, if it exists (yes, no).
- #
- # For this option to work the options <SaveQueue> and <ReloadQueue> must
- # be also enabled.
- ReloadUrlQueue=yes
- # Reload Post-processor-queue on start, if it exists (yes, no).
- #
- # For this option to work the options <SaveQueue> and <ReloadQueue> must
- # be also enabled.
- ReloadPostQueue=yes
- # Reuse articles saved in temp-directory from previous program start (yes, no).
- #
- # This allows to continue download of file, if program was exited before
- # the file was completed.
- ContinuePartial=yes
- # Visibly rename broken files on download appending "_broken" (yes, no).
- #
- # Do not activate this option if par-check is enabled.
- RenameBroken=no
- # Decode articles (yes, no).
- #
- # yes - decode articles using internal decoder (supports yEnc and UU formats);
- # no - the articles will not be decoded and joined. External programs
- # (like "uudeview") can be used to decode and join downloaded articles.
- # Also useful for debugging to look at article's source text.
- Decode=yes
- # Write decoded articles directly into destination output file (yes, no).
- #
- # Files are posted to Usenet within artilce bodies. Each file typically
- # requires hundreds of articles.
- #
- # When option <DirectWrite> is disabled, the program downloads all articles
- # into temporary directory and then combine them into destination file.
- #
- # With this option enabled the program at first creates the output
- # destination file with required size (total size of all articles),
- # then writes on the fly decoded articles directly to the file
- # without creating of any temporary files.
- #
- # This may improve performance but depends on OS and file system ability to
- # instantly create large files without initializing them with nulls. Such
- # files are called sparse files and are supported by modern file systems
- # like EXT3 on Linux or NTFS on Windows.
- #
- # Using of this option reduces disk operations but may produce more fragmented
- # files (depends on disk driver), which may slow down the post-processing.
- # It's recommended to test how the option behave on your platform to find the
- # best setting.
- #
- # INFO: a particular test on a Linux router with EXT3-partition showed that
- # activating of this option results in up to 20% better performance during
- # downloading.
- #
- # NOTE: For test try to download few big nzb-collections (each 4GB or more)
- # and measure the time used for downloading and post-processing (use timestamps
- # in a log-file to determine when the post-processing was ended).
- #
- # NOTE: When option <DirectWrite> is enabled the temporary directory (option
- # <TempDir>) must be located on the same partition with destination directory
- # (option DestDir>) for better performance. If option <DirectWrite> is disabled
- # it's better to use different drives for temporary and destination directories.
- #
- # NOTE: If both options <DirectWrite> and <ContinuePartial> are enabled,
- # the program still creates empty article-files in temp-directory. They are used
- # by the option <ContinuePartial> to check if a certain article was downloaded.
- # To minimize disk-io it is recommended to disable option <ContinuePartial>,
- # if <DirectWrite> is enabled. Especially on a fast connections (where you
- # would want to activate <DirectWrite>) it should not be a problem to redownload
- # an interrupted file.
- DirectWrite=yes
- # Check CRC of downloaded and decoded articles (yes, no).
- #
- # Normally this option should be enabled for better detecting of download
- # errors. However checking of CRC needs CPU time. On a fast connection and
- # slow CPU disabling of CRC-Check may improve performance.
- CrcCheck=yes
- # How many retries should be attempted if a download error occurs (0-99).
- #
- # 1) If download fails because of "article or group not found error" the
- # program tries another news server.
- #
- # 2) If download fails because of interrupted connection, the program
- # tries the same server again until connection can be established.
- #
- # In both cases 1) and 2) option <Retries> is not used.
- #
- # If download however fails because of incomplete article, CRC-error or other
- # error not mentioned above the program tries to redownload the article from
- # the same news server as many times as defined in option <Retries>. If all
- # attempts fail the program tries another news server.
- Retries=3
- # Set the interval between retries (seconds).
- RetryInterval=10
- # Set connection timeout (seconds).
- ConnectionTimeout=60
- # Timeout until a download-thread should be killed (seconds).
- #
- # This can help on hanging downloads, but is dangerous.
- # Do not use small values!
- TerminateTimeout=600
- # Set the (approximate) maximum number of allowed threads (10-999).
- #
- # Sometimes under certain circumstances the program may create way to many
- # download threads. Most of them are in wait-state. That is not bad,
- # but threads are usually a limited resource. If a program creates to many
- # of them, operating system may kill it. The option <ThreadLimit> prevents that.
- #
- # NOTE: The number of threads is not the same as the number of connections
- # opened to NNTP-servers. Do not use the option <ThreadLimit> to limit the
- # number of connections. Use the appropriate options <ServerX.Connections>
- # instead.
- #
- # NOTE: The actual number of created threads can be slightly larger as
- # defined by the option. Important threads may be created even if the
- # number of threads is exceeded. The option prevents only the creation of
- # additional download threads.
- #
- # NOTE: In most cases you should leave the default value "100" unchanged.
- # However you may increase that value if you need more than 90 connections
- # (that's very unlikely) or decrease the value if the OS does not allow so
- # many threads. But the most OSes should not have problems with 100 threads.
- ThreadLimit=100
- # Set the maximum download rate on program start (kilobytes/sec).
- #
- # Value "0" means no speed control.
- # The download rate can be changed later via remote calls.
- DownloadRate=0
- # Accurate speed rate calculation (yes, no).
- #
- # During downloading using several connections the download threads may
- # interfere with each other when updating statistical data for speed
- # meter. This may cause small errors in current download speed reported
- # by the program. The speed meter recovers automatically from such errors
- # after max. 30 seconds (time window used for speed calculation).
- #
- # Enable the option to use thread synchronisation mechanisms in order to
- # provide absolutely accurate speed calculations.
- #
- # NOTE: Thread synchronisation increases CPU load and therefore can
- # decrease download speed. Do not activate this option on computers with
- # limited CPU power. Before activating the option it is recommended to
- # run tests to determine how the option affects the CPU usage and the
- # download speed on a particular system.
- AccurateRate=no
- # Set the size of memory buffer used by writing the articles (bytes).
- #
- # Bigger values decrease disk-io, but increase memory usage.
- # Value "0" causes an OS-dependent default value to be used.
- # With value "-1" (which means "max/auto") the program sets the size of
- # buffer according to the size of current article (typically less than 500K).
- #
- # NOTE: The value must be written in bytes, do not use postfixes "K" or "M".
- #
- # NOTE: To calculate the memory usage multiply WriteBufferSize by max number
- # of connections, configured in section "NEWS-SERVERS".
- #
- # NOTE: Typical article's size not exceed 500000 bytes, so using bigger values
- # (like several megabytes) will just waste memory.
- #
- # NOTE: For desktop computers with large amount of memory value "-1" (max/auto)
- # is recommended, but for computers with very low memory (routers, NAS)
- # value "0" (default OS-dependent size) could be better alternative.
- #
- # NOTE: Write-buffer is managed by OS (system libraries) and therefore
- # the effect of the option is highly OS-dependent.
- WriteBufferSize=0
- # Pause if disk space gets below this value (megabytes).
- #
- # Value "0" disables the check.
- # Only the disk space on the drive with <DestDir> is checked.
- # The drive with <TempDir> is not checked.
- DiskSpace=250
- # Delete already downloaded files from disk, if the download of nzb-file was
- # cancelled (nzb-file was deleted from queue) (yes, no).
- #
- # NOTE: NZBGet does not delete files in a case if all remaining files in
- # queue are par-files. That prevents the accidental deletion if the option
- # <ParCleanupQueue> is disabled or if the program was interrupted during
- # parcheck and later restarted without reloading of post queue (option
- # <ReloadPostQueue> disabled).
- DeleteCleanupDisk=no
- # Keep the history of downloaded nzb-files (days).
- #
- # Value "0" disables the history.
- #
- # NOTE: When a collection having paused files is added to history all remaining
- # files are moved from download queue to a list of parked files. It holds files
- # which could be required later if the collection will be moved back to
- # download queue for downloading of remaining files. The parked files still
- # consume some amount of memory and disk space. If the collection was downloaded
- # and successfully par-checked or postprocessed it is recommended to discard the
- # unneeded parked files before adding the collection to history. For par2-files
- # that can be achieved with the option <ParCleanupQueue>.
- KeepHistory=7
- # Maximal number of simultaneous connections for nzb URL downloads (0-999).
- #
- # When NZB-files are added to queue via URL, the program downloads them
- # from the specified URL. The option limits the maximal number of connections
- # used for this purpose, when multiple URLs were added at the same time.
- UrlConnections=4
- ##############################################################################
- ### CATEGORIES ###
- # This section defines categories available in web-interface.
- # Category name.
- #
- # Each nzb-file can be assigned to a category.
- # Category name is passed to post-processing script and can be used by it
- # to perform category specific processing.
- Category1.Name=Movies
- # Destination directory for this category.
- #
- # If this option is empty, then the default destination directory
- # (option <DestDir>) is used. In this case if the option <AppendCategoryDir>
- # is active, the program creates a subdirectory with category name within
- # destination directory.
- Category1.DestDir=/media/HDD1/Downloads/Complete/Movies
- Category2.Name=TV
- Category3.Name=Music
- Category4.Name=Software
- ##############################################################################
- ### LOGGING ###
- # Create log file (yes, no).
- CreateLog=yes
- # Delete log file upon server start (only in server-mode) (yes, no).
- ResetLog=no
- # How error messages must be printed (screen, log, both, none).
- ErrorTarget=both
- # How warning messages must be printed (screen, log, both, none).
- WarningTarget=both
- # How info messages must be printed (screen, log, both, none).
- InfoTarget=both
- # How detail messages must be printed (screen, log, both, none).
- DetailTarget=both
- # How debug messages must be printed (screen, log, both, none).
- #
- # Debug-messages can be printed only if the program was compiled in
- # debug-mode: "./configure --enable-debug".
- DebugTarget=both
- # Set the default message-kind for output received from process-scripts
- # (PostProcess, NzbProcess, TaskX.Process) (detail, info, warning,
- # error, debug, none).
- #
- # NZBGet checks if the line written by the script to stdout or stderr starts
- # with special character-sequence, determining the message-kind, e.g.:
- # [INFO] bla-bla.
- # [DETAIL] bla-bla.
- # [WARNING] bla-bla.
- # [ERROR] bla-bla.
- # [DEBUG] bla-bla.
- #
- # If the message-kind was detected the text is added to log with detected type.
- # Otherwise the message becomes the default kind, specified in this option.
- ProcessLogKind=detail
- # Number of messages stored in buffer and available for remote
- # clients (messages).
- LogBufferSize=1000
- # Create a log of all broken files (yes ,no).
- #
- # It is a text file placed near downloaded files, which contains
- # the names of broken files.
- CreateBrokenLog=yes
- # Create memory dump (core-file) on abnormal termination, Linux only (yes, no).
- #
- # Core-files are very helpful for debugging.
- #
- # NOTE: Core-files may contain sensible data, like your login/password to
- # newsserver etc.
- DumpCore=no
- # See also option <LogFile> in section "PATHS"
- ##############################################################################
- ### DISPLAY (TERMINAL) ###
- # Set screen-outputmode (loggable, colored, curses).
- #
- # loggable - only messages will be printed to standard output;
- # colored - prints messages (with simple coloring for messages categories)
- # and download progress info; uses escape-sequences to move cursor;
- # curses - advanced interactive interface with the ability to edit
- # download queue and various output option.
- OutputMode=curses
- # Shows NZB-Filename in file list in curses-outputmode (yes, no).
- #
- # This option controls the initial state of curses-frontend,
- # it can be switched on/off in run-time with Z-key.
- CursesNzbName=yes
- # Show files in groups (NZB-files) in queue list in curses-outputmode (yes, no).
- #
- # This option controls the initial state of curses-frontend,
- # it can be switched on/off in run-time with G-key.
- CursesGroup=no
- # Show timestamps in message list in curses-outputmode (yes, no).
- #
- # This option controls the initial state of curses-frontend,
- # it can be switched on/off in run-time with T-key.
- CursesTime=no
- # Update interval for Frontend-output in console mode or remote client
- # mode (milliseconds).
- #
- # Min value 25. Bigger values reduce CPU usage (especially in curses-outputmode)
- # and network traffic in remote-client mode.
- UpdateInterval=200
- ##############################################################################
- ### PAR CHECK/REPAIR ###
- # How many par2-files to load (one, all, none).
- #
- # one - only one main par2-file must be downloaded and other must be paused;
- # all - all par2-files must be downloaded;
- # none - all par2-files must be automatically paused.
- # Paused files remain in queue and can be unpaused by parchecker when needed.
- LoadPars=one
- # Force par-verification (yes, no).
- #
- # Force par-check for every download. When set to "no" the par-check is
- # performed only if the unpacker or the post-processing script detect a
- # damaged download.
- #
- # To download only needed par2-files (smart par-files loading) set also
- # the option <LoadPars> to "one". If option <LoadPars> is set to "all",
- # all par2-files will be downloaded before verification and repair starts.
- # The option <RenameBroken> must be set to "no", otherwise the par-checker
- # may not find renamed files and fail.
- ParCheck=auto
- # Automatic par-repair (yes, no).
- #
- # If option <ParCheck> is enabled and <ParRepair> is not, the program
- # only verifies downloaded files and downloads needed par2-files, but does
- # not start repair-process. This is useful if computer does not have
- # enough CPU power, since repairing of large files may take too much
- # resources and time on a slow computers.
- ParRepair=yes
- # What files should be scanned during par-verification (limited,
- # full, auto).
- #
- # limited - scan only files belonging to the par-set;
- # full - scan all files in the directory. This helps if the
- # files were renamed after creating of par-set.
- # auto - a limited scan is performed first. If the par-checker
- # detects missing files, it scans other files in the
- # directory until all required files are found.
- #
- # NOTE: for par-check/repair NZBGet uses library libpar2. The last and
- # widely used version 0.2 of the library has few bugs, sometimes causing
- # a crash of the program. This is especially true when using "full" or
- # "auto" par-scan. NZBGet is supplied with patches addressing these
- # issues. Please apply the patches to libpar2 and recompile it.
- ParScan=auto
- # Use only par2-files with matching names (yes, no).
- #
- # If par-check needs extra par-blocks it searches for par2-files
- # in download queue, which can be unpaused and used for restore.
- # These par2-files should have the same base name as the main par2-file,
- # currently loaded in par-checker. Sometimes extra par files (especially if
- # they were uploaded by a different poster) have not matching names.
- # Normally par-checker does not use these files, but you can allow it
- # to use these files by setting <StrictParName> to "no".
- # This has however a side effect: if NZB-file contains more than one collection
- # of files (with different par-sets), par-checker may download par-files from
- # a wrong collection. This increases you traffic (but not harm par-check).
- #
- # NOTE: Par-checker always uses only par-files added from the same NZB-file
- # and the option <StrictParName> does not change this behavior.
- StrictParName=yes
- # Maximum allowed time for par-repair (minutes).
- #
- # Value "0" means unlimited.
- #
- # If you use NZBGet on a very slow computer like NAS-device, it may be good to
- # limit the time allowed for par-repair. NZBGet calculates the estimated time
- # required for par-repair. If the estimated value exceeds the limit defined
- # here, NZBGet cancels the repair.
- #
- # To avoid a false cancellation NZBGet compares the estimated time with
- # <ParTimeLimit> after the first 5 minutes of repairing, when the calculated
- # estimated time is more or less accurate. But in a case if <ParTimeLimit> is
- # set to a value smaller than 5 minutes, the comparison is made after the first
- # whole minute.
- #
- # NOTE: The option limits only the time required for repairing. It doesn't
- # affect the first stage of parcheck - verification of files. However the
- # verification speed is constant, it doesn't depend on files integrity and
- # therefore it is not necessary to limit the time needed for the first stage.
- #
- # NOTE: This option requires an extended version of libpar2 (the original
- # version doesn't support the cancelling of repairing). Please refer to
- # NZBGet's README for info on how to apply the patch to libpar2.
- ParTimeLimit=0
- # Pause download queue during check/repair (yes, no).
- #
- # Enable the option to give CPU more time for par-check/repair. That helps
- # to speed up check/repair on slow CPUs with fast connection (e.g. NAS-devices).
- #
- # NOTE: If parchecker needs additional par-files it temporarily unpauses
- # the queue.
- #
- # NOTE: See also options <PostPauseQueue> and <UnpackPauseQueue>.
- ParPauseQueue=no
- # Cleanup download queue after successful check/repair (yes, no).
- #
- # Enable this option for automatic deletion of unneeded (paused) par-files
- # from download queue after successful check/repair.
- ParCleanupQueue=yes
- # Delete source nzb-file after successful check/repair (yes, no).
- #
- # Enable this option for automatic deletion of nzb-file from incoming directory
- # after successful check/repair.
- NzbCleanupDisk=yes
- ##############################################################################
- ### UNPACK ###
- # Unpack downloaded nzb-files (yes, no).
- #
- # If the download is damaged and could not be repaired using par-files
- # the unpacking is not performed.
- #
- # If the option <ParCheck> is disabled the program will try to unpack
- # downloaded files first. If the unpacking fails the par-check/repair
- # is performed and the unpack will be executed again.
- Unpack=yes
- # Pause download queue during unpack (yes, no).
- #
- # Enable the option to give CPU more time for unpacking. That helps
- # to speed up unpacking on slow CPUs.
- #
- # NOTE: See also options <ParPauseQueue> and <PostPauseQueue>.
- UnpackPauseQueue=yes
- # Delete archive files after successful unpacking (yes, no).
- UnpackCleanupDisk=yes
- # Full path to unrar executable.
- #
- # Example: "/usr/bin/unrar".
- #
- # If unrar is in your PATH you may leave the path part and set only
- # the executable name ("unrar" on POSIX or "unrar.exe" on Windows).
- UnrarCmd=unrar
- # Full path to 7-Zip executable.
- #
- # Example: "/usr/bin/7z".
- #
- # If 7-Zip binary is in your PATH you may leave the path part and set only
- # the executable name ("7z" or "7za" on POSIX or "7z.exe" on Windows).
- SevenZipCmd=7z
- ##############################################################################
- ### POST-PROCESSING ###
- # Set path to program, that must be executed after the download of nzb-file
- # is completed and possibly par-checked/repaired and unpacked, depending
- # on other options.
- #
- # Example: "PostProcess=~/nzbget-postprocess.sh".
- #
- # NOTE: An example script is provided within distribution in file
- # "nzbget-postprocess.sh" (installed into /usr/local/bin).
- #
- # NOTE: Since version 10.0 NZBGet has a built-in support for unpack
- # (option <Unpack>). In the previous versions unpack was performed by
- # post-processing scripts. If you use a script created for older NZBGet
- # version you need to disable the built-in unpack for script to operate
- # properly.
- #
- # INFO FOR DEVELOPERS:
- # If the option <AllowReProcess> is disabled (that's the default setting)
- # the post-processing script is executed once per nzb-file after
- # par-check/repair (if needed) and unpacking (if enabled).
- #
- # If the option <AllowReProcess> is active the post-processing script is
- # executed for each collection within nzb-file (for nzb-files having multiple
- # collections but at least once). Depending on option <ParCheck> the collection
- # could be already par-checked/repaired or the script could be called without
- # par-check taken place. In the latest case if the script detects errors
- # (such as unpack failed) it has an ability to request par-check from
- # NZBGet. After par-check/repair NZBGet calls the script once again.
- #
- # NZBGet passes following arguments to post-processing script as environment
- # variables:
- # NZBPP_DIRECTORY - path to destination dir for downloaded files;
- # NZBPP_NZBNAME - user-friendly name of processed nzb-file as it is displayed
- # by the program. The file path and extension are removed.
- # If download was renamed, this parameter reflects the new name;
- # NZBPP_NZBFILENAME - name of processed nzb-file. It includes file extension and also
- # may include full path;
- # NZBPP_CATEGORY - category assigned to nzb-file (can be empty string);
- # NZBPP_PARSTATUS - result of par-check:
- # 0 = not checked: par-check is disabled or nzb-file does
- # not contain any par-files;
- # 1 = checked and failed to repair;
- # 2 = checked and successfully repaired;
- # 3 = checked and can be repaired but repair is disabled.
- # NZBPP_UNPACKSTATUS - result of unpack:
- # 0 = unpack is disabled or was skipped due to nzb-file
- # properties or due to errors during par-check;
- # 1 = unpack failed;
- # 2 = unpack successful.
- #
- # In addition the following arguments are passed if the option <AllowReProcess>
- # is active:
- # NZBPP_PARFILENAME - name of par-file or empty string (if no collections were
- # found);
- # NZBPP_PARFAILED - indication of failed par-jobs for current nzb-file:
- # 0 = no failed par-jobs;
- # 1 = current par-job or any of the previous par-jobs for
- # the same nzb-files failed;
- # NZBPP_NZBCOMPLETED - state of nzb-job:
- # 0 = there are more collections in this nzb-file queued;
- # 1 = this was the last collection in nzb-file.
- #
- # If nzb-file has associated postprocess-parameters (which can be set using
- # subcommand <O> of command <-E>, for example: NZBGet -E G O "myvar=hello !" 10)
- # or using XML-/JSON-RPC (for example via web-interface), they are also passed
- # as environment variables. These variables have prefix "NZBPR_" in their names.
- # For example, pp-parameter "myvar" will be passed as environment
- # variable "NZBPR_myvar".
- #
- # In addition to arguments and postprocess-parameters NZBGet passes all
- # nzbget.conf-options to postprocess-program as environment variables. These
- # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
- # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
- # The dots in option names are replaced with underscores, for example
- # "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
- # the values are passed always in lower case.
- #
- # Return value: NZBGet processes the exit code returned by the script:
- # 93 - post-process successful (status = SUCCESS);
- # 94 - post-process failed (status = FAILURE);
- # 95 - post-process skipped (status = NONE);
- # 91 - request NZBGet to do par-check/repair for current collection in the
- # current nzb-file. This return code is accepted only if the
- # option <AllowReProcess> is active;
- # 92 - request NZBGet to do par-check/repair for all collections (par-sets)
- # in the current nzb-file.
- # All other return codes are interpreted as "status unknown".
- #
- # The return value is used to display the status of post-processing in
- # a history view. In addition to status one or more text messages can be
- # passed to history using a special prefix "[HISTORY]" by printing messages
- # to standard output. For example:
- # echo "[ERROR] [HISTORY] Unpack failed, not enough disk space";
- #
- # NOTE: If the option <AllowReProcess> is active NZBGet calls the script
- # for each collection within nzb-file. The term "collection" actually means
- # "par-set". To determine what "collections" are present in nzb-file NZBGet
- # looks for par-sets. If any collection of files within nzb-file does
- # not have any par-files, this collection will not be detected.
- # For example, for nzb-file containing three collections but only two par-sets,
- # the postprocess will be called two times - after processing of each par-set.
- # If NZBGet doesn't find any collections it calls PostProcess once
- # with empty string for parameter NZBPP_PARFILENAME.
- PostProcess=
- # Allow multiple post-processing for the same nzb-file (yes, no).
- #
- # NOTE: Enable this option only if you were advised to do that by the author
- # of the post-processing script.
- #
- # NOTE: By enabling <AllowReProcess> you should disable the option <ParCheck>
- # to prevent multiple par-checking.
- #
- # INFO FOR DEVELOPERS:
- # This option affects the post-processing in several ways:
- # 1) If the option is active the post-processing script (option <PostProcess>)
- # is called for each collection (par-set) within nzb-file;
- # 2) The post-processing script may be called multiple times when nzb-file
- # reaches the state "completely downloaded". This can be needed if
- # the par-check/-repair is performed by the post-processing script
- # (instead of relying on NZBGet's built-in par-check-feature).
- #
- # NOTE: If the built-in unpacking is active (option <Unpack>) this option
- # is ignored (as if it were set to "no").
- #
- # NOTE: If you develop a script depending on this option you should check
- # if the option is active when your script is started and generate an
- # error message if the option is not set correctly. You should also check
- # the option <Unpack> because if it's active the option <AllowReProcess>
- # doesn't work too.
- AllowReProcess=no
- # Pause download queue during executing of postprocess-script (yes, no).
- #
- # Enable the option to give CPU more time for postprocess-script. That helps
- # to speed up postprocess on slow CPUs with fast connection (e.g. NAS-devices).
- #
- # NOTE: See also options <ParPauseQueue> and <UnpackPauseQueue>.
- ##############################################################################
- ### SCHEDULER ###
- # This section defines scheduler commands.
- # For each command create a set of options <TaskX.Time>, <TaskX.Command>,
- # <TaskX.WeekDays> and <TaskX.DownloadRate>.
- # The following example shows how to throttle downloads in the daytime
- # by 100 KB/s and download at full speed overnights:
- # Time to execute the command (HH:MM).
- #
- # Multiple comma-separated values are accepted.
- # Asterix as hours-part means "every hour".
- #
- # Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*:00,*:30".
- #Task1.Time=08:00
- # Week days to execute the command (1-7).
- #
- # Comma separated list of week days numbers.
- # 1 is Monday.
- # Character '-' may be used to define ranges.
- #
- # Examples: "1-7", "1-5", "5,6", "1-5, 7".
- #Task1.WeekDays=1-7
- # Command to be executed (DownloadRate, PauseDownload, UnpauseDownload, PauseScan,
- # UnpauseScan, Process).
- #
- # Possible commands:
- # DownloadRate - sets download rate in KB/s;
- # PauseDownload - pauses download;
- # UnpauseDownload - resumes download;
- # PauseScan - pauses scan of incoming nzb-directory;
- # UnpauseScan - resumes scan of incoming nzb-directory;
- # Process - executes external program.
- #Task1.Command=DownloadRate
- # Download rate to be set if the command is "DownloadRate" (kilobytes/sec).
- #
- # Value "0" means no speed control.
- #
- # If the option <TaskX.Command> is not set to "DownloadRate" this option
- # is ignored and can be omitted.
- #Task1.DownloadRate=100
- # Path to the program to execute if the command is "Process".
- #
- # Example: "Task1.Process=/home/user/fetch-nzb.sh".
- #
- # If the option <TaskX.Command> is not set to "Process" this option
- # is ignored and can be omitted.
- #
- # NOTE: It's allowed to add parameters to command line. If filename or
- # any parameter contains spaces it must be surrounded with single quotation
- # marks. If filename/parameter contains single quotation marks, each of them
- # must be replaced with two single quotation marks and the resulting filename/
- # parameter must be surrounded with single quotation marks.
- # Example: '/home/user/download/my scripts/task process.sh' 'world''s fun'.
- # In this example one parameter (world's fun) is passed to the script
- # (task process.sh).
- #Task1.Process=/home/user/script.sh
- #Task2.Time=20:00
- #Task2.WeekDays=1-7
- #Task2.Command=DownloadRate
- #Task2.DownloadRate=0
- Category5.Name=Blu-ray
- Category6.Name=Games
- Category2.DestDir=/media/HDD1/Downloads/Complete/TV
- Category3.DestDir=/media/HDD1/Downloads/Complete/Music
- Category4.DestDir=/media/HDD1/Downloads/Complete/Software
- Category5.DestDir=/media/HDD1/Downloads/Complete/Blu-ray
- Category6.DestDir=/media/HDD1/Downloads/Complete/Games
- Category7.Name=Movies _ HD
- Category7.DestDir=/media/HDD1/Downloads/Complete/Movies
- Category8.Name=Movies-x264
- Category8.DestDir=/media/HDD1/Downloads/Complete/Movies
- Category9.Name=TV-HD
- Category9.DestDir=/media/HDD1/Downloads/Complete/TV
- PostPauseQueue=no
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement