0 | |
# Sample configuration file for NZBGet
|
1 | |
#
|
2 | |
# On POSIX put this file to one of the following locations:
|
3 | |
# ~/.nzbget
|
4 | |
# /etc/nzbget.conf
|
5 | |
# /usr/etc/nzbget.conf
|
6 | |
# /usr/local/etc/nzbget.conf
|
7 | |
# /opt/etc/nzbget.conf
|
8 | |
#
|
9 | |
# On Windows put this file in program's directory.
|
10 | |
#
|
11 | |
# You can also put the file into any location, if you specify the path to it
|
12 | |
# using switch "-c", e.g:
|
13 | |
# nzbget -c /home/user/myconfig.txt
|
14 | |
|
15 | |
# For quick start change the option MainDir and configure one news-server
|
|
0 |
# Configuration file for NZBGet
|
16 | 1 |
|
17 | 2 |
|
18 | 3 |
##############################################################################
|
|
28 | 13 |
#
|
29 | 14 |
# If you want to distinguish between partially downloaded files and
|
30 | 15 |
# completed downloads, use also option <InterDir>.
|
|
16 |
#
|
|
17 |
# It is allowed to enter multiple directories here by separating them with comma
|
|
18 |
# or semicolon. NZBGet checks how much free disk space is available in each
|
|
19 |
# directory (assuming all directories are located on different drives) and
|
|
20 |
# chooses the directory with the most free space.
|
31 | 21 |
DestDir=${MainDir}/dst
|
32 | 22 |
|
33 | 23 |
# Directory to store intermediate files.
|
|
50 | 40 |
# Directory for incoming nzb-files.
|
51 | 41 |
#
|
52 | 42 |
# If a new nzb-file is added to queue via web-interface or RPC-API, it
|
53 | |
# is saved into this directory and then processed by pre-processing
|
|
43 |
# is saved into this directory and then processed by preprocessing
|
54 | 44 |
# script (option <ScanScript>).
|
55 | 45 |
#
|
56 | 46 |
# This directory is also monitored for new nzb-files. If a new file
|
|
79 | 69 |
|
80 | 70 |
# Directory with post-processing and other scripts.
|
81 | 71 |
#
|
|
72 |
# This option may contain multiple directories separated with commas or semicolons.
|
|
73 |
#
|
82 | 74 |
# NOTE: For information on writing scripts visit http://nzbget.net/Extension_scripts.
|
83 | 75 |
ScriptDir=${MainDir}/scripts
|
84 | 76 |
|
|
128 | 120 |
# available on program start.
|
129 | 121 |
RequiredDir=
|
130 | 122 |
|
|
123 |
|
131 | 124 |
##############################################################################
|
132 | 125 |
### NEWS-SERVERS ###
|
133 | 126 |
|
|
167 | 160 |
# Several servers with the same level may be defined, they have
|
168 | 161 |
# the same priority.
|
169 | 162 |
Server1.Level=0
|
|
163 |
|
|
164 |
# This is an optional non-reliable server (yes, no).
|
|
165 |
#
|
|
166 |
# Marking server as optional tells NZBGet to ignore this server if a
|
|
167 |
# connection to this server cannot be established. Normally NZBGet
|
|
168 |
# doesn't try upper-level servers before all servers on current level
|
|
169 |
# were tried. If a connection to server fails NZBGet waits until the
|
|
170 |
# server becomes available (it may try others from current level at this
|
|
171 |
# time). This is usually what you want to avoid exhausting of
|
|
172 |
# (costly) upper level servers if one of main servers is temporary
|
|
173 |
# unavailable. However, for less reliable servers you may prefer to ignore
|
|
174 |
# connection errors and go on with higher-level servers instead.
|
|
175 |
Server1.Optional=no
|
170 | 176 |
|
171 | 177 |
# Group of news server (0-99).
|
172 | 178 |
#
|
|
258 | 264 |
|
259 | 265 |
# IP on which NZBGet server listen and which clients use to contact NZBGet.
|
260 | 266 |
#
|
261 | |
# It could be a dns-hostname (e. g. "mypc") or an ip-address (e. g. "192.168.1.2" or
|
|
267 |
# It could be a dns-hostname (e. g. "mypc") or an IP address (e. g. "192.168.1.2" or
|
262 | 268 |
# "127.0.0.1"). An IP-address is more effective because does not require dns-lookup.
|
263 | 269 |
#
|
264 | 270 |
# Your computer may have multiple network interfaces and therefore multiple IP
|
|
296 | 302 |
|
297 | 303 |
# User name for restricted access.
|
298 | 304 |
#
|
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.
|
|
305 |
# The restricted user can control the program with a few restrictions.
|
|
306 |
# They have access to the web-interface and can see most of the program
|
|
307 |
# settings. They however, can not change program settings, view security
|
|
308 |
# related options or options provided by extension scripts.
|
303 | 309 |
#
|
304 | 310 |
# Use this user to connect to NZBGet from other programs and web-sites.
|
305 | 311 |
#
|
|
427 | 433 |
# is usually supplied by nzb-site or by application accessing
|
428 | 434 |
# NZBGet. Using Aliases you can match their categories with your owns.
|
429 | 435 |
#
|
430 | |
# Separate aliases with commas or semicolons. Use wildcard-characters
|
|
436 |
# Separate aliases with commas or semicolons. Use wildcard characters
|
431 | 437 |
# * and ? for pattern matching.
|
432 | 438 |
#
|
433 | 439 |
# Example: TV - HD, TV - SD, TV*
|
|
475 | 481 |
# [A:|A(options):|R:|Q:|O(options):|#] search-string
|
476 | 482 |
#
|
477 | 483 |
# 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
|
|
484 |
# "A:" can be omitted. If the feed item matches to the rule the
|
479 | 485 |
# item is considered good and no further rules are checked.
|
480 | 486 |
# R - declares Reject-rule. If the feed item matches to the rule the
|
481 | 487 |
# item is considered bad and no further rules are checked.
|
|
531 | 537 |
#
|
532 | 538 |
# + - declares a positive term. Terms are positive by default,
|
533 | 539 |
# the "+" can be omitted;
|
534 | |
# - - declares a negative term. If the term succeed the feed
|
|
540 |
# - - declares a negative term. If the term succeeds the feed
|
535 | 541 |
# item is ignored;
|
536 | 542 |
# field - field to which apply the term. If not specified
|
537 | 543 |
# the default field "title" is used;
|
|
559 | 565 |
# Any newznab attribute (encoded as "newznab:attr" in the RSS feed) can
|
560 | 566 |
# be used as search field with prefix "attr-", for example "attr-genre".
|
561 | 567 |
#
|
562 | |
# Text search (Command @) supports supports wildcard characters * (matches
|
|
568 |
# Text search (Command @) supports wildcard characters * (matches
|
563 | 569 |
# any number of any characters), ? (matches any one character)
|
564 | 570 |
# and # (matches one digit).
|
565 | 571 |
# Text search is by default performed against words (word-search mode): the
|
|
587 | 593 |
# http://nzbget.net/RSS.
|
588 | 594 |
#Feed1.Filter=
|
589 | 595 |
|
|
596 |
# How often to check for new items (minutes).
|
|
597 |
#
|
|
598 |
# Value "0" disables the automatic check of this feed.
|
|
599 |
#Feed1.Interval=15
|
|
600 |
|
590 | 601 |
# Treat all items on first fetch as backlog (yes, no).
|
591 | 602 |
#
|
592 | 603 |
# yes - when the feed is fetched for the very first time (or after
|
593 | 604 |
# changing of URL or filter) all existing items are ignored (marked
|
594 | |
# as backlog). The items found on subsequentional fetches are processed;
|
|
605 |
# as backlog). The items found on subsequent fetches are processed;
|
595 | 606 |
# no - all items are processed even on first fetch (or after
|
596 | 607 |
# changing of URL or filter).
|
597 | 608 |
#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 | 609 |
|
604 | 610 |
# Add nzb-files as paused (yes, no).
|
605 | 611 |
#Feed1.PauseNzb=no
|
|
625 | 631 |
# For more information see global option <FeedScript>.
|
626 | 632 |
#Feed1.FeedScript=
|
627 | 633 |
|
|
634 |
|
628 | 635 |
##############################################################################
|
629 | 636 |
### INCOMING NZBS ###
|
630 | 637 |
|
|
654 | 661 |
# 1) if history contains the same title (see below) with success status
|
655 | 662 |
# the nzb-file is not added to queue;
|
656 | 663 |
# 2) if download queue already contains the same title the nzb-file is
|
657 | |
# added to queue for backup (if firt file fails);
|
|
664 |
# added to queue for backup (if the first file fails);
|
658 | 665 |
# 3) if nzb-file contains duplicate entries. This helps to find errors
|
659 | 666 |
# in bad nzb-files.
|
660 | 667 |
#
|
|
667 | 674 |
# duplicates are deleted from queue.
|
668 | 675 |
#
|
669 | 676 |
# 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
|
|
677 |
# set to "Delete", "Park" or "None". If it is set to "Pause" you will need to
|
671 | 678 |
# manually unpause another duplicate (if any exists in queue).
|
672 | 679 |
#
|
673 | 680 |
# NOTE: For more info on duplicates see http://nzbget.net/RSS.
|
|
704 | 711 |
# download-jobs (nzb-files) itself. Download-jobs are always
|
705 | 712 |
# continued regardless of that option.
|
706 | 713 |
#
|
707 | |
# Disabling this option may slighlty reduce disk access and is
|
|
714 |
# Disabling this option may slightly reduce disk access and is
|
708 | 715 |
# therefore recommended on fast connections.
|
709 | 716 |
ContinuePartial=yes
|
710 | 717 |
|
|
812 | 819 |
# How many retries should be attempted if a download error occurs (0-99).
|
813 | 820 |
#
|
814 | 821 |
# 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
|
|
822 |
# CRC-error the program tries to re-download the article from the same
|
816 | 823 |
# news server as many times as defined in option <Retries>. If all
|
817 | 824 |
# attempts fail the program tries another news server.
|
818 | 825 |
#
|
|
877 | 884 |
# Value "0" disables the check.
|
878 | 885 |
DiskSpace=250
|
879 | 886 |
|
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 | 887 |
# Delete source nzb-file when it is not needed anymore (yes, no).
|
890 | 888 |
#
|
891 | 889 |
# Enable this option for automatic deletion of source nzb-file from
|
|
897 | 895 |
#
|
898 | 896 |
# After download and post-processing the items are added to history where
|
899 | 897 |
# their status can be checked and they can be post-processed again if
|
900 | |
# neccessary.
|
|
898 |
# necessary.
|
901 | 899 |
#
|
902 | 900 |
# After expiring of defined period:
|
903 | 901 |
#
|
904 | 902 |
# If option <DupeCheck> is active the items become hidden and the amount
|
905 | 903 |
# of data kept is significantly reduced (for better performance), only
|
906 | |
# fields necessary for duplicate check are kept. The item remain in the
|
|
904 |
# fields necessary for duplicate check are kept. The item remains in the
|
907 | 905 |
# hidden history (forever);
|
908 | 906 |
#
|
909 | 907 |
# If option <DupeCheck> is NOT active the items are removed from history.
|
|
927 | 925 |
# days. Keeping of items for few days helps in situations when feed provider
|
928 | 926 |
# has technical issues and may response with empty feeds (or with missing
|
929 | 927 |
# 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
|
|
928 |
# feed causing the program to re-download items if they were not found in
|
931 | 929 |
# the feed history.
|
932 | 930 |
FeedHistory=7
|
933 | 931 |
|
|
944 | 942 |
# via URL or fetching of RSS feeds and nzb-files from feeds) are performed
|
945 | 943 |
# even if download is in paused state.
|
946 | 944 |
UrlForce=yes
|
|
945 |
|
|
946 |
# Monthly download volume quota (megabytes).
|
|
947 |
#
|
|
948 |
# During download the quota is constantly monitored and the downloading
|
|
949 |
# is automatically stopped if the limit is reached. Once the next billing month
|
|
950 |
# starts the "quota reached"-status is automatically lifted and the downloading
|
|
951 |
# continues.
|
|
952 |
#
|
|
953 |
# Downloads with force-priority are processed regardless of quota status.
|
|
954 |
#
|
|
955 |
# Value "0" disables monthly quota check.
|
|
956 |
MonthlyQuota=0
|
|
957 |
|
|
958 |
# Day of month when the monthly quota starts (1-31).
|
|
959 |
QuotaStartDay=1
|
|
960 |
|
|
961 |
# Daily download volume quota (megabytes).
|
|
962 |
#
|
|
963 |
# See option <MonthlyQuota> for details.
|
|
964 |
#
|
|
965 |
# Value "0" disables daily quota check.
|
|
966 |
DailyQuota=0
|
947 | 967 |
|
948 | 968 |
|
949 | 969 |
##############################################################################
|
|
1002 | 1022 |
#
|
1003 | 1023 |
# Core-files are very helpful for debugging.
|
1004 | 1024 |
#
|
1005 | |
# NOTE: Core-files may contain sensible data, like your login/password to
|
|
1025 |
# NOTE: Core-files may contain sensitive data, like your login/password to
|
1006 | 1026 |
# newsserver etc.
|
1007 | 1027 |
DumpCore=no
|
1008 | 1028 |
|
|
1013 | 1033 |
# to the log-file and by option "TaskX.Time" in the scheduler settings.
|
1014 | 1034 |
#
|
1015 | 1035 |
# 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
|
|
1036 |
# However, sometimes, especially when using a binary compiled on another
|
1017 | 1037 |
# platform (cross-compiling) the conversion between system and local time
|
1018 | 1038 |
# may not work properly and requires adjustment.
|
1019 | 1039 |
#
|
|
1021 | 1041 |
# Example 1: set time correction to one hour: TimeCorrection=1;
|
1022 | 1042 |
# Example 2: set time correction to one hour and a half: TimeCorrection=90.
|
1023 | 1043 |
TimeCorrection=0
|
1024 | |
|
1025 | |
# See also option <LogFile> in section "PATHS"
|
1026 | 1044 |
|
1027 | 1045 |
|
1028 | 1046 |
##############################################################################
|
|
1069 | 1087 |
# Time to execute the command (HH:MM).
|
1070 | 1088 |
#
|
1071 | 1089 |
# Multiple comma-separated values are accepted.
|
1072 | |
# Asterix as hours-part means "every hour".
|
|
1090 |
# An asterisk placed in the hours location will run every hour.
|
1073 | 1091 |
#
|
1074 | 1092 |
# Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*:00,*:30".
|
1075 | 1093 |
#
|
|
1113 | 1131 |
# Some scheduler commands require additional parameters:
|
1114 | 1132 |
# DownloadRate - download rate limit to be set (kilobytes/sec).
|
1115 | 1133 |
# 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;
|
|
1134 |
# Script - list of scheduler scripts to execute. The scripts in the
|
|
1135 |
# list must be separated with commas or semicolons. All
|
|
1136 |
# scripts must be stored in directory set by option
|
|
1137 |
# <ScriptDir> and paths relative to <ScriptDir> must be
|
|
1138 |
# entered here. For more info see below;
|
1121 | 1139 |
# Process - path to the program to execute and its parameters.
|
1122 | 1140 |
# Example: /home/user/fetch.sh.
|
1123 | 1141 |
# If filename or any parameter contains spaces it
|
1124 | 1142 |
# must be surrounded with single quotation
|
1125 | 1143 |
# marks. If filename/parameter contains single quotation marks,
|
1126 | |
# each of them must be replaced with two single quotation
|
|
1144 |
# each of them must be replaced (escaped) with two single quotation
|
1127 | 1145 |
# marks and the resulting filename/parameter must be
|
1128 | 1146 |
# surrounded with single quotation marks.
|
1129 | 1147 |
# Example: '/home/user/download/my scripts/task process.sh' 'world''s fun'.
|
|
1186 | 1204 |
# the option <ParRepair> is enabled;
|
1187 | 1205 |
# Manual - par-check is skipped. One par2-file is always
|
1188 | 1206 |
# downloaded. If a damaged download is detected, all
|
1189 | |
# par2-files are downloaded but neithet par-check nor par-repair
|
|
1207 |
# par2-files are downloaded but neither par-check nor par-repair
|
1190 | 1208 |
# take place. The download can be then repaired manually,
|
1191 | 1209 |
# eventually on another faster computer.
|
1192 | 1210 |
ParCheck=auto
|
|
1206 | 1224 |
#
|
1207 | 1225 |
# If option <ParCheck> is set to "Auto" or "Force" this option defines
|
1208 | 1226 |
# 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.
|
|
1227 |
# disabled if a computer does not have enough CPU power, since repairing
|
|
1228 |
# may consume too many resources and time on a slow computer.
|
1211 | 1229 |
ParRepair=yes
|
1212 | 1230 |
|
1213 | 1231 |
# What files should be scanned during par-verification (limited, extended,
|
|
1273 | 1291 |
# will ignore files matching this option and will not initiate
|
1274 | 1292 |
# repair. This avoids time costing repair for unimportant files.
|
1275 | 1293 |
#
|
1276 | |
# NOTE: Files matching the option <ExtCleanupDisk> are ignored as well.
|
1277 | |
#
|
1278 | 1294 |
# Example: .sfv, .nzb, .nfo
|
1279 | 1295 |
ParIgnoreExt=.sfv, .nzb, .nfo
|
1280 | 1296 |
|
1281 | |
# What to do if download health drops below critical health (delete,
|
|
1297 |
# What to do if download health drops below critical health (delete, park,
|
1282 | 1298 |
# pause, none).
|
1283 | 1299 |
#
|
1284 | |
# Delete - delete nzb-file from queue. If option <DeleteCleanupDisk>
|
1285 | |
# is active the already downloaded files will be deleted too;
|
|
1300 |
# Delete - delete nzb-file from queue, also delete already downloaded files;
|
|
1301 |
# Park - move nzb-file to history, keep already downloaded files. Commands
|
|
1302 |
# "Download remaining files" and "Retry failed articles" are available
|
|
1303 |
# for this nzb;
|
1286 | 1304 |
# Pause - pause nzb-file;
|
1287 | 1305 |
# None - do nothing (continue download).
|
1288 | 1306 |
#
|
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
|
|
1307 |
# NOTE: For automatic duplicate handling option must be set to "Delete", "Park"
|
|
1308 |
# or "None". If it is set to "Pause" you will need to manually move another
|
|
1309 |
# duplicate from history to queue. See also option <DupeCheck>.
|
|
1310 |
#
|
|
1311 |
# NOTE: When option <ParScan> is set to "Dupe" the park-action is performed
|
1295 | 1312 |
# only if article completion is below 10% (empirical threshold). This is to
|
1296 | 1313 |
# improve efficiency of dupe par scan mode.
|
1297 | |
HealthCheck=delete
|
|
1314 |
HealthCheck=park
|
1298 | 1315 |
|
1299 | 1316 |
# Maximum allowed time for par-repair (minutes).
|
1300 | 1317 |
#
|
|
1312 | 1329 |
# Value "0" means unlimited.
|
1313 | 1330 |
#
|
1314 | 1331 |
# 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
|
|
1332 |
# affect the first stage of parcheck - verification of files. However, the
|
1316 | 1333 |
# verification speed is constant, it doesn't depend on files integrity and
|
1317 | 1334 |
# therefore it is not necessary to limit the time needed for the first stage.
|
1318 | 1335 |
ParTimeLimit=0
|
|
1327 | 1344 |
#
|
1328 | 1345 |
# NOTE: See also options <ScriptPauseQueue> and <UnpackPauseQueue>.
|
1329 | 1346 |
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 | 1347 |
|
1337 | 1348 |
|
1338 | 1349 |
##############################################################################
|
|
1377 | 1388 |
# Switch "x" is added only if neither "x" nor "e" were defined in
|
1378 | 1389 |
# the option (this allows you to use switch "e" instead of "x"). switch
|
1379 | 1390 |
# "-o+" is added only if neither "-o+" nor "-o-" were defined
|
1380 | |
# in the command line. All other paramaters are always added. Parameter
|
|
1391 |
# in the command line. All other parameters are always added. Parameter
|
1381 | 1392 |
# "-p-" is replaced with "-ppassword" if a password is set for nzb-file.
|
1382 | 1393 |
#
|
1383 | 1394 |
# Examples:
|
1384 | |
# 1) ignore file attributes (pemissions):
|
|
1395 |
# 1) ignore file attributes (permissions):
|
1385 | 1396 |
# /usr/bin/unrar x -ai;
|
1386 | 1397 |
# 2) decrease priority of unrar-process:
|
1387 | 1398 |
# nice -n 19 unrar.
|
|
1414 | 1425 |
# extensions, file names or file masks containing wildcard
|
1415 | 1426 |
# characters * and ?.
|
1416 | 1427 |
#
|
1417 | |
# Files listed here are also ignored by par-rename and par-check.
|
1418 | |
#
|
1419 | |
# NOTE: See also option <ParIgnoreExt>.
|
1420 | |
#
|
1421 | 1428 |
# Example: .par2, .sfv
|
1422 | 1429 |
ExtCleanupDisk=.par2, .sfv, _brokenlog.txt
|
1423 | 1430 |
|
|
1434 | 1441 |
# passwords should be set per nzb-file in their post-processing settings.
|
1435 | 1442 |
UnpackPassFile=
|
1436 | 1443 |
|
|
1444 |
|
1437 | 1445 |
##############################################################################
|
1438 | 1446 |
### EXTENSION SCRIPTS ###
|
1439 | 1447 |
|
1440 | 1448 |
# Default list of post-processing scripts to execute after the download
|
1441 | 1449 |
# of nzb-file is completed and possibly par-checked/repaired and unpacked.
|
1442 | 1450 |
#
|
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>.
|
|
1451 |
# The scripts in the list must be separated with commas or semicolons. All
|
|
1452 |
# scripts must be stored in directory set by option <ScriptDir> and
|
|
1453 |
# paths relative to <ScriptDir> must be entered here.
|
1446 | 1454 |
#
|
1447 | 1455 |
# Example: Cleanup.sh, Move.sh, EMail.py.
|
1448 | 1456 |
#
|
|
1470 | 1478 |
#
|
1471 | 1479 |
# NZBGet passes following arguments to post-processing script as environment
|
1472 | 1480 |
# variables:
|
1473 | |
# NZBPP_DIRECTORY - path to destination dir for downloaded files;
|
|
1481 |
# NZBPP_DIRECTORY - path to destination directory for downloaded files;
|
1474 | 1482 |
# NZBPP_NZBNAME - user-friendly name of processed nzb-file as it is displayed
|
1475 | 1483 |
# by the program. The file path and extension are removed.
|
1476 | 1484 |
# 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;
|
|
1485 |
# NZBPP_NZBFILENAME - original name of processed nzb-file. It includes file extension
|
|
1486 |
# and may include full path;
|
|
1487 |
# NZBPP_QUEUEDFILE - full filename of the queued (renamed) nzb-file;
|
1479 | 1488 |
# NZBPP_FINALDIR - final destination path if set by one of previous pp-scripts;
|
1480 | 1489 |
# NZBPP_CATEGORY - category assigned to nzb-file (can be empty string);
|
1481 | 1490 |
# NZBPP_DUPEKEY - duplicate key of nzb-file;
|
|
1547 | 1556 |
# or:
|
1548 | 1557 |
# echo "[NZB] FINALDIR=/path/to/moved/files";
|
1549 | 1558 |
#
|
1550 | |
# Command "DIRECTORY" changes the destiantion path of the download and
|
|
1559 |
# Command "DIRECTORY" changes the destination path of the download and
|
1551 | 1560 |
# affects the scripts executed after the current script as well as the
|
1552 | 1561 |
# program code itself, for example the command "Post-process again"
|
1553 | 1562 |
# will work on new location. Command "FINALDIR" just sets a separate
|
1554 | 1563 |
# 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
|
|
1564 |
# into an existing directory containing other files to avoid the processing
|
1556 | 1565 |
# of those files by other scripts.
|
1557 | 1566 |
#
|
1558 | 1567 |
# To assign post-processing parameters:
|
|
1569 | 1578 |
# 93 - post-process successful (status = SUCCESS);
|
1570 | 1579 |
# 94 - post-process failed (status = FAILURE);
|
1571 | 1580 |
# 95 - post-process skipped (status = NONE). Use this code when you script
|
1572 | |
# terminates immediateley without doing any job and when this is not
|
|
1581 |
# terminates immediately without doing any job and when this is not
|
1573 | 1582 |
# a failure termination;
|
1574 | 1583 |
# 92 - request NZBGet to do par-check/repair for current nzb-file.
|
1575 | 1584 |
#
|
|
1581 | 1590 |
|
1582 | 1591 |
# List of scan scripts to execute before a nzb-file is added to queue.
|
1583 | 1592 |
#
|
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>.
|
|
1593 |
# The scripts in the list must be separated with commas or semicolons. All
|
|
1594 |
# scripts must be stored in directory set by option <ScriptDir> and
|
|
1595 |
# paths relative to <ScriptDir> must be entered here.
|
1587 | 1596 |
#
|
1588 | 1597 |
# The scripts are executed each time a new file is found in incoming
|
1589 | 1598 |
# directory (option <NzbDir>) or a file is received via RPC (web-interface,
|
|
1617 | 1626 |
#
|
1618 | 1627 |
# In addition to these arguments NZBGet passes all nzbget.conf-options
|
1619 | 1628 |
# as environment variables. These variables have prefix "NZBOP_" and
|
1620 | |
# are written in UPPER CASE. For Example option "ParRepair" is passed as
|
|
1629 |
# are written in UPPER CASE. For , the option "ParRepair" is passed as
|
1621 | 1630 |
# environment variable "NZBOP_PARREPAIR". The dots in option names are
|
1622 | 1631 |
# replaced with underscores, for example "SERVER1_HOST". For options
|
1623 | 1632 |
# with predefined possible values (yes/no, etc.) the values are passed
|
|
1698 | 1707 |
|
1699 | 1708 |
# List of queue scripts to execute on queue events.
|
1700 | 1709 |
#
|
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>.
|
|
1710 |
# The scripts in the list must be separated with commas or semicolons. All
|
|
1711 |
# scripts must be stored in directory set by option <ScriptDir> and
|
|
1712 |
# paths relative to <ScriptDir> must be entered here.
|
1704 | 1713 |
#
|
1705 | 1714 |
# The scripts are executed on certain queue events such as adding
|
1706 | 1715 |
# a new nzb-file to queue, etc.
|
|
1708 | 1717 |
# Example: DeleteQueueSamples.sh, NzbAddedNotify.py.
|
1709 | 1718 |
#
|
1710 | 1719 |
# The script can modify the files in download queue (for example
|
1711 | |
# delete or pause all nfo, sfv, sample files) or do something else.
|
|
1720 |
# delete or pause all .nfo, .sfv, sample files) or do something else.
|
1712 | 1721 |
#
|
1713 | 1722 |
# INFO FOR DEVELOPERS:
|
1714 | 1723 |
# NOTE: This is a short documentation, for more information visit
|
|
1717 | 1726 |
# NZBGet passes following arguments to the queue script as environment
|
1718 | 1727 |
# variables:
|
1719 | 1728 |
# NZBNA_NZBNAME - name of nzb-group. This name can be used in calls
|
1720 | |
# to nzbget edit-command using subswitch "-GN name";
|
|
1729 |
# to nzbget edit-command using the subswitch "-GN name";
|
1721 | 1730 |
# NZBNA_FILENAME - filename of the nzb-file. If the file was added
|
1722 | |
# from nzb-directory this is the fullname with path.
|
|
1731 |
# from nzb-directory this is the full name with path.
|
1723 | 1732 |
# If the file was added via web-interface it contains
|
1724 | 1733 |
# only filename without path;
|
1725 | 1734 |
# NZBNA_EVENT - describes why the script was called:
|
|
1730 | 1739 |
# (before post-processing);
|
1731 | 1740 |
# NZB_DELETED - when nzb is deleted from queue (moved
|
1732 | 1741 |
# to history). See NZBNA_DELETESTATUS for details;
|
|
1742 |
# NZB_MARKED - when a history item is marked as good, bad or
|
|
1743 |
# success. See NZBNA_MARKSTATUS for details;
|
1733 | 1744 |
# URL_COMPLETED - after an URL download is completed
|
1734 | 1745 |
# and the downloaded file was not added to queue
|
1735 | 1746 |
# (not nzb-extension, download error, parse
|
|
1737 | 1748 |
# In the future the list of supported events may be
|
1738 | 1749 |
# extended. To avoid conflicts with future NZBGet
|
1739 | 1750 |
# versions the script must exit if the parameter
|
1740 | |
# has a value unknown to the script.
|
|
1751 |
# has a value unknown to the script;
|
|
1752 |
# NZBNA_QUEUEDFILE - full filename of the queued (renamed) nzb-file;
|
1741 | 1753 |
# NZBNA_DELETESTATUS - delete status info, NZBNA_EVENT=NZB_DELETED:
|
1742 | 1754 |
# MANUAL - deleted by user or via API call;
|
1743 | 1755 |
# HEALTH - deleted by health check;
|
|
1753 | 1765 |
# SCAN_SKIPPED - downloaded file doesn't have
|
1754 | 1766 |
# nzb-extension and was skipped;
|
1755 | 1767 |
# SCAN_FAILED - file format error;
|
|
1768 |
# NZBNA_MARKSTATUS - mark status info, NZBNA_EVENT=NZB_MARKED:
|
|
1769 |
# GOOD - marked as good by user or by a script;
|
|
1770 |
# BAD - marked as bad;
|
|
1771 |
# SUCCESS - marked as success;
|
1756 | 1772 |
# NZBNA_CATEGORY - category of nzb-file (if assigned);
|
1757 | 1773 |
# NZBNA_NZBID - id of the nzb-file. This ID can be used with
|
1758 | 1774 |
# calls to nzbget edit-command;
|
|
1763 | 1779 |
#
|
1764 | 1780 |
# In addition to these arguments NZBGet passes all nzbget.conf-options
|
1765 | 1781 |
# to the script as environment variables. These variables have prefix
|
1766 | |
# "NZBOP_" and are written in UPPER CASE. For Example option "ParRepair"
|
|
1782 |
# "NZBOP_" and are written in UPPER CASE. For Example, the option "ParRepair"
|
1767 | 1783 |
# is passed as environment variable "NZBOP_PARREPAIR". The dots in option
|
1768 | 1784 |
# names are replaced with underscores, for example "SERVER1_HOST". For
|
1769 | 1785 |
# options with predefined possible values (yes/no, etc.) the values are
|
|
1781 | 1797 |
#
|
1782 | 1798 |
# To inform NZBGet about bad download:
|
1783 | 1799 |
# echo "[NZB] MARK=BAD";
|
|
1800 |
#
|
|
1801 |
# To set destination directory (only from event "NZB_DOWNLOADED"):
|
|
1802 |
# echo "[NZB] DIRECTORY=/destination/path/for/this/nzb";
|
1784 | 1803 |
#
|
1785 | 1804 |
# Examples of what the script can do:
|
1786 | 1805 |
# 1) pausing nzb-file using file-id:
|
|
1796 | 1815 |
|
1797 | 1816 |
# List of rss feed scripts to execute before a rss feed content is processed.
|
1798 | 1817 |
#
|
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>.
|
|
1818 |
# The scripts in the list must be separated with commas or semicolons. All
|
|
1819 |
# scripts must be stored in directory set by option <ScriptDir> and
|
|
1820 |
# paths relative to <ScriptDir> must be entered here.
|
1802 | 1821 |
#
|
1803 | 1822 |
# If rss feed has option <FeedX.FeedScript> defined (if not empty)
|
1804 | 1823 |
# the scripts defined there override the global option <FeedScript>.
|
|
1832 | 1851 |
# with predefined possible values (yes/no, etc.) the values are passed
|
1833 | 1852 |
# always in lower case.
|
1834 | 1853 |
#
|
|
1854 |
# Return value: NZBGet processes the exit code returned by the script:
|
|
1855 |
# 93 - script successful (status = SUCCESS).
|
|
1856 |
# All other return codes are interpreted as failure (status = FAILURE).
|
|
1857 |
#
|
|
1858 |
# If the script doesn't end with SUCCESS-status the whole content of RSS
|
|
1859 |
# feed is ignored. This is to prevent accidental enqueuing of many
|
|
1860 |
# nzb-files if a feed script unexpectedly terminates before processing
|
|
1861 |
# of the feed.
|
|
1862 |
#
|
1835 | 1863 |
# NOTE: This is a short documentation, for more information visit
|
1836 | 1864 |
# http://nzbget.net/Extension_scripts.
|
1837 | 1865 |
FeedScript=
|
|
1842 | 1870 |
# order defined by this option. Scripts not listed here are executed at
|
1843 | 1871 |
# the end in their alphabetical order.
|
1844 | 1872 |
#
|
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>.
|
|
1873 |
# The scripts in the list must be separated with commas or semicolons. All
|
|
1874 |
# scripts must be stored in directory set by option <ScriptDir> and
|
|
1875 |
# paths relative to <ScriptDir> must be entered here.
|
1848 | 1876 |
#
|
1849 | 1877 |
# Example: Cleanup.sh, Move.sh.
|
1850 | 1878 |
ScriptOrder=
|
|
1856 | 1884 |
#
|
1857 | 1885 |
# NOTE: See also options <ParPauseQueue> and <UnpackPauseQueue>.
|
1858 | 1886 |
ScriptPauseQueue=no
|
|
1887 |
|
|
1888 |
# Shell overrides for script interpreters.
|
|
1889 |
#
|
|
1890 |
# By default extension scripts are executed as normal programs. The system finds
|
|
1891 |
# an associated interpreter automatically. If for some reason that doesn't work
|
|
1892 |
# properly you can provide shell overrides here.
|
|
1893 |
#
|
|
1894 |
# This option contains a comma separated list of shell overrides per
|
|
1895 |
# file extension. A shell override consists of file extension (starting with
|
|
1896 |
# dot) followed by equal sign and the full path to script interpreter.
|
|
1897 |
#
|
|
1898 |
# Example: .py=/usr/bin/python2;.py3=/usr/bin/python3;.sh=/usr/bin/bash.
|
|
1899 |
ShellOverride=
|
1859 | 1900 |
|
1860 | 1901 |
# Minimum interval between calls of queue-scripts (seconds).
|
1861 | 1902 |
#
|