SHARE
TWEET

Untitled

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