« back to all changes in this revision
Viewing changes to nzbget.conf
- browse files at revision 4
- compare with another revision
- download diff
- download tarball
- view history from revision 4
- Committer: Package Import Robot
- Author(s): Andreas Moog
- Date: 2013-07-18 14:50:28 UTC
- mfrom: (1.1.1)
- Revision ID: package-import@ubuntu.com-20130718145028-qhxse81w1sj5w424
Tags: 11.0+dfsg-1
* New upstream release (Closes: #701896)
* Repackage original tarball to remove copies of jquery and twitter-
bootstrap
* debian/watch: Update for new versioning scheme
* debian/patches: Remove all old patches, add one patch:
- dont-embed-libraries.patch: Don't install embedded jquery and bootstrap
libraries
* debian/combat: Upgrade to debhelper combat 9
* debian/control:
- Fix Vcs-Git field
- Adjust debhelper version for combat level 9
- Add jquery and bootstrap to depends for integrated webserver
- Add python to recommends for post-processing scripts
- Bump build-depends on libpar2-dev to support the cancel function
* debian/links:
- Use the system jquery and bootstrap libraries
* debian/rules:
- Add get-orig-source target to build modified upstream tarball
* Adjust sample nzbget.conf:
- Only listen to 127.0.0.1 instead of 0.0.0.0
- Use nzbget.conf as template for webui configuration
* Adjust sample nzbgetd init file:
- Point to correct location of nzbget binary
* Repackage original tarball to remove copies of jquery and twitter-
bootstrap
* debian/watch: Update for new versioning scheme
* debian/patches: Remove all old patches, add one patch:
- dont-embed-libraries.patch: Don't install embedded jquery and bootstrap
libraries
* debian/combat: Upgrade to debhelper combat 9
* debian/control:
- Fix Vcs-Git field
- Adjust debhelper version for combat level 9
- Add jquery and bootstrap to depends for integrated webserver
- Add python to recommends for post-processing scripts
- Bump build-depends on libpar2-dev to support the cancel function
* debian/links:
- Use the system jquery and bootstrap libraries
* debian/rules:
- Add get-orig-source target to build modified upstream tarball
* Adjust sample nzbget.conf:
- Only listen to 127.0.0.1 instead of 0.0.0.0
- Use nzbget.conf as template for webui configuration
* Adjust sample nzbgetd init file:
- Point to correct location of nzbget binary
- files added:
- .pc/.quilt_patches
- .pc/0001-dont-embed-libraries.patch
- ppscripts
- webui
- webui/img
- webui/lib
- files removed:
- .pc/ac_lang_source.patch
- .pc/fix_fsf_address.patch
- .pc/fix_spelling_error_options.patch
- .pc/link-order.patch
- files modified:
- .pc/applied-patches
- AUTHORS *
- COPYING *
- INSTALL *
- Makefile.cvs *
- NEWS *
- README *
- libpar2-0.2-MSVC8.patch *
- libsigc++-2.0.18-MSVC8.patch *
- nzbget.sln *
- nzbgetd *
added
removed
nzbget.conf
1
# Sample configuration file for NZBGet
2
#
3
# On POSIX put this file to one of the following locations:
4
# ~/.nzbget
5
# /etc/nzbget.conf
6
# /usr/etc/nzbget.conf
7
# /usr/local/etc/nzbget.conf
8
# /opt/etc/nzbget.conf
9
#
10
# On Windows put this file in program's directory.
11
#
12
# You can also put the file into any location, if you specify the path to it
13
# using switch "-c", e.g:
14
# nzbget -c /home/user/myconfig.txt
15
16
# For quick start change the option MainDir and configure one news-server
17
18
19
##############################################################################
20
### PATHS ###
21
22
# Root directory for all tasks.
23
#
24
# On POSIX you can use "~" as alias for home directory (e.g. "~/download").
25
# On Windows use absolute paths (e.g. "C:\Download").
26
MainDir=~/downloads
27
28
# Destination directory for downloaded files.
29
#
30
# If you want to distinguish between partially downloaded files and
31
# completed downloads, use also option <InterDir>.
32
DestDir=${MainDir}/dst
33
34
# Directory to store intermediate files.
35
#
36
# If this option is set (not empty) the files are downloaded into
37
# this directory first. After successful download of nzb-file (possibly
38
# after par-repair) the files are moved to destination directory
39
# (option <DestDir>). If download or unpack fail the files remain in
40
# intermediate directory.
41
#
42
# Using of intermediate directory can significantly improve unpack
43
# performance if you can put intermediate directory (option <InterDir>)
44
# and destination directory (option <DestDir>) on separate physical
45
# hard drives.
46
#
47
# NOTE: If the option <InterDir> is set to empty value the downloaded
48
# files are put directly to destination directory (option <DestDir>).
49
InterDir=
50
51
# Directory to monitor for incoming nzb-jobs.
52
#
53
# Can have subdirectories.
54
# A nzb-file queued from a subdirectory will be automatically assigned to
55
# category with the directory-name.
56
NzbDir=${MainDir}/nzb
57
58
# Directory to store download queue.
59
QueueDir=${MainDir}/queue
60
61
# Directory to store temporary files.
62
TempDir=${MainDir}/tmp
63
64
# Directory with web-interface files.
65
#
66
# Example: /usr/local/share/nzbget/webui.
67
#
68
# NOTE: To disable web-interface set the option to an empty value.
69
# This however doesn't disable the built-in web-server completely because
70
# it is also used to serve JSON-/XML-RPC requests.
71
WebDir=
72
73
# Directory with post-processing scripts.
74
#
75
# NOTE: For information on writing post-processing scripts visit
76
# http://nzbget.sourceforge.net/Post-processing_scripts.
77
ScriptDir=${MainDir}/ppscripts
78
79
# Lock-file for daemon-mode, POSIX only.
80
#
81
# If the option is not empty, NZBGet creates the file and writes process-id
82
# (PID) into it. That info can be used in shell scripts.
83
LockFile=${MainDir}/nzbget.lock
84
85
# Where to store log file, if it needs to be created.
86
#
87
# NOTE: See also option <CreateLog>.
88
LogFile=${DestDir}/nzbget.log
89
90
# Configuration file template.
91
#
92
# Put the path to the example configuration file which comes with
93
# NZBGet. Web-interface needs this file to read option descriptions.
94
#
95
# Do not put here your actual configuration file (typically stored
96
# in your home directory or in /etc/nzbget.conf) but instead the unchanged
97
# example configuration file (typically installed to
98
# /usr/local/share/nzbget/nzbget.conf).
99
#
100
# Example: /usr/local/share/nzbget/nzbget.conf.
101
ConfigTemplate=
102
103
104
##############################################################################
105
### NEWS-SERVERS ###
106
107
# This section defines which servers NZBGet should connect to.
108
#
109
# The servers should be numbered subsequently without holes.
110
# For example if you configure three servers you should name them as Server1,
111
# Server2 and Server3. If you need to delete Server2 later you should also
112
# change the name of Server3 to Server2. Otherwise it will not be properly
113
# read from the config file. Server number doesn't affect its priority (level).
114
115
# Level (priority) of news server (0-99).
116
#
117
# The servers are ordered by their level. NZBGet first tries to download
118
# an article from one (any) of level-0-servers. If that server fails,
119
# NZBGet tries all other level-0-servers. If all servers fail, it proceeds
120
# with the level-1-servers, etc.
121
#
122
# Put your major download servers at level 0 and your fill servers at
123
# levels 1, 2, etc..
124
#
125
# Several servers with the same level may be defined, they have
126
# the same priority.
127
Server1.Level=0
128
129
# Group of news server (0-99).
130
#
131
# If you have multiple accounts with same conditions (retention, etc.)
132
# on the same news server, set the same group (greater than 0) for all
133
# of them. If download fails on one news server, NZBGet does not try
134
# other servers from the same group.
135
#
136
# Value "0" means no group defined (default).
137
Server1.Group=0
138
139
# Host name of news server.
140
Server1.Host=my.newsserver.com
141
142
# Port to connect to (1-65535).
143
Server1.Port=119
144
145
# User name to use for authentication.
146
Server1.Username=user
147
148
# Password to use for authentication.
149
Server1.Password=pass
150
151
# Server requires "Join Group"-command (yes, no).
152
Server1.JoinGroup=no
153
154
# Encrypted server connection (TLS/SSL) (yes, no).
155
#
156
# NOTE: By changing this option you should also change the option <ServerX.Port>
157
# accordingly because unsecure and encrypted connections use different ports.
158
Server1.Encryption=no
159
160
# Cipher to use for encrypted server connection.
161
#
162
# By default (when the option is empty) the underlying encryption library
163
# chooses the cipher automatically. To achieve the best performance
164
# however you can manually select a faster cipher.
165
#
166
# See http://nzbget.sourceforge.net/Choosing_a_cipher for details.
167
#
168
# NOTE: One of the fastest cipher is RC4, it also provides strong 128 bit
169
# encryption. To select it use the cipher string "RC4-MD5" (if NZBGet was
170
# configured to use OpenSSL) or "NONE:+VERS-TLS-ALL:+ARCFOUR-128:+RSA:+MD5:+COMP-ALL"
171
# (if NZBGet was configured to use GnuTLS).
172
#
173
# NOTE: You may get a TLS handshake error if the news server does
174
# not support the chosen cipher. You can also get an error "Could not
175
# select cipher for TLS" if the cipher string is not valid.
176
Server1.Cipher=
177
178
# Maximum number of simultaneous connections to this server (0-999).
179
Server1.Connections=4
180
181
# Second server, on level 0.
182
183
#Server2.Level=0
184
#Server2.Host=my2.newsserver.com
185
#Server2.Port=119
186
#Server2.Username=me
187
#Server2.Password=mypass
188
#Server2.JoinGroup=yes
189
#Server2.Connections=4
190
191
# Third server, on level 1.
192
193
#Server3.Level=1
194
#Server3.Host=fills.newsserver.com
195
#Server3.Port=119
196
#Server3.Username=me2
197
#Server3.Password=mypass2
198
#Server3.JoinGroup=yes
199
#Server3.Connections=1
200
201
202
##############################################################################
203
### REMOTE CONTROL ###
204
205
# IP on which NZBGet server listen and which clients use to contact NZBGet.
206
#
207
# It could be a dns-hostname (e. g. "mypc") or an ip-address (e. g. "192.168.1.2" or
208
# "127.0.0.1"). An IP-address is more effective because does not require dns-lookup.
209
#
210
# Your computer may have multiple network interfaces and therefore multiple IP
211
# addresses. If you want NZBGet to listen to all interfaces and be available from
212
# all IP-addresses use value "0.0.0.0".
213
#
214
# NOTE: When you start NZBGet as client (to send remote commands to NZBGet server) and
215
# the option <ControlIP> is set to "0.0.0.0" the client will use IP "127.0.0.1".
216
#
217
# NOTE: If you set the option to "127.0.0.1" you will be able to connect to NZBGet
218
# only from the computer running NZBGet. This restriction applies to web-interface too.
219
ControlIP=0.0.0.0
220
221
# Port which NZBGet server and remote client use (1-65535).
222
#
223
# NOTE: The communication via this port is not encrypted. For encrypted
224
# communication see option <SecurePort>.
225
ControlPort=6789
226
227
# User name which NZBGet server and remote client use.
228
#
229
# Set to empty value to disable user name check (check only password).
230
#
231
# NOTE: this option was added in NZBGet 11. Older versions used predefined
232
# not changeable user name "nzbget". Third-party tools or web-sites written
233
# for older NZBGet versions may not have an option to define user name. In
234
# this case you should set option <ControlUsername> to the default value
235
# "nzbget" or use empty value.
236
ControlUsername=nzbget
237
238
# Password which NZBGet server and remote client use.
239
#
240
# Set to empty value to disable authorization request.
241
ControlPassword=tegbzn6789
242
243
# Secure control of NZBGet server (yes, no).
244
#
245
# Activate the option if you want to access NZBGet built-in web-server
246
# via HTTPS (web-interface and RPC). You should also provide certificate
247
# and key files, see option <SecureCert> and option <SecureKey>.
248
SecureControl=no
249
250
# Port which NZBGet server and remote client use for encrypted
251
# communication (1-65535).
252
SecurePort=6791
253
254
# Full path to certificate file for encrypted communication.
255
SecureCert=
256
257
# Full path to key file for encrypted communication.
258
SecureKey=
259
260
261
##############################################################################
262
### PERMISSIONS ###
263
264
# User name for daemon-mode, POSIX only.
265
#
266
# Set the user that the daemon normally runs at (POSIX in daemon-mode only).
267
# Set MainDir with an absolute path to be sure where it will write.
268
# This allows NZBGet daemon to be launched in rc.local (at boot), and
269
# download items as a specific user id.
270
#
271
# NOTE: This option has effect only if the program was started from
272
# root-account, otherwise it is ignored and the daemon runs under
273
# current user id.
274
DaemonUsername=root
275
276
# Specify default umask (affects file permissions) for newly created
277
# files, POSIX only (000-1000).
278
#
279
# The value should be written in octal form (the same as for "umask" shell
280
# command).
281
# Empty value or value "1000" disable the setting of umask-mode; current
282
# umask-mode (set via shell) is used in this case.
283
UMask=1000
284
285
286
##############################################################################
287
### INCOMING NZBS ###
288
289
# Create subdirectory with category-name in destination-directory (yes, no).
290
AppendCategoryDir=yes
291
292
# How often incoming-directory (option <NzbDir>) must be checked for new
293
# nzb-files (seconds).
294
#
295
# Value "0" disables the check.
296
NzbDirInterval=5
297
298
# How old nzb-file should at least be for it to be loaded to queue (seconds).
299
#
300
# NZBGet checks if nzb-file was not modified in last few seconds, defined by
301
# this option. That safety interval prevents the loading of files, which
302
# were not yet completely saved to disk, for example if they are still being
303
# downloaded in web-browser.
304
NzbDirFileAge=60
305
306
# Automatic merging of nzb-files with the same filename (yes, no).
307
#
308
# A typical scenario: you put nzb-file into incoming directory, NZBGet adds
309
# file to queue. You find out, that the file doesn't have par-files. You
310
# find required par-files, put nzb-file with the par-files into incoming
311
# directory, NZBGet adds it to queue as a separate group. You want the second
312
# file to be merged with the first for parchecking to work properly. With
313
# option "MergeNzb" NZBGet can merge files automatically. You only need to
314
# save the second file under the same filename as the first one.
315
MergeNzb=no
316
317
# Set path to program, that must be executed before a nzb-file is added
318
# to queue.
319
#
320
# This program is called each time a new file is found in incoming
321
# directory (option <NzbDir>) or a file is received via RPC (web-interface,
322
# command "nzbget --append", etc.).
323
#
324
# Example: ~/nzbprocess.sh.
325
#
326
# That program can unpack archives which were put in incoming directory, make
327
# filename cleanup, change nzb-name, category, priority and post-processing
328
# parameters of the nzb-file or do other things.
329
#
330
# INFO FOR DEVELOPERS:
331
# NZBGet passes following arguments to nzbprocess-program as environment
332
# variables:
333
# NZBNP_DIRECTORY - path to directory, where file is located. It is a directory
334
# specified by the option <NzbDir> or a subdirectory;
335
# NZBNP_FILENAME - name of file to be processed;
336
# NZBNP_NZBNAME - nzb-name (without path but with extension);
337
# NZBNP_CATEGORY - category of nzb-file;
338
# NZBNP_PRIORITY - priority of nzb-file;
339
# NZBNP_TOP - flag indicating that the file will be added to the top
340
# of queue: 0 or 1;
341
# NZBNP_PAUSED - flag indicating that the file will be added as
342
# paused: 0 or 1.
343
#
344
# In addition to these arguments NZBGet passes all
345
# nzbget.conf-options to nzbprocess-program as environment variables. These
346
# variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
347
# option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
348
# The dots in option names are replaced with underscores, for example
349
# "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
350
# the values are passed always in lower case.
351
#
352
# The nzbprocess-script can change nzb-name, category, priority,
353
# post-processing parameters and top-/paused-flags of the nzb-file
354
# by printing special messages into standard output (which is processed
355
# by NZBGet).
356
#
357
# To change nzb-name use following syntax:
358
# echo "[NZB] NZBNAME=my download";
359
#
360
# To change category:
361
# echo "[NZB] CATEGORY=my category";
362
#
363
# To change priority:
364
# echo "[NZB] PRIORITY=signed_integer_value";
365
#
366
# for example: to set priority higher than normal:
367
# echo "[NZB] PRIORITY=50";
368
#
369
# another example: use a negative value for "lower than normal" priority:
370
# echo "[NZB] PRIORITY=-100";
371
#
372
# Although priority can be any integer value, the web-interface operates
373
# with five predefined priorities:
374
# -100 - very low priority;
375
# -50 - low priority;
376
# 0 - normal priority (default);
377
# 50 - high priority;
378
# 100 - very high priority.
379
#
380
# To assign post-processing parameters:
381
# echo "[NZB] NZBPR_myvar=my value";
382
#
383
# The prefix "NZBPR_" will be removed. In this example a post-processing
384
# parameter with name "myvar" and value "my value" will be associated
385
# with nzb-file.
386
#
387
# To change top-flag (nzb-file will be added to the top of queue):
388
# echo "[NZB] TOP=1";
389
#
390
# To change paused-flag (nzb-file will be added in paused state):
391
# echo "[NZB] PAUSED=1";
392
#
393
# The nzbprocess-script can delete processed file, rename it or move somewhere.
394
# After the calling of the script the file will be either added to queue
395
# (if it was an nzb-file) or renamed by adding the extension ".processed".
396
#
397
# NOTE: Files with extensions ".processed", ".queued" and ".error" are skipped
398
# during the directory scanning.
399
#
400
# NOTE: Files with extension ".nzb_processed" are not passed to
401
# NzbProcess-script before adding to queue. This feature allows
402
# NzbProcess-script to prevent the scanning of nzb-files extracted from
403
# archives, if they were already processed by the script.
404
#
405
# NOTE: Files added via RPC calls in particular from web-interface are
406
# saved into incoming nzb-directory and then processed by the script.
407
NzbProcess=
408
409
# Set path to program, that must be executed after a nzb-file is added
410
# to queue.
411
#
412
# This program is called each time a new nzb-file is added to queue.
413
#
414
# Example: ~/nzbaddedprocess.sh.
415
#
416
# That program can modify the files in download queue (for example
417
# delete or pause all nfo, sfv, sample files) or do something else.
418
#
419
# INFO FOR DEVELOPERS:
420
# NZBGet passes following arguments to nzbaddedprocess-program as environment
421
# variables:
422
# NZBNA_NZBNAME - name of nzb-group. This name can be used in calls
423
# to nzbget edit-command using subswitch "-GN name";
424
# NZBNA_FILENAME - filename of the nzb-file. If the file was added
425
# from nzb-directory this is the fullname with path.
426
# If the file was added via web-interface it contains
427
# only filename without path;
428
# NZBNA_CATEGORY - category of nzb-file (if assigned);
429
# NZBNA_LASTID - the id of the last file in the nzb-file. This ID can
430
# be used with calls to nzbget edit-command;
431
# NZBNA_PRIORITY - priority (default is 0).
432
#
433
# In addition to these arguments NZBGet passes all
434
# nzbget.conf-options to nzbaddedprocess-program as environment variables. These
435
# variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
436
# option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR".
437
# The dots in option names are replaced with underscores, for example
438
# "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
439
# the values are passed always in lower case.
440
#
441
# Examples:
442
# 1) pausing nzb-file using file-id:
443
# "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E G P $NZBNA_LASTID;
444
# 2) setting category using nzb-name:
445
# "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E GN K "my cat" "$NZBNA_NZBNAME";
446
# 3) pausing files with extension "nzb":
447
# "$NZBOP_APPBIN" -c "$NZBOP_CONFIGFILE" -E FR P "$NZBNA_NZBNAME/.*\.nzb";
448
NzbAddedProcess=
449
450
# Check for duplicate files (yes, no).
451
#
452
# If this option is enabled the program checks by adding of a new nzb-file:
453
# 1) if nzb-file contains duplicate entries. This check aims on detecting
454
# of reposted files (if first file was not fully uploaded).
455
# If the program find two files with identical names, only the
456
# biggest of these files will be added to queue;
457
# 2) if download queue already contains file with the same name;
458
# 3) if destination file on disk already exists.
459
# In last two cases: if the file exists it will not be added to queue.
460
#
461
# If this option is disabled, all files are downloaded and duplicate files
462
# are renamed to "filename_duplicate1".
463
# Existing files are never deleted or overwritten.
464
DupeCheck=yes
465
466
467
##############################################################################
468
### DOWNLOAD QUEUE ###
469
470
# Save download queue to disk (yes, no).
471
#
472
# This allows to reload it on next start.
473
SaveQueue=yes
474
475
# Reload download queue on start, if it exists (yes, no).
476
ReloadQueue=yes
477
478
# Reload url-queue on start, if it exists (yes, no).
479
#
480
# For this option to work the options <SaveQueue> and <ReloadQueue> must
481
# be also enabled.
482
ReloadUrlQueue=yes
483
484
# Reload Post-processor-queue on start, if it exists (yes, no).
485
#
486
# For this option to work the options <SaveQueue> and <ReloadQueue> must
487
# be also enabled.
488
ReloadPostQueue=yes
489
490
# Reuse articles saved in temp-directory from previous program start (yes, no).
491
#
492
# This allows to continue download of file, if program was exited before
493
# the file was completed.
494
ContinuePartial=yes
495
496
# Decode articles (yes, no).
497
#
498
# yes - decode articles using internal decoder (supports yEnc and UU formats);
499
# no - the articles will not be decoded and joined. Useful for debugging to
500
# look at article's source text.
501
Decode=yes
502
503
# Write decoded articles directly into destination output file (yes, no).
504
#
505
# Files are posted to Usenet within artilce bodies. Each file typically
506
# requires hundreds of articles.
507
#
508
# When option <DirectWrite> is disabled, the program downloads all articles
509
# into temporary directory and then combine them into destination file.
510
#
511
# With this option enabled the program at first creates the output
512
# destination file with required size (total size of all articles),
513
# then writes on the fly decoded articles directly to the file
514
# without creating of any temporary files.
515
#
516
# This may improve performance but depends on OS and file system ability to
517
# instantly create large files without initializing them with nulls. Such
518
# files are called sparse files and are supported by modern file systems
519
# like EXT3 on Linux or NTFS on Windows.
520
#
521
# Using of this option reduces disk operations but may produce more fragmented
522
# files (depends on disk driver), which may slow down the post-processing.
523
# It's recommended to test how the option behave on your platform to find the
524
# best setting.
525
#
526
# INFO: a particular test on a Linux router with EXT3-partition showed that
527
# activating of this option results in up to 20% better performance during
528
# downloading.
529
#
530
# NOTE: For test try to download few big nzb-collections (each 4GB or more)
531
# and measure the time used for downloading and post-processing (use timestamps
532
# in a log-file to determine when the post-processing was ended).
533
#
534
# NOTE: When option <DirectWrite> is enabled the temporary directory (option
535
# <TempDir>) must be located on the same partition with destination directory
536
# (option DestDir>) for better performance. If option <DirectWrite> is disabled
537
# it's better to use different drives for temporary and destination directories.
538
#
539
# NOTE: If both options <DirectWrite> and <ContinuePartial> are enabled,
540
# the program still creates empty article-files in temp-directory. They are used
541
# by the option <ContinuePartial> to check if a certain article was downloaded.
542
# To minimize disk-io it is recommended to disable option <ContinuePartial>,
543
# if <DirectWrite> is enabled. Especially on a fast connections (where you
544
# would want to activate <DirectWrite>) it should not be a problem to redownload
545
# an interrupted file.
546
DirectWrite=yes
547
548
# Check CRC of downloaded and decoded articles (yes, no).
549
#
550
# Normally this option should be enabled for better detecting of download
551
# errors. However checking of CRC needs CPU time. On a fast connection and
552
# slow CPU disabling of CRC-Check may improve performance.
553
CrcCheck=yes
554
555
# How many retries should be attempted if a download error occurs (0-99).
556
#
557
# 1) If download fails because of "article or group not found error" the
558
# program tries another news server.
559
#
560
# 2) If download fails because of interrupted connection, the program
561
# tries the same server again until connection can be established.
562
#
563
# In both cases 1) and 2) option <Retries> is not used.
564
#
565
# If download however fails because of incomplete article, CRC-error or other
566
# error not mentioned above the program tries to redownload the article from
567
# the same news server as many times as defined in option <Retries>. If all
568
# attempts fail the program tries another news server.
569
Retries=3
570
571
# Set the interval between retries (seconds).
572
RetryInterval=10
573
574
# Set connection timeout (seconds).
575
ConnectionTimeout=60
576
577
# Timeout until a download-thread should be killed (seconds).
578
#
579
# This can help on hanging downloads, but is dangerous.
580
# Do not use small values!
581
TerminateTimeout=600
582
583
# Set the maximum download rate on program start (kilobytes/sec).
584
#
585
# Value "0" means no speed control.
586
# The download rate can be changed later via remote calls.
587
DownloadRate=0
588
589
# Accurate speed rate calculation (yes, no).
590
#
591
# During downloading using several connections the download threads may
592
# interfere with each other when updating statistical data for speed
593
# meter. This may cause small errors in current download speed reported
594
# by the program. The speed meter recovers automatically from such errors
595
# after max. 30 seconds (time window used for speed calculation).
596
#
597
# Enable the option to use thread synchronisation mechanisms in order to
598
# provide absolutely accurate speed calculations.
599
#
600
# NOTE: Thread synchronisation increases CPU load and therefore can
601
# decrease download speed. Do not activate this option on computers with
602
# limited CPU power. Before activating the option it is recommended to
603
# run tests to determine how the option affects the CPU usage and the
604
# download speed on a particular system.
605
AccurateRate=no
606
607
# Set the size of memory buffer used by writing the articles (bytes).
608
#
609
# Bigger values decrease disk-io, but increase memory usage.
610
# Value "0" causes an OS-dependent default value to be used.
611
# With value "-1" (which means "max/auto") the program sets the size of
612
# buffer according to the size of current article (typically less than 500K).
613
#
614
# NOTE: The value must be written in bytes, do not use postfixes "K" or "M".
615
#
616
# NOTE: To calculate the memory usage multiply WriteBufferSize by max number
617
# of connections, configured in section "NEWS-SERVERS".
618
#
619
# NOTE: Typical article's size not exceed 500000 bytes, so using bigger values
620
# (like several megabytes) will just waste memory.
621
#
622
# NOTE: For desktop computers with large amount of memory value "-1" (max/auto)
623
# is recommended, but for computers with very low memory (routers, NAS)
624
# value "0" (default OS-dependent size) could be better alternative.
625
#
626
# NOTE: Write-buffer is managed by OS (system libraries) and therefore
627
# the effect of the option is highly OS-dependent.
628
WriteBufferSize=0
629
630
# Pause if disk space gets below this value (megabytes).
631
#
632
# Value "0" disables the check.
633
# Only the disk space on the drive with <DestDir> is checked.
634
# The drive with <TempDir> is not checked.
635
DiskSpace=250
636
637
# Delete already downloaded files from disk, if the download of nzb-file was
638
# cancelled (nzb-file was deleted from queue) (yes, no).
639
#
640
# NOTE: NZBGet does not delete files in a case if all remaining files in
641
# queue are par-files. That prevents the accidental deletion if the option
642
# <ParCleanupQueue> is disabled or if the program was interrupted during
643
# parcheck and later restarted without reloading of post queue (option
644
# <ReloadPostQueue> disabled).
645
DeleteCleanupDisk=no
646
647
# Keep the history of downloaded nzb-files (days).
648
#
649
# Value "0" disables the history.
650
#
651
# NOTE: When a collection having paused files is added to history all remaining
652
# files are moved from download queue to a list of parked files. It holds files
653
# which could be required later if the collection will be moved back to
654
# download queue for downloading of remaining files. The parked files still
655
# consume some amount of memory and disk space. If the collection was downloaded
656
# and successfully par-checked or postprocessed it is recommended to discard the
657
# unneeded parked files before adding the collection to history. For par2-files
658
# that can be achieved with the option <ParCleanupQueue>.
659
KeepHistory=7
660
661
# Maximum number of simultaneous connections for nzb URL downloads (0-999).
662
#
663
# When NZB-files are added to queue via URL, the program downloads them
664
# from the specified URL. The option limits the maximal number of connections
665
# used for this purpose, when multiple URLs were added at the same time.
666
UrlConnections=4
667
668
669
##############################################################################
670
### CATEGORIES ###
671
672
# This section defines categories available in web-interface.
673
674
# Category name.
675
#
676
# Each nzb-file can be assigned to a category.
677
# Category name is passed to post-processing script and can be used by it
678
# to perform category specific processing.
679
Category1.Name=Movies
680
681
# Destination directory for this category.
682
#
683
# If this option is empty, then the default destination directory
684
# (option <DestDir>) is used. In this case if the option <AppendCategoryDir>
685
# is active, the program creates a subdirectory with category name within
686
# destination directory.
687
Category1.DestDir=
688
689
# Default list of post-processing scripts.
690
#
691
# For more information see global option <DefScript>.
692
Category1.DefScript=
693
694
Category2.Name=Series
695
Category3.Name=Music
696
Category4.Name=Software
697
698
699
##############################################################################
700
### LOGGING ###
701
702
# Create log file (yes, no).
703
CreateLog=yes
704
705
# Delete log file upon server start (only in server-mode) (yes, no).
706
ResetLog=no
707
708
# How error messages must be printed (screen, log, both, none).
709
ErrorTarget=both
710
711
# How warning messages must be printed (screen, log, both, none).
712
WarningTarget=both
713
714
# How info messages must be printed (screen, log, both, none).
715
InfoTarget=both
716
717
# How detail messages must be printed (screen, log, both, none).
718
DetailTarget=both
719
720
# How debug messages must be printed (screen, log, both, none).
721
#
722
# Debug-messages can be printed only if the program was compiled in
723
# debug-mode: "./configure --enable-debug".
724
DebugTarget=both
725
726
# Number of messages stored in buffer and available for remote
727
# clients (messages).
728
LogBufferSize=1000
729
730
# Create a log of all broken files (yes ,no).
731
#
732
# It is a text file placed near downloaded files, which contains
733
# the names of broken files.
734
CreateBrokenLog=yes
735
736
# Create memory dump (core-file) on abnormal termination, Linux only (yes, no).
737
#
738
# Core-files are very helpful for debugging.
739
#
740
# NOTE: Core-files may contain sensible data, like your login/password to
741
# newsserver etc.
742
DumpCore=no
743
744
# See also option <LogFile> in section "PATHS"
745
746
747
##############################################################################
748
### DISPLAY (TERMINAL) ###
749
750
# Set screen-outputmode (loggable, colored, curses).
751
#
752
# loggable - only messages will be printed to standard output;
753
# colored - prints messages (with simple coloring for messages categories)
754
# and download progress info; uses escape-sequences to move cursor;
755
# curses - advanced interactive interface with the ability to edit
756
# download queue and various output option.
757
OutputMode=curses
758
759
# Shows NZB-Filename in file list in curses-outputmode (yes, no).
760
#
761
# This option controls the initial state of curses-frontend,
762
# it can be switched on/off in run-time with Z-key.
763
CursesNzbName=yes
764
765
# Show files in groups (NZB-files) in queue list in curses-outputmode (yes, no).
766
#
767
# This option controls the initial state of curses-frontend,
768
# it can be switched on/off in run-time with G-key.
769
CursesGroup=no
770
771
# Show timestamps in message list in curses-outputmode (yes, no).
772
#
773
# This option controls the initial state of curses-frontend,
774
# it can be switched on/off in run-time with T-key.
775
CursesTime=no
776
777
# Update interval for Frontend-output in console mode or remote client
778
# mode (milliseconds).
779
#
780
# Min value 25. Bigger values reduce CPU usage (especially in curses-outputmode)
781
# and network traffic in remote-client mode.
782
UpdateInterval=200
783
784
785
##############################################################################
786
### SCHEDULER ###
787
788
# This section defines scheduler commands.
789
# For each command create a set of options <TaskX.Time>, <TaskX.Command>,
790
# <TaskX.WeekDays> and <TaskX.DownloadRate>.
791
# The following example shows how to throttle downloads in the daytime
792
# by 100 KB/s and download at full speed overnights:
793
794
# Time to execute the command (HH:MM).
795
#
796
# Multiple comma-separated values are accepted.
797
# Asterix as hours-part means "every hour".
798
#
799
# Examples: "08:00", "00:00,06:00,12:00,18:00", "*:00", "*:00,*:30".
800
#Task1.Time=08:00
801
802
# Week days to execute the command (1-7).
803
#
804
# Comma separated list of week days numbers.
805
# 1 is Monday.
806
# Character '-' may be used to define ranges.
807
#
808
# Examples: "1-7", "1-5", "5,6", "1-5, 7".
809
#Task1.WeekDays=1-7
810
811
# Command to be executed (DownloadRate, PauseDownload, UnpauseDownload, PauseScan,
812
# UnpauseScan, Process).
813
#
814
# Possible commands:
815
# DownloadRate - sets download rate in KB/s;
816
# PauseDownload - pauses download;
817
# UnpauseDownload - resumes download;
818
# PauseScan - pauses scan of incoming nzb-directory;
819
# UnpauseScan - resumes scan of incoming nzb-directory;
820
# Process - executes external program.
821
#Task1.Command=DownloadRate
822
823
# Download rate to be set if the command is "DownloadRate" (kilobytes/sec).
824
#
825
# Value "0" means no speed control.
826
#
827
# If the option <TaskX.Command> is not set to "DownloadRate" this option
828
# is ignored and can be omitted.
829
#Task1.DownloadRate=100
830
831
# Path to the program to execute if the command is "Process".
832
#
833
# Example: /home/user/fetch-nzb.sh.
834
#
835
# If the option <TaskX.Command> is not set to "Process" this option
836
# is ignored and can be omitted.
837
#
838
# NOTE: It's allowed to add parameters to command line. If filename or
839
# any parameter contains spaces it must be surrounded with single quotation
840
# marks. If filename/parameter contains single quotation marks, each of them
841
# must be replaced with two single quotation marks and the resulting filename/
842
# parameter must be surrounded with single quotation marks.
843
# Example: '/home/user/download/my scripts/task process.sh' 'world''s fun'.
844
# In this example one parameter (world's fun) is passed to the script
845
# (task process.sh).
846
#Task1.Process=/home/user/script.sh
847
848
#Task2.Time=20:00
849
#Task2.WeekDays=1-7
850
#Task2.Command=DownloadRate
851
#Task2.DownloadRate=0
852
853
854
##############################################################################
855
### PAR CHECK/REPAIR ###
856
857
# Whether and how par-verification must be performed (auto, force, manual).
858
#
859
# Auto - par-check is performed when needed. One par2-file is always
860
# downloaded. Additional par2-files are downloaded if needed
861
# for repair. Repair is performed if the option <ParRepair>
862
# is enabled;
863
# Force - force par-check for every download (even undamaged). All
864
# par2-files are always downloaded. Repair is performed if
865
# the option <ParRepair> is enabled;
866
# Manual - par-check is skipped. One par2-file is always
867
# downloaded. If a damaged download is detected, all
868
# par2-files are downloaded but neithet par-check nor par-repair
869
# take place. The download can be then repaired manually
870
# (possibly on another, faster computer).
871
ParCheck=auto
872
873
# Automatic par-repair after par-verification (yes, no).
874
#
875
# If option <ParCheck> is set to "Auto" or "Force" this option defines
876
# if the download must be repaired when needed. The option can be
877
# disabled if computer does not have enough CPU power, since repairing
878
# may take too much resources and time on a slow computers.
879
ParRepair=yes
880
881
# What files should be scanned during par-verification (limited,
882
# full, auto).
883
#
884
# Limited - scan only files belonging to the par-set;
885
# Full - scan all files in the directory. This helps if the
886
# files were renamed after creating of par-set;
887
# Auto - a limited scan is performed first. If the par-checker
888
# detects missing files, it scans other files in the
889
# directory until all required files are found.
890
#
891
# NOTE: for par-check/repair NZBGet uses library libpar2. The last and
892
# widely used version 0.2 of the library has few bugs, sometimes causing
893
# a crash of the program. This is especially true when using "full" or
894
# "auto" par-scan. NZBGet is supplied with patches addressing these
895
# issues. Please apply the patches to libpar2 and recompile it.
896
ParScan=auto
897
898
# Use only par2-files with matching names (yes, no).
899
#
900
# If par-check needs extra par-blocks it looks for paused par2-files
901
# in the download queue. These par2-files should have the same base name
902
# as the main par2-file, currently loaded in par-checker. Sometimes extra
903
# par2-files have non-matching names (especially if they were uploaded
904
# by a different poster). Normally par-checker does not use these files, but
905
# you can allow it to use them by setting <StrictParName> to "no".
906
# There is a small side effect then: if NZB-file contains more than one
907
# collection of files (with different par-sets), par-checker may download
908
# par2-files from a wrong collection and will need to unpause other
909
# par2-files until all required files are downloaded. This increases the
910
# traffic (but not harm the par-check).
911
#
912
# NOTE: Par-checker always uses only par-files added from the same NZB-file
913
# and the option <StrictParName> does not change this behavior.
914
StrictParName=yes
915
916
# Maximum allowed time for par-repair (minutes).
917
#
918
# Value "0" means unlimited.
919
#
920
# If you use NZBGet on a very slow computer like NAS-device, it may be good to
921
# limit the time allowed for par-repair. NZBGet calculates the estimated time
922
# required for par-repair. If the estimated value exceeds the limit defined
923
# here, NZBGet cancels the repair.
924
#
925
# To avoid a false cancellation NZBGet compares the estimated time with
926
# <ParTimeLimit> after the first 5 minutes of repairing, when the calculated
927
# estimated time is more or less accurate. But in a case if <ParTimeLimit> is
928
# set to a value smaller than 5 minutes, the comparison is made after the first
929
# whole minute.
930
#
931
# NOTE: The option limits only the time required for repairing. It doesn't
932
# affect the first stage of parcheck - verification of files. However the
933
# verification speed is constant, it doesn't depend on files integrity and
934
# therefore it is not necessary to limit the time needed for the first stage.
935
#
936
# NOTE: This option requires an extended version of libpar2 (the original
937
# version doesn't support the cancelling of repairing). Please refer to
938
# NZBGet's README for info on how to apply the patch to libpar2.
939
ParTimeLimit=0
940
941
# Pause download queue during check/repair (yes, no).
942
#
943
# Enable the option to give CPU more time for par-check/repair. That helps
944
# to speed up check/repair on slow CPUs with fast connection (e.g. NAS-devices).
945
#
946
# NOTE: If parchecker needs additional par-files it temporarily unpauses
947
# the queue.
948
#
949
# NOTE: See also options <ScriptPauseQueue> and <UnpackPauseQueue>.
950
ParPauseQueue=no
951
952
# Cleanup download queue after successful check/repair (yes, no).
953
#
954
# Enable this option for automatic deletion of unneeded (paused) par-files
955
# from download queue after successful check/repair.
956
ParCleanupQueue=yes
957
958
# Delete source nzb-file after successful check/repair (yes, no).
959
#
960
# Enable this option for automatic deletion of nzb-file from incoming directory
961
# after successful check/repair.
962
NzbCleanupDisk=no
963
964
# Files to delete after successful check/repair.
965
#
966
# List of file extensions or file names to delete after successful
967
# check/repair. The entries must be separated with commas. The entries
968
# can be file extensions or any text the file name may end with.
969
#
970
# Example: .par2, .sfv
971
ExtCleanupDisk=.par2, .sfv, _brokenlog.txt
972
973
974
##############################################################################
975
### UNPACK ###
976
977
# Unpack downloaded nzb-files (yes, no).
978
#
979
# If the download is damaged and could not be repaired using par-files
980
# the unpacking is not performed.
981
#
982
# If the option <ParCheck> is disabled the program will try to unpack
983
# downloaded files first. If the unpacking fails the par-check/repair
984
# is performed and the unpack will be executed again.
985
Unpack=yes
986
987
# Pause download queue during unpack (yes, no).
988
#
989
# Enable the option to give CPU more time for unpacking. That helps
990
# to speed up unpacking on slow CPUs.
991
#
992
# NOTE: See also options <ParPauseQueue> and <ScriptPauseQueue>.
993
UnpackPauseQueue=no
994
995
# Delete archive files after successful unpacking (yes, no).
996
UnpackCleanupDisk=yes
997
998
# Full path to unrar executable.
999
#
1000
# Example: /usr/bin/unrar.
1001
#
1002
# If unrar is in your PATH you may leave the path part and set only
1003
# the executable name ("unrar" on POSIX or "unrar.exe" on Windows).
1004
UnrarCmd=unrar
1005
1006
# Full path to 7-Zip executable.
1007
#
1008
# Example: /usr/bin/7z.
1009
#
1010
# If 7-Zip binary is in your PATH you may leave the path part and set only
1011
# the executable name ("7z" or "7za" on POSIX or "7z.exe" on Windows).
1012
SevenZipCmd=7z
1013
1014
1015
##############################################################################
1016
### POST-PROCESSING SCRIPTS ###
1017
1018
# Default list of post-processing scripts to execute after the download
1019
# of nzb-file is completed and possibly par-checked/repaired and unpacked,
1020
# depending on other options.
1021
#
1022
# The scripts in the list must be separated with commas or semicolons. Only
1023
# filenames without path must be used. All scripts must be stored in directory
1024
# pointed by option <ScriptDir>.
1025
#
1026
# Example: Cleanup.sh, Move.sh, EMail.py.
1027
#
1028
# Each download (nzb-file) has its own list of post-processing scripts. The option
1029
# <DefScript> is the default value assigned to download when it is added to
1030
# queue. The list of post-processing scripts for a particular download can be
1031
# changed in the edit dialog in web-interface or using remote command "--edit/-E".
1032
#
1033
# When nzb-file is added to queue it can have a category assigned to it. In this
1034
# case the option <CategoryX.DefScript> (if not empty) overrides the
1035
# global option <DefScript>.
1036
#
1037
# NOTE: The script execution order is controlled by option <ScriptOrder>, not
1038
# by their order in option <DefScript>.
1039
#
1040
# NOTE: Changing options <DefScript> and <CategoryX.DefScript> doesn't affect
1041
# already queued downloads.
1042
#
1043
# NOTE: For the list of interesting post-processing scripts see
1044
# http://nzbget.sourceforge.net/Catalog_of_post-processing_scripts.
1045
#
1046
# INFO FOR DEVELOPERS:
1047
# NOTE: This is a short documentation, for more information visit
1048
# http://nzbget.sourceforge.net/Post-processing_scripts.
1049
#
1050
# NZBGet passes following arguments to post-processing script as environment
1051
# variables:
1052
# NZBPP_DIRECTORY - path to destination dir for downloaded files;
1053
# NZBPP_NZBNAME - user-friendly name of processed nzb-file as it is displayed
1054
# by the program. The file path and extension are removed.
1055
# If download was renamed, this parameter reflects the new name;
1056
# NZBPP_NZBFILENAME - name of processed nzb-file. It includes file extension and also
1057
# may include full path;
1058
# NZBPP_CATEGORY - category assigned to nzb-file (can be empty string);
1059
# NZBPP_PARSTATUS - result of par-check:
1060
# 0 = not checked: par-check is disabled or nzb-file does
1061
# not contain any par-files;
1062
# 1 = checked and failed to repair;
1063
# 2 = checked and successfully repaired;
1064
# 3 = checked and can be repaired but repair is disabled;
1065
# 4 = par-check needed but skipped (option ParCheck=manual);
1066
# NZBPP_UNPACKSTATUS - result of unpack:
1067
# 0 = unpack is disabled or was skipped due to nzb-file
1068
# properties or due to errors during par-check;
1069
# 1 = unpack failed;
1070
# 2 = unpack successful.
1071
#
1072
# If the script defines own options they are also passed as environment
1073
# variables. These variables have prefix "NZBPO_" in their names. For
1074
# example, option "myoption" will be passed as environment variable
1075
# "NZBPO_myoption" and in addition in uppercase as "NZBPO_MYOPTION".
1076
#
1077
# If the script defines own post-processing parameters, they are also passed as
1078
# environment variables. These variables have prefix "NZBPR_" in their
1079
# names. For example, pp-parameter "myparam" will be passed as environment
1080
# variable "NZBPR_myparam" and in addition in uppercase as "NZBPR_MYPARAM".
1081
#
1082
# In addition to arguments, pp-options and pp-parameters NZBGet passes all
1083
# nzbget.conf-options to pp-script as environment variables. These
1084
# variables have prefix "NZBOP_" and are written in UPPER CASE. For Example
1085
# option "ParRepair" is passed as environment variable "NZBOP_PARREPAIR". The
1086
# dots in option names are replaced with underscores, for example
1087
# "SERVER1_HOST". For options with predefined possible values (yes/no, etc.)
1088
# the values are passed always in lower case.
1089
#
1090
# Return value: NZBGet processes the exit code returned by the script:
1091
# 93 - post-process successful (status = SUCCESS);
1092
# 94 - post-process failed (status = FAILURE);
1093
# 95 - post-process skipped (status = NONE). Use this code when you script
1094
# terminates immediateley without doing any job and when this is not
1095
# a failure termination;
1096
# 92 - request NZBGet to do par-check/repair for current nzb-file.
1097
#
1098
# All other return codes are interpreted as failure (status = FAILURE).
1099
#
1100
# NOTE: This is a short documentation, for more information visit
1101
# http://nzbget.sourceforge.net/Post-processing_scripts.
1102
DefScript=
1103
1104
# Execution order for scripts.
1105
#
1106
# If you assign multiple scripts to one nzb-file, they are executed in the
1107
# order defined by this option. Scripts not listed here are executed at
1108
# the end in their alphabetical order.
1109
#
1110
# The scripts in the list must be separated with commas or semicolons. Only
1111
# filenames without path must be used. All scripts must be stored in directory
1112
# pointed by option <ScriptDir>.
1113
#
1114
# Example: Cleanup.sh, Move.sh.
1115
ScriptOrder=
1116
1117
# Pause download queue during executing of postprocess-script (yes, no).
1118
#
1119
# Enable the option to give CPU more time for postprocess-script. That helps
1120
# to speed up postprocess on slow CPUs with fast connection (e.g. NAS-devices).
1121
#
1122
# NOTE: See also options <ParPauseQueue> and <UnpackPauseQueue>.
1123
ScriptPauseQueue=no
Loggerhead is a web-based interface for Breezy
Version: 2.0.1