Advertisement
Guest User

Untitled

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