Advertisement
Guest User

nzbget config

a guest
Mar 17th, 2017
493
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 85.63 KB | None | 0 0
  1. # Sample configuration file for NZBGet
  2. #
  3. # On POSIX put this file to one of the following locations:
  4. # ~/.nzbget
  5. # /etc/nzbget.conf
  6. # /usr/etc/nzbget.conf
  7. # /usr/local/etc/nzbget.conf
  8. # /opt/etc/nzbget.conf
  9. #
  10. # On Windows put this file in program's directory.
  11. #
  12. # You can also put the file into any location, if you specify the path to it
  13. # using switch "-c", e.g:
  14. # nzbget -c /home/user/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=/volume1/Downloads/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 <ScanScript>).
  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/nzbget/share/nzbget/webui
  80.  
  81. # Directory with post-processing and other scripts.
  82. #
  83. # NOTE: For information on writing scripts visit http://nzbget.net/Extension_scripts.
  84. ScriptDir=/usr/local/nzbget/share/nzbget/scripts
  85.  
  86. # Lock-file for daemon-mode, POSIX only.
  87. #
  88. # When started in daemon mode the program creates the lock file and
  89. # writes process-id (PID) into it. That info can be used in shell
  90. # scripts. If the lock file can not be created or the lock to the file
  91. # can not be acquired the daemon terminates, preventing unintentional
  92. # starting of multiple daemons.
  93. #
  94. # Set to empty value to disable the creating of the lock-file and the
  95. # check for another running instance (not recommended).
  96. LockFile=/usr/local/nzbget/var/nzbget.pid
  97.  
  98. # Where to store log file, if it needs to be created.
  99. #
  100. # NOTE: See also option <WriteLog>.
  101. LogFile=/usr/local/nzbget/var/nzbget.log
  102.  
  103. # Configuration file template.
  104. #
  105. # Put the path to the example configuration file which comes with
  106. # NZBGet. Web-interface needs this file to read option descriptions.
  107. #
  108. # Do not put here your actual configuration file (typically stored
  109. # in your home directory or in /etc/nzbget.conf) but instead the unchanged
  110. # example configuration file (typically installed to
  111. # /usr/local/share/nzbget/nzbget.conf).
  112. #
  113. # Example: /usr/local/share/nzbget/nzbget.conf.
  114. ConfigTemplate=/usr/local/nzbget/share/nzbget/nzbget.conf
  115.  
  116. # Required directories.
  117. #
  118. # List of destination directories to be waited for on program start. Directories
  119. # must be separated with commas or semicolons.
  120. #
  121. # The list of directories is checked on program start. The program waits
  122. # until all directories become available before starting download or
  123. # post-processing. This is useful if the download destination is configured
  124. # on network or external drives, which may require some time to mount on boot.
  125. #
  126. # NOTE: Only directories used in option <InterDir> and option <DestDir>
  127. # (global or per-category) can be waited. Other directories, such as
  128. # option <TempDir>, option <NzbDir> and option <QueueDir> must be
  129. # available on program start.
  130. RequiredDir=
  131.  
  132. ##############################################################################
  133. ### NEWS-SERVERS ###
  134.  
  135. # This section defines which servers NZBGet should connect to.
  136. #
  137. # The servers should be numbered subsequently without holes.
  138. # For example if you configure three servers you should name them as Server1,
  139. # Server2 and Server3. If you need to delete Server2 later you should also
  140. # change the name of Server3 to Server2. Otherwise it will not be properly
  141. # read from the config file. Server number doesn't affect its priority (level).
  142.  
  143. # Use this news server (yes, no).
  144. #
  145. # Set to "no" to disable the server on program start. Servers can be activated
  146. # later via scheduler tasks or manually via web-interface.
  147. #
  148. # NOTE: Download is not possible when all servers on level 0 are disabled. Servers
  149. # on higher levels are used only if at least one server on level 0 was tried.
  150. Server1.Active=yes
  151.  
  152. # Name of news server.
  153. #
  154. # The name is used in UI and for logging. It can be any string, you
  155. # may even leave it empty.
  156. Server1.Name=Eweka
  157.  
  158. # Level (priority) of news server (0-99).
  159. #
  160. # The servers are ordered by their level. NZBGet first tries to download
  161. # an article from one (any) of level-0-servers. If that server fails,
  162. # NZBGet tries all other level-0-servers. If all servers fail, it proceeds
  163. # with the level-1-servers, etc.
  164. #
  165. # Put your major download servers at level 0 and your fill servers at
  166. # levels 1, 2, etc..
  167. #
  168. # Several servers with the same level may be defined, they have
  169. # the same priority.
  170. Server1.Level=0
  171.  
  172. # Group of news server (0-99).
  173. #
  174. # If you have multiple accounts with same conditions (retention, etc.)
  175. # on the same news server, set the same group (greater than 0) for all
  176. # of them. If download fails on one news server, NZBGet does not try
  177. # other servers from the same group.
  178. #
  179. # Value "0" means no group defined (default).
  180. Server1.Group=0
  181.  
  182. # Host name of news server.
  183. Server1.Host=news.eweka.nl
  184.  
  185. # Port to connect to (1-65535).
  186. Server1.Port=119
  187.  
  188. # User name to use for authentication.
  189. Server1.Username=<blocked>
  190.  
  191. # Password to use for authentication.
  192. Server1.Password=<blocked>
  193.  
  194. # Server requires "Join Group"-command (yes, no).
  195. Server1.JoinGroup=no
  196.  
  197. # Encrypted server connection (TLS/SSL) (yes, no).
  198. #
  199. # NOTE: By changing this option you should also change the option <ServerX.Port>
  200. # accordingly because unsecure and encrypted connections use different ports.
  201. Server1.Encryption=no
  202.  
  203. # Cipher to use for encrypted server connection.
  204. #
  205. # By default (when the option is empty) the underlying encryption library
  206. # chooses the cipher automatically. To achieve the best performance
  207. # however you can manually select a faster cipher.
  208. #
  209. # See http://nzbget.net/Choosing_a_cipher for details.
  210. #
  211. # NOTE: One of the fastest cipher is RC4. To select it use the cipher string
  212. # "RC4-MD5" (if NZBGet was configured to use OpenSSL) or
  213. # "NONE:+VERS-TLS-ALL:+ARCFOUR-128:+RSA:+MD5:+COMP-ALL"
  214. # (if NZBGet was configured to use GnuTLS). Note that RC4 is considered insecure
  215. # by the IETF (http://tools.ietf.org/html/rfc7465), but may be sufficient for
  216. # the usage of NZBGet.
  217. #
  218. # NOTE: You may get a TLS handshake error if the news server does
  219. # not support the chosen cipher. You can also get an error "Could not
  220. # select cipher for TLS" if the cipher string is not valid.
  221. Server1.Cipher=
  222.  
  223. # Maximum number of simultaneous connections to this server (0-999).
  224. Server1.Connections=7
  225.  
  226. # Server retention time (days).
  227. #
  228. # How long the articles are stored on the news server. The articles
  229. # whose age exceed the defined server retention time are not tried on
  230. # this news server, the articles are instead considered failed on this
  231. # news server.
  232. #
  233. # Value "0" disables retention check.
  234. Server1.Retention=0
  235.  
  236. # Second server, on level 0.
  237.  
  238. #Server2.Level=0
  239. #Server2.Host=my2.newsserver.com
  240. #Server2.Port=119
  241. #Server2.Username=me
  242. #Server2.Password=mypass
  243. #Server2.JoinGroup=yes
  244. #Server2.Connections=4
  245.  
  246. # Third server, on level 1.
  247.  
  248. #Server3.Level=1
  249. #Server3.Host=fills.newsserver.com
  250. #Server3.Port=119
  251. #Server3.Username=me2
  252. #Server3.Password=mypass2
  253. #Server3.JoinGroup=yes
  254. #Server3.Connections=1
  255.  
  256.  
  257. ##############################################################################
  258. ### SECURITY ###
  259.  
  260. # IP on which NZBGet server listen and which clients use to contact NZBGet.
  261. #
  262. # It could be a dns-hostname (e. g. "mypc") or an ip-address (e. g. "192.168.1.2" or
  263. # "127.0.0.1"). An IP-address is more effective because does not require dns-lookup.
  264. #
  265. # Your computer may have multiple network interfaces and therefore multiple IP
  266. # addresses. If you want NZBGet to listen to all interfaces and be available from
  267. # all IP-addresses use value "0.0.0.0".
  268. #
  269. # NOTE: When you start NZBGet as client (to send remote commands to NZBGet server) and
  270. # the option <ControlIP> is set to "0.0.0.0" the client will use IP "127.0.0.1".
  271. #
  272. # NOTE: If you set the option to "127.0.0.1" you will be able to connect to NZBGet
  273. # only from the computer running NZBGet. This restriction applies to web-interface too.
  274. ControlIP=0.0.0.0
  275.  
  276. # Port which NZBGet server and remote client use (1-65535).
  277. #
  278. # NOTE: The communication via this port is not encrypted. For encrypted
  279. # communication see option <SecurePort>.
  280. ControlPort=6789
  281.  
  282. # User name which NZBGet server and remote client use.
  283. #
  284. # Set to empty value to disable user name check (check only password).
  285. #
  286. # NOTE: This option was added in NZBGet 11. Older versions used predefined
  287. # not changeable user name "nzbget". Third-party tools or web-sites written
  288. # for older NZBGet versions may not have an option to define user name. In
  289. # this case you should set option <ControlUsername> to the default value
  290. # "nzbget" or use empty value.
  291. ControlUsername=<blocked>
  292.  
  293. # Password which NZBGet server and remote client use.
  294. #
  295. # Set to empty value to disable authorization request.
  296. ControlPassword=<blocked>
  297. # User name for restricted access.
  298. #
  299. # Restricted user can control the program with few restrictions. He
  300. # has access to web-interface and can see most program settings. He
  301. # can not change program settings and can not view security related
  302. # options or options provided by extension scripts.
  303. #
  304. # Use this user to connect to NZBGet from other programs and web-sites.
  305. #
  306. # In terms of RPC-API the user:
  307. # - cannot use method "saveconfig";
  308. # - methods "config" and "saveconfig" return string "***" for
  309. # options those content is protected from the user.
  310. #
  311. # Set to empty value to disable restricted user.
  312. #
  313. # NOTE: Don't forget to change default username/password of the control
  314. # user (options <ControlUsername> and <ControlPassword>).
  315. RestrictedUsername=<blocked>
  316.  
  317. # Password for restricted access.
  318. #
  319. # Set to empty value to disable password check.
  320. RestrictedPassword=<blocked>
  321.  
  322. # User name to add downloads via RPC-API.
  323. #
  324. # Use the AddUsername/AddPassword to give other programs or web-services
  325. # access to NZBGet with only two permissions:
  326. # - add new downloads using RPC-method "append";
  327. # - check program version using RPC-method "version".
  328. #
  329. # In a case the program/web-service needs more rights use the restricted
  330. # user instead (options <RestrictedUsername> and <RestrictedPassword>).
  331. #
  332. # Set to empty value to disable add-user.
  333. #
  334. # NOTE: Don't forget to change default username/password of the control
  335. # user (options <ControlUsername> and <ControlPassword>).
  336. AddUsername=
  337.  
  338. # Password for user with add downloads access.
  339. #
  340. # Set to empty value to disable password check.
  341. AddPassword=
  342.  
  343. # Secure control of NZBGet server (yes, no).
  344. #
  345. # Activate the option if you want to access NZBGet built-in web-server
  346. # via HTTPS (web-interface and RPC). You should also provide certificate
  347. # and key files, see option <SecureCert> and option <SecureKey>.
  348. SecureControl=no
  349.  
  350. # Port which NZBGet server and remote client use for encrypted
  351. # communication (1-65535).
  352. SecurePort=6791
  353.  
  354. # Full path to certificate file for encrypted communication.
  355. SecureCert=
  356.  
  357. # Full path to key file for encrypted communication.
  358. SecureKey=
  359.  
  360. # IP-addresses allowed to connect without authorization.
  361. #
  362. # Comma separated list of privileged IPs for easy access to NZBGet
  363. # built-in web-server (web-interface and RPC). The connected clients
  364. # have full unrestricted access.
  365. #
  366. # Example: 127.0.0.1,192.168.178.2.
  367. #
  368. # NOTE: Do not use this option if the program works behind another
  369. # web-server because all requests will have the address of this server.
  370. AuthorizedIP=
  371.  
  372. # User name for daemon-mode, POSIX only.
  373. #
  374. # Set the user that the daemon normally runs at (POSIX in daemon-mode only).
  375. # Set MainDir with an absolute path to be sure where it will write.
  376. # This allows NZBGet daemon to be launched in rc.local (at boot), and
  377. # download items as a specific user id.
  378. #
  379. # NOTE: This option has effect only if the program was started from
  380. # root-account, otherwise it is ignored and the daemon runs under
  381. # current user id.
  382. DaemonUsername=<blocked>
  383.  
  384. # Specify default umask (affects file permissions) for newly created
  385. # files, POSIX only (000-1000).
  386. #
  387. # The value should be written in octal form (the same as for "umask" shell
  388. # command).
  389. # Empty value or value "1000" disable the setting of umask-mode; current
  390. # umask-mode (set via shell) is used in this case.
  391. UMask=0000
  392.  
  393.  
  394. ##############################################################################
  395. ### CATEGORIES ###
  396.  
  397. # This section defines categories available in web-interface.
  398.  
  399. # Category name.
  400. #
  401. # Each nzb-file can be assigned to a category.
  402. # Category name is passed to post-processing script and can be used by it
  403. # to perform category specific processing.
  404. Category1.Name=Movies
  405.  
  406. # Destination directory for this category.
  407. #
  408. # If this option is empty, then the default destination directory
  409. # (option <DestDir>) is used. In this case if the option <AppendCategoryDir>
  410. # is active, the program creates a subdirectory with category name within
  411. # destination directory.
  412. Category1.DestDir=
  413.  
  414. # Unpack downloaded nzb-files (yes, no).
  415. #
  416. # For more information see global option <Unpack>.
  417. Category1.Unpack=yes
  418.  
  419. # Default list of post-processing scripts.
  420. #
  421. # For more information see global option <PostScript>.
  422. Category1.PostScript=CharTransProcess.py, GetScripts/DeleteSamples.py, GetScripts/SafeRename.py, GetScripts/flatten.py, Logger.py
  423.  
  424. # List of aliases.
  425. #
  426. # When a nzb-file is added from URL, RSS or RPC the category name
  427. # is usually supplied by nzb-site or by application accessing
  428. # NZBGet. Using Aliases you can match their categories with your owns.
  429. #
  430. # Separate aliases with commas or semicolons. Use wildcard-characters
  431. # * and ? for pattern matching.
  432. #
  433. # Example: TV - HD, TV - SD, TV*
  434. Category1.Aliases=Tekenfilms, tekenfilms, Tekenfilm, tekenfilm, Anime, anime, Animation, Animations
  435.  
  436. Category2.Name=Series
  437. Category3.Name=Music
  438. Category4.Name=Software
  439.  
  440.  
  441. ##############################################################################
  442. ### RSS FEEDS ###
  443.  
  444. # Name of RSS Feed.
  445. #
  446. # The name is used in UI and for logging. It can be any string.
  447. #Feed1.Name=my feed
  448.  
  449. # Address (URL) of RSS Feed.
  450. #
  451. # Example: https://myindexer.com/api?apikey=3544646bfd1c535a9654645609800901&t=search&q=game.
  452. #Feed1.URL=
  453.  
  454. # Filter rules for items.
  455. #
  456. # Use filter to ignore unwanted items in the feed. In its simplest version
  457. # the filter is a space separated list of words which must be present in
  458. # the item title.
  459. #
  460. # Example: linux debian dvd.
  461. #
  462. # MORE INFO:
  463. # NOTE: This is a short documentation, for more information visit
  464. # http://nzbget.net/RSS.
  465. #
  466. # Feed filter consists of rules - one rule per line. Each rule defines
  467. # a search string and a command, which must be performed if the search
  468. # string matches. There are five kinds of rule-commands: Accept,
  469. # Reject, Require, Options, Comment.
  470. #
  471. # NOTE: Since options in the configuration file can not span multiple
  472. # lines, the lines (rules) must be separated with %-character (percent).
  473. #
  474. # Definition of a rule:
  475. # [A:|A(options):|R:|Q:|O(options):|#] search-string
  476. #
  477. # A - declares Accept-rule. Rules are accept-rules by default, the
  478. # "A:" can be imitted. If the feed item matches to the rule the
  479. # item is considered good and no further rules are checked.
  480. # R - declares Reject-rule. If the feed item matches to the rule the
  481. # item is considered bad and no further rules are checked.
  482. # Q - declares Require-rule. If the feed item DOES NOT match to the rule
  483. # the item is considered bad and no further rules are checked.
  484. # O - declares Options-rule. If the feed item matches to the rule the
  485. # options declared in the rule are set for the item. The item is
  486. # neither accepted nor rejected via this rule but can be accepted
  487. # later by one of Accept-rules. In this case the item will have its
  488. # options already set (unless the Accept-rule overrides them).
  489. # # - lines starting with # are considered comments and are ignored. You
  490. # can use comments to explain complex rules or to temporary disable
  491. # rules for debugging.
  492. #
  493. # Options allow to set properties on nzb-file. It's a comma-separated
  494. # list of property names with their values.
  495. #
  496. # Definition of an option:
  497. # name:value
  498. #
  499. # Options can be defined using long option names or short names:
  500. # category (cat, c) - set category name, value is a string;
  501. # pause (p) - add nzb in paused or unpaused state, possible
  502. # values are: yes (y), no (n);
  503. # priority (pr, r) - set priority, value is a signed integer number;
  504. # priority+ (pr+, r+) - increase priority, value is a signed integer number;
  505. # dupescore (ds, s) - set duplicate score, value is a signed integer number;
  506. # dupescore+ (ds+, s+) - increase duplicate score, value is a signed integer number;
  507. # dupekey (dk, k) - set duplicate key, value is a string;
  508. # dupekey+ (dk+, k+) - add to duplicate key, value is a string;
  509. # dupemode (dm, m) - set duplicate check mode, possible values
  510. # are: score (s), all (a), force (f);
  511. # rageid - generate duplicate key using this rageid
  512. # (integer number) and season/episode numbers;
  513. # series - generate duplicate key using series identifier
  514. # (any unique string) and season/episode numbers.
  515. #
  516. # Examples of option definitions:
  517. # Accept(category:my series, pause:yes, priority:100): my show 1080p;
  518. # Options(c:my series, p:y, r:100): 1080p;
  519. # Options(s:1000): 1080p;
  520. # Options(k+:1080p): 1080p;
  521. # Options(dupemode:force): BluRay.
  522. #
  523. # Rule-options override values set in feed-options.
  524. #
  525. # The search-string is similar to used in search engines. It consists of
  526. # search terms separated with spaces. Every term is checked for a feed
  527. # item and if they all succeed the rule is considered matching.
  528. #
  529. # Definition of a term:
  530. # [+|-][field:][command]param
  531. #
  532. # + - declares a positive term. Terms are positive by default,
  533. # the "+" can be omitted;
  534. # - - declares a negative term. If the term succeed the feed
  535. # item is ignored;
  536. # field - field to which apply the term. If not specified
  537. # the default field "title" is used;
  538. # command - a special character defining how to interpret the
  539. # parameter (followed after the command):
  540. # @ - search for string "param". This is default command,
  541. # the "@" can be omitted;
  542. # $ - "param" defines a regular expression (using POSIX Extended
  543. # Regular Expressions syntax);
  544. # = - equal;
  545. # < - less than;
  546. # <= - equal or less than;
  547. # > - greater than;
  548. # >= - equal or greater than;
  549. # param - parameter for command.
  550. #
  551. # Commands @ and $ are for use with text fields (title, filename, category,
  552. # link, description, dupekey). Commands =, <, <=, > and >= are for use
  553. # with numeric fields (size, age, imdbid, rageid, season, episode, priority,
  554. # dupescore).
  555. #
  556. # Only fields title, filename and age are always present. The availability of
  557. # other fields depend on rss feed provider.
  558. #
  559. # Any newznab attribute (encoded as "newznab:attr" in the RSS feed) can
  560. # be used as search field with prefix "attr-", for example "attr-genre".
  561. #
  562. # Text search (Command @) supports supports wildcard characters * (matches
  563. # any number of any characters), ? (matches any one character)
  564. # and # (matches one digit).
  565. # Text search is by default performed against words (word-search mode): the
  566. # field content is separated into words and then each word is checked
  567. # against pattern. If the search pattern starts and ends with * (star)
  568. # the search is performed against the whole field content
  569. # (substring-search mode). If the search pattern contains word separator
  570. # characters (except * and ?) the search is performed on the whole
  571. # field (the word-search would be obviously never successful in this
  572. # case). Word separators are: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~.
  573. #
  574. # Field "size" can have suffixes "K" or "KB" for kilobytes, "M" or "MB"
  575. # for megabytes and "G" or "GB" for gigabytes. Field "age" can have
  576. # suffixes "m" for minutes, "h" for hours and "d" for days. If suffix
  577. # is not specified default is days.
  578. #
  579. # Examples (the trailing ; or . is not part of filter):
  580. # 1) A: s01* -category:anime;
  581. # 2) my show WEB-DL;
  582. # 3) *my?show* WEB-DL size:<1.8GB age:>2h;
  583. # 4) R: size:>9GB;
  584. # 5) Q: HDTV.
  585. #
  586. # NOTE: This is a short documentation, for more information visit
  587. # http://nzbget.net/RSS.
  588. #Feed1.Filter=
  589.  
  590. # Treat all items on first fetch as backlog (yes, no).
  591. #
  592. # yes - when the feed is fetched for the very first time (or after
  593. # changing of URL or filter) all existing items are ignored (marked
  594. # as backlog). The items found on subsequentional fetches are processed;
  595. # no - all items are processed even on first fetch (or after
  596. # changing of URL or filter).
  597. #Feed1.Backlog=yes
  598.  
  599. # How often to check for new items (minutes).
  600. #
  601. # Value "0" disables the automatic check of this feed.
  602. #Feed1.Interval=15
  603.  
  604. # Add nzb-files as paused (yes, no).
  605. #Feed1.PauseNzb=no
  606.  
  607. # Category for added nzb-files.
  608. #
  609. # NOTE: Feed providers may include category name within response when nzb-file
  610. # is downloaded. If you want to use the providers category leave the option empty.
  611. #Feed1.Category=
  612.  
  613. # Priority for added nzb-files (number).
  614. #
  615. # Priority can be any integer value. The web-interface however operates
  616. # with only six predefined priorities: -100 (very low priority), -50
  617. # (low priority), 0 (normal priority, default), 50 (high priority),
  618. # 100 (very high priority) and 900 (force priority). Downloads with
  619. # priorities equal to or greater than 900 are downloaded and
  620. # post-processed even if the program is in paused state (force mode).
  621. #Feed1.Priority=0
  622.  
  623. # List of rss feed scripts to execute before rss feed content is processed.
  624. #
  625. # For more information see global option <FeedScript>.
  626. #Feed1.FeedScript=
  627.  
  628. ##############################################################################
  629. ### INCOMING NZBS ###
  630.  
  631. # Create subdirectory with category-name in destination-directory (yes, no).
  632. AppendCategoryDir=yes
  633.  
  634. # How often incoming-directory (option <NzbDir>) must be checked for new
  635. # nzb-files (seconds).
  636. #
  637. # Value "0" disables the check.
  638. #
  639. # NOTE: nzb-files are processed by scan and queue scripts. See
  640. # options <ScanScript> and <QueueScript>.
  641. NzbDirInterval=5
  642.  
  643. # How old nzb-file should at least be for it to be loaded to queue (seconds).
  644. #
  645. # NZBGet checks if nzb-file was not modified in last few seconds, defined by
  646. # this option. That safety interval prevents the loading of files, which
  647. # were not yet completely saved to disk, for example if they are still being
  648. # downloaded in web-browser.
  649. NzbDirFileAge=60
  650.  
  651. # Check for duplicate titles (yes, no).
  652. #
  653. # If this option is enabled the program checks by adding of a new nzb-file:
  654. # 1) if history contains the same title (see below) with success status
  655. # the nzb-file is not added to queue;
  656. # 2) if download queue already contains the same title the nzb-file is
  657. # added to queue for backup (if firt file fails);
  658. # 3) if nzb-file contains duplicate entries. This helps to find errors
  659. # in bad nzb-files.
  660. #
  661. # "Same title" means the nzb file name is same or the duplicate key is
  662. # same. Duplicate keys are set by fetching from RSS feeds using title
  663. # identifier fields provided by RSS provider (imdbid or rageid/season/episode).
  664. #
  665. # If duplicates were detected only one of them is downloaded. If download
  666. # fails another duplicate is tried. If download succeeds all remaining
  667. # duplicates are deleted from queue.
  668. #
  669. # NOTE: For automatic duplicate handling option <HealthCheck> must be
  670. # set to "Delete" or "None". If it is set to "Pause" you will need to
  671. # manually unpause another duplicate (if any exists in queue).
  672. #
  673. # NOTE: For more info on duplicates see http://nzbget.net/RSS.
  674. DupeCheck=yes
  675.  
  676.  
  677. ##############################################################################
  678. ### DOWNLOAD QUEUE ###
  679.  
  680. # Save download queue to disk (yes, no).
  681. #
  682. # This allows to reload it on next start.
  683. SaveQueue=yes
  684.  
  685. # Flush download queue to disk (yes, no).
  686. #
  687. # Immediately flush file buffers for queue state file. This improves
  688. # safety for the queue file but may decrease disk performance due to
  689. # disabling of disk caching for queue state file.
  690. #
  691. # You can disable this option if it negatively affects disk performance on your
  692. # system. You should create backups of queue-directory (option <QueueDir>)
  693. # in that case. Keep the option enabled if your system often crashes.
  694. FlushQueue=yes
  695.  
  696. # Reload download queue on start, if it exists (yes, no).
  697. ReloadQueue=yes
  698.  
  699. # Continue download of partially downloaded files (yes, no).
  700. #
  701. # If active the current state (the info about what articles were already
  702. # downloaded) is saved every second and is reloaded after restart. This is
  703. # about files included in download jobs (usually rar-files), not about
  704. # download-jobs (nzb-files) itself. Download-jobs are always
  705. # continued regardless of that option.
  706. #
  707. # Disabling this option may slighlty reduce disk access and is
  708. # therefore recommended on fast connections.
  709. ContinuePartial=yes
  710.  
  711. # Propagation delay to your news servers (minutes).
  712. #
  713. # The option sets minimum post age for nzb-files. Very recent files
  714. # are not downloaded to avoid download failures. The files remain
  715. # on hold in the download queue until the propagation delay expires,
  716. # after that they are downloaded.
  717. PropagationDelay=0
  718.  
  719. # Decode articles (yes, no).
  720. #
  721. # yes - decode articles using internal decoder (supports yEnc and UU formats);
  722. # no - articles will not be decoded/joined. Useful to look at article's source text.
  723. #
  724. # NOTE: This option is primary for debugging purposes. You should not
  725. # disable it.
  726. Decode=yes
  727.  
  728. # Memory limit for article cache (megabytes).
  729. #
  730. # Article cache helps to improve performance. First the amount of disk
  731. # operations can be significantly reduced. Second the created files are
  732. # less fragmented, which again speeds up the post-processing (unpacking).
  733. #
  734. # The article cache works best with option <DirectWrite> which can
  735. # effectively use even small cache (like 50 MB).
  736. #
  737. # If option <DirectWrite> is disabled the cache should be big enough to
  738. # hold all articles of one file (typically up to 200 MB, sometimes even
  739. # 500 MB). Otherwise the articles are written into temporary directory
  740. # when the cache is full, which degrades performance.
  741. #
  742. # Value "0" disables article cache.
  743. #
  744. # In 32 bit mode the maximum allowed value is 1900.
  745. #
  746. # NOTE: Also see option <WriteBuffer>.
  747. ArticleCache=0
  748.  
  749. # Write decoded articles directly into destination output file (yes, no).
  750. #
  751. # Files are posted to Usenet in multiple pieces (articles). Each file
  752. # typically consists of hundreds of articles.
  753. #
  754. # When option <DirectWrite> is disabled and the article cache (option
  755. # <ArticleCache>) is not active or is full the program saves downloaded
  756. # articles into temporary directory and later reads them all to write
  757. # again into the destination file.
  758. #
  759. # When option <DirectWrite> is enabled the program at first creates the
  760. # output destination file with required size (total size of all articles),
  761. # then writes the articles directly to this file without creating of any
  762. # temporary files. If article cache (option <ArticleCache>) is active
  763. # the downloaded articles are saved into cache first and are written
  764. # into the destination file when the cache flushes. This happen when
  765. # all articles of the file are downloaded or when the cache becomes
  766. # full to 90%.
  767. #
  768. # The direct write relies on the ability of file system to create
  769. # empty files without allocating the space on the drive (sparse files),
  770. # which most modern file systems support including EXT3, EXT4
  771. # and NTFS. The notable exception is HFS+ (default file system on OSX).
  772. #
  773. # The direct write usually improves performance by reducing the amount
  774. # of disk operations but may produce more fragmented files when used
  775. # without article cache.
  776. DirectWrite=yes
  777.  
  778. # Memory limit for per article write buffer (kilobytes).
  779. #
  780. # When downloaded articles are written into disk the OS collects
  781. # data in the internal buffer before flushing it into disk. This option
  782. # controls the size of this buffer per connection/download thread.
  783. #
  784. # Larger buffers decrease the amount of disk operations and help
  785. # producing less fragmented files speeding up the post-processing
  786. # (unpack).
  787. #
  788. # To calculate the maximum memory required for all download threads multiply
  789. # WriteBuffer by number of connections configured in section
  790. # "NEWS-SERVERS". The option sets the limit, the actual buffer can be
  791. # smaller if the article size (typically about 500 KB) is below the limit.
  792. #
  793. # Write-buffer is managed by OS (system libraries) and therefore
  794. # the effect of the option is highly OS-dependent.
  795. #
  796. # Recommended value for computers with enough memory: 1024.
  797. #
  798. # Value "0" disables the setting of buffer size. In this case a buffer
  799. # of default size (OS and compiler specific) is used, which is usually
  800. # too small (1-4 KB) and therefore not optimal.
  801. #
  802. # NOTE: Also see option <ArticleCache>.
  803. WriteBuffer=0
  804.  
  805. # Check CRC of downloaded and decoded articles (yes, no).
  806. #
  807. # Normally this option should be enabled for better detecting of download
  808. # errors. However checking of CRC needs CPU time. On a fast connection and
  809. # slow CPU disabling of CRC-Check may improve performance.
  810. CrcCheck=yes
  811.  
  812. # How many retries should be attempted if a download error occurs (0-99).
  813. #
  814. # If download fails because of incomplete or damaged article or due to
  815. # CRC-error the program tries to redownload the article from the same
  816. # news server as many times as defined in option <Retries>. If all
  817. # attempts fail the program tries another news server.
  818. #
  819. # If download fails because of "article or group not found error" the
  820. # program tries another news server without retrying on the failed server.
  821. #
  822. # If download fails because of interrupted connection the program
  823. # tries another news server or the same server after the block interval
  824. # expires.
  825. Retries=3
  826.  
  827. # Wait interval between retries (seconds).
  828. #
  829. # If download of an article fails because of interrupted connection
  830. # the server is temporary blocked until the retry interval expires.
  831. RetryInterval=10
  832.  
  833. # Connection timeout for article downloading (seconds).
  834. ArticleTimeout=60
  835.  
  836. # Connection timeout for URL fetching (seconds).
  837. #
  838. # This includes fetching of nzb-files via URLs and fetching of RSS feeds.
  839. UrlTimeout=60
  840.  
  841. # Timeout until a download-thread should be killed (seconds).
  842. #
  843. # This can help on hanging downloads, but is dangerous.
  844. # Do not use small values!
  845. TerminateTimeout=600
  846.  
  847. # Set the maximum download rate on program start (kilobytes/sec).
  848. #
  849. # The download rate can be changed later via remote calls.
  850. #
  851. # Value "0" means no speed control.
  852. DownloadRate=0
  853.  
  854. # Accurate speed rate calculation (yes, no).
  855. #
  856. # During downloading using several connections the download threads may
  857. # interfere with each other when updating statistical data for speed
  858. # meter. This may cause small errors in current download speed reported
  859. # by the program. The speed meter recovers automatically from such errors
  860. # after max. 30 seconds (time window used for speed calculation).
  861. #
  862. # Enable the option to use thread synchronisation mechanisms in order to
  863. # provide absolutely accurate speed calculations.
  864. #
  865. # NOTE: Thread synchronisation increases CPU load and therefore can
  866. # decrease download speed. Do not activate this option on computers with
  867. # limited CPU power. Before activating the option it is recommended to
  868. # run tests to determine how the option affects the CPU usage and the
  869. # download speed on a particular system.
  870. AccurateRate=no
  871.  
  872. # Pause if disk space gets below this value (megabytes).
  873. #
  874. # Disk space is checked for directories pointed by option <DestDir> and
  875. # option <InterDir>.
  876. #
  877. # Value "0" disables the check.
  878. DiskSpace=250
  879.  
  880. # Delete already downloaded files from disk when nzb-file is deleted
  881. # (yes, no).
  882. #
  883. # This option defines if downloaded files must be deleted when:
  884. # 1) download of nzb-file is cancelled (deleted from queue);
  885. # 2) history record with failure-status (par-failure or unpack-failure)
  886. # is deleted from history.
  887. DeleteCleanupDisk=yes
  888.  
  889. # Delete source nzb-file when it is not needed anymore (yes, no).
  890. #
  891. # Enable this option for automatic deletion of source nzb-file from
  892. # incoming directory when the program doesn't require it anymore (the
  893. # nzb-file has been deleted from queue and history).
  894. NzbCleanupDisk=yes
  895.  
  896. # Keep the history of downloaded nzb-files (days).
  897. #
  898. # After download and post-processing the items are added to history where
  899. # their status can be checked and they can be post-processed again if
  900. # neccessary.
  901. #
  902. # After expiring of defined period:
  903. #
  904. # If option <DupeCheck> is active the items become hidden and the amount
  905. # of data kept is significantly reduced (for better performance), only
  906. # fields necessary for duplicate check are kept. The item remain in the
  907. # hidden history (forever);
  908. #
  909. # If option <DupeCheck> is NOT active the items are removed from history.
  910. #
  911. # Value "0" disables history. Duplicate check will not work.
  912. KeepHistory=30
  913.  
  914. # Keep the history of outdated feed items (days).
  915. #
  916. # After fetching of an RSS feed the information about included items (nzb-files)
  917. # is saved to disk. This allows to detect new items on next fetch. Feed
  918. # providers update RSS feeds constantly. Since the feed length is limited
  919. # (usually 100 items or less) the old items get pushed away by new
  920. # ones. When an item is not present in the feed anymore it's not necessary
  921. # to keep the information about this item on the disk.
  922. #
  923. # If option is set to "0", the outdated items are deleted from history
  924. # immediately.
  925. #
  926. # Otherwise the items are held in the history for defined number of
  927. # days. Keeping of items for few days helps in situations when feed provider
  928. # has technical issues and may response with empty feeds (or with missing
  929. # items). When the technical issue is fixed the items may reappear in the
  930. # feed causing the program to redownload items if they were not found in
  931. # the feed history.
  932. FeedHistory=7
  933.  
  934. # Maximum number of simultaneous connections for nzb URL downloads (0-999).
  935. #
  936. # When NZB-files are added to queue via URL, the program downloads them
  937. # from the specified URL. The option limits the maximal number of connections
  938. # used for this purpose, when multiple URLs were added at the same time.
  939. UrlConnections=4
  940.  
  941. # Force URL-downloads even if download queue is paused (yes, no).
  942. #
  943. # If option is active the URL-downloads (such as appending of nzb-files
  944. # via URL or fetching of RSS feeds and nzb-files from feeds) are performed
  945. # even if download is in paused state.
  946. UrlForce=yes
  947.  
  948.  
  949. ##############################################################################
  950. ### LOGGING ###
  951.  
  952. # How to use log file (none, append, reset, rotate).
  953. #
  954. # none - do not write into log file;
  955. # append - append to the existing log file or create it;
  956. # reset - delete existing log file on program start and create a new one;
  957. # rotate - create new log file for each day, delete old files,
  958. # see option <RotateLog>.
  959. WriteLog=rotate
  960.  
  961. # Log file rotation period (days).
  962. #
  963. # Defines how long to keep old log-files, when log rotation is active
  964. # (option <WriteLog> is set to "rotate").
  965. RotateLog=3
  966.  
  967. # How error messages must be printed (screen, log, both, none).
  968. ErrorTarget=both
  969.  
  970. # How warning messages must be printed (screen, log, both, none).
  971. WarningTarget=both
  972.  
  973. # How info messages must be printed (screen, log, both, none).
  974. InfoTarget=both
  975.  
  976. # How detail messages must be printed (screen, log, both, none).
  977. DetailTarget=log
  978.  
  979. # How debug messages must be printed (screen, log, both, none).
  980. #
  981. # Debug-messages can be printed only if the program was compiled in
  982. # debug-mode: "./configure --enable-debug".
  983. DebugTarget=log
  984.  
  985. # Number of messages stored in buffer and available for remote
  986. # clients (messages).
  987. LogBufferSize=1000
  988.  
  989. # Create log for each downloaded nzb-file (yes, no).
  990. #
  991. # The messages are saved for each download separately and can be viewed
  992. # at any time in download details dialog or history details dialog.
  993. NzbLog=yes
  994.  
  995. # Create a log of all broken files (yes, no).
  996. #
  997. # It is a text file placed near downloaded files, which contains
  998. # the names of broken files.
  999. BrokenLog=yes
  1000.  
  1001. # Create memory dump (core-file) on abnormal termination, Linux only (yes, no).
  1002. #
  1003. # Core-files are very helpful for debugging.
  1004. #
  1005. # NOTE: Core-files may contain sensible data, like your login/password to
  1006. # newsserver etc.
  1007. DumpCore=no
  1008.  
  1009. # Local time correction (hours or minutes).
  1010. #
  1011. # The option allows to adjust timestamps when converting system time to
  1012. # local time and vice versa. The conversion is used when printing messages
  1013. # to the log-file and by option "TaskX.Time" in the scheduler settings.
  1014. #
  1015. # The option is usually not needed if the time zone is set up correctly.
  1016. # However, sometimes, especially when using a binary compiled on onother
  1017. # platform (cross-compiling) the conversion between system and local time
  1018. # may not work properly and requires adjustment.
  1019. #
  1020. # Values in the range -24..+24 are interpreted as hours, other values as minutes.
  1021. # Example 1: set time correction to one hour: TimeCorrection=1;
  1022. # Example 2: set time correction to one hour and a half: TimeCorrection=90.
  1023. TimeCorrection=0
  1024.  
  1025. # See also option <LogFile> in section "PATHS"
  1026.  
  1027.  
  1028. ##############################################################################
  1029. ### DISPLAY (TERMINAL) ###
  1030.  
  1031. # Set screen-outputmode (loggable, colored, curses).
  1032. #
  1033. # loggable - only messages will be printed to standard output;
  1034. # colored - prints messages (with simple coloring for messages categories)
  1035. # and download progress info; uses escape-sequences to move cursor;
  1036. # curses - advanced interactive interface with the ability to edit
  1037. # download queue and various output option.
  1038. OutputMode=curses
  1039.  
  1040. # Shows NZB-Filename in file list in curses-outputmode (yes, no).
  1041. #
  1042. # This option controls the initial state of curses-frontend,
  1043. # it can be switched on/off in run-time with Z-key.
  1044. CursesNzbName=yes
  1045.  
  1046. # Show files in groups (NZB-files) in queue list in curses-outputmode (yes, no).
  1047. #
  1048. # This option controls the initial state of curses-frontend,
  1049. # it can be switched on/off in run-time with G-key.
  1050. CursesGroup=no
  1051.  
  1052. # Show timestamps in message list in curses-outputmode (yes, no).
  1053. #
  1054. # This option controls the initial state of curses-frontend,
  1055. # it can be switched on/off in run-time with T-key.
  1056. CursesTime=no
  1057.  
  1058. # Update interval for Frontend-output in console mode or remote client
  1059. # mode (milliseconds).
  1060. #
  1061. # Min value 25. Bigger values reduce CPU usage (especially in curses-outputmode)
  1062. # and network traffic in remote-client mode.
  1063. UpdateInterval=200
  1064.  
  1065.  
  1066. ##############################################################################
  1067. ### SCHEDULER ###
  1068.  
  1069. # Time to execute the command (HH:MM).
  1070. #
  1071. # Multiple comma-separated values are accepted.
  1072. # Asterix as hours-part means "every hour".
  1073. #
  1074. # Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*:00,*:30".
  1075. #
  1076. # NOTE: Also see option <TimeCorrection>.
  1077. #Task1.Time=08:00
  1078.  
  1079. # Week days to execute the command (1-7).
  1080. #
  1081. # Comma separated list of week days numbers.
  1082. # 1 is Monday.
  1083. # Character '-' may be used to define ranges.
  1084. #
  1085. # Examples: "1-7", "1-5", "5,6", "1-5, 7".
  1086. #Task1.WeekDays=1-7
  1087.  
  1088. # Command to be executed (PauseDownload, UnpauseDownload, PausePostProcess,
  1089. # UnpausePostProcess, PauseScan, UnpauseScan, DownloadRate, Script, Process,
  1090. # ActivateServer, DeactivateServer, FetchFeed).
  1091. #
  1092. # Possible commands:
  1093. # PauseDownload - pause download;
  1094. # UnpauseDownload - resume download;
  1095. # PausePostProcess - pause post-processing;
  1096. # UnpausePostProcess - resume post-processing;
  1097. # PauseScan - pause scan of incoming nzb-directory;
  1098. # UnpauseScan - resume scan of incoming nzb-directory;
  1099. # DownloadRate - set download rate limit;
  1100. # Script - execute one or multiple scheduler scripts. The scripts
  1101. # must be written specially for NZBGet;
  1102. # Process - execute an external (any) program;
  1103. # ActivateServer - activate news-server;
  1104. # DeactivateServer - deactivate news-server;
  1105. # FetchFeed - fetch RSS feed.
  1106. #
  1107. # On start the program checks all tasks and determines current state
  1108. # for download-pause, scan-pause, download-rate and active servers.
  1109. #Task1.Command=PauseDownload
  1110.  
  1111. # Parameters for the command if needed.
  1112. #
  1113. # Some scheduler commands require additional parameters:
  1114. # DownloadRate - download rate limit to be set (kilobytes/sec).
  1115. # Example: 1000;
  1116. # Script - list of scheduler scripts to execute. The scripts in
  1117. # the list must be separated with commas or semicolons. Only
  1118. # filenames without path must be used. All scripts must be
  1119. # stored in directory pointed by option <ScriptDir>. For
  1120. # more info see below;
  1121. # Process - path to the program to execute and its parameters.
  1122. # Example: /home/user/fetch.sh.
  1123. # If filename or any parameter contains spaces it
  1124. # must be surrounded with single quotation
  1125. # marks. If filename/parameter contains single quotation marks,
  1126. # each of them must be replaced with two single quotation
  1127. # marks and the resulting filename/parameter must be
  1128. # surrounded with single quotation marks.
  1129. # Example: '/home/user/download/my scripts/task process.sh' 'world''s fun'.
  1130. # In this example one parameter (world's fun) is passed
  1131. # to the script (task process.sh).
  1132. # ActivateServer - comma separated list of news server ids or server names.
  1133. # Example: 1,3.
  1134. # Example: my news server 1, my news server 2.
  1135. # NOTE: server names should not have commas.
  1136. # DeactivateServer - see ActivateServer.
  1137. # FetchFeed - comma separated list of RSS feed ids or feed names.
  1138. # Example: 1,3.
  1139. # Example: bookmarks feed, another feed.
  1140. # NOTE: feed names should not have commas.
  1141. # NOTE: use feed id "0" to fetch all feeds.
  1142. #
  1143. # INFO FOR DEVELOPERS:
  1144. # The rest of the description is for command "Script".
  1145. #
  1146. # NOTE: This is a short documentation, for more information visit
  1147. # http://nzbget.net/Extension_scripts.
  1148. #
  1149. # NZBGet passes following arguments to scheduler script as environment
  1150. # variables:
  1151. # NZBSP_TASKID - id number of scheduler Task.
  1152. #
  1153. # In addition to these arguments NZBGet passes all nzbget.conf-options
  1154. # as environment variables. These variables have prefix "NZBOP_" and
  1155. # are written in UPPER CASE. For Example option "ParRepair" is passed as
  1156. # environment variable "NZBOP_PARREPAIR". The dots in option names are
  1157. # replaced with underscores, for example "SERVER1_HOST". For options
  1158. # with predefined possible values (yes/no, etc.) the values are passed
  1159. # always in lower case.
  1160. #
  1161. # NOTE: This is a short documentation, for more information visit
  1162. # http://nzbget.net/Extension_scripts.
  1163. #Task1.Param=
  1164.  
  1165. #Task2.Time=20:00
  1166. #Task2.WeekDays=1-7
  1167. #Task2.Command=UnpauseDownload
  1168. #Task2.Param=
  1169.  
  1170.  
  1171. ##############################################################################
  1172. ### PAR CHECK/REPAIR ###
  1173.  
  1174. # Whether and how par-verification must be performed (auto, always, force, manual).
  1175. #
  1176. # Auto - par-check is performed when needed. One par2-file is always
  1177. # downloaded. Additional par2-files are downloaded if needed
  1178. # for repair. Repair is performed if the option <ParRepair>
  1179. # is enabled;
  1180. # Always - check every download (even undamaged). One par2-file is
  1181. # always downloaded. Additional par2-files are downloaded
  1182. # if needed for repair. Repair is performed if the option
  1183. # <ParRepair> is enabled;
  1184. # Force - force par-check for every download (even undamaged). All
  1185. # par2-files are always downloaded. Repair is performed if
  1186. # the option <ParRepair> is enabled;
  1187. # Manual - par-check is skipped. One par2-file is always
  1188. # downloaded. If a damaged download is detected, all
  1189. # par2-files are downloaded but neithet par-check nor par-repair
  1190. # take place. The download can be then repaired manually,
  1191. # eventually on another faster computer.
  1192. ParCheck=always
  1193.  
  1194. # Check for renamed and missing files (yes, no).
  1195. #
  1196. # Par-rename restores original file names using information stored
  1197. # in par2-files. It also detects missing files (files listed in
  1198. # par2-files but not present on disk). When enabled the par-rename is
  1199. # performed as the first step of post-processing for every nzb-file.
  1200. #
  1201. # Par-rename is very fast and is highly recommended, especially if
  1202. # unpack is disabled.
  1203. ParRename=yes
  1204.  
  1205. # Automatic par-repair after par-verification (yes, no).
  1206. #
  1207. # If option <ParCheck> is set to "Auto" or "Force" this option defines
  1208. # if the download must be repaired when needed. The option can be
  1209. # disabled if computer does not have enough CPU power, since repairing
  1210. # may take too much resources and time on a slow computers.
  1211. ParRepair=yes
  1212.  
  1213. # What files should be scanned during par-verification (limited, extended,
  1214. # full, dupe).
  1215. #
  1216. # Limited - scan only files belonging to par-set;
  1217. # Extended - scan files belonging to par-set first, scan other files until
  1218. # all missing files are found;
  1219. # Full - scan all files in destination directory. Can be very time
  1220. # consuming but may sometimes repair where Limited and Extended fail;
  1221. # Dupe - scan files belonging to par-set first, scan other files until
  1222. # repair is possible. Even files from other duplicate-downloads
  1223. # are scanned. Can be very time consuming but brings best results.
  1224. ParScan=extended
  1225.  
  1226. # Quick file verification during par-check (yes, no).
  1227. #
  1228. # If the option is active the files are quickly verified using
  1229. # checksums calculated during download; quick verification is very fast
  1230. # because it doesn't require the reading of files from disk, NZBGet
  1231. # knows checksums of downloaded files and quickly compares them with
  1232. # checksums stored in the par-file.
  1233. #
  1234. # If the option is disabled the files are verified as usual. That's
  1235. # slow. Use this if the quick verification doesn't work properly.
  1236. ParQuick=yes
  1237.  
  1238. # Memory limit for par-repair buffer (megabytes).
  1239. #
  1240. # Set the amount of RAM that the par-checker may use during repair. Having
  1241. # the buffer as big as the total size of all damaged blocks allows for
  1242. # the optimal repair speed. The option sets the maximum buffer size, the
  1243. # allocated buffer can be smaller.
  1244. #
  1245. # If you have a lot of RAM set the option to few hundreds (MB) for the
  1246. # best repair performance.
  1247. ParBuffer=16
  1248.  
  1249. # Number of threads to use during par-repair (0-99).
  1250. #
  1251. # On multi-core CPUs for the best speed set the option to the number of
  1252. # logical cores (physical cores + hyper-threading units). If you want
  1253. # to utilize the CPU to 100% you may need to add one or two additional threads
  1254. # to compensate for wait intervals used for thread synchronization.
  1255. #
  1256. # On single-core CPUs use only one thread.
  1257. #
  1258. # Set to '0' to automatically use all available CPU cores (may not
  1259. # work on old or exotic platforms).
  1260. ParThreads=0
  1261.  
  1262. # Files to ignore during par-check.
  1263. #
  1264. # List of file extensions, file names or file masks to ignore by
  1265. # par-rename and par-check. The entries must be separated with
  1266. # commas.
  1267. #
  1268. # The entries must be separated with commas. The entries can be file
  1269. # extensions, file names or file masks containing wildcard
  1270. # characters * and ?.
  1271. #
  1272. # If par-rename or par-check detect missing or damaged files they
  1273. # will ignore files matching this option and will not initiate
  1274. # repair. This avoids time costing repair for unimportant files.
  1275. #
  1276. # NOTE: Files matching the option <ExtCleanupDisk> are ignored as well.
  1277. #
  1278. # Example: .sfv, .nzb, .nfo
  1279. ParIgnoreExt=.sfv, .nzb, .nfo
  1280.  
  1281. # What to do if download health drops below critical health (delete,
  1282. # pause, none).
  1283. #
  1284. # Delete - delete nzb-file from queue. If option <DeleteCleanupDisk>
  1285. # is active the already downloaded files will be deleted too;
  1286. # Pause - pause nzb-file;
  1287. # None - do nothing (continue download).
  1288. #
  1289. # NOTE: For automatic duplicate handling option must be set to "Delete"
  1290. # or "None". If it is set to "Pause" you will need to manually return
  1291. # another duplicate to queue (if any exists in history). See also
  1292. # option <DupeCheck>.
  1293. #
  1294. # NOTE: When option <ParScan> is set to "Dupe" the delete-action is performed
  1295. # only if article completion is below 10% (empirical threshold). This is to
  1296. # improve efficiency of dupe par scan mode.
  1297. HealthCheck=delete
  1298.  
  1299. # Maximum allowed time for par-repair (minutes).
  1300. #
  1301. # If you use NZBGet on a very slow computer like NAS-device, it may be good to
  1302. # limit the time allowed for par-repair. NZBGet calculates the estimated time
  1303. # required for par-repair. If the estimated value exceeds the limit defined
  1304. # here, NZBGet cancels the repair.
  1305. #
  1306. # To avoid a false cancellation NZBGet compares the estimated time with
  1307. # <ParTimeLimit> after the first 5 minutes of repairing, when the calculated
  1308. # estimated time is more or less accurate. But in a case if <ParTimeLimit> is
  1309. # set to a value smaller than 5 minutes, the comparison is made after the first
  1310. # whole minute.
  1311. #
  1312. # Value "0" means unlimited.
  1313. #
  1314. # NOTE: The option limits only the time required for repairing. It doesn't
  1315. # affect the first stage of parcheck - verification of files. However the
  1316. # verification speed is constant, it doesn't depend on files integrity and
  1317. # therefore it is not necessary to limit the time needed for the first stage.
  1318. ParTimeLimit=0
  1319.  
  1320. # Pause download queue during check/repair (yes, no).
  1321. #
  1322. # Enable the option to give CPU more time for par-check/repair. That helps
  1323. # to speed up check/repair on slow CPUs with fast connection (e.g. NAS-devices).
  1324. #
  1325. # NOTE: If parchecker needs additional par-files it temporarily unpauses
  1326. # the queue.
  1327. #
  1328. # NOTE: See also options <ScriptPauseQueue> and <UnpackPauseQueue>.
  1329. ParPauseQueue=no
  1330.  
  1331. # Cleanup download queue after successful check/repair (yes, no).
  1332. #
  1333. # Enable this option for automatic deletion of unneeded (paused) par-files
  1334. # from download queue after successful check/repair.
  1335. ParCleanupQueue=yes
  1336.  
  1337.  
  1338. ##############################################################################
  1339. ### UNPACK ###
  1340.  
  1341. # Unpack downloaded nzb-files (yes, no).
  1342. #
  1343. # Each download (nzb-file) has a post-processing parameter "Unpack". The option
  1344. # <Unpack> is the default value assigned to this pp-parameter of the download
  1345. # when it is added to queue.
  1346. #
  1347. # When nzb-file is added to queue it can have a category assigned to it. In this
  1348. # case the option <CategoryX.Unpack> overrides the global option <Unpack>.
  1349. #
  1350. # If the download is damaged and could not be repaired using par-files
  1351. # the unpacking is not performed.
  1352. #
  1353. # If the option <ParCheck> is set to "Auto" the program tries to unpack
  1354. # downloaded files first. If the unpacking fails the par-check/repair
  1355. # is performed and the unpack is executed again.
  1356. Unpack=yes
  1357.  
  1358. # Pause download queue during unpack (yes, no).
  1359. #
  1360. # Enable the option to give CPU more time for unpacking. That helps
  1361. # to speed up unpacking on slow CPUs.
  1362. #
  1363. # NOTE: See also options <ParPauseQueue> and <ScriptPauseQueue>.
  1364. UnpackPauseQueue=no
  1365.  
  1366. # Delete archive files after successful unpacking (yes, no).
  1367. UnpackCleanupDisk=yes
  1368.  
  1369. # Full path to unrar executable.
  1370. #
  1371. # Example: /usr/bin/unrar.
  1372. #
  1373. # The option can also contain extra switches to pass to unrar. To the
  1374. # here defined command line NZBGet adds the following switches:
  1375. # x -y -p- -o+ *.rar ./_unpack/
  1376. #
  1377. # Switch "x" is added only if neither "x" nor "e" were defined in
  1378. # the option (this allows you to use switch "e" instead of "x"). switch
  1379. # "-o+" is added only if neither "-o+" nor "-o-" were defined
  1380. # in the command line. All other paramaters are always added. Parameter
  1381. # "-p-" is replaced with "-ppassword" if a password is set for nzb-file.
  1382. #
  1383. # Examples:
  1384. # 1) ignore file attributes (pemissions):
  1385. # /usr/bin/unrar x -ai;
  1386. # 2) decrease priority of unrar-process:
  1387. # nice -n 19 unrar.
  1388. #
  1389. # For other useful switches refer to unrar documentation.
  1390. #
  1391. # If unrar is in your PATH you may leave the path part and set only
  1392. # the executable name ("unrar" on POSIX or "unrar.exe" on Windows).
  1393. UnrarCmd=unrar
  1394.  
  1395. # Full path to 7-Zip executable.
  1396. #
  1397. # Example: /usr/bin/7z.
  1398. #
  1399. # Similar to option <UnrarCmd> this option can also include extra switches.
  1400. #
  1401. # If 7-Zip binary is in your PATH you may leave the path part and set only
  1402. # the executable name ("7z" or "7za" on POSIX or "7z.exe" on Windows).
  1403. SevenZipCmd=7z
  1404.  
  1405. # Files to delete after successful download.
  1406. #
  1407. # List of file extensions, file names or file masks to delete after
  1408. # successful download. If either unpack or par-check fail the cleanup is
  1409. # not performed. If neither unpack nor par-check were made (because they
  1410. # were disabled or the download doesn't contain archives and/or par-files
  1411. # the cleanup is performed if the health is 100%.
  1412. #
  1413. # The entries must be separated with commas. The entries can be file
  1414. # extensions, file names or file masks containing wildcard
  1415. # characters * and ?.
  1416. #
  1417. # Files listed here are also ignored by par-rename and par-check.
  1418. #
  1419. # NOTE: See also option <ParIgnoreExt>.
  1420. #
  1421. # Example: .par2, .sfv
  1422. ExtCleanupDisk=.par2, .sfv, _brokenlog.txt, .nzb, .srr, .srs, .tbn, .html, .bat, .htm, .txt, .png, .exe, .1, .jpg, .sample, .sample.srs, .url, .idx, .info, .md5
  1423.  
  1424. # Path to file containing unpack passwords.
  1425. #
  1426. # If the option is set the program will try all passwords from the file
  1427. # when unpacking the archives. The file must be a text file containing
  1428. # one password per line.
  1429. #
  1430. # If an nzb-file has a defined password (in the post-processing settings)
  1431. # then the password-file is not used for that nzb-file.
  1432. #
  1433. # NOTE: Trying multiple passwords is a time consuming task. Whenever possible
  1434. # passwords should be set per nzb-file in their post-processing settings.
  1435. UnpackPassFile=
  1436.  
  1437. ##############################################################################
  1438. ### EXTENSION SCRIPTS ###
  1439.  
  1440. # Default list of post-processing scripts to execute after the download
  1441. # of nzb-file is completed and possibly par-checked/repaired and unpacked.
  1442. #
  1443. # The scripts in the list must be separated with commas or semicolons. Only
  1444. # filenames without path must be used. All scripts must be stored in directory
  1445. # pointed by option <ScriptDir>.
  1446. #
  1447. # Example: Cleanup.sh, Move.sh, EMail.py.
  1448. #
  1449. # Each download (nzb-file) has its own list of post-processing scripts. The option
  1450. # <PostScript> is the default value assigned to download when it is added to
  1451. # queue. The list of post-processing scripts for a particular download can be
  1452. # changed in the edit dialog in web-interface or using remote command "--edit/-E".
  1453. #
  1454. # When nzb-file is added to queue it can have a category assigned to it. In this
  1455. # case the option <CategoryX.PostScript> (if not empty) overrides the
  1456. # global option <PostScript>.
  1457. #
  1458. # NOTE: The script execution order is controlled by option <ScriptOrder>, not
  1459. # by their order in option <PostScript>.
  1460. #
  1461. # NOTE: Changing options <PostScript> and <CategoryX.PostScript> doesn't affect
  1462. # already queued downloads.
  1463. #
  1464. # NOTE: For the list of interesting post-processing scripts see
  1465. # http://nzbget.net/Catalog_of_post-processing_scripts.
  1466. #
  1467. # INFO FOR DEVELOPERS:
  1468. # NOTE: This is a short documentation, for more information visit
  1469. # http://nzbget.net/Extension_scripts.
  1470. #
  1471. # NZBGet passes following arguments to post-processing script as environment
  1472. # variables:
  1473. # NZBPP_DIRECTORY - path to destination dir for downloaded files;
  1474. # NZBPP_NZBNAME - user-friendly name of processed nzb-file as it is displayed
  1475. # by the program. The file path and extension are removed.
  1476. # If download was renamed, this parameter reflects the new name;
  1477. # NZBPP_NZBFILENAME - name of processed nzb-file. It includes file extension and also
  1478. # may include full path;
  1479. # NZBPP_FINALDIR - final destination path if set by one of previous pp-scripts;
  1480. # NZBPP_CATEGORY - category assigned to nzb-file (can be empty string);
  1481. # NZBPP_DUPEKEY - duplicate key of nzb-file;
  1482. # NZBPP_DUPESCORE - duplicate score of nzb-file;
  1483. # NZBPP_DUPEMODE - duplicate mode of nzb-file: SCORE, ALL, FORCE;
  1484. # NZBPP_TOTALSTATUS - total status of nzb-file:
  1485. # SUCCESS - everything OK;
  1486. # WARNING - download is damaged but probably can
  1487. # be repaired; user intervention is
  1488. # required;
  1489. # FAILURE - download has failed or a serious error
  1490. # occurred during post-processing (unpack, par);
  1491. # DELETED - download was deleted; post-processing
  1492. # scripts are usually not called in this case;
  1493. # however it's possible to force calling
  1494. # scripts with command "post-process again";
  1495. # NZBPP_STATUS - complete status info for nzb-file: it consists
  1496. # of total status and status detail separated with
  1497. # slash, for example: "FAILURE/UNPACK"; for possible
  1498. # status details see documentation on web site;
  1499. # NZBPP_SCRIPTSTATUS - summary status of the scripts executed before the
  1500. # current one:
  1501. # NONE - no other scripts were executed yet or all
  1502. # of them have ended with exit code "NONE";
  1503. # SUCCESS - all other scripts have ended with exit
  1504. # code "SUCCESS" ;
  1505. # FAILURE - at least one of the script has failed;
  1506. # NZBPP_HEALTH - download health: an integer value in the range
  1507. # from 0 (all articles failed) to 1000 (all articles
  1508. # successfully downloaded);
  1509. # NZBPP_CRITICALHEALTH - critical health for this nzb-file: an integer
  1510. # value in the range 0-1000. The critical health
  1511. # is calculated based on number and size of
  1512. # par-files. If nzb-file doesn't have any par-files
  1513. # the critical health is 1000 (100.0%). If a half
  1514. # of nzb-file were par-files its critical health
  1515. # would be 0. If NZBPP_HEALTH goes down below
  1516. # NZBPP_CRITICALHEALTH the download becomes unrepairable;
  1517. # NZBPP_TOTALARTICLES - number of articles in nzb-file;
  1518. # NZBPP_SUCCESSARTICLES - number of successfully downloaded articles;
  1519. # NZBPP_FAILEDARTICLES - number of failed articles;
  1520. # NZBPP_SERVERX_SUCCESSARTICLES - number of successfully downloaded
  1521. # articles from ServerX (X is replaced with server
  1522. # number, for example NZBPP_SERVER1_SUCCESSARTICLES);
  1523. # NZBPP_SERVERX_FAILEDARTICLES - number of failed articles from ServerX.
  1524. #
  1525. # If the script defines own options they are also passed as environment
  1526. # variables. These variables have prefix "NZBPO_" in their names. For
  1527. # example, option "myoption" will be passed as environment variable
  1528. # "NZBPO_myoption" and in addition in uppercase as "NZBPO_MYOPTION".
  1529. #
  1530. # If the script defines own post-processing parameters, they are also passed as
  1531. # environment variables. These variables have prefix "NZBPR_" in their
  1532. # names. For example, pp-parameter "myparam" will be passed as environment
  1533. # variable "NZBPR_myparam" and in addition in uppercase as "NZBPR_MYPARAM".
  1534. #
  1535. # In addition to arguments, pp-options and pp-parameters NZBGet passes all
  1536. # nzbget.conf-options to pp-script as environment variables. These
  1537. # variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
  1538. # option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR". The
  1539. # dots in option names are replaced with underscores, for example
  1540. # "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
  1541. # the values are passed always in lower case.
  1542. #
  1543. # If the script moves files it can inform the program about new location
  1544. # by printing special message into standard output (which is processed
  1545. # by NZBGet):
  1546. # echo "[NZB] DIRECTORY=/path/to/moved/files";
  1547. # or:
  1548. # echo "[NZB] FINALDIR=/path/to/moved/files";
  1549. #
  1550. # Command "DIRECTORY" changes the destiantion path of the download and
  1551. # affects the scripts executed after the current script as well as the
  1552. # program code itself, for example the command "Post-process again"
  1553. # will work on new location. Command "FINALDIR" just sets a separate
  1554. # property of the download and should be used when the files are moved
  1555. # into an existing directory containg other files to avoid the processing
  1556. # of those files by other scripts.
  1557. #
  1558. # To assign post-processing parameters:
  1559. # echo "[NZB] NZBPR_myvar=my value";
  1560. #
  1561. # The prefix "NZBPR_" will be removed. In this example a post-processing
  1562. # parameter with name "myvar" and value "my value" will be associated
  1563. # with nzb-file.
  1564. #
  1565. # To inform NZBGet about bad download:
  1566. # echo "[NZB] MARK=BAD";
  1567. #
  1568. # Return value: NZBGet processes the exit code returned by the script:
  1569. # 93 - post-process successful (status = SUCCESS);
  1570. # 94 - post-process failed (status = FAILURE);
  1571. # 95 - post-process skipped (status = NONE). Use this code when you script
  1572. # terminates immediateley without doing any job and when this is not
  1573. # a failure termination;
  1574. # 92 - request NZBGet to do par-check/repair for current nzb-file.
  1575. #
  1576. # All other return codes are interpreted as failure (status = FAILURE).
  1577. #
  1578. # NOTE: This is a short documentation, for more information visit
  1579. # http://nzbget.net/Extension_scripts.
  1580. PostScript=
  1581.  
  1582. # List of scan scripts to execute before a nzb-file is added to queue.
  1583. #
  1584. # The scripts in the list must be separated with commas or semicolons. Only
  1585. # filenames without path must be used. All scripts must be stored in directory
  1586. # pointed by option <ScriptDir>.
  1587. #
  1588. # The scripts are executed each time a new file is found in incoming
  1589. # directory (option <NzbDir>) or a file is received via RPC (web-interface,
  1590. # command "nzbget --append", etc.).
  1591. #
  1592. # Example: UnzipNzb.sh, ScanNotify.py.
  1593. #
  1594. # The scripts can unpack archives which were put in incoming directory, make
  1595. # filename cleanup, change nzb-name, category, priority and post-processing
  1596. # parameters of the nzb-file or do other things.
  1597. #
  1598. # INFO FOR DEVELOPERS:
  1599. # NOTE: This is a short documentation, for more information visit
  1600. # http://nzbget.net/Extension_scripts.
  1601. #
  1602. # NZBGet passes following arguments to the script as environment
  1603. # variables:
  1604. # NZBNP_DIRECTORY - path to directory, where file is located. It is a directory
  1605. # specified by the option <NzbDir> or a subdirectory;
  1606. # NZBNP_FILENAME - name of file to be processed;
  1607. # NZBNP_NZBNAME - nzb-name (without path but with extension);
  1608. # NZBNP_CATEGORY - category of nzb-file;
  1609. # NZBNP_PRIORITY - priority of nzb-file;
  1610. # NZBNP_TOP - flag indicating that the file will be added to the top
  1611. # of queue: 0 or 1;
  1612. # NZBNP_PAUSED - flag indicating that the file will be added as
  1613. # paused: 0 or 1;
  1614. # NZBNP_DUPEKEY - duplicate key of nzb-file;
  1615. # NZBNP_DUPESCORE - duplicate score of nzb-file;
  1616. # NZBNP_DUPEMODE - duplicate mode of nzb-file: SCORE, ALL, FORCE.
  1617. #
  1618. # In addition to these arguments NZBGet passes all nzbget.conf-options
  1619. # as environment variables. These variables have prefix "NZBOP_" and
  1620. # are written in UPPER CASE. For Example option "ParRepair" is passed as
  1621. # environment variable "NZBOP_PARREPAIR". The dots in option names are
  1622. # replaced with underscores, for example "SERVER1_HOST". For options
  1623. # with predefined possible values (yes/no, etc.) the values are passed
  1624. # always in lower case.
  1625. #
  1626. # The script can change nzb-name, category, priority,
  1627. # post-processing parameters and top-/paused-flags of the nzb-file
  1628. # by printing special messages into standard output (which is processed
  1629. # by NZBGet).
  1630. #
  1631. # To change nzb-name use following syntax:
  1632. # echo "[NZB] NZBNAME=my download";
  1633. #
  1634. # To change category:
  1635. # echo "[NZB] CATEGORY=my category";
  1636. #
  1637. # To change priority:
  1638. # echo "[NZB] PRIORITY=signed_integer_value";
  1639. #
  1640. # for example: to set priority higher than normal:
  1641. # echo "[NZB] PRIORITY=50";
  1642. #
  1643. # another example: use a negative value for "lower than normal" priority:
  1644. # echo "[NZB] PRIORITY=-100";
  1645. #
  1646. # Although priority can be any integer value, the web-interface operates
  1647. # with six predefined priorities:
  1648. # -100 - very low priority;
  1649. # -50 - low priority;
  1650. # 0 - normal priority (default);
  1651. # 50 - high priority;
  1652. # 100 - very high priority;
  1653. # 900 - force priority.
  1654. #
  1655. # Downloads with priorities equal to or greater than 900 are downloaded and
  1656. # post-processed even if the program is in paused state (force mode).
  1657. #
  1658. # To assign post-processing parameters:
  1659. # echo "[NZB] NZBPR_myvar=my value";
  1660. #
  1661. # The prefix "NZBPR_" will be removed. In this example a post-processing
  1662. # parameter with name "myvar" and value "my value" will be associated
  1663. # with nzb-file.
  1664. #
  1665. # To change top-flag (nzb-file will be added to the top of queue):
  1666. # echo "[NZB] TOP=1";
  1667. #
  1668. # To change paused-flag (nzb-file will be added in paused state):
  1669. # echo "[NZB] PAUSED=1";
  1670. #
  1671. # To change duplicate key:
  1672. # echo "[NZB] DUPEKEY=tv show s01e02";
  1673. #
  1674. # To change duplicate score:
  1675. # echo "[NZB] DUPESCORE=integer_value";
  1676. #
  1677. # To change duplicate mode:
  1678. # echo "[NZB] DUPEMODE=(SCORE|ALL|FORCE)";
  1679. #
  1680. # The script can delete processed file, rename it or move somewhere.
  1681. # After the calling of the script the file will be either added to queue
  1682. # (if it was an nzb-file) or renamed by adding the extension ".processed".
  1683. #
  1684. # NOTE: Files with extensions ".processed", ".queued" and ".error" are skipped
  1685. # during the directory scanning.
  1686. #
  1687. # NOTE: Files with extension ".nzb_processed" are not passed to
  1688. # scan-script before adding to queue. This feature allows scan-script
  1689. # to prevent the scanning of nzb-files extracted from archives, if
  1690. # they were already processed by the script.
  1691. #
  1692. # NOTE: Files added via RPC calls in particular from web-interface are
  1693. # saved into incoming nzb-directory and then processed by the script.
  1694. #
  1695. # NOTE: This is a short documentation, for more information visit
  1696. # http://nzbget.net/Extension_scripts.
  1697. ScanScript=Completion.py
  1698.  
  1699. # List of queue scripts to execute on queue events.
  1700. #
  1701. # The scripts in the list must be separated with commas or semicolons. Only
  1702. # filenames without path must be used. All scripts must be stored in directory
  1703. # pointed by option <ScriptDir>.
  1704. #
  1705. # The scripts are executed on certain queue events such as adding
  1706. # a new nzb-file to queue, etc.
  1707. #
  1708. # Example: DeleteQueueSamples.sh, NzbAddedNotify.py.
  1709. #
  1710. # The script can modify the files in download queue (for example
  1711. # delete or pause all nfo, sfv, sample files) or do something else.
  1712. #
  1713. # INFO FOR DEVELOPERS:
  1714. # NOTE: This is a short documentation, for more information visit
  1715. # http://nzbget.net/Extension_scripts.
  1716. #
  1717. # NZBGet passes following arguments to the queue script as environment
  1718. # variables:
  1719. # NZBNA_NZBNAME - name of nzb-group. This name can be used in calls
  1720. # to nzbget edit-command using subswitch "-GN name";
  1721. # NZBNA_FILENAME - filename of the nzb-file. If the file was added
  1722. # from nzb-directory this is the fullname with path.
  1723. # If the file was added via web-interface it contains
  1724. # only filename without path;
  1725. # NZBNA_EVENT - describes why the script was called:
  1726. # NZB_ADDED - after adding of nzb-file to queue;
  1727. # FILE_DOWNLOADED - after a file included in nzb is
  1728. # downloaded;
  1729. # NZB_DOWNLOADED - after all files in nzb are downloaded
  1730. # (before post-processing);
  1731. # NZB_DELETED - when nzb is deleted from queue (moved
  1732. # to history). See NZBNA_DELETESTATUS for details;
  1733. # URL_COMPLETED - after an URL download is completed
  1734. # and the downloaded file was not added to queue
  1735. # (not nzb-extension, download error, parse
  1736. # error). See NZBNA_URLSTATUS for details;
  1737. # In the future the list of supported events may be
  1738. # extended. To avoid conflicts with future NZBGet
  1739. # versions the script must exit if the parameter
  1740. # has a value unknown to the script.
  1741. # NZBNA_DELETESTATUS - delete status info, NZBNA_EVENT=NZB_DELETED:
  1742. # MANUAL - deleted by user or via API call;
  1743. # HEALTH - deleted by health check;
  1744. # DUPE - moved to history by duplicate check, can be
  1745. # reused later if necessary;
  1746. # GOOD - moved to history by duplicate check because
  1747. # there is already a duplicate marked as good;
  1748. # BAD - marked as bad by user or by queue-script;
  1749. # COPY - already in queue or in history;
  1750. # SCAN - malformed nzb-file, cannot be parsed;
  1751. # NZBNA_URLSTATUS - URL status info, when NZBNA_EVENT=URL_COMPLETED:
  1752. # FAILURE - fetch error (could not be downloaded);
  1753. # SCAN_SKIPPED - downloaded file doesn't have
  1754. # nzb-extension and was skipped;
  1755. # SCAN_FAILED - file format error;
  1756. # NZBNA_CATEGORY - category of nzb-file (if assigned);
  1757. # NZBNA_NZBID - id of the nzb-file. This ID can be used with
  1758. # calls to nzbget edit-command;
  1759. # NZBNA_PRIORITY - priority (default is 0);
  1760. # NZBNA_DUPEKEY - duplicate key of nzb-file;
  1761. # NZBNA_DUPESCORE - duplicate score of nzb-file;
  1762. # NZBNA_DUPEMODE - duplicate mode of nzb-file: SCORE, ALL, FORCE.
  1763. #
  1764. # In addition to these arguments NZBGet passes all nzbget.conf-options
  1765. # to the script as environment variables. These variables have prefix
  1766. # "NZBOP_" and are written in UPPER CASE. For Example option "ParRepair"
  1767. # is passed as environment variable "NZBOP_PARREPAIR". The dots in option
  1768. # names are replaced with underscores, for example "SERVER1_HOST". For
  1769. # options with predefined possible values (yes/no, etc.) the values are
  1770. # passed always in lower case.
  1771. #
  1772. # The script can printing special messages into standard output (which
  1773. # is processed by NZBGet).
  1774. #
  1775. # To assign post-processing parameters:
  1776. # echo "[NZB] NZBPR_myvar=my value";
  1777. #
  1778. # The prefix "NZBPR_" will be removed. In this example a post-processing
  1779. # parameter with name "myvar" and value "my value" will be associated
  1780. # with nzb-file.
  1781. #
  1782. # To inform NZBGet about bad download:
  1783. # echo "[NZB] MARK=BAD";
  1784. #
  1785. # Examples of what the script can do:
  1786. # 1) pausing nzb-file using file-id:
  1787. # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E G P $NZBNA_NZBID;
  1788. # 2) setting category using nzb-name:
  1789. # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E GN K "my cat" "$NZBNA_NZBNAME";
  1790. # 3) pausing files with extension "nzb":
  1791. # "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E FR P "$NZBNA_NZBNAME/.*\.nzb";
  1792. #
  1793. # NOTE: This is a short documentation, for more information visit
  1794. # http://nzbget.net/Extension_scripts.
  1795. QueueScript=Completion.py
  1796.  
  1797. # List of rss feed scripts to execute before a rss feed content is processed.
  1798. #
  1799. # The scripts in the list must be separated with commas or semicolons. Only
  1800. # filenames without path must be used. All scripts must be stored in directory
  1801. # pointed by option <ScriptDir>.
  1802. #
  1803. # If rss feed has option <FeedX.FeedScript> defined (if not empty)
  1804. # the scripts defined there override the global option <FeedScript>.
  1805. #
  1806. # The scripts are executed after rss feed is read from server and before it
  1807. # is processed by the feed parser. Once the feed is fetched it is saved
  1808. # to a temporary file and the feed scripts are executed. The scripts
  1809. # can modify the content of the temporary feed file. Then the file is
  1810. # read by the feed parser and processed.
  1811. #
  1812. # Example: Rss.sh, Filter.py.
  1813. #
  1814. # The feed content is usually filtered using option <FeedX.Filter>. If a
  1815. # required filtering cannot be achieved via built-in filter commands the
  1816. # more advanced processing of the feed can be made using feed scripts.
  1817. #
  1818. # INFO FOR DEVELOPERS:
  1819. # NOTE: This is a short documentation, for more information visit
  1820. # http://nzbget.net/Extension_scripts.
  1821. #
  1822. # NZBGet passes following arguments to the script as environment
  1823. # variables:
  1824. # NZBFP_FILENAME - name of feed file to be processed;
  1825. # NZBFP_FEEDID - ID of the feed.
  1826. #
  1827. # In addition to these arguments NZBGet passes all nzbget.conf-options
  1828. # as environment variables. These variables have prefix "NZBOP_" and
  1829. # are written in UPPER CASE. For Example option "ParRepair" is passed as
  1830. # environment variable "NZBOP_PARREPAIR". The dots in option names are
  1831. # replaced with underscores, for example "SERVER1_HOST". For options
  1832. # with predefined possible values (yes/no, etc.) the values are passed
  1833. # always in lower case.
  1834. #
  1835. # NOTE: This is a short documentation, for more information visit
  1836. # http://nzbget.net/Extension_scripts.
  1837. FeedScript=
  1838.  
  1839. # Execution order for scripts.
  1840. #
  1841. # If you assign multiple scripts to one nzb-file, they are executed in the
  1842. # order defined by this option. Scripts not listed here are executed at
  1843. # the end in their alphabetical order.
  1844. #
  1845. # The scripts in the list must be separated with commas or semicolons. Only
  1846. # filenames without path must be used. All scripts must be stored in directory
  1847. # pointed by option <ScriptDir>.
  1848. #
  1849. # Example: Cleanup.sh, Move.sh.
  1850. ScriptOrder=Completion.py, CharTransProcess.py, GetScripts/DeleteSamples.py, GetScripts/SafeRename.py, GetScripts/flatten.py, VideoSort.py, Logger.py, GetScripts/passwordList.py, nzbToMedia/nzbToCouchPotato.py, nzbToMedia/nzbToGamez.py, nzbToMedia/nzbToHeadPhones.py, nzbToMedia/nzbToMedia.py, nzbToMedia/nzbToMylar.py, nzbToMedia/nzbToNzbDrone.py, nzbToMedia/nzbToSickBeard.py, EMail.py, GetScripts/ResetDateTime.py
  1851.  
  1852. # Pause download queue during executing of postprocess-script (yes, no).
  1853. #
  1854. # Enable the option to give CPU more time for postprocess-script. That helps
  1855. # to speed up postprocess on slow CPUs with fast connection (e.g. NAS-devices).
  1856. #
  1857. # NOTE: See also options <ParPauseQueue> and <UnpackPauseQueue>.
  1858. ScriptPauseQueue=no
  1859.  
  1860. # Minimum interval between calls of queue-scripts (seconds).
  1861. #
  1862. # Queue-scripts are executed during download, after every file included in
  1863. # nzb-file is downloaded. If the files are small they may be downloaded
  1864. # very fast causing queue-scripts to be working all the time. Sometimes
  1865. # this may lead to a performance decrease on systems with slow CPUs.
  1866. #
  1867. # This option allows to reduce the number of calls of queue-scripts by
  1868. # skipping "file-downloaded"-events if the previous call of queue-scripts
  1869. # for the same download (nzb-file) were performed a short time ago
  1870. # (as defined by the option).
  1871. #
  1872. # Value "-1" disables executing of queue-scripts on
  1873. # "file-downloaded"-events. Scripts are still executed on events
  1874. # "nzb-added" and "nzb-downloaded".
  1875. #
  1876. # NOTE: This options affects only queue-scripts and only
  1877. # "file-downloaded"-events. Queue-scripts can be activated using
  1878. # option <QueueScript> (for pure queue-scripts) or option <PostScript>
  1879. # (for dual-mode scripts which act as queue- and post-processing-scripts
  1880. # at the same time).
  1881. EventInterval=0
  1882. Category2.DestDir=
  1883. Category2.Unpack=yes
  1884. Category2.PostScript=
  1885. Category2.Aliases=
  1886. Category3.DestDir=
  1887. Category3.Unpack=yes
  1888. Category3.PostScript=
  1889. Category3.Aliases=
  1890. Category4.DestDir=
  1891. Category4.Unpack=yes
  1892. Category4.PostScript=
  1893. Category4.Aliases=
  1894. EMail.py:SendMail=Always
  1895. EMail.py:From="NZBGet" <myaccount@gmail.com>
  1896. EMail.py:To=myaccount@gmail.com
  1897. EMail.py:Server=smtp.gmail.com
  1898. EMail.py:Port=25
  1899. EMail.py:Encryption=yes
  1900. EMail.py:Username=myaccount
  1901. EMail.py:Password=mypass
  1902. EMail.py:Statistics=yes
  1903. EMail.py:FileList=yes
  1904. EMail.py:BrokenLog=yes
  1905. EMail.py:NzbLog=OnFailure
  1906. GetScripts/DeleteSamples.py:mediaExtensions=.mkv,.avi,.divx,.xvid,.mov,.wmv,.mp4,.mpg,.mpeg,.vob,.iso
  1907. GetScripts/DeleteSamples.py:maxSampleSize=200
  1908. GetScripts/DeleteSamples.py:SampleIDs=sample,-s.
  1909. GetScripts/flatten.py:DestinationDirectory=
  1910. GetScripts/flatten.py:AppendCategories=no
  1911. GetScripts/passwordList.py:PasswordFile="/share/Download/password.txt"
  1912. GetScripts/passwordList.py:SevenZip=
  1913. GetScripts/passwordList.py:niceness=10
  1914. GetScripts/passwordList.py:ionice_class=2
  1915. GetScripts/passwordList.py:ionice_classdata=4
  1916. nzbToMedia/nzbToMedia.py:auto_update=0
  1917. nzbToMedia/nzbToMedia.py:check_media=1
  1918. nzbToMedia/nzbToMedia.py:safe_mode=1
  1919. nzbToMedia/nzbToMedia.py:cpsCategory=movie
  1920. nzbToMedia/nzbToMedia.py:cpsapikey=
  1921. nzbToMedia/nzbToMedia.py:cpshost=localhost
  1922. nzbToMedia/nzbToMedia.py:cpsport=5050
  1923. nzbToMedia/nzbToMedia.py:cpsssl=0
  1924. nzbToMedia/nzbToMedia.py:cpsweb_root=
  1925. nzbToMedia/nzbToMedia.py:cpsmethod=renamer
  1926. nzbToMedia/nzbToMedia.py:cpsdelete_failed=0
  1927. nzbToMedia/nzbToMedia.py:cpswait_for=2
  1928. nzbToMedia/nzbToMedia.py:cpsremote_path=0
  1929. nzbToMedia/nzbToMedia.py:sbCategory=tv
  1930. nzbToMedia/nzbToMedia.py:sbhost=localhost
  1931. nzbToMedia/nzbToMedia.py:sbport=8081
  1932. nzbToMedia/nzbToMedia.py:sbusername=
  1933. nzbToMedia/nzbToMedia.py:sbpassword=
  1934. nzbToMedia/nzbToMedia.py:sbssl=0
  1935. nzbToMedia/nzbToMedia.py:sbweb_root=
  1936. nzbToMedia/nzbToMedia.py:sbwatch_dir=
  1937. nzbToMedia/nzbToMedia.py:sbfork=auto
  1938. nzbToMedia/nzbToMedia.py:sbdelete_failed=0
  1939. nzbToMedia/nzbToMedia.py:sbprocess_method=
  1940. nzbToMedia/nzbToMedia.py:sbremote_path=0
  1941. nzbToMedia/nzbToMedia.py:ndCategory=tv2
  1942. nzbToMedia/nzbToMedia.py:ndhost=localhost
  1943. nzbToMedia/nzbToMedia.py:ndport=8989
  1944. nzbToMedia/nzbToMedia.py:ndapikey=
  1945. nzbToMedia/nzbToMedia.py:ndssl=0
  1946. nzbToMedia/nzbToMedia.py:ndweb_root=
  1947. nzbToMedia/nzbToMedia.py:ndwait_for=2
  1948. nzbToMedia/nzbToMedia.py:nddelete_failed=0
  1949. nzbToMedia/nzbToMedia.py:ndremote_path=0
  1950. nzbToMedia/nzbToMedia.py:hpCategory=music
  1951. nzbToMedia/nzbToMedia.py:hpapikey=
  1952. nzbToMedia/nzbToMedia.py:hphost=localhost
  1953. nzbToMedia/nzbToMedia.py:hpport=8181
  1954. nzbToMedia/nzbToMedia.py:hpssl=0
  1955. nzbToMedia/nzbToMedia.py:hpweb_root=
  1956. nzbToMedia/nzbToMedia.py:hpremote_path=0
  1957. nzbToMedia/nzbToMedia.py:myCategory=comics
  1958. nzbToMedia/nzbToMedia.py:myhost=localhost
  1959. nzbToMedia/nzbToMedia.py:myport=8090
  1960. nzbToMedia/nzbToMedia.py:myusername=
  1961. nzbToMedia/nzbToMedia.py:mypassword=
  1962. nzbToMedia/nzbToMedia.py:myssl=0
  1963. nzbToMedia/nzbToMedia.py:myweb_root=
  1964. nzbToMedia/nzbToMedia.py:myswait_for=1
  1965. nzbToMedia/nzbToMedia.py:myremote_path=0
  1966. nzbToMedia/nzbToMedia.py:gzCategory=games
  1967. nzbToMedia/nzbToMedia.py:gzapikey=
  1968. nzbToMedia/nzbToMedia.py:gzhost=localhost
  1969. nzbToMedia/nzbToMedia.py:gzport=8085
  1970. nzbToMedia/nzbToMedia.py:gzssl=0
  1971. nzbToMedia/nzbToMedia.py:gzweb_root=
  1972. nzbToMedia/nzbToMedia.py:gzremote_path=0
  1973. nzbToMedia/nzbToMedia.py:mountPoints=
  1974. nzbToMedia/nzbToMedia.py:mediaExtensions=.mkv,.avi,.divx,.xvid,.mov,.wmv,.mp4,.mpg,.mpeg,.vob,.iso,.ts
  1975. nzbToMedia/nzbToMedia.py:niceness=10
  1976. nzbToMedia/nzbToMedia.py:ionice_class=2
  1977. nzbToMedia/nzbToMedia.py:ionice_classdata=4
  1978. nzbToMedia/nzbToMedia.py:getSubs=0
  1979. nzbToMedia/nzbToMedia.py:subLanguages=eng,spa,fra
  1980. nzbToMedia/nzbToMedia.py:transcode=0
  1981. nzbToMedia/nzbToMedia.py:duplicate=1
  1982. nzbToMedia/nzbToMedia.py:ignoreExtensions=.avi,.mkv
  1983. nzbToMedia/nzbToMedia.py:outputFastStart=0
  1984. nzbToMedia/nzbToMedia.py:outputVideoPath=
  1985. nzbToMedia/nzbToMedia.py:processOutput=0
  1986. nzbToMedia/nzbToMedia.py:audioLanguage=eng
  1987. nzbToMedia/nzbToMedia.py:allAudioLanguages=0
  1988. nzbToMedia/nzbToMedia.py:allSubLanguages=0
  1989. nzbToMedia/nzbToMedia.py:embedSubs=1
  1990. nzbToMedia/nzbToMedia.py:burnInSubtitle=0
  1991. nzbToMedia/nzbToMedia.py:extractSubs=0
  1992. nzbToMedia/nzbToMedia.py:externalSubDir=
  1993. nzbToMedia/nzbToMedia.py:outputDefault=None
  1994. nzbToMedia/nzbToMedia.py:hwAccel=0
  1995. nzbToMedia/nzbToMedia.py:outputVideoExtension=.mp4
  1996. nzbToMedia/nzbToMedia.py:outputVideoCodec=libx264
  1997. nzbToMedia/nzbToMedia.py:VideoCodecAllow=
  1998. nzbToMedia/nzbToMedia.py:outputVideoPreset=medium
  1999. nzbToMedia/nzbToMedia.py:outputVideoFramerate=24
  2000. nzbToMedia/nzbToMedia.py:outputVideoBitrate=800k
  2001. nzbToMedia/nzbToMedia.py:outputAudioCodec=ac3
  2002. nzbToMedia/nzbToMedia.py:AudioCodecAllow=
  2003. nzbToMedia/nzbToMedia.py:outputAudioChannels=6
  2004. nzbToMedia/nzbToMedia.py:outputAudioBitrate=640k
  2005. nzbToMedia/nzbToMedia.py:outputQualityPercent=
  2006. nzbToMedia/nzbToMedia.py:outputAudioTrack2Codec=libfaac
  2007. nzbToMedia/nzbToMedia.py:AudioCodec2Allow=
  2008. nzbToMedia/nzbToMedia.py:outputAudioTrack2Channels=2
  2009. nzbToMedia/nzbToMedia.py:outputAudioTrack2Bitrate=160k
  2010. nzbToMedia/nzbToMedia.py:outputAudioOtherCodec=libmp3lame
  2011. nzbToMedia/nzbToMedia.py:AudioOtherCodecAllow=
  2012. nzbToMedia/nzbToMedia.py:outputAudioOtherChannels=2
  2013. nzbToMedia/nzbToMedia.py:outputAudioOtherBitrate=128k
  2014. nzbToMedia/nzbToMedia.py:outputSubtitleCodec=
  2015. nzbToMedia/nzbToMedia.py:wolwake=0
  2016. nzbToMedia/nzbToMedia.py:wolmac=00:01:2e:2D:64:e1
  2017. nzbToMedia/nzbToMedia.py:wolhost=192.168.1.37
  2018. nzbToMedia/nzbToMedia.py:wolport=80
  2019. nzbToMedia/nzbToMedia.py:usCategory=mine
  2020. nzbToMedia/nzbToMedia.py:usremote_path=0
  2021. nzbToMedia/nzbToMedia.py:user_script_mediaExtensions=.mkv,.avi,.divx,.xvid,.mov,.wmv,.mp4,.mpg,.mpeg
  2022. nzbToMedia/nzbToMedia.py:user_script_path=/nzbToMedia/userscripts/script.sh
  2023. nzbToMedia/nzbToMedia.py:user_script_param=FN
  2024. nzbToMedia/nzbToMedia.py:user_script_runOnce=0
  2025. nzbToMedia/nzbToMedia.py:user_script_successCodes=0
  2026. nzbToMedia/nzbToMedia.py:user_script_clean=1
  2027. nzbToMedia/nzbToMedia.py:usdelay=120
  2028. Task2.Time=06:00
  2029. Task2.WeekDays=1-7
  2030. Task2.Command=DownloadRate
  2031. Task2.Param=800
  2032. Task1.Time=01:00
  2033. Task1.WeekDays=1-7
  2034. Task1.Command=DownloadRate
  2035. Task1.Param=0
  2036. VideoSort.py:MoviesDir=
  2037. VideoSort.py:SeriesDir=${DestDir}/series
  2038. VideoSort.py:DatedDir=${DestDir}/tv
  2039. VideoSort.py:OtherTvDir=${DestDir}/tv
  2040. VideoSort.py:TvCategories=tv
  2041. VideoSort.py:VideoExtensions=.mkv,.avi,.divx,.xvid,.mov,.wmv,.mp4,.mpg,.mpeg,.vob,.iso
  2042. VideoSort.py:SatelliteExtensions=.srt,.sub
  2043. VideoSort.py:MinSize=100
  2044. VideoSort.py:MoviesFormat=%t (%y) %qss
  2045. VideoSort.py:SeriesFormat=%sn/Season %s/%sn - S%0sE%0e - %en
  2046. VideoSort.py:EpisodeSeparator=E
  2047. VideoSort.py:SeriesYear=yes
  2048. VideoSort.py:DatedFormat=%sn/%sn - %y-%0m-%0d
  2049. VideoSort.py:OtherTvFormat=%t
  2050. VideoSort.py:LowerWords=the,of,and,at,vs,a,an,but,nor,for,on,so,yet
  2051. VideoSort.py:UpperWords=III,II,IV
  2052. VideoSort.py:DNZBHeaders=yes
  2053. VideoSort.py:PreferNZBName=no
  2054. VideoSort.py:Overwrite=no
  2055. VideoSort.py:Cleanup=yes
  2056. VideoSort.py:Preview=no
  2057. VideoSort.py:Verbose=no
  2058. Server2.Active=yes
  2059. Server2.Name=free-usenet 1TB
  2060. Server2.Level=1
  2061. Server2.Group=0
  2062. Server2.Host=news.free-usenet.com
  2063. Server2.Port=443
  2064. Server2.Username=<blocked>
  2065. Server2.Password=<blocked>
  2066. Server2.JoinGroup=no
  2067. Server2.Encryption=yes
  2068. Server2.Cipher=
  2069. Server2.Connections=20
  2070. Server2.Retention=0
  2071. Completion.py:AgeLimit=4
  2072. Completion.py:Prioritize=No
  2073. Completion.py:CheckDupes=SameScore
  2074. Completion.py:ForceFailure=Yes
  2075. Completion.py:CheckLimit=10
  2076. Completion.py:MinArticles=50
  2077. Completion.py:MaxArticles=1000
  2078. Completion.py:FullCheckNoPars=Yes
  2079. Completion.py:Categories=
  2080. Completion.py:Servers=
  2081. Completion.py:FillServers=
  2082. Completion.py:MaxFailure=0
  2083. Completion.py:Verbose=No
  2084. Completion.py:Extreme=No
  2085. Task3.Time=*:00,*:15,*:30,*:45
  2086. Task3.WeekDays=1-7
  2087. Task3.Command=Script
  2088. Task3.Param=Completion.py
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement