API tools faq
paste
Advertisement
Guest User

configrepeat

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