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/myconfig.txt
  15. # For quick start change the option MainDir and configure one news-server
  16. ##############################################################################
  17. ### PATHS ###
  18. # Root directory for all tasks.
  19. #
  20. # On POSIX you can use "~" as alias for home directory (e.g. "~/download").
  21. # On Windows use absolute paths (e.g. "C:\Download").
  22. MainDir=~/Descargas/nzb
  23. # Destination directory for downloaded files.
  24. #
  25. # If you want to distinguish between partially downloaded files and
  26. # completed downloads, use also option <InterDir>.
  27. DestDir=${MainDir}/dst
  28. # Directory to store intermediate files.
  29. #
  30. # If this option is set (not empty) the files are downloaded into
  31. # this directory first. After successful download of nzb-file (possibly
  32. # after par-repair) the files are moved to destination directory
  33. # (option <DestDir>). If download or unpack fail the files remain in
  34. # intermediate directory.
  35. #
  36. # Using of intermediate directory can significantly improve unpack
  37. # performance if you can put intermediate directory (option <InterDir>)
  38. # and destination directory (option <DestDir>) on separate physical
  39. # hard drives.
  40. #
  41. # NOTE: If the option <InterDir> is set to empty value the downloaded
  42. # files are put directly to destination directory (option <DestDir>).
  43. InterDir=
  44. # Directory to monitor for incoming nzb-jobs.
  45. #
  46. # Can have subdirectories.
  47. # A nzb-file queued from a subdirectory will be automatically assigned to
  48. # category with the directory-name.
  49. NzbDir=${MainDir}/incoming
  50. # Directory to store download queue.
  51. QueueDir=${MainDir}/queue
  52. # Directory to store temporary files.
  53. TempDir=${MainDir}/tmp
  54. # Directory with web-interface files.
  55. #
  56. # Example: /usr/local/share/nzbget/webui.
  57. #
  58. # NOTE: To disable web-interface set the option to an empty value.
  59. # This however doesn't disable the built-in web-server completely because
  60. # it is also used to serve JSON-/XML-RPC requests.
  61. WebDir=
  62. # Directory with post-processing scripts.
  63. #
  64. # NOTE: For information on writing post-processing scripts visit
  65. # http://nzbget.sourceforge.net/Post-processing_scripts.
  66. ScriptDir=${MainDir}/ppscripts
  67. # Lock-file for daemon-mode, POSIX only.
  68. #
  69. # If the option is not empty, NZBGet creates the file and writes process-id
  70. # (PID) into it. That info can be used in shell scripts.
  71. LockFile=${MainDir}/nzbget.lock
  72. # Where to store log file, if it needs to be created.
  73. #
  74. # NOTE: See also option <CreateLog>.
  75. LogFile=${DestDir}/nzbget.log
  76. # Configuration file template.
  77. #
  78. # Put the path to the example configuration file which comes with
  79. # NZBGet. Web-interface needs this file to read option descriptions.
  80. #
  81. # Do not put here your actual configuration file (typically stored
  82. # in your home directory or in /etc/nzbget.conf) but instead the unchanged
  83. # example configuration file (typically installed to
  84. # /usr/local/share/nzbget/nzbget.conf).
  85. #
  86. # Example: /usr/local/share/nzbget/nzbget.conf.
  87. ConfigTemplate=/usr/local/share/nzbget/nzbget.conf
  88. ##############################################################################
  89. ### NEWS-SERVERS ###
  90. # This section defines which servers NZBGet should connect to.
  91. #
  92. # The servers should be numbered subsequently without holes.
  93. # For example if you configure three servers you should name them as Server1,
  94. # Server2 and Server3. If you need to delete Server2 later you should also
  95. # change the name of Server3 to Server2. Otherwise it will not be properly
  96. # read from the config file. Server number doesn't affect its priority (level).
  97. # Use this news server (yes, no).
  98. #
  99. # Set to "no" to temporary disable the server.
  100. Server1.Active=yes
  101. # Name of news server.
  102. #
  103. # The name is used in UI and for logging. It can be any string, you
  104. # may even leave it empty.
  105. Server1.Name=
  106. # Level (priority) of news server (0-99).
  107. #
  108. # The servers are ordered by their level. NZBGet first tries to download
  109. # an article from one (any) of level-0-servers. If that server fails,
  110. # NZBGet tries all other level-0-servers. If all servers fail, it proceeds
  111. # with the level-1-servers, etc.
  112. #
  113. # Put your major download servers at level 0 and your fill servers at
  114. # levels 1, 2, etc..
  115. #
  116. # Several servers with the same level may be defined, they have
  117. # the same priority.
  118. Server1.Level=0
  119. # Group of news server (0-99).
  120. #
  121. # If you have multiple accounts with same conditions (retention, etc.)
  122. # on the same news server, set the same group (greater than 0) for all
  123. # of them. If download fails on one news server, NZBGet does not try
  124. # other servers from the same group.
  125. #
  126. # Value "0" means no group defined (default).
  127. Server1.Group=0
  128. # Host name of news server.
  129. Server1.Host=my.newsserver.com
  130. # Port to connect to (1-65535).
  131. Server1.Port=119
  132. # User name to use for authentication.
  133. Server1.Username=user
  134. # Password to use for authentication.
  135. Server1.Password=pass
  136. # Server requires "Join Group"-command (yes, no).
  137. Server1.JoinGroup=no
  138. # Encrypted server connection (TLS/SSL) (yes, no).
  139. #
  140. # NOTE: By changing this option you should also change the option <ServerX.Port>
  141. # accordingly because unsecure and encrypted connections use different ports.
  142. Server1.Encryption=no
  143. # Cipher to use for encrypted server connection.
  144. #
  145. # By default (when the option is empty) the underlying encryption library
  146. # chooses the cipher automatically. To achieve the best performance
  147. # however you can manually select a faster cipher.
  148. #
  149. # See http://nzbget.sourceforge.net/Choosing_a_cipher for details.
  150. #
  151. # NOTE: One of the fastest cipher is RC4, it also provides strong 128 bit
  152. # encryption. To select it use the cipher string "RC4-MD5" (if NZBGet was
  153. # configured to use OpenSSL) or "NONE:+VERS-TLS-ALL:+ARCFOUR-128:+RSA:+MD5:+COMP-ALL"
  154. # (if NZBGet was configured to use GnuTLS).
  155. #
  156. # NOTE: You may get a TLS handshake error if the news server does
  157. # not support the chosen cipher. You can also get an error "Could not
  158. # select cipher for TLS" if the cipher string is not valid.
  159. Server1.Cipher=
  160. # Maximum number of simultaneous connections to this server (0-999).
  161. Server1.Connections=4
  162. # Second server, on level 0.
  163. #Server2.Level=0
  164. #Server2.Host=my2.newsserver.com
  165. #Server2.Port=119
  166. #Server2.Username=me
  167. #Server2.Password=mypass
  168. #Server2.JoinGroup=yes
  169. #Server2.Connections=4
  170. # Third server, on level 1.
  171. #Server3.Level=1
  172. #Server3.Host=fills.newsserver.com
  173. #Server3.Port=119
  174. #Server3.Username=me2
  175. #Server3.Password=mypass2
  176. #Server3.JoinGroup=yes
  177. #Server3.Connections=1
  178. ##############################################################################
  179. ### REMOTE CONTROL ###
  180. # IP on which NZBGet server listen and which clients use to contact NZBGet.
  181. #
  182. # It could be a dns-hostname (e. g. "mypc") or an ip-address (e. g. "192.168.1.2" or
  183. # "127.0.0.1"). An IP-address is more effective because does not require dns-lookup.
  184. #
  185. # Your computer may have multiple network interfaces and therefore multiple IP
  186. # addresses. If you want NZBGet to listen to all interfaces and be available from
  187. # all IP-addresses use value "0.0.0.0".
  188. #
  189. # NOTE: When you start NZBGet as client (to send remote commands to NZBGet server) and
  190. # the option <ControlIP> is set to "0.0.0.0" the client will use IP "127.0.0.1".
  191. #
  192. # NOTE: If you set the option to "127.0.0.1" you will be able to connect to NZBGet
  193. # only from the computer running NZBGet. This restriction applies to web-interface too.
  194. ControlIP=0.0.0.0
  195. # Port which NZBGet server and remote client use (1-65535).
  196. #
  197. # NOTE: The communication via this port is not encrypted. For encrypted
  198. # communication see option <SecurePort>.
  199. ControlPort=6789
  200. # User name which NZBGet server and remote client use.
  201. #
  202. # Set to empty value to disable user name check (check only password).
  203. #
  204. # NOTE: this option was added in NZBGet 11. Older versions used predefined
  205. # not changeable user name "nzbget". Third-party tools or web-sites written
  206. # for older NZBGet versions may not have an option to define user name. In
  207. # this case you should set option <ControlUsername> to the default value
  208. # "nzbget" or use empty value.
  209. ControlUsername=nzbget
  210. # Password which NZBGet server and remote client use.
  211. #
  212. # Set to empty value to disable authorization request.
  213. ControlPassword=tegbzn6789
  214. # Secure control of NZBGet server (yes, no).
  215. #
  216. # Activate the option if you want to access NZBGet built-in web-server
  217. # via HTTPS (web-interface and RPC). You should also provide certificate
  218. # and key files, see option <SecureCert> and option <SecureKey>.
  219. SecureControl=no
  220. # Port which NZBGet server and remote client use for encrypted
  221. # communication (1-65535).
  222. SecurePort=6791
  223. # Full path to certificate file for encrypted communication.
  224. SecureCert=
  225. # Full path to key file for encrypted communication.
  226. SecureKey=
  227. ##############################################################################
  228. ### PERMISSIONS ###
  229. # User name for daemon-mode, POSIX only.
  230. #
  231. # Set the user that the daemon normally runs at (POSIX in daemon-mode only).
  232. # Set MainDir with an absolute path to be sure where it will write.
  233. # This allows NZBGet daemon to be launched in rc.local (at boot), and
  234. # download items as a specific user id.
  235. #
  236. # NOTE: This option has effect only if the program was started from
  237. # root-account, otherwise it is ignored and the daemon runs under
  238. # current user id.
  239. DaemonUsername=root
  240. # Specify default umask (affects file permissions) for newly created
  241. # files, POSIX only (000-1000).
  242. #
  243. # The value should be written in octal form (the same as for "umask" shell
  244. # command).
  245. # Empty value or value "1000" disable the setting of umask-mode; current
  246. # umask-mode (set via shell) is used in this case.
  247. UMask=1000
  248. ##############################################################################
  249. ### INCOMING NZBS ###
  250. # Create subdirectory with category-name in destination-directory (yes, no).
  251. AppendCategoryDir=yes
  252. # How often incoming-directory (option <NzbDir>) must be checked for new
  253. # nzb-files (seconds).
  254. #
  255. # Value "0" disables the check.
  256. NzbDirInterval=5
  257. # How old nzb-file should at least be for it to be loaded to queue (seconds).
  258. #
  259. # NZBGet checks if nzb-file was not modified in last few seconds, defined by
  260. # this option. That safety interval prevents the loading of files, which
  261. # were not yet completely saved to disk, for example if they are still being
  262. # downloaded in web-browser.
  263. NzbDirFileAge=60
  264. # Automatic merging of nzb-files with the same filename (yes, no).
  265. #
  266. # A typical scenario: you put nzb-file into incoming directory, NZBGet adds
  267. # file to queue. You find out, that the file doesn't have par-files. You
  268. # find required par-files, put nzb-file with the par-files into incoming
  269. # directory, NZBGet adds it to queue as a separate group. You want the second
  270. # file to be merged with the first for parchecking to work properly. With
  271. # option "MergeNzb" NZBGet can merge files automatically. You only need to
  272. # save the second file under the same filename as the first one.
  273. #MergeNzb=no #Option "MergeNzb" is obsolete, ignored
  274. # Set path to program, that must be executed before a nzb-file is added
  275. # to queue.
  276. #
  277. # This program is called each time a new file is found in incoming
  278. # directory (option <NzbDir>) or a file is received via RPC (web-interface,
  279. # command "nzbget --append", etc.).
  280. #
  281. # Example: ~/nzbprocess.sh.
  282. #
  283. # That program can unpack archives which were put in incoming directory, make
  284. # filename cleanup, change nzb-name, category, priority and post-processing
  285. # parameters of the nzb-file or do other things.
  286. #
  287. # INFO FOR DEVELOPERS:
  288. # NZBGet passes following arguments to nzbprocess-program as environment
  289. # variables:
  290. # NZBNP_DIRECTORY - path to directory, where file is located. It is a directory
  291. # specified by the option <NzbDir> or a subdirectory;
  292. # NZBNP_FILENAME - name of file to be processed;
  293. # NZBNP_NZBNAME - nzb-name (without path but with extension);
  294. # NZBNP_CATEGORY - category of nzb-file;
  295. # NZBNP_PRIORITY - priority of nzb-file;
  296. # NZBNP_TOP - flag indicating that the file will be added to the top
  297. # of queue: 0 or 1;
  298. # NZBNP_PAUSED - flag indicating that the file will be added as
  299. # paused: 0 or 1.
  300. #
  301. # In addition to these arguments NZBGet passes all
  302. # nzbget.conf-options to nzbprocess-program as environment variables. These
  303. # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
  304. # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
  305. # The dots in option names are replaced with underscores, for example
  306. # "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
  307. # the values are passed always in lower case.
  308. #
  309. # The nzbprocess-script can change nzb-name, category, priority,
  310. # post-processing parameters and top-/paused-flags of the nzb-file
  311. # by printing special messages into standard output (which is processed
  312. # by NZBGet).
  313. #
  314. # To change nzb-name use following syntax:
  315. # echo "[NZB] NZBNAME=my download";
  316. #
  317. # To change category:
  318. # echo "[NZB] CATEGORY=my category";
  319. #
  320. # To change priority:
  321. # echo "[NZB] PRIORITY=signed_integer_value";
  322. #
  323. # for example: to set priority higher than normal:
  324. # echo "[NZB] PRIORITY=50";
  325. #
  326. # another example: use a negative value for "lower than normal" priority:
  327. # echo "[NZB] PRIORITY=-100";
  328. #
  329. # Although priority can be any integer value, the web-interface operates
  330. # with five predefined priorities:
  331. # -100 - very low priority;
  332. # -50 - low priority;
  333. # 0 - normal priority (default);
  334. # 50 - high priority;
  335. # 100 - very high priority.
  336. #
  337. # To assign post-processing parameters:
  338. # echo "[NZB] NZBPR_myvar=my value";
  339. #
  340. # The prefix "NZBPR_" will be removed. In this example a post-processing
  341. # parameter with name "myvar" and value "my value" will be associated
  342. # with nzb-file.
  343. #
  344. # To change top-flag (nzb-file will be added to the top of queue):
  345. # echo "[NZB] TOP=1";
  346. #
  347. # To change paused-flag (nzb-file will be added in paused state):
  348. # echo "[NZB] PAUSED=1";
  349. #
  350. # The nzbprocess-script can delete processed file, rename it or move somewhere.
  351. # After the calling of the script the file will be either added to queue
  352. # (if it was an nzb-file) or renamed by adding the extension ".processed".
  353. #
  354. # NOTE: Files with extensions ".processed", ".queued" and ".error" are skipped
  355. # during the directory scanning.
  356. #
  357. # NOTE: Files with extension ".nzb_processed" are not passed to
  358. # NzbProcess-script before adding to queue. This feature allows
  359. # NzbProcess-script to prevent the scanning of nzb-files extracted from
  360. # archives, if they were already processed by the script.
  361. #
  362. # NOTE: Files added via RPC calls in particular from web-interface are
  363. # saved into incoming nzb-directory and then processed by the script.
  364. NzbProcess=
  365. # Set path to program, that must be executed after a nzb-file is added
  366. # to queue.
  367. #
  368. # This program is called each time a new nzb-file is added to queue.
  369. #
  370. # Example: ~/nzbaddedprocess.sh.
  371. #
  372. # That program can modify the files in download queue (for example
  373. # delete or pause all nfo, sfv, sample files) or do something else.
  374. #
  375. # INFO FOR DEVELOPERS:
  376. # NZBGet passes following arguments to nzbaddedprocess-program as environment
  377. # variables:
  378. # NZBNA_NZBNAME - name of nzb-group. This name can be used in calls
  379. # to nzbget edit-command using subswitch "-GN name";
  380. # NZBNA_FILENAME - filename of the nzb-file. If the file was added
  381. # from nzb-directory this is the fullname with path.
  382. # If the file was added via web-interface it contains
  383. # only filename without path;
  384. # NZBNA_CATEGORY - category of nzb-file (if assigned);
  385. # NZBNA_LASTID - the id of the last file in the nzb-file. This ID can
  386. # be used with calls to nzbget edit-command;
  387. # NZBNA_PRIORITY - priority (default is 0).
  388. #
  389. # In addition to these arguments NZBGet passes all
  390. # nzbget.conf-options to nzbaddedprocess-program as environment variables. These
  391. # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
  392. # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
  393. # The dots in option names are replaced with underscores, for example
  394. # "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
  395. # the values are passed always in lower case.
  396. #
  397. # Examples:
  398. # 1) pausing nzb-file using file-id:
  399. # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E G P $NZBNA_LASTID;
  400. # 2) setting category using nzb-name:
  401. # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E GN K "my cat" "$NZBNA_NZBNAME";
  402. # 3) pausing files with extension "nzb":
  403. # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E FR P "$NZBNA_NZBNAME/.*\.nzb";
  404. NzbAddedProcess=
  405. # Check for duplicate files (yes, no).
  406. #
  407. # If this option is enabled the program checks by adding of a new nzb-file:
  408. # 1) if nzb-file contains duplicate entries. This check aims on detecting
  409. # of reposted files (if first file was not fully uploaded).
  410. # If the program find two files with identical names, only the
  411. # biggest of these files will be added to queue;
  412. # 2) if download queue already contains file with the same name;
  413. # 3) if destination file on disk already exists.
  414. # In last two cases: if the file exists it will not be added to queue.
  415. #
  416. # If this option is disabled, all files are downloaded and duplicate files
  417. # are renamed to "filename_duplicate1".
  418. # Existing files are never deleted or overwritten.
  419. DupeCheck=yes
  420. ##############################################################################
  421. ### DOWNLOAD QUEUE ###
  422. # Save download queue to disk (yes, no).
  423. #
  424. # This allows to reload it on next start.
  425. SaveQueue=yes
  426. # Reload download queue on start, if it exists (yes, no).
  427. ReloadQueue=yes
  428. # Reload url-queue on start, if it exists (yes, no).
  429. #
  430. # For this option to work the options <SaveQueue> and <ReloadQueue> must
  431. # be also enabled.
  432. #ReloadUrlQueue=yes #Option "ReloadUrlQueue" is obsolete, ignored
  433. # Reload Post-processor-queue on start, if it exists (yes, no).
  434. #
  435. # For this option to work the options <SaveQueue> and <ReloadQueue> must
  436. # be also enabled.
  437. #ReloadPostQueue=yes #Option "ReloadPostQueue" is obsolete, ignored
  438. # Reuse articles saved in temp-directory from previous program start (yes, no).
  439. #
  440. # This allows to continue download of file, if program was exited before
  441. # the file was completed.
  442. ContinuePartial=yes
  443. # Decode articles (yes, no).
  444. #
  445. # yes - decode articles using internal decoder (supports yEnc and UU formats);
  446. # no - the articles will not be decoded and joined. Useful for debugging to
  447. # look at article's source text.
  448. Decode=yes
  449. # Write decoded articles directly into destination output file (yes, no).
  450. #
  451. # Files are posted to Usenet within artilce bodies. Each file typically
  452. # requires hundreds of articles.
  453. #
  454. # When option <DirectWrite> is disabled, the program downloads all articles
  455. # into temporary directory and then combine them into destination file.
  456. #
  457. # With this option enabled the program at first creates the output
  458. # destination file with required size (total size of all articles),
  459. # then writes on the fly decoded articles directly to the file
  460. # without creating of any temporary files.
  461. #
  462. # This may improve performance but depends on OS and file system ability to
  463. # instantly create large files without initializing them with nulls. Such
  464. # files are called sparse files and are supported by modern file systems
  465. # like EXT3 on Linux or NTFS on Windows.
  466. #
  467. # Using of this option reduces disk operations but may produce more fragmented
  468. # files (depends on disk driver), which may slow down the post-processing.
  469. # It's recommended to test how the option behave on your platform to find the
  470. # best setting.
  471. #
  472. # INFO: a particular test on a Linux router with EXT3-partition showed that
  473. # activating of this option results in up to 20% better performance during
  474. # downloading.
  475. #
  476. # NOTE: For test try to download few big nzb-collections (each 4GB or more)
  477. # and measure the time used for downloading and post-processing (use timestamps
  478. # in a log-file to determine when the post-processing was ended).
  479. #
  480. # NOTE: When option <DirectWrite> is enabled the temporary directory (option
  481. # <TempDir>) must be located on the same partition with destination directory
  482. # (option DestDir>) for better performance. If option <DirectWrite> is disabled
  483. # it's better to use different drives for temporary and destination directories.
  484. #
  485. # NOTE: If both options <DirectWrite> and <ContinuePartial> are enabled,
  486. # the program still creates empty article-files in temp-directory. They are used
  487. # by the option <ContinuePartial> to check if a certain article was downloaded.
  488. # To minimize disk-io it is recommended to disable option <ContinuePartial>,
  489. # if <DirectWrite> is enabled. Especially on a fast connections (where you
  490. # would want to activate <DirectWrite>) it should not be a problem to redownload
  491. # an interrupted file.
  492. DirectWrite=yes
  493. # Check CRC of downloaded and decoded articles (yes, no).
  494. #
  495. # Normally this option should be enabled for better detecting of download
  496. # errors. However checking of CRC needs CPU time. On a fast connection and
  497. # slow CPU disabling of CRC-Check may improve performance.
  498. CrcCheck=yes
  499. # How many retries should be attempted if a download error occurs (0-99).
  500. #
  501. # 1) If download fails because of "article or group not found error" the
  502. # program tries another news server.
  503. #
  504. # 2) If download fails because of interrupted connection, the program
  505. # tries the same server again until connection can be established.
  506. #
  507. # In both cases 1) and 2) option <Retries> is not used.
  508. #
  509. # If download however fails because of incomplete article, CRC-error or other
  510. # error not mentioned above the program tries to redownload the article from
  511. # the same news server as many times as defined in option <Retries>. If all
  512. # attempts fail the program tries another news server.
  513. Retries=3
  514. # Set the interval between retries (seconds).
  515. RetryInterval=10
  516. # Set connection timeout (seconds).
  517. ConnectionTimeout=60
  518. # Timeout until a download-thread should be killed (seconds).
  519. #
  520. # This can help on hanging downloads, but is dangerous.
  521. # Do not use small values!
  522. TerminateTimeout=600
  523. # Set the maximum download rate on program start (kilobytes/sec).
  524. #
  525. # Value "0" means no speed control.
  526. # The download rate can be changed later via remote calls.
  527. DownloadRate=0
  528. # Accurate speed rate calculation (yes, no).
  529. #
  530. # During downloading using several connections the download threads may
  531. # interfere with each other when updating statistical data for speed
  532. # meter. This may cause small errors in current download speed reported
  533. # by the program. The speed meter recovers automatically from such errors
  534. # after max. 30 seconds (time window used for speed calculation).
  535. #
  536. # Enable the option to use thread synchronisation mechanisms in order to
  537. # provide absolutely accurate speed calculations.
  538. #
  539. # NOTE: Thread synchronisation increases CPU load and therefore can
  540. # decrease download speed. Do not activate this option on computers with
  541. # limited CPU power. Before activating the option it is recommended to
  542. # run tests to determine how the option affects the CPU usage and the
  543. # download speed on a particular system.
  544. AccurateRate=no
  545. # Set the size of memory buffer used by writing the articles (bytes).
  546. #
  547. # Bigger values decrease disk-io, but increase memory usage.
  548. # Value "0" causes an OS-dependent default value to be used.
  549. # With value "-1" (which means "max/auto") the program sets the size of
  550. # buffer according to the size of current article (typically less than 500K).
  551. #
  552. # NOTE: The value must be written in bytes, do not use postfixes "K" or "M".
  553. #
  554. # NOTE: To calculate the memory usage multiply WriteBufferSize by max number
  555. # of connections, configured in section "NEWS-SERVERS".
  556. #
  557. # NOTE: Typical article's size not exceed 500000 bytes, so using bigger values
  558. # (like several megabytes) will just waste memory.
  559. #
  560. # NOTE: For desktop computers with large amount of memory value "-1" (max/auto)
  561. # is recommended, but for computers with very low memory (routers, NAS)
  562. # value "0" (default OS-dependent size) could be better alternative.
  563. #
  564. # NOTE: Write-buffer is managed by OS (system libraries) and therefore
  565. # the effect of the option is highly OS-dependent.
  566. WriteBufferSize=0
  567. # Pause if disk space gets below this value (megabytes).
  568. #
  569. # Value "0" disables the check.
  570. # Only the disk space on the drive with <DestDir> is checked.
  571. # The drive with <TempDir> is not checked.
  572. DiskSpace=250
  573. # Delete already downloaded files from disk, if the download of nzb-file was
  574. # cancelled (nzb-file was deleted from queue) (yes, no).
  575. #
  576. # NOTE: NZBGet does not delete files in a case if all remaining files in
  577. # queue are par-files. That prevents the accidental deletion if the option
  578. # <ParCleanupQueue> is disabled or if the program was interrupted during
  579. # parcheck and later restarted without reloading of post queue (option
  580. # <ReloadPostQueue> disabled).
  581. #DeleteCleanupDisk=no #Option "DeleteCleanupDisk" is obsolete, ignored
  582. # Keep the history of downloaded nzb-files (days).
  583. #
  584. # Value "0" disables the history.
  585. #
  586. # NOTE: When a collection having paused files is added to history all remaining
  587. # files are moved from download queue to a list of parked files. It holds files
  588. # which could be required later if the collection will be moved back to
  589. # download queue for downloading of remaining files. The parked files still
  590. # consume some amount of memory and disk space. If the collection was downloaded
  591. # and successfully par-checked or postprocessed it is recommended to discard the
  592. # unneeded parked files before adding the collection to history. For par2-files
  593. # that can be achieved with the option <ParCleanupQueue>.
  594. KeepHistory=7
  595. # Keep the history of outdated feed items (days).
  596. #
  597. # After fetching of an RSS feed the information about included items (nzb-files)
  598. # is saved to disk. This allows to detect new items on next fetch. Feed
  599. # providers update RSS feeds constantly. Since the feed length is limited
  600. # (usually 100 items or less) the old items get pushed away by new
  601. # ones. When an item is not present in the feed anymore it's not necessary
  602. # to keep the information about this item on the disk.
  603. #
  604. # If option is set to "0", the outdated items are deleted from history
  605. # immediately.
  606. #
  607. # Otherwise the items are held in the history for defined number of
  608. # days. Keeping of items for few days helps in situations when feed provider
  609. # has technical issues and may response with empty feeds (or with missing
  610. # items). When the technical issue is fixed the items may reappear in the
  611. # feed causing the program to redownload items if they were not found in
  612. # the feed history.
  613. FeedHistory=7
  614. # Maximum number of simultaneous connections for nzb URL downloads (0-999).
  615. #
  616. # When NZB-files are added to queue via URL, the program downloads them
  617. # from the specified URL. The option limits the maximal number of connections
  618. # used for this purpose, when multiple URLs were added at the same time.
  619. UrlConnections=4
  620. ##############################################################################
  621. ### CATEGORIES ###
  622. # This section defines categories available in web-interface.
  623. # Category name.
  624. #
  625. # Each nzb-file can be assigned to a category.
  626. # Category name is passed to post-processing script and can be used by it
  627. # to perform category specific processing.
  628. Category1.Name=Movies
  629. # Destination directory for this category.
  630. #
  631. # If this option is empty, then the default destination directory
  632. # (option <DestDir>) is used. In this case if the option <AppendCategoryDir>
  633. # is active, the program creates a subdirectory with category name within
  634. # destination directory.
  635. Category1.DestDir=
  636. # Unpack downloaded nzb-files (yes, no).
  637. #
  638. # For more information see global option <Unpack>.
  639. Category1.Unpack=yes
  640. # Default list of post-processing scripts.
  641. #
  642. # For more information see global option <DefScript>.
  643. Category1.DefScript=
  644. # List of aliases.
  645. #
  646. # When a nzb-file is added from URL, RSS or RPC the category name
  647. # is usually supplied by nzb-site or by application accessing
  648. # NZBGet. Using Aliases you can match their categories with your owns.
  649. #
  650. # Separate aliases with commas or semicolons. Use wildcard-characters
  651. # * and ? for pattern matching.
  652. #
  653. # Example: TV - HD, TV - SD, TV*
  654. Category1.Aliases=
  655. Category2.Name=Series
  656. Category3.Name=Music
  657. Category4.Name=Software
  658. ##############################################################################
  659. ### RSS FEEDS ###
  660. # Name of RSS Feed.
  661. #
  662. # The name is used in UI and for logging. It can be any string.
  663. #Feed1.Name=my feed
  664. # Address (URL) of RSS Feed.
  665. #
  666. # Example: https://myindexer.com/api?apikey=3544646bfd1c535a9654645609800901&t=search&q=game.
  667. #
  668. # NOTE: When the feed is fetched for the very first time all existing
  669. # items are ignored. The items found on subsequentional fetches are processed.
  670. #Feed1.URL=
  671. # Filter rules for items.
  672. #
  673. # Use filter to ignore unwanted items in the feed. In its simplest version
  674. # the filter is a space separated list of words which must be present in
  675. # the item title.
  676. #
  677. # Example: linux debian dvd.
  678. #
  679. # MORE INFO:
  680. # NOTE: This is a short documentation, for more information visit
  681. # http://nzbget.sourceforge.net/RSS.
  682. #
  683. # Filter string is similar to used in search engines. It consists of
  684. # search rules separated with spaces. Every rule is checked for a feed
  685. # item and if they all succeed the feed item is considered good. If
  686. # any of the rules fails the feed item is ignored (rejected).
  687. #
  688. # Definition of rules:
  689. # [+|-][field:][command]param
  690. #
  691. # + - declares a positive rule. Rules are positive by default,
  692. # the "+" can be omitted;
  693. # - - declares a negative rule. If the rule succeed the feed
  694. # item is ignored;
  695. # field - field to which apply the rule. Available fields: title,
  696. # filename, category, link, size, age. If not specified
  697. # the default field "title" is used;
  698. # command - one of the special characters defining how to interpret the
  699. # parameter (followed after the command):
  700. # @ - search for word "param" This is default command,
  701. # the "@" can be omitted;
  702. # " (quotation mark) - search for substring "param". The parameter
  703. # must end with quotation mark as well;
  704. # $ - "param" defines a regular expression (using POSIX Extended
  705. # Regular Expressions syntax);
  706. # < - less than;
  707. # <= - equal or less than;
  708. # > - greater than;
  709. # >= - equal or greater than;
  710. # param - parameter for command.
  711. #
  712. # Commands @, " and $ are for use with text fields (title, filename, category,
  713. # link). Commands <, <=, > and >= are for use with numeric fields (size,
  714. # age). Commands @ and " support wildcard characters * and ?. Command @ assumes
  715. # following characters being word separators: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~.
  716. #
  717. # Examples (the trailing ; or . is not part of filter):
  718. # 1) s01* -category:anime;
  719. # 2) game of thrones "WEB-DL";
  720. # 3) "game?of?thrones" "WEB-DL" size:<1.8GB age:>2h.
  721. #
  722. # NOTE: This is a short documentation, for more information visit
  723. # http://nzbget.sourceforge.net/RSS.
  724. #Feed1.Filter=
  725. # How often to check for new items (minutes).
  726. #
  727. # Value "0" disables the automatic check of this feed.
  728. #Feed1.Interval=15
  729. # Add nzb-files as paused (yes, no).
  730. #Feed1.PauseNzb=no
  731. # Category for added nzb-files.
  732. #
  733. # NOTE: Feed providers may include category name within response when nzb-file
  734. # is downloaded. If you want to use the providers category leave the option empty.
  735. #Feed1.Category=
  736. # Priority for added nzb-files (number).
  737. #
  738. # Priority can be any integer value. The web-interface however operates
  739. # with only five predefined priorities: -100 (very low priority), -50
  740. # (low priority), 0 (normal priority, default), 50 (high priority),
  741. # 100 (very high priority).
  742. #Feed1.Priority=0
  743. ##############################################################################
  744. ### LOGGING ###
  745. # Create log file (yes, no).
  746. #CreateLog=yes #Option "CreateLog" is obsolete, ignored, use "WriteLog" instead
  747. # Delete log file upon server start (only in server-mode) (yes, no).
  748. #ResetLog=no #Obsolete Option, use "WriteLog=yes|no" instead
  749. # How error messages must be printed (screen, log, both, none).
  750. ErrorTarget=both
  751. # How warning messages must be printed (screen, log, both, none).
  752. WarningTarget=both
  753. # How info messages must be printed (screen, log, both, none).
  754. InfoTarget=both
  755. # How detail messages must be printed (screen, log, both, none).
  756. DetailTarget=both
  757. # How debug messages must be printed (screen, log, both, none).
  758. #
  759. # Debug-messages can be printed only if the program was compiled in
  760. # debug-mode: "./configure --enable-debug".
  761. DebugTarget=both
  762. # Number of messages stored in buffer and available for remote
  763. # clients (messages).
  764. LogBufferSize=1000
  765. # Create a log of all broken files (yes ,no).
  766. #
  767. # It is a text file placed near downloaded files, which contains
  768. # the names of broken files.
  769. CreateBrokenLog=yes
  770. # Create memory dump (core-file) on abnormal termination, Linux only (yes, no).
  771. #
  772. # Core-files are very helpful for debugging.
  773. #
  774. # NOTE: Core-files may contain sensible data, like your login/password to
  775. # newsserver etc.
  776. DumpCore=no
  777. # See also option <LogFile> in section "PATHS"
  778. ##############################################################################
  779. ### DISPLAY (TERMINAL) ###
  780. # Set screen-outputmode (loggable, colored, curses).
  781. #
  782. # loggable - only messages will be printed to standard output;
  783. # colored - prints messages (with simple coloring for messages categories)
  784. # and download progress info; uses escape-sequences to move cursor;
  785. # curses - advanced interactive interface with the ability to edit
  786. # download queue and various output option.
  787. OutputMode=curses
  788. # Shows NZB-Filename in file list in curses-outputmode (yes, no).
  789. #
  790. # This option controls the initial state of curses-frontend,
  791. # it can be switched on/off in run-time with Z-key.
  792. CursesNzbName=yes
  793. # Show files in groups (NZB-files) in queue list in curses-outputmode (yes, no).
  794. #
  795. # This option controls the initial state of curses-frontend,
  796. # it can be switched on/off in run-time with G-key.
  797. CursesGroup=no
  798. # Show timestamps in message list in curses-outputmode (yes, no).
  799. #
  800. # This option controls the initial state of curses-frontend,
  801. # it can be switched on/off in run-time with T-key.
  802. CursesTime=no
  803. # Update interval for Frontend-output in console mode or remote client
  804. # mode (milliseconds).
  805. #
  806. # Min value 25. Bigger values reduce CPU usage (especially in curses-outputmode)
  807. # and network traffic in remote-client mode.
  808. UpdateInterval=200
  809. ##############################################################################
  810. ### SCHEDULER ###
  811. # This section defines scheduler commands.
  812. # For each command create a set of options <TaskX.Time>, <TaskX.Command>,
  813. # <TaskX.WeekDays> and <TaskX.DownloadRate>.
  814. # The following example shows how to throttle downloads in the daytime
  815. # by 100 KB/s and download at full speed overnights:
  816. # Time to execute the command (HH:MM).
  817. #
  818. # Multiple comma-separated values are accepted.
  819. # Asterix as hours-part means "every hour".
  820. #
  821. # Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*:00,*:30".
  822. #Task1.Time=08:00
  823. # Week days to execute the command (1-7).
  824. #
  825. # Comma separated list of week days numbers.
  826. # 1 is Monday.
  827. # Character '-' may be used to define ranges.
  828. #
  829. # Examples: "1-7", "1-5", "5,6", "1-5, 7".
  830. #Task1.WeekDays=1-7
  831. # Command to be executed (DownloadRate, PauseDownload, UnpauseDownload, PauseScan,
  832. # UnpauseScan, Process).
  833. #
  834. # Possible commands:
  835. # DownloadRate - sets download rate in KB/s;
  836. # PauseDownload - pauses download;
  837. # UnpauseDownload - resumes download;
  838. # PauseScan - pauses scan of incoming nzb-directory;
  839. # UnpauseScan - resumes scan of incoming nzb-directory;
  840. # Process - executes external program.
  841. #Task1.Command=DownloadRate
  842. # Download rate to be set if the command is "DownloadRate" (kilobytes/sec).
  843. #
  844. # Value "0" means no speed control.
  845. #
  846. # If the option <TaskX.Command> is not set to "DownloadRate" this option
  847. # is ignored and can be omitted.
  848. #Task1.DownloadRate=100
  849. # Path to the program to execute if the command is "Process".
  850. #
  851. # Example: /home/user/fetch-nzb.sh.
  852. #
  853. # If the option <TaskX.Command> is not set to "Process" this option
  854. # is ignored and can be omitted.
  855. #
  856. # NOTE: It's allowed to add parameters to command line. If filename or
  857. # any parameter contains spaces it must be surrounded with single quotation
  858. # marks. If filename/parameter contains single quotation marks, each of them
  859. # must be replaced with two single quotation marks and the resulting filename/
  860. # parameter must be surrounded with single quotation marks.
  861. # Example: '/home/user/download/my scripts/task process.sh' 'world''s fun'.
  862. # In this example one parameter (world's fun) is passed to the script
  863. # (task process.sh).
  864. #Task1.Process=/home/user/script.sh
  865. #Task2.Time=20:00
  866. #Task2.WeekDays=1-7
  867. #Task2.Command=DownloadRate
  868. #Task2.DownloadRate=0
  869. ##############################################################################
  870. ### PAR CHECK/REPAIR ###
  871. # Whether and how par-verification must be performed (auto, force, manual).
  872. #
  873. # Auto - par-check is performed when needed. One par2-file is always
  874. # downloaded. Additional par2-files are downloaded if needed
  875. # for repair. Repair is performed if the option <ParRepair>
  876. # is enabled;
  877. # Force - force par-check for every download (even undamaged). All
  878. # par2-files are always downloaded. Repair is performed if
  879. # the option <ParRepair> is enabled;
  880. # Manual - par-check is skipped. One par2-file is always
  881. # downloaded. If a damaged download is detected, all
  882. # par2-files are downloaded but neithet par-check nor par-repair
  883. # take place. The download can be then repaired manually
  884. # (possibly on another, faster computer).
  885. ParCheck=auto
  886. # Automatic par-repair after par-verification (yes, no).
  887. #
  888. # If option <ParCheck> is set to "Auto" or "Force" this option defines
  889. # if the download must be repaired when needed. The option can be
  890. # disabled if computer does not have enough CPU power, since repairing
  891. # may take too much resources and time on a slow computers.
  892. ParRepair=yes
  893. # What files should be scanned during par-verification (limited,
  894. # full, auto).
  895. #
  896. # Limited - scan only files belonging to the par-set;
  897. # Full - scan all files in the directory. This helps if the
  898. # files were renamed after creating of par-set;
  899. # Auto - a limited scan is performed first. If the par-checker
  900. # detects missing files, it scans other files in the
  901. # directory until all required files are found.
  902. #
  903. # NOTE: for par-check/repair NZBGet uses library libpar2. The last and
  904. # widely used version 0.2 of the library has few bugs, sometimes causing
  905. # a crash of the program. This is especially true when using "full" or
  906. # "auto" par-scan. NZBGet is supplied with patches addressing these
  907. # issues. Please apply the patches to libpar2 and recompile it.
  908. ParScan=auto
  909. # Use only par2-files with matching names (yes, no).
  910. #
  911. # If par-check needs extra par-blocks it looks for paused par2-files
  912. # in the download queue. These par2-files should have the same base name
  913. # as the main par2-file, currently loaded in par-checker. Sometimes extra
  914. # par2-files have non-matching names (especially if they were uploaded
  915. # by a different poster). Normally par-checker does not use these files, but
  916. # you can allow it to use them by setting <StrictParName> to "no".
  917. # There is a small side effect then: if NZB-file contains more than one
  918. # collection of files (with different par-sets), par-checker may download
  919. # par2-files from a wrong collection and will need to unpause other
  920. # par2-files until all required files are downloaded. This increases the
  921. # traffic (but not harm the par-check).
  922. #
  923. # NOTE: Par-checker always uses only par-files added from the same NZB-file
  924. # and the option <StrictParName> does not change this behavior.
  925. #StrictParName=yes #Option "StrictParName" is obsolete, ignored
  926. # Maximum allowed time for par-repair (minutes).
  927. #
  928. # Value "0" means unlimited.
  929. #
  930. # If you use NZBGet on a very slow computer like NAS-device, it may be good to
  931. # limit the time allowed for par-repair. NZBGet calculates the estimated time
  932. # required for par-repair. If the estimated value exceeds the limit defined
  933. # here, NZBGet cancels the repair.
  934. #
  935. # To avoid a false cancellation NZBGet compares the estimated time with
  936. # <ParTimeLimit> after the first 5 minutes of repairing, when the calculated
  937. # estimated time is more or less accurate. But in a case if <ParTimeLimit> is
  938. # set to a value smaller than 5 minutes, the comparison is made after the first
  939. # whole minute.
  940. #
  941. # NOTE: The option limits only the time required for repairing. It doesn't
  942. # affect the first stage of parcheck - verification of files. However the
  943. # verification speed is constant, it doesn't depend on files integrity and
  944. # therefore it is not necessary to limit the time needed for the first stage.
  945. #
  946. # NOTE: This option requires an extended version of libpar2 (the original
  947. # version doesn't support the cancelling of repairing). Please refer to
  948. # NZBGet's README for info on how to apply the patch to libpar2.
  949. ParTimeLimit=0
  950. # Pause download queue during check/repair (yes, no).
  951. #
  952. # Enable the option to give CPU more time for par-check/repair. That helps
  953. # to speed up check/repair on slow CPUs with fast connection (e.g. NAS-devices).
  954. #
  955. # NOTE: If parchecker needs additional par-files it temporarily unpauses
  956. # the queue.
  957. #
  958. # NOTE: See also options <ScriptPauseQueue> and <UnpackPauseQueue>.
  959. ParPauseQueue=no
  960. # Cleanup download queue after successful check/repair (yes, no).
  961. #
  962. # Enable this option for automatic deletion of unneeded (paused) par-files
  963. # from download queue after successful check/repair.
  964. #ParCleanupQueue=yes #Option "ParCleanupQueue" is obsolete, ignored
  965. # Delete source nzb-file after successful check/repair (yes, no).
  966. #
  967. # Enable this option for automatic deletion of nzb-file from incoming directory
  968. # after successful check/repair.
  969. NzbCleanupDisk=no
  970. # Files to delete after successful check/repair.
  971. #
  972. # List of file extensions or file names to delete after successful
  973. # check/repair. The entries must be separated with commas. The entries
  974. # can be file extensions or any text the file name may end with.
  975. #
  976. # Example: .par2, .sfv
  977. ExtCleanupDisk=.par2, .sfv, _brokenlog.txt
  978. ##############################################################################
  979. ### UNPACK ###
  980. # Unpack downloaded nzb-files (yes, no).
  981. #
  982. # Each download (nzb-file) has a post-processing parameter "Unpack". The option
  983. # <Unpack> is the default value assigned to this pp-parameter of the download
  984. # when it is added to queue.
  985. #
  986. # When nzb-file is added to queue it can have a category assigned to it. In this
  987. # case the option <CategoryX.Unpack> overrides the global option <Unpack>.
  988. #
  989. # If the download is damaged and could not be repaired using par-files
  990. # the unpacking is not performed.
  991. #
  992. # If the option <ParCheck> is set to "Auto" the program tries to unpack
  993. # downloaded files first. If the unpacking fails the par-check/repair
  994. # is performed and the unpack is executed again.
  995. Unpack=yes
  996. # Pause download queue during unpack (yes, no).
  997. #
  998. # Enable the option to give CPU more time for unpacking. That helps
  999. # to speed up unpacking on slow CPUs.
  1000. #
  1001. # NOTE: See also options <ParPauseQueue> and <ScriptPauseQueue>.
  1002. UnpackPauseQueue=no
  1003. # Delete archive files after successful unpacking (yes, no).
  1004. UnpackCleanupDisk=yes
  1005. # Full path to unrar executable.
  1006. #
  1007. # Example: /usr/bin/unrar.
  1008. #
  1009. # If unrar is in your PATH you may leave the path part and set only
  1010. # the executable name ("unrar" on POSIX or "unrar.exe" on Windows).
  1011. UnrarCmd=unrar
  1012. # Full path to 7-Zip executable.
  1013. #
  1014. # Example: /usr/bin/7z.
  1015. #
  1016. # If 7-Zip binary is in your PATH you may leave the path part and set only
  1017. # the executable name ("7z" or "7za" on POSIX or "7z.exe" on Windows).
  1018. SevenZipCmd=7z
  1019. ##############################################################################
  1020. ### POST-PROCESSING SCRIPTS ###
  1021. # Default list of post-processing scripts to execute after the download
  1022. # of nzb-file is completed and possibly par-checked/repaired and unpacked,
  1023. # depending on other options.
  1024. #
  1025. # The scripts in the list must be separated with commas or semicolons. Only
  1026. # filenames without path must be used. All scripts must be stored in directory
  1027. # pointed by option <ScriptDir>.
  1028. #
  1029. # Example: Cleanup.sh, Move.sh, EMail.py.
  1030. #
  1031. # Each download (nzb-file) has its own list of post-processing scripts. The option
  1032. # <DefScript> is the default value assigned to download when it is added to
  1033. # queue. The list of post-processing scripts for a particular download can be
  1034. # changed in the edit dialog in web-interface or using remote command "--edit/-E".
  1035. #
  1036. # When nzb-file is added to queue it can have a category assigned to it. In this
  1037. # case the option <CategoryX.DefScript> (if not empty) overrides the
  1038. # global option <DefScript>.
  1039. #
  1040. # NOTE: The script execution order is controlled by option <ScriptOrder>, not
  1041. # by their order in option <DefScript>.
  1042. #
  1043. # NOTE: Changing options <DefScript> and <CategoryX.DefScript> doesn't affect
  1044. # already queued downloads.
  1045. #
  1046. # NOTE: For the list of interesting post-processing scripts see
  1047. # http://nzbget.sourceforge.net/Catalog_of_post-processing_scripts.
  1048. #
  1049. # INFO FOR DEVELOPERS:
  1050. # NOTE: This is a short documentation, for more information visit
  1051. # http://nzbget.sourceforge.net/Post-processing_scripts.
  1052. #
  1053. # NZBGet passes following arguments to post-processing script as environment
  1054. # variables:
  1055. # NZBPP_DIRECTORY - path to destination dir for downloaded files;
  1056. # NZBPP_NZBNAME - user-friendly name of processed nzb-file as it is displayed
  1057. # by the program. The file path and extension are removed.
  1058. # If download was renamed, this parameter reflects the new name;
  1059. # NZBPP_NZBFILENAME - name of processed nzb-file. It includes file extension and also
  1060. # may include full path;
  1061. # NZBPP_CATEGORY - category assigned to nzb-file (can be empty string);
  1062. # NZBPP_PARSTATUS - result of par-check:
  1063. # 0 = not checked: par-check is disabled or nzb-file does
  1064. # not contain any par-files;
  1065. # 1 = checked and failed to repair;
  1066. # 2 = checked and successfully repaired;
  1067. # 3 = checked and can be repaired but repair is disabled;
  1068. # 4 = par-check needed but skipped (option ParCheck=manual);
  1069. # NZBPP_UNPACKSTATUS - result of unpack:
  1070. # 0 = unpack is disabled or was skipped due to nzb-file
  1071. # properties or due to errors during par-check;
  1072. # 1 = unpack failed;
  1073. # 2 = unpack successful.
  1074. #
  1075. # If the script defines own options they are also passed as environment
  1076. # variables. These variables have prefix "NZBPO_" in their names. For
  1077. # example, option "myoption" will be passed as environment variable
  1078. # "NZBPO_myoption" and in addition in uppercase as "NZBPO_MYOPTION".
  1079. #
  1080. # If the script defines own post-processing parameters, they are also passed as
  1081. # environment variables. These variables have prefix "NZBPR_" in their
  1082. # names. For example, pp-parameter "myparam" will be passed as environment
  1083. # variable "NZBPR_myparam" and in addition in uppercase as "NZBPR_MYPARAM".
  1084. #
  1085. # In addition to arguments, pp-options and pp-parameters NZBGet passes all
  1086. # nzbget.conf-options to pp-script as environment variables. These
  1087. # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
  1088. # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR". The
  1089. # dots in option names are replaced with underscores, for example
  1090. # "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
  1091. # the values are passed always in lower case.
  1092. #
  1093. # Return value: NZBGet processes the exit code returned by the script:
  1094. # 93 - post-process successful (status = SUCCESS);
  1095. # 94 - post-process failed (status = FAILURE);
  1096. # 95 - post-process skipped (status = NONE). Use this code when you script
  1097. # terminates immediateley without doing any job and when this is not
  1098. # a failure termination;
  1099. # 92 - request NZBGet to do par-check/repair for current nzb-file.
  1100. #
  1101. # All other return codes are interpreted as failure (status = FAILURE).
  1102. #
  1103. # NOTE: This is a short documentation, for more information visit
  1104. # http://nzbget.sourceforge.net/Post-processing_scripts.
  1105. DefScript=
  1106. # Execution order for scripts.
  1107. #
  1108. # If you assign multiple scripts to one nzb-file, they are executed in the
  1109. # order defined by this option. Scripts not listed here are executed at
  1110. # the end in their alphabetical order.
  1111. #
  1112. # The scripts in the list must be separated with commas or semicolons. Only
  1113. # filenames without path must be used. All scripts must be stored in directory
  1114. # pointed by option <ScriptDir>.
  1115. #
  1116. # Example: Cleanup.sh, Move.sh.
  1117. ScriptOrder=
  1118. # Pause download queue during executing of postprocess-script (yes, no).
  1119. #
  1120. # Enable the option to give CPU more time for postprocess-script. That helps
  1121. # to speed up postprocess on slow CPUs with fast connection (e.g. NAS-devices).
  1122. #
  1123. # NOTE: See also options <ParPauseQueue> and <UnpackPauseQueue>.
  1124. ScriptPauseQueue=no