1
# Sample configuration file for nzbget
3
# On POSIX put this file to one of the following locations:
7
# /usr/local/etc/nzbget.conf
10
# On Windows put this file in program's directory.
12
# You can also put the file into any location, if you specify the path to it
13
# using switch "-c", e.g:
14
# nzbget -c /home/user/myconig.txt
16
# For quick start change the option MAINDIR and configure one news-server
19
##############################################################################
22
# Root directory for all related tasks.
24
# MAINDIR is a variable and therefore starts with "$".
25
# On POSIX you can use "~" as alias for home directory (e.g. "~/download").
26
# On Windows use absolute paths (e.g. "C:\Download").
29
# Destination-directory to store the downloaded files.
30
DestDir=${MAINDIR}/dst
32
# Directory to monitor for incoming nzb-jobs.
34
# Can have subdirectories.
35
# A nzb-file queued from a subdirectory will be automatically assigned to
36
# category with the directory-name.
39
# Directory to store download queue.
40
QueueDir=${MAINDIR}/queue
42
# Directory to store temporary files.
43
TempDir=${MAINDIR}/tmp
45
# Lock-file for daemon-mode, POSIX only.
47
# If the option is not empty, nzbget creates the file and writes process-id
48
# (PID) into it. That info can be used in shell scripts.
49
LockFile=/tmp/nzbget.lock
51
# Where to store log file, if it needs to be created.
53
# NOTE: See also option <CreateLog>.
54
LogFile=${DestDir}/nzbget.log
57
##############################################################################
60
# This section defines which servers nzbget should connect to.
62
# Level of newsserver (0-99).
64
# The servers will be ordered by their level, i.e. nzbget will at
65
# first try to download an article from the level-0-server.
66
# If that server fails, nzbget proceeds with the level-1-server, etc.
67
# A good idea is surely to put your major download-server at level 0
68
# and your fill-servers at levels 1,2,...
70
# NOTE: Do not leave out a level in your server-list and start with level 0.
72
# NOTE: Several servers with the same level may be used, they will have
76
# Host name of newsserver.
77
Server1.Host=my1.newsserver.com
79
# Port to connect to (1-65535).
82
# User name to use for authentication.
85
# Password to use for authentication.
88
# Server requires "Join Group"-command (yes, no).
91
# Encrypted server connection (TLS/SSL) (yes, no).
94
# Maximal number of simultaneous connections to this server (0-999).
97
# Second server, on level 0.
100
#Server2.Host=my2.newsserver.com
103
#Server2.Password=mypass
104
#Server2.JoinGroup=yes
105
#Server2.Connections=4
107
# Third server, on level 1.
110
#Server3.Host=fills.newsserver.com
112
#Server3.Username=me2
113
#Server3.Password=mypass2
114
#Server3.JoinGroup=yes
115
#Server3.Connections=1
118
##############################################################################
121
# User name for daemon-mode, POSIX only.
123
# Set the user that the daemon normally runs at (POSIX in daemon-mode only).
124
# Set $MAINDIR with an absolute path to be sure where it will write.
125
# This allows nzbget daemon to be launched in rc.local (at boot), and
126
# download items as a specific user id.
128
# NOTE: This option has effect only if the program was started from
129
# root-account, otherwise it is ignored and the daemon runs under
133
# Specify default umask (affects file permissions) for newly created
134
# files, POSIX only (000-1000).
136
# The value should be written in octal form (the same as for "umask" shell
138
# Empty value or value "1000" disable the setting of umask-mode; current
139
# umask-mode (set via shell) is used in this case.
143
##############################################################################
144
### INCOMING NZBS ###
146
# Create subdirectory with category-name in destination-directory (yes, no).
147
AppendCategoryDir=yes
149
# Create subdirectory with nzb-filename in destination-directory (yes, no).
152
# How often incoming-directory (option <NzbDir>) must be checked for new
153
# nzb-files (seconds).
155
# Value "0" disables the check.
158
# How old nzb-file should at least be for it to be loaded to queue (seconds).
160
# Nzbget checks if nzb-file was not modified in last few seconds, defined by
161
# this option. That safety interval prevents the loading of files, which
162
# were not yet completely saved to disk, for example if they are still being
163
# downloaded in web-browser.
166
# Automatic merging of nzb-files with the same filename (yes, no).
168
# A typical scenario: you put nzb-file into incoming directory, nzbget adds
169
# file to queue. You find out, that the file doesn't have par-files. You
170
# find required par-files, put nzb-file with the par-files into incoming
171
# directory, nzbget adds it to queue as a separate group. You want the second
172
# file to be merged with the first for parchecking to work properly. With
173
# option "MergeNzb" nzbget can merge files automatically. You only need to
174
# save the second file under the same filename as the first one.
177
# Set path to program, that must be executed before any file in incoming
178
# directory (option <NzbDir>) is processed.
180
# Example: "NzbProcess=~/nzbprocess.sh".
182
# That program can unpack archives which were put in incoming directory, make
183
# filename cleanup, assign category and post-processing parameters to nzb-file
184
# or do something else.
186
# NZBGet passes following arguments to nzbprocess-program as environment
188
# NZBNP_DIRECTORY - path to directory, where file is located. It is a directory
189
# specified by the option <NzbDir> or a subdirectory;
190
# NZBNP_FILENAME - name of file to be processed;
192
# In addition to these arguments nzbget passes all
193
# nzbget.conf-options to postprocess-program as environment variables. These
194
# variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
195
# option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
196
# The dots in option names are replaced with underscores, for example
197
# "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
198
# the values are passed always in lower case.
200
# The nzbprocess-script can assign category or post-processing parameters
201
# to current nzb-file by printing special messages into standard output
202
# (which is processed by NZBGet).
204
# To assign category use following syntax:
205
# echo "[NZB] CATEGORY=my category";
207
# To assign post-processing parameters:
208
# echo "[NZB] NZBPR_myvar=my value";
210
# The prefix "NZBPR_" will be removed. In this example a post-processing
211
# parameter with name "myvar" and value "my value" will be associated
214
# The nzbprocess-script can delete processed file, rename it or move somewhere.
215
# After the calling of the script the file will be either added to queue
216
# (if it was an nzb-file) or renamed by adding the extension ".processed".
218
# NOTE: Files with extensions ".processed", ".queued" and ".error" are skipped
219
# during the directory scanning.
221
# NOTE: Files with extension ".nzb_processed" are not passed to
222
# NzbProcess-script before adding to queue. This feature allows
223
# NzbProcess-script to prevent the scanning of nzb-files extracted from
224
# archives, if they were already processed by the script.
227
# Check for duplicate files (yes, no).
229
# If this option is enabled the program checks by adding of a new nzb-file:
230
# 1) if nzb-file contains duplicate entries. This check aims on detecting
231
# of reposted files (if first file was not fully uploaded);
232
# If the program find two files with identical names, only the
233
# biggest of these files will be added to queue;
234
# 2) if download queue already contains file with the same name;
235
# 3) if destination file on disk already exists.
236
# In last two cases: if the file exists it will not be added to queue;
238
# If this option is disabled, all files are downloaded and duplicate files
239
# are renamed to "filename_duplicate1".
240
# Existing files are never deleted or overwritten.
244
##############################################################################
245
### DOWNLOAD QUEUE ###
247
# Save download queue to disk (yes, no).
249
# This allows to reload it on next start.
252
# Reload download queue on start, if it exists (yes, no).
255
# Reload Post-processor-queue on start, if it exists (yes, no).
257
# For this option to work the options <SaveQueue> and <ReloadQueue> must
261
# Reuse articles saved in temp-directory from previous program start (yes, no).
263
# This allows to continue download of file, if program was exited before
264
# the file was completed.
267
# Visibly rename broken files on download appending "_broken" (yes, no).
269
# Do not activate this option if par-check is enabled.
272
# Decode articles (yes, no).
274
# yes - decode articles using internal decoder (supports yEnc and UU formats);
275
# no - the articles will not be decoded and joined. External programs
276
# (like "uudeview") can be used to decode and join downloaded articles.
277
# Also useful for debugging to look at article's source text.
280
# Write decoded articles directly into destination output file (yes, no).
282
# With this option enabled the program at first creates the output
283
# destination file with required size (total size of all articles),
284
# then writes on the fly decoded articles directly to the file
285
# without creating of any temporary files, even for decoded articles.
286
# This may results in major performance improvement, but this highly
287
# depends on OS and file system.
289
# Can improve performance on a very fast internet connections,
290
# but you need to test if it works in your case.
292
# INFO: Tests showed, that on Linux with EXT3-partition activating of
293
# this option results in up to 20% better performance, but on Windows with NTFS
294
# or Linux with FAT32-partitions the performance were decreased.
295
# The possible reason is that on EXT3-partition Linux can create large files
296
# very fast (if the content of file does not need to be initialized),
297
# but Windows on NTFS-partition and also Linux on FAT32-partition need to
298
# initialize created large file with nulls, resulting in a big performance
301
# NOTE: for testing try to download few big files (with total size 500-1000MB)
302
# and measure required time. Do not rely on the program's speed indicator.
304
# NOTE: if both options <DirectWrite> and <ContinuePartial> are enabled,
305
# the program will still create empty articles-files in temp-directory. They
306
# are used to continue download of file on a next program start. To minimize
307
# disk-io it is recommended to disable option <ContinuePartial>, if
308
# <DirectWrite> is enabled. Especially on a fast connections (where you
309
# would want to activate <DirectWrite>) it should not be a problem to
310
# redownload an interrupted file.
313
# Check CRC of downloaded and decoded articles (yes, no).
315
# Normally this option should be enabled for better detecting of download
316
# errors. However checking of CRC needs about the same CPU time as
317
# decoding of articles. On a fast connections with slow CPUs disabling of
318
# CPU-check may slightly improve performance (if CPU is a limiting factor).
321
# How much retries should be attempted if a download error occurs (0-99).
324
# Set the interval between retries (seconds).
327
# Redownload article if CRC-check fails (yes, no).
329
# Helps to minimize number of broken files, but may be effective
330
# only if you have multiple download servers (even from the same provider
331
# but from different locations (e.g. europe, usa)).
332
# In any case the option increases your traffic.
333
# For slow connections loading of extra par-blocks may be more effective
334
# The option <CrcCheck> must be enabled for option <RetryOnCrcError> to work.
337
# Set connection timeout (seconds).
340
# Timeout until a download-thread should be killed (seconds).
342
# This can help on hanging downloads, but is dangerous.
343
# Do not use small values!
346
# Set the (approximate) maximum number of allowed threads (0-999).
348
# Sometimes under certain circumstances the program may create way to many
349
# download threads. Most of them are in wait-state. That is not bad,
350
# but threads are usually a limited resource. If a program creates to many
351
# of them, operating system may kill it. The option <ThreadLimit> prevents that.
353
# NOTE: the number of threads is not the same as the number of connections
354
# opened to NNTP-servers. Do not use the option <ThreadLimit> to limit the
355
# number of connections. Use the appropriate options <ServerX.Connections>
358
# NOTE: the actual number of created threads can be slightly larger as
359
# defined by the option. Important threads may be created even if the
360
# number of threads is exceeded. The option prevents only the creation of
361
# additional download threads.
363
# NOTE: in most cases you should leave the default value "100" unchanged.
364
# However you may increase that value if you need more than 90 connections
365
# (that's very unlikely) or decrease the value if the OS does not allow so
366
# many threads. But the most OSes should not have problems with 100 threads.
369
# Set the maximum download rate on program start (kilobytes/sec).
371
# Value "0" means no speed control.
372
# The download rate can be changed later via remote calls.
375
# Set the size of memory buffer used by writing the articles (bytes).
377
# Bigger values decrease disk-io, but increase memory usage.
378
# Value "0" causes an OS-dependent default value to be used.
379
# With value "-1" (which means "max/auto") the program sets the size of
380
# buffer according to the size of current article (typically less than 500K).
382
# NOTE: the value must be written in bytes, do not use postfixes "K" or "M".
384
# NOTE: to calculate the memory usage multiply WriteBufferSize by max number
385
# of connections, configured in section "NEWS-SERVERS".
387
# NOTE: typical article's size not exceed 500000 bytes, so using bigger values
388
# (like several megabytes) will just waste memory.
390
# NOTE: for desktop computers with large amount of memory value "-1" (max/auto)
391
# is recommended, but for computers with very low memory (routers, NAS)
392
# value "0" (default OS-dependent size) could be better alternative.
394
# NOTE: write-buffer is managed by OS (system libraries) and therefore
395
# the effect of the option is highly OS-dependent.
398
# Pause if disk space gets below this value (megabytes).
400
# Value "0" disables the check.
401
# Only the disk space on the drive with <DestDir> is checked.
402
# The drive with <TempDir> is not checked.
405
# Delete already downloaded files from disk, if the download of nzb-file was
406
# cancelled (nzb-file was deleted from queue) (yes, no).
408
# NOTE: nzbget does not delete files in a case if all remaining files in
409
# queue are par-files. That prevents the accidental deletion if the option
410
# <ParCleanupQueue> is disabled or if the program was interrupted during
411
# parcheck and later restarted without reloading of post queue (option
412
# <ReloadPostQueue> disabled).
415
# Keep the history of downloaded nzb-files (days).
417
# Value "0" disables the history.
419
# NOTE: when a collection having paused files is added to history all remaining
420
# files are moved from download queue to a list of parked files. It holds files
421
# which could be required later if the collection will be moved back to
422
# download queue for downloading of remaining files. The parked files still
423
# consume some amount of memory and disk space. If the collection was downloaded
424
# and successfully par-checked or postprocessed it is recommended to discard the
425
# unneeded parked files before adding the collection to history. For par2-files
426
# that can be achieved with the option <ParCleanupQueue>.
429
##############################################################################
432
# Create log file (yes, no).
435
# Delete log file upon server start (only in server-mode) (yes, no).
438
# How error messages must be printed (screen, log, both, none).
441
# How warning messages must be printed (screen, log, both, none).
444
# How info messages must be printed (screen, log, both, none).
447
# How detail messages must be printed (screen, log, both, none).
450
# How debug messages must be printed (screen, log, both, none).
452
# Debug-messages can be printed only if the program was compiled in
453
# debug-mode: "./configure --enable-debug".
456
# Set the default message-kind for output received from process-scripts
457
# (PostProcess, NzbProcess, TaskX.Process) (none, detail, info, warning,
460
# NZBGet checks if the line written by the script to stdout or stderr starts
461
# with special character-sequence, determining the message-kind, e.g.:
468
# If the message-kind was detected the text is added to log with detected type.
469
# Otherwise the message becomes the default kind, specified in this option.
470
ProcessLogKind=detail
472
# Number of messages stored in buffer and available for remote
473
# clients (messages).
476
# Create a log of all broken files (yes ,no).
478
# It is a text file placed near downloaded files, which contains
479
# the names of broken files.
482
# Create memory dump (core-file) on abnormal termination, Linux only (yes, no).
484
# Core-files are very helpful for debugging.
486
# NOTE: core-files may contain sensible data, like your login/password to
490
# See also option <LogFile> in section "PATHS"
493
##############################################################################
494
### DISPLAY (TERMINAL) ###
496
# Set screen-outputmode (loggable, colored, curses).
498
# loggable - only messages will be printed to standard output;
499
# colored - prints messages (with simple coloring for messages categories)
500
# and download progress info; uses escape-sequences to move cursor;
501
# curses - advanced interactive interface with the ability to edit
502
# download queue and various output option.
505
# Shows NZB-Filename in file list in curses-outputmode (yes, no).
507
# This option controls the initial state of curses-frontend,
508
# it can be switched on/off in run-time with Z-key.
511
# Show files in groups (NZB-files) in queue list in curses-outputmode (yes, no).
513
# This option controls the initial state of curses-frontend,
514
# it can be switched on/off in run-time with G-key.
517
# Show timestamps in message list in curses-outputmode (yes, no).
519
# This option controls the initial state of curses-frontend,
520
# it can be switched on/off in run-time with T-key.
523
# Update interval for Frontend-output in console mode or remote client
524
# mode (milliseconds).
526
# Min value 25. Bigger values reduce CPU usage (especially in curses-outputmode)
527
# and network traffic in remote-client mode.
531
##############################################################################
532
### CLIENT/SERVER COMMUNICATION ###
534
# IP on which the server listen and which client uses to contact the server.
536
# It could be dns-hostname or ip-address (more effective since does not
537
# require dns-lookup).
538
# If you want the server to listen to all interfaces, use "0.0.0.0".
541
# Port which the server & client use (1-65535).
544
# Password which the server & client use.
545
ServerPassword=tegbzn6789
547
# See also option <LogBufferSize> in section "LOGGING"
550
##############################################################################
551
### PAR CHECK/REPAIR ###
553
# How many par2-files to load (none, all, one).
555
# none - all par2-files must be automatically paused;
556
# all - all par2-files must be downloaded;
557
# one - only one main par2-file must be dowloaded and other must be paused.
558
# Paused files remain in queue and can be unpaused by parchecker when needed.
561
# Automatic par-verification (yes, no).
563
# To download only needed par2-files (smart par-files loading) set also
564
# the option <LoadPars> to "one". If option <LoadPars> is set to "all",
565
# all par2-files will be downloaded before verification and repair starts.
566
# The option <RenameBroken> must be set to "no", otherwise the par-checker
567
# may not find renamed files and fail.
570
# Automatic par-repair (yes, no).
572
# If option <ParCheck> is enabled and <ParRepair> is not, the program
573
# only verifies downloaded files and downloads needed par2-files, but does
574
# not start repair-process. This is useful if the server does not have
575
# enough CPU power, since repairing of large files may take too much
576
# resources and time on a slow computers.
577
# This option has effect only if the option <ParCheck> is enabled.
580
# Use only par2-files with matching names (yes, no).
582
# If par-check needs extra par-blocks it searches for par2-files
583
# in download queue, which can be unpaused and used for restore.
584
# These par2-files should have the same base name as the main par2-file,
585
# currently loaded in par-checker. Sometimes extra par files (especially if
586
# they were uploaded by a different poster) have not matching names.
587
# Normally par-checker does not use these files, but you can allow it
588
# to use these files by setting <StrictParName> to "no".
589
# This has however a side effect: if NZB-file contains more than one collection
590
# of files (with different par-sets), par-checker may download par-files from
591
# a wrong collection. This increases you traffic (but not harm par-check).
593
# NOTE: par-checker always uses only par-files added from the same NZB-file
594
# and the option <StrictParName> does not change this behavior.
597
# Maximum allowed time for par-repair (minutes).
599
# Value "0" means unlimited.
601
# If you use nzbget on a very slow computer like NAS-device, it may be good to
602
# limit the time allowed for par-repair. Nzbget calculates the estimated time
603
# required for par-repair. If the estimated value exceeds the limit defined
604
# here, nzbget cancels the repair.
606
# To avoid a false cancellation nzbget compares the estimated time with
607
# <ParTimeLimit> after the first 5 minutes of repairing, when the calculated
608
# estimated time is more or less accurate. But in a case if <ParTimeLimit> is
609
# set to a value smaller than 5 minutes, the comparison is made after the first
612
# NOTE: the option limits only the time required for repairing. It doesn't
613
# affect the first stage of parcheck - verification of files. However the
614
# verification speed is constant, it doesn't depend on files integrity and
615
# therefore it is not necessary to limit the time needed for the first stage.
617
# NOTE: this option requires an extended version of libpar2 (the original
618
# version doesn't support the cancelling of repairing). Please refer to
619
# nzbget's README for info on how to apply a patch to libpar2.
622
# Pause download queue during check/repair (yes, no).
624
# Enable the option to give CPU more time for par-check/repair. That helps
625
# to speed up check/repair on slow CPUs with fast connection (e.g. NAS-devices).
627
# NOTE: if parchecker needs additional par-files it temporary unpauses queue.
629
# NOTE: See also option <PostPauseQueue>.
632
# Cleanup download queue after successful check/repair (yes, no).
634
# Enable this option for automatic deletion of unneeded (paused) par-files
635
# from download queue after successful check/repair.
638
# Delete source nzb-file after successful check/repair (yes, no).
640
# Enable this option for automatic deletion of nzb-file from incoming directory
641
# after successful check/repair.
645
##############################################################################
646
### POSTPROCESSING ###
648
# Set path to program, that must be executed after the download of nzb-file
649
# or one collection in nzb-file (if par-check enabled and nzb-file contains
650
# multiple collections; see note below for the definition of "collection")
651
# is completed and possibly par-checked/repaired.
653
# Example: "PostProcess=~/postprocess-example.sh".
655
# NZBGet passes following arguments to postprocess-program as environment
657
# NZBPP_DIRECTORY - path to destination dir for downloaded files;
658
# NZBPP_NZBFILENAME - name of processed nzb-file;
659
# NZBPP_PARFILENAME - name of par-file or empty string (if no collections were
661
# NZBPP_PARSTATUS - result of par-check:
662
# 0 = not checked: par-check disabled or nzb-file does
663
# not contain any par-files;
664
# 1 = checked and failed to repair;
665
# 2 = checked and successfully repaired;
666
# 3 = checked and can be repaired but repair is disabled;
667
# NZBPP_NZBCOMPLETED - state of nzb-job:
668
# 0 = there are more collections in this nzb-file queued;
669
# 1 = this was the last collection in nzb-file;
670
# NZBPP_PARFAILED - indication of failed par-jobs for current nzb-file:
671
# 0 = no failed par-jobs;
672
# 1 = current par-job or any of the previous par-jobs for
673
# the same nzb-files failed;
674
# NZBPP_CATEGORY - category assigned to nzb-file (can be empty string).
676
# If nzb-file has associated postprocess-parameters (which can be set using
677
# subcommand <O> of command <-E>, for example: nzbget -E G O "myvar=hello !" 10)
678
# or using XML-/JSON-RPC (for example via web-interface), they are also passed
679
# as environment variables. These variables have prefix "NZBPR_" in their names.
680
# For example, pp-parameter "myvar" will be passed as environment
681
# variable "NZBPR_myvar".
683
# In addition to arguments and postprocess-parameters nzbget passes all
684
# nzbget.conf-options to postprocess-program as environment variables. These
685
# variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
686
# option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
687
# The dots in option names are replaced with underscores, for example
688
# "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
689
# the values are passed always in lower case.
691
# Return value: nzbget processes the exit code returned by the script:
692
# 91 - request nzbget to do par-check/repair for current collection in the
694
# 92 - request nzbget to do par-check/repair for all collections in the
696
# 93 - post-process successful (status = SUCCESS);
697
# 94 - post-process failed (status = FAILURE);
698
# 95 - post-process skipped (status = NONE);
699
# All other return codes are interpreted as "status unknown".
701
# The return value is used to display the status of post-processing in
702
# a history view. In addition to status one or more text messages can be
703
# passed to history using a special prefix "[HISTORY]" by printing messages
704
# to standard output. For example:
705
# echo "[ERROR] [HISTORY] Unpack failed, not enough disk space";
707
# NOTE: The parameter NZBPP_NZBCOMPLETED is very important and MUST be checked
708
# even in the simplest scripts.
709
# If par-check is enabled and nzb-file contains more than one collection
710
# of files the postprocess-program is called after each collection is completed
711
# and par-checked. If you want to unpack files or clean up the directory
712
# (delete par-files, etc.) there are two possibilities, when you can do this:
713
# 1) you parse NZBPP_PARFILENAME to find out the base name of collection and
714
# clean up only files from this collection (not reliable, because par-files
715
# sometimes have different names than rar-files);
716
# 2) or you just check the parameters NZBPP_NZBCOMPLETED and NZBPP_PARFAILED
717
# and do the processing, only if NZBPP_NZBCOMPLETED is set to "1" (which
718
# means, that this was the last collection in nzb-file and all files
719
# are now completed) and NZBPP_PARFAILED is set to "0" (no failed par-jobs);
721
# NOTE: the term "collection" in the above description actually means
722
# "par-set". To determine what "collections" are present in nzb-file nzbget
723
# looks for par-sets. If any collection of files within nzb-file does
724
# not have any par-files, this collection will not be detected.
725
# For example, for nzb-file containing three collections but only two par-sets,
726
# the postprocess will be called two times - after processing of each par-set.
728
# NOTE: if nzbget doesn't find any collections it calls PostProcess once
729
# with empty string for parameter NZBPP_PARFILENAME;
731
# NOTE: the using of special return values (91 and 92) for requesting of
732
# par-check/repair allows to organize the delayed parcheck. To do that:
733
# 1) set options: LoadPars=one, ParCheck=no, ParRepair=yes;
734
# 2) in post-process-script check the parameter NZBPP_PARSTATUS. If it is "0",
735
# that means, the script is called for the first time. Try to unpack files.
736
# If unpack fails, exit the script with exit code for par-check/repair;
737
# 3) nzbget will start par-check/repair. After that it calls the script again;
738
# 4) on second pass the parameter NZBPP_PARSTATUS will have value
739
# greater than "0". If it is "2" ("checked and successfully repaired")
740
# you can try unpack again.
742
# NOTE: an example script for unrarring is provided within distribution
743
# in file "postprocess-example.sh".
746
# Allow multiple post-processing for the same nzb-file (yes, no).
748
# After the post-processing (par-check and call of a postprocess-script) is
749
# completed, nzbget adds the nzb-file to a list of completed-jobs. The nzb-file
750
# stays in the list until the last file from that nzb-file is deleted from
751
# the download queue (it occurs straight away if the par-check was successful
752
# and the option <ParCleanupQueue> is enabled).
753
# That means, if a paused file from a nzb-collection becomes unpaused
754
# (manually or from a post-process-script) after the collection was already
755
# postprocessed nzbget will not post-process nzb-file again.
756
# This prevents the unwanted multiple post-processings of the same nzb-file.
757
# But it might be needed if the par-check/-repair are performed not directly
758
# by nzbget but from a post-process-script.
760
# NOTE: enable this option only if you were advised to do that by the author
761
# of the post-process-script.
763
# NOTE: by enabling <AllowReProcess> you should disable the option <ParCheck>
764
# to prevent multiple par-checking.
767
# Pause download queue during executing of postprocess-script (yes, no).
769
# Enable the option to give CPU more time for postprocess-script. That helps
770
# to speed up postprocess on slow CPUs with fast connection (e.g. NAS-devices).
772
# NOTE: See also option <ParPauseQueue>.
776
##############################################################################
779
# This section defines scheduler commands.
780
# For each command create a set of options <TaskX.Time>, <TaskX.Command>,
781
# <TaskX.WeekDays> and <TaskX.DownloadRate>.
782
# The following example shows how to throttle downloads in the daytime
783
# by 100 KB/s and download at full speed overnights:
785
# Time to execute the command (HH:MM).
787
# Multiple comma-separated values are accepted.
788
# Asterix as hours-part means "every hour".
790
# Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*:00,*:30".
793
# Week days to execute the command (1-7).
795
# Comma separated list of week days numbers.
797
# Character '-' may be used to define ranges.
799
# Examples: "1-7", "1-5", "5,6", "1-5, 7".
802
# Command to be executed (PauseDownload, UnpauseDownload, PauseScan,
803
# UnpauseScan, DownloadRate, Process).
806
# PauseDownload - pauses download;
807
# UnpauseDownload - resumes download;
808
# PauseScan - pauses scan of incoming nzb-directory;
809
# UnpauseScan - resumes scan of incoming nzb-directory;
810
# DownloadRate - sets download rate in KB/s;
811
# Process - executes external program.
812
#Task1.Command=DownloadRate
814
# Download rate to be set if the command is "DownloadRate" (kilobytes/sec).
816
# Value "0" means no speed control.
818
# If the option <TaskX.Command> is not set to "DownloadRate" this option
819
# is ignored and can be omitted.
820
#Task1.DownloadRate=100
822
# Path to the porgram to execute if the command is "Process".
824
# Example: "Task1.Process=/home/user/fetch-nzb.sh".
826
# If the option <TaskX.Command> is not set to "Process" this option
827
# is ignored and can be omitted.
829
# NOTE: it's allowed to add parameters to command line. If filename or
830
# any parameter contains spaces it must be surrounded with single quotation
831
# marks. If filename/parameter contains single quotation marks, each of them
832
# must be replaced with two single quotation marks and the resulting filename/
833
# parameter must be surrounded with single quotation marks.
834
# Example: '/home/user/download/my scripts/task process.sh' 'world''s fun'.
835
# In this example one parameter (world's fun) is passed to the script
841
#Task2.Command=DownloadRate
842
#Task2.DownloadRate=0
845
##############################################################################
848
# On a very fast connection and slow CPU and/or drive the following
849
# settings may improve performance:
850
# 1) Disable par-checking and -repairing ("ParCheck=no"). VERY important,
851
# because par-checking/repairing needs a lot of CPU-power and
852
# significantly increases disk usage;
853
# 2) Try to activate option <DirectWrite> ("DirectWrite=yes"), especially
854
# if you use EXT3-partitions;
855
# 3) Disable option <CrcCheck> ("CrcCheck=no");
856
# 4) Disable option <ContinuePartial> ("ContinuePartial=no");
857
# 5) Do not limit download rate ("DownloadRate=0"), because the bandwidth
858
# throttling eats some CPU time;
859
# 6) Disable logging for detail- and debug-messages ("DetailTarget=none",
860
# "DebugTarget=none");
861
# 7) Run the program in daemon (Posix) or service (Windows) mode and use
862
# remote client for short periods of time needed for controlling of
863
# download process on server. Daemon/Service mode eats less CPU
864
# resources than console server mode due to not updating the screen.
865
# 8) Increase the value of option <WriteBufferSize> or better set it to
866
# "-1" (max/auto) if you have spare 5-20 MB of memory.
added
removed
nzbget.conf.example
