API tools faq
paste
Advertisement
Guest User

nzbget config file

a guest
Feb 28th, 2019
318
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
Bash 66.84 KB | None | 0 0
raw download clone embed print report
  1. # Configuration file for NZBGet
  2.  
  3.  
  4. ##############################################################################
  5. ### PATHS                                                                  ###
  6.  
  7. # Root directory for all tasks.
  8. #
  9. # On POSIX you can use "~" as alias for home directory (e.g. "~/downloads").
  10. # On Windows use absolute paths (e.g. "C:\Downloads").
  11. MainDir=~/Downloads
  12.  
  13. # Destination directory for downloaded files.
  14. #
  15. # If you want to distinguish between partially downloaded files and
  16. # completed downloads, use also option <InterDir>.
  17. DestDir=${MainDir}/dst
  18.  
  19. # Directory to store intermediate files.
  20. #
  21. # If this option is set (not empty) the files are downloaded into
  22. # this directory first. After successful download of nzb-file (possibly
  23. # after par-repair) the files are moved to destination directory
  24. # (option <DestDir>). If download or unpack fail the files remain in
  25. # intermediate directory.
  26. #
  27. # Using of intermediate directory can significantly improve unpack
  28. # performance if you can put intermediate directory (option <InterDir>)
  29. # and destination directory (option <DestDir>) on separate physical
  30. # hard drives.
  31. #
  32. # NOTE: If the option <InterDir> is set to empty value the downloaded
  33. # files are put directly to destination directory (option <DestDir>).
  34. InterDir=${MainDir}/inter
  35.  
  36. # Directory for incoming nzb-files.
  37. #
  38. # If a new nzb-file is added to queue via web-interface or RPC-API, it
  39. # is saved into this directory and then processed by extension
  40. # scripts (option <Extensions>).
  41. #
  42. # This directory is also monitored for new nzb-files. If a new file
  43. # is found it is added to download queue. The directory can have
  44. # sub-directories. A nzb-file queued from a subdirectory is automatically
  45. # assigned to category with sub-directory-name.
  46. NzbDir=${MainDir}/nzb
  47.  
  48. # Directory to store program state.
  49. #
  50. # This directory is used to save download queue, history, information
  51. # about fetched RSS feeds, statistics, etc.
  52. QueueDir=${MainDir}/queue
  53.  
  54. # Directory to store temporary files.
  55. TempDir=${MainDir}/tmp
  56.  
  57. # Directory with web-interface files.
  58. #
  59. # Example: /usr/local/share/nzbget/webui.
  60. #
  61. # NOTE: To disable web-interface set the option to an empty value.
  62. # This however doesn't disable the built-in web-server completely because
  63. # it is also used to serve JSON-/XML-RPC requests.
  64. WebDir=/usr/share/nzbget/webui
  65.  
  66. # Directory with post-processing and other scripts.
  67. #
  68. # This option may contain multiple directories separated with commas or semicolons.
  69. #
  70. # NOTE: For information on writing scripts visit http://nzbget.net/extension-scripts.
  71. ScriptDir=${WebDir}/scripts
  72.  
  73. # Lock-file for daemon-mode, POSIX only.
  74. #
  75. # When started in daemon mode the program creates the lock file and
  76. # writes process-id (PID) into it. That info can be used in shell
  77. # scripts. If the lock file can not be created or the lock to the file
  78. # can not be acquired the daemon terminates, preventing unintentional
  79. # starting of multiple daemons.
  80. #
  81. # Set to empty value to disable the creating of the lock-file and the
  82. # check for another running instance (not recommended).
  83. LockFile=/var/lib/nzbget/nzbget.lock
  84.  
  85. # Where to store log file, if it needs to be created.
  86. #
  87. # NOTE: See also option <WriteLog>.
  88. LogFile=${MainDir}/nzbget.log
  89.  
  90. # Configuration file template.
  91. #
  92. # Put the path to the example configuration file which comes with
  93. # NZBGet. Web-interface needs this file to read option descriptions.
  94. #
  95. # Do not put here your actual configuration file (typically stored
  96. # in your home directory or in /etc/nzbget.conf) but instead the unchanged
  97. # example configuration file (installed to
  98. # /usr/share/nzbget/nzbget.conf).
  99. #
  100. # Example: /usr/local/share/nzbget/nzbget.conf.
  101. ConfigTemplate=/usr/share/nzbget/nzbget.conf
  102.  
  103. # Required directories.
  104. #
  105. # List of destination directories to be waited for on program start. Directories
  106. # must be separated with commas or semicolons.
  107. #
  108. # The list of directories is checked on program start. The program waits
  109. # until all directories become available before starting download or
  110. # post-processing. This is useful if the download destination is configured
  111. # on network or external drives, which may require some time to mount on boot.
  112. #
  113. # NOTE: Only directories used in option <InterDir> and option <DestDir>
  114. # (global or per-category) can be waited. Other directories, such as
  115. # option <TempDir>, option <NzbDir> and option <QueueDir> must be
  116. # available on program start.
  117. RequiredDir=
  118.  
  119. # Certificate store file or directory.
  120. #
  121. # Certificate store contains root certificates used for server certificate
  122. # verification when connecting to servers with encryption (TLS/SSL). This
  123. # includes communication with news-servers for article downloading and
  124. # with web-servers (via https) for fetching of rss feeds and nzb-files.
  125. #
  126. # The option can point either to one big file containing all root
  127. # certificates or to a directory containing certificate files, in PEM format.
  128. #
  129. # Example: /etc/ssl/certs/ca-certificates.crt.
  130. #
  131. # NOTE: Certificate verification must be enabled separately via option <CertCheck>.
  132. #
  133. # NOTE: For more details visit http://nzbget.net/certificate-verification.
  134. CertStore=
  135.  
  136. ##############################################################################
  137. ### NEWS-SERVERS                                                           ###
  138.  
  139. # This section defines which servers NZBGet should connect to.
  140. #
  141. # The servers should be numbered subsequently without holes.
  142. # For example if you configure three servers you should name them as Server1,
  143. # Server2 and Server3. If you need to delete Server2 later you should also
  144. # change the name of Server3 to Server2. Otherwise it will not be properly
  145. # read from the config file. Server number doesn't affect its priority (level).
  146.  
  147. # Use this news server (yes, no).
  148. #
  149. # Set to "no" to disable the server on program start. Servers can be activated
  150. # later via scheduler tasks or manually via web-interface.
  151. #
  152. # NOTE: Download is not possible when all servers on level 0 are disabled. Servers
  153. # on higher levels are used only if at least one server on level 0 was tried.
  154. Server1.Active=yes
  155.  
  156. # Name of news server.
  157. #
  158. # The name is used in UI and for logging. It can be any string, you
  159. # may even leave it empty.
  160. Server1.Name=
  161.  
  162. # Level (priority) of news server (0-99).
  163. #
  164. # The servers are ordered by their level. NZBGet first tries to download
  165. # an article from one (any) of level-0-servers. If that server fails,
  166. # NZBGet tries all other level-0-servers. If all servers fail, it proceeds
  167. # with the level-1-servers, etc.
  168. #
  169. # Put your major download servers at level 0 and your fill servers at
  170. # levels 1, 2, etc..
  171. #
  172. # Several servers with the same level may be defined, they have
  173. # the same priority.
  174. Server1.Level=0
  175.  
  176. # This is an optional non-reliable server (yes, no).
  177. #
  178. # Marking server as optional tells NZBGet to ignore this server if a
  179. # connection to this server cannot be established. Normally NZBGet
  180. # doesn't try upper-level servers before all servers on current level
  181. # were tried. If a connection to server fails NZBGet waits until the
  182. # server becomes available (it may try others from current level at this
  183. # time). This is usually what you want to avoid exhausting of
  184. # (costly) upper level servers if one of main servers is temporary
  185. # unavailable. However, for less reliable servers you may prefer to ignore
  186. # connection errors and go on with higher-level servers instead.
  187. Server1.Optional=no
  188.  
  189. # Group of news server (0-99).
  190. #
  191. # If you have multiple accounts with same conditions (retention, etc.)
  192. # on the same news server, set the same group (greater than 0) for all
  193. # of them. If download fails on one news server, NZBGet does not try
  194. # other servers from the same group.
  195. #
  196. # Value "0" means no group defined (default).
  197. Server1.Group=0
  198.  
  199. # Host name of news server.
  200. Server1.Host=my.newsserver.com
  201.  
  202. # Port to connect to (1-65535).
  203. Server1.Port=119
  204.  
  205. # User name to use for authentication.
  206. Server1.Username=user
  207.  
  208. # Password to use for authentication.
  209. Server1.Password=pass
  210.  
  211. # Server requires "Join Group"-command (yes, no).
  212. Server1.JoinGroup=no
  213.  
  214. # Encrypted server connection (TLS/SSL) (yes, no).
  215. #
  216. # NOTE: By changing this option you should also change the option <ServerX.Port>
  217. # accordingly because unsecure and encrypted connections use different ports.
  218. Server1.Encryption=no
  219.  
  220. # Cipher to use for encrypted server connection.
  221. #
  222. # By default (when the option is empty) the underlying encryption library
  223. # chooses the cipher automatically. To achieve the best performance
  224. # however you can manually select a faster cipher.
  225. #
  226. # See http://nzbget.net/choosing-cipher for details.
  227. #
  228. # NOTE: One of the fastest cipher is RC4. To select it use the cipher string
  229. # "RC4-MD5" (if NZBGet was configured to use OpenSSL) or
  230. # "NONE:+VERS-TLS-ALL:+ARCFOUR-128:+RSA:+MD5:+COMP-ALL"
  231. # (if NZBGet was configured to use GnuTLS). Note that RC4 is considered insecure
  232. # by the IETF (http://tools.ietf.org/html/rfc7465), but may be sufficient for
  233. # the usage of NZBGet.
  234. #
  235. # NOTE: You may get a TLS handshake error if the news server does
  236. # not support the chosen cipher. You can also get an error "Could not
  237. # select cipher for TLS" if the cipher string is not valid.
  238. Server1.Cipher=
  239.  
  240. # Maximum number of simultaneous connections to this server (0-999).
  241. Server1.Connections=4
  242.  
  243. # Server retention time (days).
  244. #
  245. # How long the articles are stored on the news server. The articles
  246. # whose age exceed the defined server retention time are not tried on
  247. # this news server, the articles are instead considered failed on this
  248. # news server.
  249. #
  250. # Value "0" disables retention check.
  251. Server1.Retention=0
  252.  
  253. # IP protocol version (auto, ipv4, ipv6).
  254. Server1.IpVersion=auto
  255.  
  256. # User comments on this server.
  257. #
  258. # Any text you want to save along with the server definition. For your convenience
  259. # or for usage in custom extension scripts.
  260. Server1.Notes=
  261.  
  262. # Second server, on level 0.
  263.  
  264. #Server2.Level=0
  265. #Server2.Host=my2.newsserver.com
  266. #Server2.Port=119
  267. #Server2.Username=me
  268. #Server2.Password=mypass
  269. #Server2.JoinGroup=yes
  270. #Server2.Connections=4
  271.  
  272. # Third server, on level 1.
  273.  
  274. #Server3.Level=1
  275. #Server3.Host=fills.newsserver.com
  276. #Server3.Port=119
  277. #Server3.Username=me2
  278. #Server3.Password=mypass2
  279. #Server3.JoinGroup=yes
  280. #Server3.Connections=1
  281.  
  282.  
  283. ##############################################################################
  284. ### SECURITY                                                               ###
  285.  
  286. # IP on which NZBGet server listen and which clients use to contact NZBGet.
  287. #
  288. # It could be a dns-hostname (e. g. "mypc") or an IP address (e. g. "192.168.1.2" or
  289. # "127.0.0.1").
  290. #
  291. # Your computer may have multiple network interfaces and therefore multiple IP
  292. # addresses. If you want NZBGet to listen to all interfaces and be available from
  293. # all IP-addresses use value "0.0.0.0".
  294. #
  295. # NOTE: When you start NZBGet as client (to send remote commands to NZBGet server) and
  296. # the option <ControlIP> is set to "0.0.0.0" the client will use IP "127.0.0.1".
  297. #
  298. # NOTE: If you set the option to "127.0.0.1" you will be able to connect to NZBGet
  299. # only from the computer running NZBGet. This restriction applies to web-interface too.
  300. #
  301. # NOTE: NZBGet also supports listening on Unix domain sockets instead of TCP/IP
  302. # sockets. To activate this mode set option <ControlIP> to a local path
  303. # (e. g. "ControlIP=/var/sock").
  304. ControlIP=0.0.0.0
  305.  
  306. # Port which NZBGet server and remote client use (1-65535).
  307. #
  308. # NOTE: The communication via this port is not encrypted. For encrypted
  309. # communication see option <SecurePort>.
  310. ControlPort=6789
  311.  
  312. # User name which NZBGet server and remote client use.
  313. #
  314. # Set to empty value to disable user name check (check only password).
  315. #
  316. # NOTE: This option was added in NZBGet 11. Older versions used predefined
  317. # not changeable user name "nzbget". Third-party tools or web-sites written
  318. # for older NZBGet versions may not have an option to define user name. In
  319. # this case you should set option <ControlUsername> to the default value
  320. # "nzbget" or use empty value.
  321. ControlUsername=nzbget
  322.  
  323. # Password which NZBGet server and remote client use.
  324. #
  325. # Set to empty value to disable authorization request.
  326. ControlPassword=tegbzn6789
  327.  
  328. # User name for restricted access.
  329. #
  330. # The restricted user can control the program with a few restrictions.
  331. # They have access to the web-interface and can see most of the program
  332. # settings. They however, can not change program settings, view security
  333. # related options or options provided by extension scripts.
  334. #
  335. # Use this user to connect to NZBGet from other programs and web-sites.
  336. #
  337. # In terms of RPC-API the user:
  338. # - cannot use method "saveconfig";
  339. # - methods "config" and "saveconfig" return string "***" for
  340. #   options those content is protected from the user.
  341. #
  342. # Set to empty value to disable restricted user.
  343. #
  344. # NOTE: Don't forget to change default username/password of the control
  345. # user (options <ControlUsername> and <ControlPassword>).
  346. RestrictedUsername=
  347.  
  348. # Password for restricted access.
  349. #
  350. # Set to empty value to disable password check.
  351. RestrictedPassword=
  352.  
  353. # User name to add downloads via RPC-API.
  354. #
  355. # Use the AddUsername/AddPassword to give other programs or web-services
  356. # access to NZBGet with only two permissions:
  357. # - add new downloads using RPC-method "append";
  358. # - check program version using RPC-method "version".
  359. #
  360. # In a case the program/web-service needs more rights use the restricted
  361. # user instead (options <RestrictedUsername> and <RestrictedPassword>).
  362. #
  363. # Set to empty value to disable add-user.
  364. #
  365. # NOTE: Don't forget to change default username/password of the control
  366. # user (options <ControlUsername> and <ControlPassword>).
  367. AddUsername=
  368.  
  369. # Password for user with add downloads access.
  370. #
  371. # Set to empty value to disable password check.
  372. AddPassword=
  373.  
  374. # Authenticate using web-form (yes, no).
  375. #
  376. # The preferred and default way to authenticate in web-interface is using
  377. # HTTP authentication. Web-browsers show a special dialog to enter username
  378. # and password which they then send back to NZBGet. Sometimes browser plugins
  379. # aided at storing and filling of passwords do not work properly with browser's
  380. # built-in dialog. To help with such tools NZBGet provide an alternative
  381. # authentication mechanism via web form.
  382. FormAuth=no
  383.  
  384. # Secure control of NZBGet server (yes, no).
  385. #
  386. # Activate the option if you want to access NZBGet built-in web-server
  387. # via HTTPS (web-interface and RPC). You should also provide certificate
  388. # and key files, see option <SecureCert> and option <SecureKey>.
  389. SecureControl=no
  390.  
  391. # Port which NZBGet server and remote client use for encrypted
  392. # communication (1-65535).
  393. SecurePort=6791
  394.  
  395. # Full path to certificate file for encrypted communication.
  396. #
  397. # In case of Let's Encrypt: full path to fullchain.pem.
  398. SecureCert=
  399.  
  400. # Full path to key file for encrypted communication.
  401. #
  402. # In case of Let's Encrypt: full path to privkey.pem.
  403. SecureKey=
  404.  
  405. # IP-addresses allowed to connect without authorization.
  406. #
  407. # Comma separated list of privileged IPs for easy access to NZBGet
  408. # built-in web-server (web-interface and RPC). The connected clients
  409. # have full unrestricted access.
  410. #
  411. # Example: 127.0.0.1,192.168.178.2.
  412. #
  413. # NOTE: Do not use this option if the program works behind another
  414. # web-server because all requests will have the address of this server.
  415. AuthorizedIP=
  416.  
  417. # TLS certificate verification (yes, no).
  418. #
  419. # When connecting to a news server (for downloading) or a web server
  420. # (for fetching of rss feeds and nzb-files) the authenticity of the server
  421. # should be validated using server security certificate. If the check
  422. # fails that means the connection cannot be trusted and must be closed
  423. # with an error message explaining the security issue.
  424. #
  425. # Sometimes servers are improperly configured and the certificate verification
  426. # fails even if there is no hacker attack in place. In that case you should
  427. # inform the server owner about the issue. If you still need to connect to
  428. # servers with invalid certificates you can disable the certificate verification
  429. # but you should know that your connection is insecure and you might be
  430. # connecting to attacker's server without your awareness.
  431. #
  432. # NOTE: Certificate verification requires a list of trusted root certificates,
  433. # which must be configured using option <CertStore>.
  434. #
  435. # NOTE: For more details visit http://nzbget.net/certificate-verification.
  436. CertCheck=no
  437.  
  438. # Automatically check for new releases (none, stable, testing).
  439. #
  440. #  None    - do not show notifcations;
  441. #  Stable  - show notifications about new stable releases;
  442. #  Testing - show notifications about new stable and testing releases.
  443. UpdateCheck=stable
  444.  
  445. # User name for daemon-mode, POSIX only.
  446. #
  447. # Set the user that the daemon normally runs at (POSIX in daemon-mode only).
  448. # Set MainDir with an absolute path to be sure where it will write.
  449. # This allows NZBGet daemon to be launched in rc.local (at boot), and
  450. # download items as a specific user id.
  451. #
  452. # NOTE: This option has effect only if the program was started from
  453. # root-account, otherwise it is ignored and the daemon runs under
  454. # current user id.
  455. DaemonUsername=nzbget
  456.  
  457. # Specify default umask (affects file permissions) for newly created
  458. # files, POSIX only (000-1000).
  459. #
  460. # The value should be written in octal form (the same as for "umask" shell
  461. # command).
  462. # Empty value or value "1000" disable the setting of umask-mode; current
  463. # umask-mode (set via shell) is used in this case.
  464. UMask=1000
  465.  
  466.  
  467. ##############################################################################
  468. ### CATEGORIES                                                             ###
  469.  
  470. # This section defines categories available in web-interface.
  471.  
  472. # Category name.
  473. #
  474. # Each nzb-file can be assigned to a category.
  475. # Category name is passed to post-processing script and can be used by it
  476. # to perform category specific processing.
  477. Category1.Name=Movies
  478.  
  479. # Destination directory for this category.
  480. #
  481. # If this option is empty, then the default destination directory
  482. # (option <DestDir>) is used. In this case if the option <AppendCategoryDir>
  483. # is active, the program creates a subdirectory with category name within
  484. # destination directory.
  485. Category1.DestDir=
  486.  
  487. # Unpack downloaded nzb-files (yes, no).
  488. #
  489. # For more information see global option <Unpack>.
  490. Category1.Unpack=yes
  491.  
  492. # List of extension scripts for this category.
  493. #
  494. # For more information see global option <Extensions>.
  495. Category1.Extensions=
  496.  
  497. # List of aliases.
  498. #
  499. # When a nzb-file is added from URL, RSS or RPC the category name
  500. # is usually supplied by nzb-site or by application accessing
  501. # NZBGet. Using Aliases you can match their categories with your owns.
  502. #
  503. # Separate aliases with commas or semicolons. Use wildcard characters
  504. # * and ? for pattern matching.
  505. #
  506. # Example: TV - HD, TV - SD, TV*
  507. Category1.Aliases=
  508.  
  509. Category2.Name=Series
  510. Category3.Name=Music
  511. Category4.Name=Software
  512.  
  513.  
  514. ##############################################################################
  515. ### RSS FEEDS                                                              ###
  516.  
  517. # Name of RSS Feed.
  518. #
  519. # The name is used in UI and for logging. It can be any string.
  520. #Feed1.Name=my feed
  521.  
  522. # Address (URL) of RSS Feed.
  523. #
  524. # Example: https://myindexer.com/api?apikey=3544646bfd1c535a9654645609800901&t=search&q=game.
  525. #Feed1.URL=
  526.  
  527. # Filter rules for items.
  528. #
  529. # Use filter to ignore unwanted items in the feed. In its simplest version
  530. # the filter is a space separated list of words which must be present in
  531. # the item title.
  532. #
  533. # Example: linux debian dvd.
  534. #
  535. # MORE INFO:
  536. # NOTE: This is a short documentation, for more information visit
  537. # http://nzbget.net/rss.
  538. #
  539. # Feed filter consists of rules - one rule per line. Each rule defines
  540. # a search string and a command, which must be performed if the search
  541. # string matches. There are five kinds of rule-commands: Accept,
  542. # Reject, Require, Options, Comment.
  543. #
  544. # NOTE: Since options in the configuration file can not span multiple
  545. # lines, the lines (rules) must be separated with %-character (percent).
  546. #
  547. # Definition of a rule:
  548. #  [A:|A(options):|R:|Q:|O(options):|#] search-string
  549. #
  550. #  A - declares Accept-rule. Rules are accept-rules by default, the
  551. #      "A:" can be omitted. If the feed item matches to the rule the
  552. #      item is considered good and no further rules are checked.
  553. #  R - declares Reject-rule. If the feed item matches to the rule the
  554. #      item is considered bad and no further rules are checked.
  555. #  Q - declares Require-rule. If the feed item DOES NOT match to the rule
  556. #      the item is considered bad and no further rules are checked.
  557. #  O - declares Options-rule. If the feed item matches to the rule the
  558. #      options declared in the rule are set for the item. The item is
  559. #      neither accepted nor rejected via this rule but can be accepted
  560. #      later by one of Accept-rules. In this case the item will have its
  561. #      options already set (unless the Accept-rule overrides them).
  562. #  # - lines starting with # are considered comments and are ignored. You
  563. #      can use comments to explain complex rules or to temporary disable
  564. #      rules for debugging.
  565. #
  566. # Options allow to set properties on nzb-file. It's a comma-separated
  567. # list of property names with their values.
  568. #
  569. # Definition of an option:
  570. #  name:value
  571. #
  572. # Options can be defined using long option names or short names:
  573. #  category (cat, c)    - set category name, value is a string;
  574. #  pause (p)            - add nzb in paused or unpaused state, possible
  575. #                         values are: yes (y), no (n);
  576. #  priority (pr, r)     - set priority, value is a signed integer number;
  577. #  priority+ (pr+, r+)  - increase priority, value is a signed integer number;
  578. #  dupescore (ds, s)    - set duplicate score, value is a signed integer number;
  579. #  dupescore+ (ds+, s+) - increase duplicate score, value is a signed integer number;
  580. #  dupekey (dk, k)      - set duplicate key, value is a string;
  581. #  dupekey+ (dk+, k+)   - add to duplicate key, value is a string;
  582. #  dupemode (dm, m)     - set duplicate check mode, possible values
  583. #                         are: score (s), all (a), force (f);
  584. #  rageid               - generate duplicate key using this rageid
  585. #                         (integer number) and season/episode numbers;
  586. #  series               - generate duplicate key using series identifier
  587. #                         (any unique string) and season/episode numbers.
  588. #
  589. # Examples of option definitions:
  590. #  Accept(category:my series, pause:yes, priority:100): my show 1080p;
  591. #  Options(c:my series, p:y, r:100): 1080p;
  592. #  Options(s:1000): 1080p;
  593. #  Options(k+:1080p): 1080p;
  594. #  Options(dupemode:force): BluRay.
  595. #
  596. # Rule-options override values set in feed-options.
  597. #
  598. # The search-string is similar to used in search engines. It consists of
  599. # search terms separated with spaces. Every term is checked for a feed
  600. # item and if they all succeed the rule is considered matching.
  601. #
  602. # Definition of a term:
  603. #  [+|-][field:][command]param
  604. #
  605. #  +       - declares a positive term. Terms are positive by default,
  606. #            the "+" can be omitted;
  607. #  -       - declares a negative term. If the term succeeds the feed
  608. #            item is ignored;
  609. #  field   - field to which apply the term. If not specified
  610. #            the default field "title" is used;
  611. #  command - a special character defining how to interpret the
  612. #            parameter (followed after the command):
  613. #            @  - search for string "param". This is default command,
  614. #                 the "@" can be omitted;
  615. #            $  - "param" defines a regular expression (using POSIX Extended
  616. #                 Regular Expressions syntax);
  617. #            =  - equal;
  618. #            <  - less than;
  619. #            <= - equal or less than;
  620. #            >  - greater than;
  621. #            >= - equal or greater than;
  622. #  param   - parameter for command.
  623. #
  624. # Commands @ and $ are for use with text fields (title, filename, category,
  625. # link, description, dupekey). Commands =, <, <=, > and >= are for use
  626. # with numeric fields (size, age, imdbid, rageid, season, episode, priority,
  627. # dupescore).
  628. #
  629. # Only fields title, filename and age are always present. The availability of
  630. # other fields depend on rss feed provider.
  631. #
  632. # Any newznab attribute (encoded as "newznab:attr" in the RSS feed) can
  633. # be used as search field with prefix "attr-", for example "attr-genre".
  634. #
  635. # Text search (Command @) supports wildcard characters * (matches
  636. # any number of any characters), ? (matches any one character)
  637. # and # (matches one digit).
  638. # Text search is by default performed against words (word-search mode): the
  639. # field content is separated into words and then each word is checked
  640. # against pattern. If the search pattern starts and ends with * (star)
  641. # the search is performed against the whole field content
  642. # (substring-search mode). If the search pattern contains word separator
  643. # characters (except * and ?) the search is performed on the whole
  644. # field (the word-search would be obviously never successful in this
  645. # case). Word separators are: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~.
  646. #
  647. # Field "size" can have suffixes "K" or "KB" for kilobytes, "M" or "MB"
  648. # for megabytes and "G" or "GB" for gigabytes. Field "age" can have
  649. # suffixes "m" for minutes, "h" for hours and "d" for days. If suffix
  650. # is not specified default is days.
  651. #
  652. # Examples (the trailing ; or . is not part of filter):
  653. # 1) A: s01* -category:anime;
  654. # 2) my show WEB-DL;
  655. # 3) *my?show* WEB-DL size:<1.8GB age:>2h;
  656. # 4) R: size:>9GB;
  657. # 5) Q: HDTV.
  658. #
  659. # NOTE: This is a short documentation, for more information visit
  660. # http://nzbget.net/rss.
  661. #Feed1.Filter=
  662.  
  663. # How often to check for new items (minutes).
  664. #
  665. # Value "0" disables the automatic check of this feed.
  666. #Feed1.Interval=15
  667.  
  668. # Treat all items on first fetch as backlog (yes, no).
  669. #
  670. #  yes - when the feed is fetched for the very first time (or after
  671. #        changing of URL or filter) all existing items are ignored (marked
  672. #        as backlog). The items found on subsequent fetches are processed;
  673. #  no  - all items are processed even on first fetch (or after
  674. #        changing of URL or filter).
  675. #Feed1.Backlog=yes
  676.  
  677. # Add nzb-files as paused (yes, no).
  678. #Feed1.PauseNzb=no
  679.  
  680. # Category for added nzb-files.
  681. #
  682. # NOTE: Feed providers may include category name within response when nzb-file
  683. # is downloaded. If you want to use the providers category leave the option empty.
  684. #Feed1.Category=
  685.  
  686. # Priority for added nzb-files (number).
  687. #
  688. # Priority can be any integer value. The web-interface however operates
  689. # with only six predefined priorities: -100 (very low priority), -50
  690. # (low priority), 0 (normal priority, default), 50 (high priority),
  691. # 100 (very high priority) and 900 (force priority). Downloads with
  692. # priorities equal to or greater than 900 are downloaded and
  693. # post-processed even if the program is in paused state (force mode).
  694. #Feed1.Priority=0
  695.  
  696. # List of rss feed extension scripts to execute for rss content.
  697. #
  698. # The scripts in the list must be separated with commas or semicolons. All
  699. # scripts must be stored in directory set by option <ScriptDir> and
  700. # paths relative to <ScriptDir> must be entered here.
  701. #
  702. # NOTE: For developer documentation visit http://nzbget.net/extension-scripts.
  703. #Feed1.Extensions=
  704.  
  705.  
  706. ##############################################################################
  707. ### INCOMING NZBS                                                          ###
  708.  
  709. # Create subdirectory with category-name in destination-directory (yes, no).
  710. AppendCategoryDir=yes
  711.  
  712. # How often incoming-directory (option <NzbDir>) must be checked for new
  713. # nzb-files (seconds).
  714. #
  715. # Value "0" disables the check.
  716. #
  717. # NOTE: nzb-files are processed by extension scripts. See option <Extensions>.
  718. NzbDirInterval=5
  719.  
  720. # How old nzb-file should at least be for it to be loaded to queue (seconds).
  721. #
  722. # NZBGet checks if nzb-file was not modified in last few seconds, defined by
  723. # this option. That safety interval prevents the loading of files, which
  724. # were not yet completely saved to disk, for example if they are still being
  725. # downloaded in web-browser.
  726. NzbDirFileAge=60
  727.  
  728. # Check for duplicate titles (yes, no).
  729. #
  730. # If this option is enabled the program checks by adding of a new nzb-file:
  731. # 1) if history contains the same title (see below) with success status
  732. #    the nzb-file is not added to queue;
  733. # 2) if download queue already contains the same title the nzb-file is
  734. #    added to queue for backup (if the first file fails);
  735. # 3) if nzb-file contains duplicate entries. This helps to find errors
  736. #    in bad nzb-files.
  737. #
  738. # "Same title" means the nzb file name is same or the duplicate key is
  739. # same. Duplicate keys are set by fetching from RSS feeds using title
  740. # identifier fields provided by RSS provider (imdbid or rageid/season/episode).
  741. #
  742. # If duplicates were detected only one of them is downloaded. If download
  743. # fails another duplicate is tried. If download succeeds all remaining
  744. # duplicates are deleted from queue.
  745. #
  746. # NOTE: For automatic duplicate handling option <HealthCheck> must be
  747. # set to "Delete", "Park" or "None". If it is set to "Pause" you will need to
  748. # manually unpause another duplicate (if any exists in queue).
  749. #
  750. # NOTE: For more info on duplicates see http://nzbget.net/rss.
  751. DupeCheck=yes
  752.  
  753.  
  754. ##############################################################################
  755. ### DOWNLOAD QUEUE                                                         ###
  756.  
  757. # Flush download queue to disk (yes, no).
  758. #
  759. # Immediately flush file buffers for queue state file. This improves
  760. # safety for the queue file but may decrease disk performance due to
  761. # disabling of disk caching for queue state file.
  762. #
  763. # You can disable this option if it negatively affects disk performance on your
  764. # system. You should create backups of queue-directory (option <QueueDir>)
  765. # in that case. Keep the option enabled if your system often crashes.
  766. FlushQueue=yes
  767.  
  768. # Continue download of partially downloaded files (yes, no).
  769. #
  770. # If active the current state (the info about what articles were already
  771. # downloaded) is saved every second and is reloaded after restart. This is
  772. # about files included in download jobs (usually rar-files), not about
  773. # download-jobs (nzb-files) itself. Download-jobs are always
  774. # continued regardless of that option.
  775. #
  776. # Disabling this option may slightly reduce disk access and is
  777. # therefore recommended on fast connections.
  778. ContinuePartial=yes
  779.  
  780. # Propagation delay to your news servers (minutes).
  781. #
  782. # The option sets minimum post age for nzb-files. Very recent files
  783. # are not downloaded to avoid download failures. The files remain
  784. # on hold in the download queue until the propagation delay expires,
  785. # after that they are downloaded.
  786. PropagationDelay=0
  787.  
  788. # Memory limit for article cache (megabytes).
  789. #
  790. # Article cache helps to improve performance. First the amount of disk
  791. # operations can be significantly reduced. Second the created files are
  792. # less fragmented, which again speeds up the post-processing (unpacking).
  793. #
  794. # The article cache works best with option <DirectWrite> which can
  795. # effectively use even small cache (like 50 MB).
  796. #
  797. # If option <DirectWrite> is disabled the cache should be big enough to
  798. # hold all articles of one file (typically up to 200 MB, sometimes even
  799. # 500 MB). Otherwise the articles are written into temporary directory
  800. # when the cache is full, which degrades performance.
  801. #
  802. # Value "0" disables article cache.
  803. #
  804. # In 32 bit mode the maximum allowed value is 1900.
  805. #
  806. # NOTE: Also see option <WriteBuffer>.
  807. ArticleCache=0
  808.  
  809. # Write decoded articles directly into destination output file (yes, no).
  810. #
  811. # Files are posted to Usenet in multiple pieces (articles). Each file
  812. # typically consists of hundreds of articles.
  813. #
  814. # When option <DirectWrite> is disabled and the article cache (option
  815. # <ArticleCache>) is not active or is full the program saves downloaded
  816. # articles into temporary directory and later reads them all to write
  817. # again into the destination file.
  818. #
  819. # When option <DirectWrite> is enabled the program at first creates the
  820. # output destination file with required size (total size of all articles),
  821. # then writes the articles directly to this file without creating of any
  822. # temporary files. If article cache (option <ArticleCache>) is active
  823. # the downloaded articles are saved into cache first and are written
  824. # into the destination file when the cache flushes. This happen when
  825. # all articles of the file are downloaded or when the cache becomes
  826. # full to 90%.
  827. #
  828. # The direct write relies on the ability of file system to create
  829. # empty files without allocating the space on the drive (sparse files),
  830. # which most modern file systems support including EXT3, EXT4
  831. # and NTFS. The notable exception is HFS+ (default file system on OSX).
  832. #
  833. # The direct write usually improves performance by reducing the amount
  834. # of disk operations but may produce more fragmented files when used
  835. # without article cache.
  836. DirectWrite=yes
  837.  
  838. # Memory limit for per connection write buffer (kilobytes).
  839. #
  840. # When downloaded articles are written into disk the OS collects
  841. # data in the internal buffer before flushing it into disk. This option
  842. # controls the size of this buffer per connection/download thread.
  843. #
  844. # Larger buffers decrease the amount of disk operations and help
  845. # producing less fragmented files speeding up the post-processing
  846. # (unpack).
  847. #
  848. # To calculate the maximum memory required for all download threads multiply
  849. # WriteBuffer by number of connections configured in section
  850. # "NEWS-SERVERS". The option sets the limit, the actual buffer can be
  851. # smaller if the article size (typically about 500 KB) is below the limit.
  852. #
  853. # Write-buffer is managed by OS (system libraries) and therefore
  854. # the effect of the option is highly OS-dependent.
  855. #
  856. # Recommended value for computers with enough memory: 1024.
  857. #
  858. # Value "0" disables the setting of buffer size. In this case a buffer
  859. # of default size (OS and compiler specific) is used, which is usually
  860. # too small (1-4 KB) and therefore not optimal.
  861. #
  862. # NOTE: Also see option <ArticleCache>.
  863. WriteBuffer=0
  864.  
  865. # How to name downloaded files (auto, article, nzb).
  866. #
  867. #  Article - use file names stored in article metadata;
  868. #  Nzb     - use file names as defined in nzb-file;
  869. #  Auto    - prefer names from article metadata; for obfuscated files use
  870. #            names from nzb-file.
  871. #
  872. # NOTE: This option sets the naming convention for files listed in nzb. It has no
  873. # effect on files extracted from archives.
  874. FileNaming=auto
  875.  
  876. # Reorder files within nzbs for optimal download order (yes, no).
  877. #
  878. # When nzb-file is added to queue the files listed within nzb can be in a random
  879. # order. When "ReorderFiles" is active the files are automatically sorted
  880. # alphabetically to ensure download of archive parts in correct order. The
  881. # par2-files are moved to the end and then sorted by size.
  882. #
  883. # NOTE: When option <DirectRename> is active the files are sorted again after the file
  884. # names become known.
  885. ReorderFiles=yes
  886.  
  887. # Post-processing strategy (sequential, balanced, aggressive, rocket).
  888. #
  889. #  Sequential - downloaded items are post processed from a queue, one item at a
  890. #               time, to dedicate the most computer resources to each
  891. #               item. Therefore, a post process par repair will prevent another
  892. #               task from running even if the item does not require a par repair;
  893. #  Balanced   - items that do not need par repair are post processed one at a
  894. #               time while par repair tasks may also run simultaneously one after
  895. #               another at the same time. This means that a post process par
  896. #               repair will not prevent another task from running, but at a cost
  897. #               of using more computer resource;
  898. #  Aggressive - will simultaneously post process up to three items including
  899. #               one par repair task;
  900. #  Rocket     - will simultaneously post process up to six items including one
  901. #               or two par repair tasks.
  902. #
  903. # NOTE: Computer resources are in heavy demand when post-processing with
  904. # simultaneous tasks - make sure the hardware is capable.
  905. PostStrategy=balanced
  906.  
  907. # Pause if disk space gets below this value (megabytes).
  908. #
  909. # Disk space is checked for directories pointed by option <DestDir> and
  910. # option <InterDir>.
  911. #
  912. # Value "0" disables the check.
  913. DiskSpace=250
  914.  
  915. # Delete source nzb-file when it is not needed anymore (yes, no).
  916. #
  917. # Enable this option for automatic deletion of source nzb-file from
  918. # incoming directory when the program doesn't require it anymore (the
  919. # nzb-file has been deleted from queue and history).
  920. NzbCleanupDisk=yes
  921.  
  922. # Keep the history of downloaded nzb-files (days).
  923. #
  924. # After download and post-processing the items are added to history where
  925. # their status can be checked and they can be post-processed again if
  926. # necessary.
  927. #
  928. # After expiring of defined period:
  929. #
  930. # If option <DupeCheck> is active the items become hidden and the amount
  931. # of data kept is significantly reduced (for better performance), only
  932. # fields necessary for duplicate check are kept. The item remains in the
  933. # hidden history (forever);
  934. #
  935. # If option <DupeCheck> is NOT active the items are removed from history.
  936. #
  937. # When a failed item is removed from history or become hidden all downloaded
  938. # files of that item are deleted from disk.
  939. #
  940. # Value "0" disables history. Duplicate check will not work.
  941. KeepHistory=30
  942.  
  943. # Keep the history of outdated feed items (days).
  944. #
  945. # After fetching of an RSS feed the information about included items (nzb-files)
  946. # is saved to disk. This allows to detect new items on next fetch. Feed
  947. # providers update RSS feeds constantly. Since the feed length is limited
  948. # (usually 100 items or less) the old items get pushed away by new
  949. # ones. When an item is not present in the feed anymore it's not necessary
  950. # to keep the information about this item on the disk.
  951. #
  952. # If option is set to "0", the outdated items are deleted from history
  953. # immediately.
  954. #
  955. # Otherwise the items are held in the history for defined number of
  956. # days. Keeping of items for few days helps in situations when feed provider
  957. # has technical issues and may response with empty feeds (or with missing
  958. # items). When the technical issue is fixed the items may reappear in the
  959. # feed causing the program to re-download items if they were not found in
  960. # the feed history.
  961. FeedHistory=7
  962.  
  963. # Discard downloaded data (do not write into disk) (yes, no).
  964. #
  965. # This option is for speed test purposes (benchmarking). When enabled the
  966. # downloaded data is not written into disk. The destination files are still
  967. # created but are either empty or contain zeros (depending on other
  968. # options). The post-processing (unpack, repair, etc.) is also completely
  969. # disabled.
  970. #
  971. # NOTE: This option is meant for development purposes. You should not
  972. # activate it except maybe for speed tests.
  973. SkipWrite=no
  974.  
  975. # Write article raw data (yes, no).
  976. #
  977. # When enabled the article content is written into disk in raw form without
  978. # processing.
  979. #
  980. # NOTE: This option is meant for development purposes. You should not
  981. # activate it.
  982. RawArticle=no
  983.  
  984. ##############################################################################
  985. ### CONNECTION                                                             ###
  986.  
  987. # How many retries should be attempted if a download error occurs (0-99).
  988. #
  989. # If download fails because of incomplete or damaged article or due to
  990. # CRC-error the program tries to re-download the article from the same
  991. # news server as many times as defined in this option. If all attempts fail
  992. # the program tries another news server.
  993. #
  994. # If download fails because of "article or group not found error" the
  995. # program tries another news server without retrying on the failed server.
  996. ArticleRetries=3
  997.  
  998. # Article retry interval (seconds).
  999. #
  1000. # If download of article fails because of interrupted connection
  1001. # the server is temporary blocked until the retry interval expires.
  1002. ArticleInterval=10
  1003.  
  1004. # Connection timeout for article downloading (seconds).
  1005. ArticleTimeout=60
  1006.  
  1007. # Number of download attempts for URL fetching (0-99).
  1008. #
  1009. # If fetching of nzb-file via URL or fetching of RSS feed fails another
  1010. # attempt is made after the retry interval (option <UrlInterval>).
  1011. UrlRetries=3
  1012.  
  1013. # URL fetching retry interval (seconds).
  1014. #
  1015. # If fetching of nzb-file via URL or fetching of RSS feed fails another
  1016. # attempt is made after the retry interval.
  1017. UrlInterval=10
  1018.  
  1019. # Connection timeout for URL fetching (seconds).
  1020. #
  1021. # Connection timeout when fetching nzb-files via URLs and fetching RSS feeds.
  1022. UrlTimeout=60
  1023.  
  1024. # Timeout for incoming connections (seconds).
  1025. #
  1026. # Set timeout for connections from clients (web-browsers and API clients).
  1027. RemoteTimeout=90
  1028.  
  1029. # Set the maximum download rate on program start (kilobytes/sec).
  1030. #
  1031. # The download rate can be changed later in web-interface or via remote calls.
  1032. #
  1033. # Value "0" means no speed control.
  1034. DownloadRate=0
  1035.  
  1036. # Maximum number of simultaneous connections for nzb URL downloads (0-999).
  1037. #
  1038. # When NZB-files are added to queue via URL, the program downloads them
  1039. # from the specified URL. The option limits the maximal number of connections
  1040. # used for this purpose, when multiple URLs were added at the same time.
  1041. UrlConnections=4
  1042.  
  1043. # Force URL-downloads even if download queue is paused (yes, no).
  1044. #
  1045. # If option is active the URL-downloads (such as appending of nzb-files
  1046. # via URL or fetching of RSS feeds and nzb-files from feeds) are performed
  1047. # even if download is in paused state.
  1048. UrlForce=yes
  1049.  
  1050. # Monthly download volume quota (megabytes).
  1051. #
  1052. # During download the quota is constantly monitored and the downloading
  1053. # is automatically stopped if the limit is reached. Once the next billing month
  1054. # starts the "quota reached"-status is automatically lifted and the downloading
  1055. # continues.
  1056. #
  1057. # Downloads with force-priority are processed regardless of quota status.
  1058. #
  1059. # Value "0" disables monthly quota check.
  1060. MonthlyQuota=0
  1061.  
  1062. # Day of month when the monthly quota starts (1-31).
  1063. QuotaStartDay=1
  1064.  
  1065. # Daily download volume quota (megabytes).
  1066. #
  1067. # See option <MonthlyQuota> for details.
  1068. #
  1069. # Value "0" disables daily quota check.
  1070. DailyQuota=0
  1071.  
  1072.  
  1073. ##############################################################################
  1074. ### LOGGING                                                                ###
  1075.  
  1076. # How to use log file (none, append, reset, rotate).
  1077. #
  1078. #  none   - do not write into log file;
  1079. #  append - append to the existing log file or create it;
  1080. #  reset  - delete existing log file on program start and create a new one;
  1081. #  rotate - create new log file for each day, delete old files,
  1082. #           see option <RotateLog>.
  1083. WriteLog=append
  1084.  
  1085. # Log file rotation period (days).
  1086. #
  1087. # Defines how long to keep old log-files, when log rotation is active
  1088. # (option <WriteLog> is set to "rotate").
  1089. RotateLog=3
  1090.  
  1091. # How error messages must be printed (screen, log, both, none).
  1092. ErrorTarget=both
  1093.  
  1094. # How warning messages must be printed (screen, log, both, none).
  1095. WarningTarget=both
  1096.  
  1097. # How info messages must be printed (screen, log, both, none).
  1098. InfoTarget=both
  1099.  
  1100. # How detail messages must be printed (screen, log, both, none).
  1101. DetailTarget=log
  1102.  
  1103. # How debug messages must be printed (screen, log, both, none).
  1104. #
  1105. # Debug-messages can be printed only if the program was compiled in
  1106. # debug-mode: "./configure --enable-debug".
  1107. DebugTarget=log
  1108.  
  1109. # Number of messages stored in screen buffer (messages).
  1110. LogBuffer=1000
  1111.  
  1112. # Create log for each downloaded nzb-file (yes, no).
  1113. #
  1114. # The messages are saved for each download separately and can be viewed
  1115. # at any time in download details dialog or history details dialog.
  1116. NzbLog=yes
  1117.  
  1118. # Print call stack trace into log on program crash (Linux and Windows) (yes, no).
  1119. #
  1120. # Call stack traces are very helpful for debugging. Call stack traces can be
  1121. # printed only when the program was compiled in debug mode.
  1122. CrashTrace=yes
  1123.  
  1124. # Save memory dump into disk on program crash (Linux only) (yes, no).
  1125. #
  1126. # Memory dumps (core-files) are very helpful for debugging, especially if
  1127. # they were produced by the program compiled in debug mode.
  1128. #
  1129. # NOTE: Memory dumps may contain sensitive data, like your login/password
  1130. # to news-server etc.
  1131. CrashDump=no
  1132.  
  1133. # Local time correction (hours or minutes).
  1134. #
  1135. # The option allows to adjust timestamps when converting system time to
  1136. # local time and vice versa. The conversion is used when printing messages
  1137. # to the log-file and by option "TaskX.Time" in the scheduler settings.
  1138. #
  1139. # The option is usually not needed if the time zone is set up correctly.
  1140. # However, sometimes, especially when using a binary compiled on another
  1141. # platform (cross-compiling) the conversion between system and local time
  1142. # may not work properly and requires adjustment.
  1143. #
  1144. # Values in the range -24..+24 are interpreted as hours, other values as minutes.
  1145. #  Example 1: set time correction to one hour: TimeCorrection=1;
  1146. #  Example 2: set time correction to one hour and a half: TimeCorrection=90.
  1147. TimeCorrection=0
  1148.  
  1149.  
  1150. ##############################################################################
  1151. ### DISPLAY (TERMINAL)                                                     ###
  1152.  
  1153. # Set screen-outputmode (loggable, colored, curses).
  1154. #
  1155. # loggable - only messages will be printed to standard output;
  1156. # colored  - prints messages (with simple coloring for messages categories)
  1157. #            and download progress info; uses escape-sequences to move cursor;
  1158. # curses   - advanced interactive interface with the ability to edit
  1159. #            download queue and various output option.
  1160. OutputMode=curses
  1161.  
  1162. # Shows NZB-Filename in file list in curses-outputmode (yes, no).
  1163. #
  1164. # This option controls the initial state of curses-frontend,
  1165. # it can be switched on/off in run-time with Z-key.
  1166. CursesNzbName=yes
  1167.  
  1168. # Show files in groups (NZB-files) in queue list in curses-outputmode (yes, no).
  1169. #
  1170. # This option controls the initial state of curses-frontend,
  1171. # it can be switched on/off in run-time with G-key.
  1172. CursesGroup=no
  1173.  
  1174. # Show timestamps in message list in curses-outputmode (yes, no).
  1175. #
  1176. # This option controls the initial state of curses-frontend,
  1177. # it can be switched on/off in run-time with T-key.
  1178. CursesTime=no
  1179.  
  1180. # Update interval for Frontend-output in console mode or remote client
  1181. # mode (milliseconds).
  1182. #
  1183. # Min value 25. Bigger values reduce CPU usage (especially in curses-outputmode)
  1184. # and network traffic in remote-client mode.
  1185. UpdateInterval=200
  1186.  
  1187.  
  1188. ##############################################################################
  1189. ### SCHEDULER                                                              ###
  1190.  
  1191. # Time to execute the command (HH:MM).
  1192. #
  1193. # Multiple comma-separated values are accepted.
  1194. # An asterisk placed in the hours location will run task every hour (e. g. "*:00").
  1195. # An asterisk without minutes will run task at program startup (e. g. "*").
  1196. #
  1197. # Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*,*:00,*:30".
  1198. #
  1199. # NOTE: Also see option <TimeCorrection>.
  1200. #Task1.Time=08:00
  1201.  
  1202. # Week days to execute the command (1-7).
  1203. #
  1204. # Comma separated list of week days numbers.
  1205. # 1 is Monday.
  1206. # Character '-' may be used to define ranges.
  1207. #
  1208. # Examples: "1-7", "1-5", "5,6", "1-5, 7".
  1209. #Task1.WeekDays=1-7
  1210.  
  1211. # Command to be executed (PauseDownload, UnpauseDownload, PausePostProcess,
  1212. # UnpausePostProcess, PauseScan, UnpauseScan, DownloadRate, Script, Process,
  1213. # ActivateServer, DeactivateServer, FetchFeed).
  1214. #
  1215. # Possible commands:
  1216. #   PauseDownload      - pause download;
  1217. #   UnpauseDownload    - resume download;
  1218. #   PausePostProcess   - pause post-processing;
  1219. #   UnpausePostProcess - resume post-processing;
  1220. #   PauseScan          - pause scan of incoming nzb-directory;
  1221. #   UnpauseScan        - resume scan of incoming nzb-directory;
  1222. #   DownloadRate       - set download rate limit;
  1223. #   Script             - execute one or multiple scheduler scripts. The scripts
  1224. #                        must be written specially for NZBGet;
  1225. #   Process            - execute an external (any) program;
  1226. #   ActivateServer     - activate news-server;
  1227. #   DeactivateServer   - deactivate news-server;
  1228. #   FetchFeed          - fetch RSS feed.
  1229. #
  1230. # On start the program checks all tasks and determines current state
  1231. # for download-pause, scan-pause, download-rate and active servers.
  1232. #Task1.Command=PauseDownload
  1233.  
  1234. # Parameters for the command if needed.
  1235. #
  1236. # Some scheduler commands require additional parameters:
  1237. #  DownloadRate     - download rate limit to be set (kilobytes/sec).
  1238. #                     Example: 1000.
  1239. #                     NOTE: use value "0" to disable download limit (unlimited speed).
  1240. #  Script           - list of scheduler scripts to execute. The scripts in the
  1241. #                     list must be separated with commas or semicolons. All
  1242. #                     scripts must be stored in directory set by option
  1243. #                     <ScriptDir> and paths relative to <ScriptDir> must be
  1244. #                     entered here. For developer documentation visit
  1245. #                     http://nzbget.net/extension-scripts;
  1246. #  Process          - path to the program to execute and its parameters.
  1247. #                     Example: /home/user/fetch.sh.
  1248. #                     If filename or any parameter contains spaces it
  1249. #                     must be surrounded with single quotation
  1250. #                     marks. If filename/parameter contains single quotation marks,
  1251. #                     each of them must be replaced (escaped) with two single quotation
  1252. #                     marks and the resulting filename/parameter must be
  1253. #                     surrounded with single quotation marks.
  1254. #                     Example: '/home/user/download/my scripts/task process.sh' 'world''s fun'.
  1255. #                     In this example one parameter (world's fun) is passed
  1256. #                     to the script (task process.sh).
  1257. #  ActivateServer   - comma separated list of news server ids or server names.
  1258. #                     Example: 1,3.
  1259. #                     Example: my news server 1, my news server 2.
  1260. #                     NOTE: server names should not have commas.
  1261. #  DeactivateServer - see ActivateServer.
  1262. #  FetchFeed        - comma separated list of RSS feed ids or feed names.
  1263. #                     Example: 1,3.
  1264. #                     Example: bookmarks feed, another feed.
  1265. #                     NOTE: feed names should not have commas.
  1266. #                     NOTE: use feed id "0" to fetch all feeds.
  1267. #Task1.Param=
  1268.  
  1269. #Task2.Time=20:00
  1270. #Task2.WeekDays=1-7
  1271. #Task2.Command=UnpauseDownload
  1272. #Task2.Param=
  1273.  
  1274.  
  1275. ##############################################################################
  1276. ### CHECK AND REPAIR                                                       ###
  1277.  
  1278. # Check CRC of downloaded and decoded articles (yes, no).
  1279. #
  1280. # Normally this option should be enabled for better detecting of download
  1281. # errors and for quick par-verification (option <ParQuick>).
  1282. CrcCheck=yes
  1283.  
  1284. # Whether and how par-verification must be performed (auto, always, force, manual).
  1285. #
  1286. #  Auto   - par-check is performed when needed. One par2-file is always
  1287. #           downloaded. Additional par2-files are downloaded if needed
  1288. #           for repair. Repair is performed if the option <ParRepair>
  1289. #           is enabled;
  1290. #  Always - check every download (even undamaged). One par2-file is
  1291. #           always downloaded. Additional par2-files are downloaded
  1292. #           if needed for repair.  Repair is performed if the option
  1293. #           <ParRepair> is enabled;
  1294. #  Force  - force par-check for every download (even undamaged). All
  1295. #           par2-files are always downloaded. Repair is performed if
  1296. #           the option <ParRepair> is enabled;
  1297. #  Manual - par-check is skipped. One par2-file is always
  1298. #           downloaded. If a damaged download is detected, all
  1299. #           par2-files are downloaded but neither par-check nor par-repair
  1300. #           take place. The download can be then repaired manually,
  1301. #           eventually on another faster computer.
  1302. ParCheck=auto
  1303.  
  1304. # Automatic par-repair after par-verification (yes, no).
  1305. #
  1306. # If option <ParCheck> is set to "Auto" or "Force" this option defines
  1307. # if the download must be repaired when needed. The option can be
  1308. # disabled if a computer does not have enough CPU power, since repairing
  1309. # may consume too many resources and time on a slow computer.
  1310. ParRepair=yes
  1311.  
  1312. # What files should be scanned during par-verification (limited, extended,
  1313. # full, dupe).
  1314. #
  1315. #  Limited  - scan only files belonging to par-set;
  1316. #  Extended - scan files belonging to par-set first, scan other files until
  1317. #             all missing files are found;
  1318. #  Full     - scan all files in destination directory. Can be very time
  1319. #             consuming but may sometimes repair where Limited and Extended fail;
  1320. #  Dupe     - scan files belonging to par-set first, scan other files until
  1321. #             repair is possible. Even files from other duplicate-downloads
  1322. #             are scanned. Can be very time consuming but brings best results.
  1323. ParScan=extended
  1324.  
  1325. # Quick file verification during par-check (yes, no).
  1326. #
  1327. # If the option is active the files are quickly verified using
  1328. # checksums calculated during download; quick verification is very fast
  1329. # because it doesn't require the reading of files from disk, NZBGet
  1330. # knows checksums of downloaded files and quickly compares them with
  1331. # checksums stored in the par-file.
  1332. #
  1333. # If the option is disabled the files are verified as usual. That's
  1334. # slow. Use this if the quick verification doesn't work properly.
  1335. ParQuick=yes
  1336.  
  1337. # Memory limit for par-repair buffer (megabytes).
  1338. #
  1339. # Set the amount of RAM that the par-checker may use during repair. Having
  1340. # the buffer as big as the total size of all damaged blocks allows for
  1341. # the optimal repair speed. The option sets the maximum buffer size, the
  1342. # allocated buffer can be smaller.
  1343. #
  1344. # If you have a lot of RAM set the option to few hundreds (MB) for the
  1345. # best repair performance.
  1346. ParBuffer=16
  1347.  
  1348. # Number of threads to use during par-repair (0-99).
  1349. #
  1350. # On multi-core CPUs for the best speed set the option to the number of
  1351. # logical cores (physical cores + hyper-threading units). If you want
  1352. # to utilize the CPU to 100% you may need to add one or two additional threads
  1353. # to compensate for wait intervals used for thread synchronization.
  1354. #
  1355. # On single-core CPUs use only one thread.
  1356. #
  1357. # Set to '0' to automatically use all available CPU cores (may not
  1358. # work on old or exotic platforms).
  1359. ParThreads=0
  1360.  
  1361. # Files to ignore during par-check.
  1362. #
  1363. # List of file extensions, file names or file masks to ignore by
  1364. # par-rename and par-check. The entries must be separated with
  1365. # commas.
  1366. #
  1367. # The entries must be separated with commas. The entries can be file
  1368. # extensions, file names or file masks containing wildcard
  1369. # characters * and ?.
  1370. #
  1371. # If par-rename or par-check detect missing or damaged files they
  1372. # will ignore files matching this option and will not initiate
  1373. # repair. This avoids time costing repair for unimportant files.
  1374. #
  1375. # Example: .sfv, .nzb, .nfo
  1376. ParIgnoreExt=.sfv, .nzb, .nfo
  1377.  
  1378. # Check for renamed and missing files using par-files (yes, no).
  1379. #
  1380. # Par-rename restores original file names using information stored
  1381. # in par2-files. It also detects missing files (files listed in
  1382. # par2-files but not present on disk). When enabled the par-rename is
  1383. # performed as the first step of post-processing for every nzb-file.
  1384. #
  1385. # Par-rename is very fast and is highly recommended, especially if
  1386. # unpack is disabled.
  1387. ParRename=yes
  1388.  
  1389. # Check for renamed rar-files (yes, no).
  1390. #
  1391. # Rar-rename restores original file names using information stored
  1392. # in rar-files. When enabled the rar-rename is performed as one of the
  1393. # first steps of post-processing for every nzb-file.
  1394. #
  1395. # Rar-rename is useful for downloads not having par2-files or for
  1396. # downloads those files were renamed before creating par2-files. In
  1397. # both cases par-rename (option <ParRename>) can't rename files
  1398. # and the rar-rename makes it possible to unpack downloads which
  1399. # would fail otherwise.
  1400. RarRename=yes
  1401.  
  1402. # Directly rename files during downloading (yes, no).
  1403. #
  1404. # This is similar to par-renaming (option <ParRename>) but the files
  1405. # are renamed during downloading instead of post-processing stage. This
  1406. # requires some tricky handling of files and works only for healthy
  1407. # downloads.
  1408. DirectRename=no
  1409.  
  1410. # What to do if download health drops below critical health (delete, park,
  1411. # pause, none).
  1412. #
  1413. #  Delete - delete nzb-file from queue, also delete already downloaded files;
  1414. #  Park   - move nzb-file to history, keep already downloaded files. Commands
  1415. #           "Download remaining files" and "Retry failed articles" are available
  1416. #           for this nzb;
  1417. #  Pause  - pause nzb-file;
  1418. #  None   - do nothing (continue download).
  1419. #
  1420. # NOTE: For automatic duplicate handling option must be set to "Delete", "Park"
  1421. # or "None". If it is set to "Pause" you will need to manually move another
  1422. # duplicate from history to queue. See also option <DupeCheck>.
  1423. #
  1424. # NOTE: When option <ParScan> is set to "Dupe" the park-action is performed
  1425. # only if article completion is below 10% (empirical threshold). This is to
  1426. # improve efficiency of dupe par scan mode.
  1427. HealthCheck=park
  1428.  
  1429. # Maximum allowed time for par-repair (minutes).
  1430. #
  1431. # If you use NZBGet on a very slow computer like NAS-device, it may be good to
  1432. # limit the time allowed for par-repair. NZBGet calculates the estimated time
  1433. # required for par-repair. If the estimated value exceeds the limit defined
  1434. # here, NZBGet cancels the repair.
  1435. #
  1436. # To avoid a false cancellation NZBGet compares the estimated time with
  1437. # <ParTimeLimit> after the first 5 minutes of repairing, when the calculated
  1438. # estimated time is more or less accurate. But in a case if <ParTimeLimit> is
  1439. # set to a value smaller than 5 minutes, the comparison is made after the first
  1440. # whole minute.
  1441. #
  1442. # Value "0" means unlimited.
  1443. #
  1444. # NOTE: The option limits only the time required for repairing. It doesn't
  1445. # affect the first stage of parcheck - verification of files. However, the
  1446. # verification speed is constant, it doesn't depend on files integrity and
  1447. # therefore it is not necessary to limit the time needed for the first stage.
  1448. ParTimeLimit=0
  1449.  
  1450. # Pause download queue during check/repair (yes, no).
  1451. #
  1452. # Enable the option to give CPU more time for par-check/repair. That helps
  1453. # to speed up check/repair on slow CPUs with fast connection (e.g. NAS-devices).
  1454. #
  1455. # NOTE: If parchecker needs additional par-files it temporarily unpauses
  1456. # the queue.
  1457. #
  1458. # NOTE: See also options <ScriptPauseQueue> and <UnpackPauseQueue>.
  1459. ParPauseQueue=no
  1460.  
  1461.  
  1462. ##############################################################################
  1463. ### UNPACK                                                                 ###
  1464.  
  1465. # Unpack downloaded nzb-files (yes, no).
  1466. #
  1467. # Each download (nzb-file) has a post-processing parameter "Unpack". The option
  1468. # <Unpack> is the default value assigned to this pp-parameter of the download
  1469. # when it is added to queue.
  1470. #
  1471. # When nzb-file is added to queue it can have a category assigned to it. In this
  1472. # case the option <CategoryX.Unpack> overrides the global option <Unpack>.
  1473. #
  1474. # If the download is damaged and could not be repaired using par-files
  1475. # the unpacking is not performed.
  1476. #
  1477. # If the option <ParCheck> is set to "Auto" the program tries to unpack
  1478. # downloaded files first. If the unpacking fails the par-check/repair
  1479. # is performed and the unpack is executed again.
  1480. Unpack=yes
  1481.  
  1482. # Directly unpack files during downloading (yes, no).
  1483. #
  1484. # When active the files are unpacked during downloading instead of post-processing
  1485. # stage. This works only for healthy downloads. Damaged downloads are unpacked
  1486. # as usual during post-processing stage after par-repair.
  1487. #
  1488. # NOTE: This option requires unpack to be enabled in general via option <Unpack>.
  1489. # NOTE: For best results also activate option <DirectRename> and option <ReorderFiles>.
  1490. DirectUnpack=no
  1491.  
  1492. # Pause download queue during unpack (yes, no).
  1493. #
  1494. # Enable the option to give CPU more time for unpacking. That helps
  1495. # to speed up unpacking on slow CPUs.
  1496. #
  1497. # NOTE: See also options <ParPauseQueue> and <ScriptPauseQueue>.
  1498. UnpackPauseQueue=no
  1499.  
  1500. # Delete archive files after successful unpacking (yes, no).
  1501. UnpackCleanupDisk=yes
  1502.  
  1503. # Full path to unrar executable.
  1504. #
  1505. # Example: /usr/bin/unrar.
  1506. #
  1507. # The option can also contain extra switches to pass to unrar. To the
  1508. # here defined command line NZBGet adds the following switches:
  1509. #    x -y -p- -o+ *.rar ./_unpack/
  1510. #
  1511. # Switch "x" is added only if neither "x" nor "e" were defined in
  1512. # the option (this allows you to use switch "e" instead of "x"). switch
  1513. # "-o+" is added only if neither "-o+" nor "-o-" were defined
  1514. # in the command line. All other parameters are always added. Parameter
  1515. # "-p-" is replaced with "-ppassword" if a password is set for nzb-file.
  1516. #
  1517. # Examples:
  1518. # 1) ignore file attributes (permissions):
  1519. # /usr/bin/unrar x -ai;
  1520. # 2) decrease priority of unrar-process:
  1521. # nice -n 19 unrar.
  1522. #
  1523. # For other useful switches refer to unrar documentation.
  1524. #
  1525. # If unrar is in your PATH you may leave the path part and set only
  1526. # the executable name ("unrar" on POSIX or "unrar.exe" on Windows).
  1527. UnrarCmd=unrar
  1528.  
  1529. # Full path to 7-Zip executable.
  1530. #
  1531. # Example: /usr/bin/7z.
  1532. #
  1533. # Similar to option <UnrarCmd> this option can also include extra switches.
  1534. #
  1535. # If 7-Zip binary is in your PATH you may leave the path part and set only
  1536. # the executable name ("7z" or "7za" on POSIX or "7z.exe" on Windows).
  1537. SevenZipCmd=7z
  1538.  
  1539. # Files to delete after successful download.
  1540. #
  1541. # List of file extensions, file names or file masks to delete after
  1542. # successful download. If either unpack or par-check fail the cleanup is
  1543. # not performed. If download doesn't contain archives nor par-files
  1544. # the cleanup is performed if the health is 100%. If parameter "unpack"
  1545. # is disabled for that nzb-file the cleanup isn't performed.
  1546. #
  1547. # The entries must be separated with commas. The entries can be file
  1548. # extensions, file names or file masks containing wildcard
  1549. # characters * and ?.
  1550. #
  1551. # Example: .par2, .sfv
  1552. ExtCleanupDisk=.par2, .sfv
  1553.  
  1554. # Files to ignore during unpack.
  1555. #
  1556. # List of file extensions to ignore when unpacking archives or renaming
  1557. # obfuscated archive files. The entries must be separated with commas.
  1558. #
  1559. # Archive files with non standard extensions belong to one of two categories: they
  1560. # are either obfuscated files or files with special purposes which should not be
  1561. # unpacked. List the files of second type here to avoid attempts to unpack them.
  1562. #
  1563. # This option has effect on two post-processing stages.
  1564. #
  1565. # First, during rar-rename (option <RarRename>) rar-files with non-standard
  1566. # extensions are renamed back to rar-extension, which is required for successful
  1567. # unpacking. Files with extensions listed here will not be renamed.
  1568. #
  1569. # Second, if during unpack no rar-files are found but instead rar-archives
  1570. # with non-rar extensions are found the unpack fails. For files listed here
  1571. # no unpack failure occurs and download is considered not having archive
  1572. # files and be successful.
  1573. #
  1574. # Example: .cbr
  1575. UnpackIgnoreExt=.cbr
  1576.  
  1577. # Path to file containing unpack passwords.
  1578. #
  1579. # If the option is set the program will try all passwords from the file
  1580. # when unpacking the archives. The file must be a text file containing
  1581. # one password per line.
  1582. #
  1583. # If an nzb-file has a defined password (in the post-processing settings)
  1584. # then the password-file is not used for that nzb-file.
  1585. #
  1586. # NOTE: Trying multiple passwords is a time consuming task. Whenever possible
  1587. # passwords should be set per nzb-file in their post-processing settings.
  1588. UnpackPassFile=
  1589.  
  1590.  
  1591. ##############################################################################
  1592. ### EXTENSION SCRIPTS                                                      ###
  1593.  
  1594. # List of active extension scripts for new downloads.
  1595. #
  1596. # Extension scripts associated with nzb-files are executed before, during
  1597. # or after download as defined by script developer.
  1598. #
  1599. # Each download (nzb-file) has its own list of extension scripts; the list
  1600. # can be viewed and changed in web-interface in download details dialog or
  1601. # via API. Option <Extensions> sets defaults for new downloads; changes
  1602. # to option <Extensions> do not affect downloads which are already in queue.
  1603. #
  1604. # When nzb-file is added to queue it can have a category assigned to it. In this
  1605. # case option <CategoryX.Extensions> (if not empty) have precedence and
  1606. # defines the scripts for that nzb-file; consequently global option <Extensions>
  1607. # has no effect for that nzb-file.
  1608. #
  1609. # Certain extensions work globally for the whole program instead of
  1610. # per-nzb basis. Such extensions are activated once and cannot be overriden
  1611. # per category or per nzb.
  1612. #
  1613. # The scripts in the list must be separated with commas or semicolons. All
  1614. # scripts must be stored in directory set by option <ScriptDir> and
  1615. # paths relative to <ScriptDir> must be entered here.
  1616. #
  1617. # Example: Cleanup.sh, Move.sh, EMail.py.
  1618. #
  1619. # NOTE: The script execution order is controlled by option <ScriptOrder>, not
  1620. # by their order in option <Extensions>.
  1621. #
  1622. # NOTE: For the list of interesting extension scripts see
  1623. # http://nzbget.net/catalog-of-extension-scripts.
  1624. #
  1625. # NOTE: For developer documentation visit http://nzbget.net/extension-scripts.
  1626. Extensions=
  1627.  
  1628. # Execution order for extension scripts.
  1629. #
  1630. # If you assign multiple scripts to one nzb-file, they are executed in the
  1631. # order defined by this option.
  1632. #
  1633. # The scripts in the list must be separated with commas or semicolons. All
  1634. # scripts must be stored in directory set by option <ScriptDir> and
  1635. # paths relative to <ScriptDir> must be entered here.
  1636. #
  1637. # Example: Cleanup.sh, Move.sh.
  1638. ScriptOrder=
  1639.  
  1640. # Pause download queue during executing of postprocess-script (yes, no).
  1641. #
  1642. # Enable the option to give CPU more time for postprocess-script. That helps
  1643. # to speed up postprocess on slow CPUs with fast connection (e.g. NAS-devices).
  1644. #
  1645. # NOTE: See also options <ParPauseQueue> and <UnpackPauseQueue>.
  1646. ScriptPauseQueue=no
  1647.  
  1648. # Shell overrides for script interpreters.
  1649. #
  1650. # By default extension scripts are executed as normal programs. The system finds
  1651. # an associated interpreter automatically. If for some reason that doesn't work
  1652. # properly you can provide shell overrides here.
  1653. #
  1654. # This option contains a comma separated list of shell overrides per
  1655. # file extension. A shell override consists of file extension (starting with
  1656. # dot) followed by equal sign and the full path to script interpreter.
  1657. #
  1658. # Example: .py=/usr/bin/python2;.py3=/usr/bin/python3;.sh=/usr/bin/bash.
  1659. ShellOverride=
  1660.  
  1661. # Minimum interval between queue events (seconds).
  1662. #
  1663. # Extension scripts can opt-in for progress notifcations during
  1664. # download. For downloads containing many small files the events can
  1665. # be fired way too often increasing load on the system due to script
  1666. # execution.
  1667. #
  1668. # This option allows to reduce the number of calls of scripts by
  1669. # skipping "file-downloaded"-events if the previous call for the same
  1670. # download (nzb-file) were performed a short time ago (as defined by
  1671. # the option).
  1672. #
  1673. # Value "-1" disables "file-downloaded"-events. Scripts are still
  1674. # notified on other events (such as "nzb-added" or "nzb-downloaded").
  1675. EventInterval=0
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
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
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!