Guest User

Untitled

a guest
Dec 26th, 2017
124
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 35.26 KB | None | 0 0
  1. # Sample configuration file for nzbget
  2. #
  3. # On POSIX put this file to one of the following locations:
  4. # ~/.nzbget
  5. # /etc/nzbget.conf
  6. # /usr/etc/nzbget.conf
  7. # /usr/local/etc/nzbget.conf
  8. # /opt/etc/nzbget.conf
  9. #
  10. # On Windows put this file in program's directory.
  11. #
  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
  15.  
  16. # For quick start change the option MAINDIR and configure one news-server
  17.  
  18.  
  19. ##############################################################################
  20. ### PATHS ###
  21.  
  22. # Root directory for all related tasks.
  23. #
  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").
  27. $MAINDIR=C:\download
  28.  
  29. # Destination-directory to store the downloaded files.
  30. DestDir=${MAINDIR}\dst
  31.  
  32. # Directory to monitor for incoming nzb-jobs.
  33. #
  34. # Can have subdirectories.
  35. # A nzb-file queued from a subdirectory will be automatically assigned to
  36. # category with the directory-name.
  37. NzbDir=${MAINDIR}\nzb
  38.  
  39. # Directory to store download queue.
  40. QueueDir=${MAINDIR}\queue
  41.  
  42. # Directory to store temporary files.
  43. TempDir=${MAINDIR}\tmp
  44.  
  45. # Lock-file for daemon-mode, POSIX only.
  46. #
  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
  50.  
  51. # Where to store log file, if it needs to be created.
  52. #
  53. # NOTE: See also option <CreateLog>.
  54. LogFile=${DestDir}\nzbget.log
  55.  
  56.  
  57. ##############################################################################
  58. ### NEWS-SERVERS ###
  59.  
  60. # This section defines which servers nzbget should connect to.
  61.  
  62. # Level of newsserver (0-99).
  63. #
  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,...
  69. #
  70. # NOTE: Do not leave out a level in your server-list and start with level 0.
  71. #
  72. # NOTE: Several servers with the same level may be used, they will have
  73. # the same priority.
  74. # Server1.Level=0
  75.  
  76. Server1.Level=0
  77. Server1.Host=us.news.astraweb.com
  78. Server1.Port=119
  79. Server1.Username=
  80. Server1.Password=
  81. Server1.JoinGroup=yes
  82. Server1.Connections=10
  83.  
  84. # Third server, on level 1.
  85.  
  86. Server2.Level=1
  87. Server2.Host=news.supernews.com
  88. Server2.Port=119
  89. Server2.Username=
  90. Server2.Password=
  91. Server2.JoinGroup=yes
  92. Server2.Connections=10
  93.  
  94.  
  95. ##############################################################################
  96. ### PERMISSIONS ###
  97.  
  98. # User name for daemon-mode, POSIX only.
  99. #
  100. # Set the user that the daemon normally runs at (POSIX in daemon-mode only).
  101. # Set $MAINDIR with an absolute path to be sure where it will write.
  102. # This allows nzbget daemon to be launched in rc.local (at boot), and
  103. # download items as a specific user id.
  104. #
  105. # NOTE: This option has effect only if the program was started from
  106. # root-account, otherwise it is ignored and the daemon runs under
  107. # current user id.
  108. DaemonUserName=root
  109.  
  110. # Specify default umask (affects file permissions) for newly created
  111. # files, POSIX only (000-1000).
  112. #
  113. # The value should be written in octal form (the same as for "umask" shell
  114. # command).
  115. # Empty value or value "1000" disable the setting of umask-mode; current
  116. # umask-mode (set via shell) is used in this case.
  117. UMask=1000
  118.  
  119.  
  120. ##############################################################################
  121. ### INCOMING NZBS ###
  122.  
  123. # Create subdirectory with category-name in destination-directory (yes, no).
  124. AppendCategoryDir=yes
  125.  
  126. # Create subdirectory with nzb-filename in destination-directory (yes, no).
  127. AppendNzbDir=yes
  128.  
  129. # How often incoming-directory (option <NzbDir>) must be checked for new
  130. # nzb-files (seconds).
  131. #
  132. # Value "0" disables the check.
  133. NzbDirInterval=5
  134.  
  135. # How old nzb-file should at least be for it to be loaded to queue (seconds).
  136. #
  137. # Nzbget checks if nzb-file was not modified in last few seconds, defined by
  138. # this option. That safety interval prevents the loading of files, which
  139. # were not yet completely saved to disk, for example if they are still being
  140. # downloaded in web-browser.
  141. NzbDirFileAge=60
  142.  
  143. # Automatic merging of nzb-files with the same filename (yes, no).
  144. #
  145. # A typical scenario: you put nzb-file into incoming directory, nzbget adds
  146. # file to queue. You find out, that the file doesn't have par-files. You
  147. # find required par-files, put nzb-file with the par-files into incoming
  148. # directory, nzbget adds it to queue as a separate group. You want the second
  149. # file to be merged with the first for parchecking to work properly. With
  150. # option "MergeNzb" nzbget can merge files automatically. You only need to
  151. # save the second file under the same filename as the first one.
  152. MergeNzb=yes
  153.  
  154. # Set path to program, that must be executed before any file in incoming
  155. # directory (option <NzbDir>) is processed.
  156. #
  157. # Example: "NzbProcess=C:\nzbprocess.sh".
  158. #
  159. # That program can unpack archives which were put in incoming directory, make
  160. # filename cleanup, assign category and post-processing parameters to nzb-file
  161. # or do something else.
  162. #
  163. # NZBGet passes following arguments to nzbprocess-program as environment
  164. # variables:
  165. # NZBNP_DIRECTORY - path to directory, where file is located. It is a directory
  166. # specified by the option <NzbDir> or a subdirectory;
  167. # NZBNP_FILENAME - name of file to be processed;
  168. #
  169. # In addition to these arguments nzbget passes all
  170. # nzbget.conf-options to postprocess-program as environment variables. These
  171. # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
  172. # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
  173. # The dots in option names are replaced with underscores, for example
  174. # "SERVER1_HOST". For options with predefined possible values (yes\no, etc.)
  175. # the values are passed always in lower case.
  176. #
  177. # The nzbprocess-script can assign category or post-processing parameters
  178. # to current nzb-file by printing special messages into standard output
  179. # (which is processed by NZBGet).
  180. #
  181. # To assign category use following syntax:
  182. # echo "[NZB] CATEGORY=my category";
  183. #
  184. # To assign post-processing parameters:
  185. # echo "[NZB] NZBPR_myvar=my value";
  186. #
  187. # The prefix "NZBPR_" will be removed. In this example a post-processing
  188. # parameter with name "myvar" and value "my value" will be associated
  189. # with nzb-file.
  190. #
  191. # The nzbprocess-script can delete processed file, rename it or move somewhere.
  192. # After the calling of the script the file will be either added to queue
  193. # (if it was an nzb-file) or renamed by adding the extension ".processed".
  194. #
  195. # NOTE: Files with extensions ".processed", ".queued" and ".error" are skipped
  196. # during the directory scanning.
  197. #
  198. # NOTE: Files with extension ".nzb_processed" are not passed to
  199. # NzbProcess-script before adding to queue. This feature allows
  200. # NzbProcess-script to prevent the scanning of nzb-files extracted from
  201. # archives, if they were already processed by the script.
  202. NzbProcess=
  203.  
  204. # Check for duplicate files (yes, no).
  205. #
  206. # If this option is enabled the program checks by adding of a new nzb-file:
  207. # 1) if nzb-file contains duplicate entries. This check aims on detecting
  208. # of reposted files (if first file was not fully uploaded);
  209. # If the program find two files with identical names, only the
  210. # biggest of these files will be added to queue;
  211. # 2) if download queue already contains file with the same name;
  212. # 3) if destination file on disk already exists.
  213. # In last two cases: if the file exists it will not be added to queue;
  214. #
  215. # If this option is disabled, all files are downloaded and duplicate files
  216. # are renamed to "filename_duplicate1".
  217. # Existing files are never deleted or overwritten.
  218. DupeCheck=yes
  219.  
  220.  
  221. ##############################################################################
  222. ### DOWNLOAD QUEUE ###
  223.  
  224. # Save download queue to disk (yes, no).
  225. #
  226. # This allows to reload it on next start.
  227. SaveQueue=yes
  228.  
  229. # Reload download queue on start, if it exists (yes, no).
  230. ReloadQueue=yes
  231.  
  232. # Reload Post-processor-queue on start, if it exists (yes, no).
  233. #
  234. # For this option to work the options <SaveQueue> and <ReloadQueue> must
  235. # be also enabled.
  236. ReloadPostQueue=yes
  237.  
  238. # Reuse articles saved in temp-directory from previous program start (yes, no).
  239. #
  240. # This allows to continue download of file, if program was exited before
  241. # the file was completed.
  242. ContinuePartial=yes
  243.  
  244. # Visibly rename broken files on download appending "_broken" (yes, no).
  245. #
  246. # Do not activate this option if par-check is enabled.
  247. RenameBroken=no
  248.  
  249. # Decode articles (yes, no).
  250. #
  251. # yes - decode articles using internal decoder (supports yEnc and UU formats);
  252. # no - the articles will not be decoded and joined. External programs
  253. # (like "uudeview") can be used to decode and join downloaded articles.
  254. # Also useful for debugging to look at article's source text.
  255. Decode=yes
  256.  
  257. # Write decoded articles directly into destination output file (yes, no).
  258. #
  259. # With this option enabled the program at first creates the output
  260. # destination file with required size (total size of all articles),
  261. # then writes on the fly decoded articles directly to the file
  262. # without creating of any temporary files, even for decoded articles.
  263. # This may results in major performance improvement, but this highly
  264. # depends on OS and file system.
  265. #
  266. # Can improve performance on a very fast internet connections,
  267. # but you need to test if it works in your case.
  268. #
  269. # INFO: Tests showed, that on Linux with EXT3-partition activating of
  270. # this option results in up to 20% better performance, but on Windows with NTFS
  271. # or Linux with FAT32-partitions the performance were decreased.
  272. # The possible reason is that on EXT3-partition Linux can create large files
  273. # very fast (if the content of file does not need to be initialized),
  274. # but Windows on NTFS-partition and also Linux on FAT32-partition need to
  275. # initialize created large file with nulls, resulting in a big performance
  276. # degradation.
  277. #
  278. # NOTE: for testing try to download few big files (with total size 500-1000MB)
  279. # and measure required time. Do not rely on the program's speed indicator.
  280. #
  281. # NOTE: if both options <DirectWrite> and <ContinuePartial> are enabled,
  282. # the program will still create empty articles-files in temp-directory. They
  283. # are used to continue download of file on a next program start. To minimize
  284. # disk-io it is recommended to disable option <ContinuePartial>, if
  285. # <DirectWrite> is enabled. Especially on a fast connections (where you
  286. # would want to activate <DirectWrite>) it should not be a problem to
  287. # redownload an interrupted file.
  288. DirectWrite=no
  289.  
  290. # Check CRC of downloaded and decoded articles (yes, no).
  291. #
  292. # Normally this option should be enabled for better detecting of download
  293. # errors. However checking of CRC needs about the same CPU time as
  294. # decoding of articles. On a fast connections with slow CPUs disabling of
  295. # CPU-check may slightly improve performance (if CPU is a limiting factor).
  296. CrcCheck=yes
  297.  
  298. # How much retries should be attempted if a download error occurs (0-99).
  299. Retries=4
  300.  
  301. # Set the interval between retries (seconds).
  302. RetryInterval=10
  303.  
  304. # Redownload article if CRC-check fails (yes, no).
  305. #
  306. # Helps to minimize number of broken files, but may be effective
  307. # only if you have multiple download servers (even from the same provider
  308. # but from different locations (e.g. europe, usa)).
  309. # In any case the option increases your traffic.
  310. # For slow connections loading of extra par-blocks may be more effective
  311. # The option <CrcCheck> must be enabled for option <RetryOnCrcError> to work.
  312. RetryOnCrcError=no
  313.  
  314. # Set connection timeout (seconds).
  315. ConnectionTimeout=60
  316.  
  317. # Timeout until a download-thread should be killed (seconds).
  318. #
  319. # This can help on hanging downloads, but is dangerous.
  320. # Do not use small values!
  321. TerminateTimeout=600
  322.  
  323. # Set the (approximate) maximum number of allowed threads (0-999).
  324. #
  325. # Sometimes under certain circumstances the program may create way to many
  326. # download threads. Most of them are in wait-state. That is not bad,
  327. # but threads are usually a limited resource. If a program creates to many
  328. # of them, operating system may kill it. The option <ThreadLimit> prevents that.
  329. #
  330. # NOTE: the number of threads is not the same as the number of connections
  331. # opened to NNTP-servers. Do not use the option <ThreadLimit> to limit the
  332. # number of connections. Use the appropriate options <ServerX.Connections>
  333. # instead.
  334. #
  335. # NOTE: the actual number of created threads can be slightly larger as
  336. # defined by the option. Important threads may be created even if the
  337. # number of threads is exceeded. The option prevents only the creation of
  338. # additional download threads.
  339. #
  340. # NOTE: in most cases you should leave the default value "100" unchanged.
  341. # However you may increase that value if you need more than 90 connections
  342. # (that's very unlikely) or decrease the value if the OS does not allow so
  343. # many threads. But the most OSes should not have problems with 100 threads.
  344. ThreadLimit=100
  345.  
  346. # Set the maximum download rate on program start (kilobytes\sec).
  347. #
  348. # Value "0" means no speed control.
  349. # The download rate can be changed later via remote calls.
  350. DownloadRate=0
  351.  
  352. # Set the size of memory buffer used by writing the articles (bytes).
  353. #
  354. # Bigger values decrease disk-io, but increase memory usage.
  355. # Value "0" causes an OS-dependent default value to be used.
  356. # With value "-1" (which means "max\auto") the program sets the size of
  357. # buffer according to the size of current article (typically less than 500K).
  358. #
  359. # NOTE: the value must be written in bytes, do not use postfixes "K" or "M".
  360. #
  361. # NOTE: to calculate the memory usage multiply WriteBufferSize by max number
  362. # of connections, configured in section "NEWS-SERVERS".
  363. #
  364. # NOTE: typical article's size not exceed 500000 bytes, so using bigger values
  365. # (like several megabytes) will just waste memory.
  366. #
  367. # NOTE: for desktop computers with large amount of memory value "-1" (max\auto)
  368. # is recommended, but for computers with very low memory (routers, NAS)
  369. # value "0" (default OS-dependent size) could be better alternative.
  370. #
  371. # NOTE: write-buffer is managed by OS (system libraries) and therefore
  372. # the effect of the option is highly OS-dependent.
  373. WriteBufferSize=0
  374.  
  375. # Pause if disk space gets below this value (megabytes).
  376. #
  377. # Value "0" disables the check.
  378. # Only the disk space on the drive with <DestDir> is checked.
  379. # The drive with <TempDir> is not checked.
  380. DiskSpace=250
  381.  
  382. # Delete already downloaded files from disk, if the download of nzb-file was
  383. # cancelled (nzb-file was deleted from queue) (yes, no).
  384. #
  385. # NOTE: nzbget does not delete files in a case if all remaining files in
  386. # queue are par-files. That prevents the accidental deletion if the option
  387. # <ParCleanupQueue> is disabled or if the program was interrupted during
  388. # parcheck and later restarted without reloading of post queue (option
  389. # <ReloadPostQueue> disabled).
  390. DeleteCleanupDisk=no
  391.  
  392. # Keep the history of downloaded nzb-files (days).
  393. #
  394. # Value "0" disables the history.
  395. #
  396. # NOTE: when a collection having paused files is added to history all remaining
  397. # files are moved from download queue to a list of parked files. It holds files
  398. # which could be required later if the collection will be moved back to
  399. # download queue for downloading of remaining files. The parked files still
  400. # consume some amount of memory and disk space. If the collection was downloaded
  401. # and successfully par-checked or postprocessed it is recommended to discard the
  402. # unneeded parked files before adding the collection to history. For par2-files
  403. # that can be achieved with the option <ParCleanupQueue>.
  404. KeepHistory=1
  405.  
  406. ##############################################################################
  407. ### LOGGING ###
  408.  
  409. # Create log file (yes, no).
  410. CreateLog=yes
  411.  
  412. # Delete log file upon server start (only in server-mode) (yes, no).
  413. ResetLog=no
  414.  
  415. # How error messages must be printed (screen, log, both, none).
  416. ErrorTarget=both
  417.  
  418. # How warning messages must be printed (screen, log, both, none).
  419. WarningTarget=both
  420.  
  421. # How info messages must be printed (screen, log, both, none).
  422. InfoTarget=both
  423.  
  424. # How detail messages must be printed (screen, log, both, none).
  425. DetailTarget=both
  426.  
  427. # How debug messages must be printed (screen, log, both, none).
  428. #
  429. # Debug-messages can be printed only if the program was compiled in
  430. # debug-mode: ".\configure --enable-debug".
  431. DebugTarget=both
  432.  
  433. # Set the default message-kind for output received from process-scripts
  434. # (PostProcess, NzbProcess, TaskX.Process) (none, detail, info, warning,
  435. # error, debug).
  436. #
  437. # NZBGet checks if the line written by the script to stdout or stderr starts
  438. # with special character-sequence, determining the message-kind, e.g.:
  439. # [INFO] bla-bla.
  440. # [DETAIL] bla-bla.
  441. # [WARNING] bla-bla.
  442. # [ERROR] bla-bla.
  443. # [DEBUG] bla-bla.
  444. #
  445. # If the message-kind was detected the text is added to log with detected type.
  446. # Otherwise the message becomes the default kind, specified in this option.
  447. ProcessLogKind=detail
  448.  
  449. # Number of messages stored in buffer and available for remote
  450. # clients (messages).
  451. LogBufferSize=1000
  452.  
  453. # Create a log of all broken files (yes ,no).
  454. #
  455. # It is a text file placed near downloaded files, which contains
  456. # the names of broken files.
  457. CreateBrokenLog=yes
  458.  
  459. # Create memory dump (core-file) on abnormal termination, Linux only (yes, no).
  460. #
  461. # Core-files are very helpful for debugging.
  462. #
  463. # NOTE: core-files may contain sensible data, like your login\password to
  464. # newsserver etc.
  465. DumpCore=no
  466.  
  467. # See also option <LogFile> in section "PATHS"
  468.  
  469.  
  470. ##############################################################################
  471. ### DISPLAY (TERMINAL) ###
  472.  
  473. # Set screen-outputmode (loggable, colored, curses).
  474. #
  475. # loggable - only messages will be printed to standard output;
  476. # colored - prints messages (with simple coloring for messages categories)
  477. # and download progress info; uses escape-sequences to move cursor;
  478. # curses - advanced interactive interface with the ability to edit
  479. # download queue and various output option.
  480. OutputMode=curses
  481.  
  482. # Shows NZB-Filename in file list in curses-outputmode (yes, no).
  483. #
  484. # This option controls the initial state of curses-frontend,
  485. # it can be switched on\off in run-time with Z-key.
  486. CursesNzbName=yes
  487.  
  488. # Show files in groups (NZB-files) in queue list in curses-outputmode (yes, no).
  489. #
  490. # This option controls the initial state of curses-frontend,
  491. # it can be switched on\off in run-time with G-key.
  492. CursesGroup=no
  493.  
  494. # Show timestamps in message list in curses-outputmode (yes, no).
  495. #
  496. # This option controls the initial state of curses-frontend,
  497. # it can be switched on\off in run-time with T-key.
  498. CursesTime=no
  499.  
  500. # Update interval for Frontend-output in console mode or remote client
  501. # mode (milliseconds).
  502. #
  503. # Min value 25. Bigger values reduce CPU usage (especially in curses-outputmode)
  504. # and network traffic in remote-client mode.
  505. UpdateInterval=200
  506.  
  507.  
  508. ##############################################################################
  509. ### CLIENT\SERVER COMMUNICATION ###
  510.  
  511. # IP on which the server listen and which client uses to contact the server.
  512. #
  513. # It could be dns-hostname or ip-address (more effective since does not
  514. # require dns-lookup).
  515. # If you want the server to listen to all interfaces, use "0.0.0.0".
  516. ServerIp=127.0.0.1
  517.  
  518. # Port which the server & client use (1-65535).
  519. ServerPort=6789
  520.  
  521. # Password which the server & client use.
  522. ServerPassword=tegbzn6789
  523.  
  524. # See also option <LogBufferSize> in section "LOGGING"
  525.  
  526.  
  527. ##############################################################################
  528. ### PAR CHECK\REPAIR ###
  529.  
  530. # How many par2-files to load (none, all, one).
  531. #
  532. # none - all par2-files must be automatically paused;
  533. # all - all par2-files must be downloaded;
  534. # one - only one main par2-file must be dowloaded and other must be paused.
  535. # Paused files remain in queue and can be unpaused by parchecker when needed.
  536. LoadPars=all
  537.  
  538. # Automatic par-verification (yes, no).
  539. #
  540. # To download only needed par2-files (smart par-files loading) set also
  541. # the option <LoadPars> to "one". If option <LoadPars> is set to "all",
  542. # all par2-files will be downloaded before verification and repair starts.
  543. # The option <RenameBroken> must be set to "no", otherwise the par-checker
  544. # may not find renamed files and fail.
  545. ParCheck=yes
  546.  
  547. # Automatic par-repair (yes, no).
  548. #
  549. # If option <ParCheck> is enabled and <ParRepair> is not, the program
  550. # only verifies downloaded files and downloads needed par2-files, but does
  551. # not start repair-process. This is useful if the server does not have
  552. # enough CPU power, since repairing of large files may take too much
  553. # resources and time on a slow computers.
  554. # This option has effect only if the option <ParCheck> is enabled.
  555. ParRepair=yes
  556.  
  557. # Use only par2-files with matching names (yes, no).
  558. #
  559. # If par-check needs extra par-blocks it searches for par2-files
  560. # in download queue, which can be unpaused and used for restore.
  561. # These par2-files should have the same base name as the main par2-file,
  562. # currently loaded in par-checker. Sometimes extra par files (especially if
  563. # they were uploaded by a different poster) have not matching names.
  564. # Normally par-checker does not use these files, but you can allow it
  565. # to use these files by setting <StrictParName> to "no".
  566. # This has however a side effect: if NZB-file contains more than one collection
  567. # of files (with different par-sets), par-checker may download par-files from
  568. # a wrong collection. This increases you traffic (but not harm par-check).
  569. #
  570. # NOTE: par-checker always uses only par-files added from the same NZB-file
  571. # and the option <StrictParName> does not change this behavior.
  572. StrictParName=yes
  573.  
  574. # Maximum allowed time for par-repair (minutes).
  575. #
  576. # Value "0" means unlimited.
  577. #
  578. # If you use nzbget on a very slow computer like NAS-device, it may be good to
  579. # limit the time allowed for par-repair. Nzbget calculates the estimated time
  580. # required for par-repair. If the estimated value exceeds the limit defined
  581. # here, nzbget cancels the repair.
  582. #
  583. # To avoid a false cancellation nzbget compares the estimated time with
  584. # <ParTimeLimit> after the first 5 minutes of repairing, when the calculated
  585. # estimated time is more or less accurate. But in a case if <ParTimeLimit> is
  586. # set to a value smaller than 5 minutes, the comparison is made after the first
  587. # whole minute.
  588. #
  589. # NOTE: the option limits only the time required for repairing. It doesn't
  590. # affect the first stage of parcheck - verification of files. However the
  591. # verification speed is constant, it doesn't depend on files integrity and
  592. # therefore it is not necessary to limit the time needed for the first stage.
  593. #
  594. # NOTE: this option requires an extended version of libpar2 (the original
  595. # version doesn't support the cancelling of repairing). Please refer to
  596. # nzbget's README for info on how to apply a patch to libpar2.
  597. ParTimeLimit=0
  598.  
  599. # Pause download queue during check\repair (yes, no).
  600. #
  601. # Enable the option to give CPU more time for par-check\repair. That helps
  602. # to speed up check\repair on slow CPUs with fast connection (e.g. NAS-devices).
  603. #
  604. # NOTE: if parchecker needs additional par-files it temporary unpauses queue.
  605. #
  606. # NOTE: See also option <PostPauseQueue>.
  607. ParPauseQueue=no
  608.  
  609. # Cleanup download queue after successful check\repair (yes, no).
  610. #
  611. # Enable this option for automatic deletion of unneeded (paused) par-files
  612. # from download queue after successful check\repair.
  613. ParCleanupQueue=yes
  614.  
  615. # Delete source nzb-file after successful check\repair (yes, no).
  616. #
  617. # Enable this option for automatic deletion of nzb-file from incoming directory
  618. # after successful check\repair.
  619. NzbCleanupDisk=yes
  620.  
  621. ##############################################################################
  622. ### POSTPROCESSING ###
  623.  
  624. # Set path to program, that must be executed after the download of nzb-file
  625. # or one collection in nzb-file (if par-check enabled and nzb-file contains
  626. # multiple collections; see note below for the definition of "collection")
  627. # is completed and possibly par-checked\repaired.
  628. #
  629. # Example: "PostProcess=C:\postprocess-example.sh".
  630. #
  631. # NZBGet passes following arguments to postprocess-program as environment
  632. # variables:
  633. # NZBPP_DIRECTORY - path to destination dir for downloaded files;
  634. # NZBPP_NZBFILENAME - name of processed nzb-file;
  635. # NZBPP_PARFILENAME - name of par-file or empty string (if no collections were
  636. # found);
  637. # NZBPP_PARSTATUS - result of par-check:
  638. # 0 = not checked: par-check disabled or nzb-file does
  639. # not contain any par-files;
  640. # 1 = checked and failed to repair;
  641. # 2 = checked and successfully repaired;
  642. # 3 = checked and can be repaired but repair is disabled;
  643. # NZBPP_NZBCOMPLETED - state of nzb-job:
  644. # 0 = there are more collections in this nzb-file queued;
  645. # 1 = this was the last collection in nzb-file;
  646. # NZBPP_PARFAILED - indication of failed par-jobs for current nzb-file:
  647. # 0 = no failed par-jobs;
  648. # 1 = current par-job or any of the previous par-jobs for
  649. # the same nzb-files failed;
  650. # NZBPP_CATEGORY - category assigned to nzb-file (can be empty string).
  651. #
  652. # If nzb-file has associated postprocess-parameters (which can be set using
  653. # subcommand <O> of command <-E>, for example: nzbget -E G O "myvar=hello !" 10)
  654. # or using XML-\JSON-RPC (for example via web-interface), they are also passed
  655. # as environment variables. These variables have prefix "NZBPR_" in their names.
  656. # For example, pp-parameter "myvar" will be passed as environment
  657. # variable "NZBPR_myvar".
  658. #
  659. # In addition to arguments and postprocess-parameters nzbget passes all
  660. # nzbget.conf-options to postprocess-program as environment variables. These
  661. # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
  662. # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
  663. # The dots in option names are replaced with underscores, for example
  664. # "SERVER1_HOST". For options with predefined possible values (yes\no, etc.)
  665. # the values are passed always in lower case.
  666. #
  667. # Return value: nzbget processes the exit code returned by the script:
  668. # 91 - request nzbget to do par-check\repair for current collection in the
  669. # current nzb-file;
  670. # 92 - request nzbget to do par-check\repair for all collections in the
  671. # current nzb-file;
  672. # 93 - post-process successful (status = SUCCESS);
  673. # 94 - post-process failed (status = FAILURE);
  674. # 95 - post-process skipped (status = NONE);
  675. # All other return codes are interpreted as "status unknown".
  676. #
  677. # The return value is used to display the status of post-processing in
  678. # a history view. In addition to status one or more text messages can be
  679. # passed to history using a special prefix "[HISTORY]" by printing messages
  680. # to standard output. For example:
  681. # echo "[ERROR] [HISTORY] Unpack failed, not enough disk space";
  682. #
  683. # NOTE: The parameter NZBPP_NZBCOMPLETED is very important and MUST be checked
  684. # even in the simplest scripts.
  685. # If par-check is enabled and nzb-file contains more than one collection
  686. # of files the postprocess-program is called after each collection is completed
  687. # and par-checked. If you want to unpack files or clean up the directory
  688. # (delete par-files, etc.) there are two possibilities, when you can do this:
  689. # 1) you parse NZBPP_PARFILENAME to find out the base name of collection and
  690. # clean up only files from this collection (not reliable, because par-files
  691. # sometimes have different names than rar-files);
  692. # 2) or you just check the parameters NZBPP_NZBCOMPLETED and NZBPP_PARFAILED
  693. # and do the processing, only if NZBPP_NZBCOMPLETED is set to "1" (which
  694. # means, that this was the last collection in nzb-file and all files
  695. # are now completed) and NZBPP_PARFAILED is set to "0" (no failed par-jobs);
  696. #
  697. # NOTE: the term "collection" in the above description actually means
  698. # "par-set". To determine what "collections" are present in nzb-file nzbget
  699. # looks for par-sets. If any collection of files within nzb-file does
  700. # not have any par-files, this collection will not be detected.
  701. # For example, for nzb-file containing three collections but only two par-sets,
  702. # the postprocess will be called two times - after processing of each par-set.
  703. #
  704. # NOTE: if nzbget doesn't find any collections it calls PostProcess once
  705. # with empty string for parameter NZBPP_PARFILENAME;
  706. #
  707. # NOTE: the using of special return values (91 and 92) for requesting of
  708. # par-check\repair allows to organize the delayed parcheck. To do that:
  709. # 1) set options: LoadPars=one, ParCheck=no, ParRepair=yes;
  710. # 2) in post-process-script check the parameter NZBPP_PARSTATUS. If it is "0",
  711. # that means, the script is called for the first time. Try to unpack files.
  712. # If unpack fails, exit the script with exit code for par-check\repair;
  713. # 3) nzbget will start par-check\repair. After that it calls the script again;
  714. # 4) on second pass the parameter NZBPP_PARSTATUS will have value
  715. # greater than "0". If it is "2" ("checked and successfully repaired")
  716. # you can try unpack again.
  717. #
  718. # NOTE: an example script for unrarring is provided within distribution
  719. # in file "postprocess-example.sh".
  720. PostProcess=postprocess-example.sh
  721.  
  722. # Allow multiple post-processing for the same nzb-file (yes, no).
  723. #
  724. # After the post-processing (par-check and call of a postprocess-script) is
  725. # completed, nzbget adds the nzb-file to a list of completed-jobs. The nzb-file
  726. # stays in the list until the last file from that nzb-file is deleted from
  727. # the download queue (it occurs straight away if the par-check was successful
  728. # and the option <ParCleanupQueue> is enabled).
  729. # That means, if a paused file from a nzb-collection becomes unpaused
  730. # (manually or from a post-process-script) after the collection was already
  731. # postprocessed nzbget will not post-process nzb-file again.
  732. # This prevents the unwanted multiple post-processings of the same nzb-file.
  733. # But it might be needed if the par-check\-repair are performed not directly
  734. # by nzbget but from a post-process-script.
  735. #
  736. # NOTE: enable this option only if you were advised to do that by the author
  737. # of the post-process-script.
  738. #
  739. # NOTE: by enabling <AllowReProcess> you should disable the option <ParCheck>
  740. # to prevent multiple par-checking.
  741. AllowReProcess=yes
  742.  
  743. # Pause download queue during executing of postprocess-script (yes, no).
  744. #
  745. # Enable the option to give CPU more time for postprocess-script. That helps
  746. # to speed up postprocess on slow CPUs with fast connection (e.g. NAS-devices).
  747. #
  748. # NOTE: See also option <ParPauseQueue>.
  749. PostPauseQueue=no
  750.  
  751.  
  752. ##############################################################################
  753. ### SCHEDULER ###
  754.  
  755. # This section defines scheduler commands.
  756. # For each command create a set of options <TaskX.Time>, <TaskX.Command>,
  757. # <TaskX.WeekDays> and <TaskX.DownloadRate>.
  758. # The following example shows how to throttle downloads in the daytime
  759. # by 100 KB\s and download at full speed overnights:
  760.  
  761. # Time to execute the command (HH:MM).
  762. #
  763. # Multiple comma-separated values are accepted.
  764. # Asterix as hours-part means "every hour".
  765. #
  766. # Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*:00,*:30".
  767. #Task1.Time=08:00
  768.  
  769. # Week days to execute the command (1-7).
  770. #
  771. # Comma separated list of week days numbers.
  772. # 1 is Monday.
  773. # Character '-' may be used to define ranges.
  774. #
  775. # Examples: "1-7", "1-5", "5,6", "1-5, 7".
  776. #Task1.WeekDays=1-7
  777.  
  778. # Command to be executed (PauseDownload, UnpauseDownload, PauseScan,
  779. # UnpauseScan, DownloadRate, Process).
  780. #
  781. # Possible commands:
  782. # PauseDownload - pauses download;
  783. # UnpauseDownload - resumes download;
  784. # PauseScan - pauses scan of incoming nzb-directory;
  785. # UnpauseScan - resumes scan of incoming nzb-directory;
  786. # DownloadRate - sets download rate in KB\s;
  787. # Process - executes external program.
  788. #Task1.Command=DownloadRate
  789.  
  790. # Download rate to be set if the command is "DownloadRate" (kilobytes\sec).
  791. #
  792. # Value "0" means no speed control.
  793. #
  794. # If the option <TaskX.Command> is not set to "DownloadRate" this option
  795. # is ignored and can be omitted.
  796. #Task1.DownloadRate=100
  797.  
  798. # Path to the porgram to execute if the command is "Process".
  799. #
  800. # Example: "Task1.Process=\home\user\fetch-nzb.sh".
  801. #
  802. # If the option <TaskX.Command> is not set to "Process" this option
  803. # is ignored and can be omitted.
  804. #
  805. # NOTE: it's allowed to add parameters to command line. If filename or
  806. # any parameter contains spaces it must be surrounded with single quotation
  807. # marks. If filename\parameter contains single quotation marks, each of them
  808. # must be replaced with two single quotation marks and the resulting filename\
  809. # parameter must be surrounded with single quotation marks.
  810. # Example: '\home\user\download\my scripts\task process.sh' 'world''s fun'.
  811. # In this example one parameter (world's fun) is passed to the script
  812. # (task process.sh).
  813. #Task1.Process=
  814.  
  815. #Task2.Time=20:00
  816. #Task2.WeekDays=1-7
  817. #Task2.Command=DownloadRate
  818. #Task2.DownloadRate=0
  819.  
  820.  
  821. ##############################################################################
  822. ## PERFORMANCE ##
  823.  
  824. # On a very fast connection and slow CPU and\or drive the following
  825. # settings may improve performance:
  826. # 1) Disable par-checking and -repairing ("ParCheck=no"). VERY important,
  827. # because par-checking\repairing needs a lot of CPU-power and
  828. # significantly increases disk usage;
  829. # 2) Try to activate option <DirectWrite> ("DirectWrite=yes"), especially
  830. # if you use EXT3-partitions;
  831. # 3) Disable option <CrcCheck> ("CrcCheck=no");
  832. # 4) Disable option <ContinuePartial> ("ContinuePartial=no");
  833. # 5) Do not limit download rate ("DownloadRate=0"), because the bandwidth
  834. # throttling eats some CPU time;
  835. # 6) Disable logging for detail- and debug-messages ("DetailTarget=none",
  836. # "DebugTarget=none");
  837. # 7) Run the program in daemon (Posix) or service (Windows) mode and use
  838. # remote client for short periods of time needed for controlling of
  839. # download process on server. Daemon\Service mode eats less CPU
  840. # resources than console server mode due to not updating the screen.
  841. # 8) Increase the value of option <WriteBufferSize> or better set it to
  842. # "-1" (max\auto) if you have spare 5-20 MB of memory.
Add Comment
Please, Sign In to add comment