forked from pzs-ng/pzs-ng
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.ZSCONFIG
1749 lines (1440 loc) · 65.8 KB
/
README.ZSCONFIG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
ZSCONFIG.H - A GUIDE
---------------------
zsconfig.h can include a number of options. Starting with pzs-ng beta 4, the
settings in zsconfig.h are overrides, meaning that not all of these settings
need be in zsconfig.h. Only the ones you change should be put there.
This provide a very flexible configuration, and upgrades should be less of a
hassle, since new settings in the config is no longer a concern - they will
be used with default settings.
Here follow a summary of all settings. I hope this will provide some idea on
what the different things does. The format is as follow:
<define> <option(s)>
Description
Default: <value>
To add a define, for instance sitepath_dir, put the following in you zsconfig.h
#define sitepath_dir "/mysite/"
ie, add '#define" in front, and the option(s) behind.
-------------------------------------------------------------------------------
BAD_CRC <STRING>
Error msg when crc check fails.
Default: "CRC-Check: BAD!"
BAD_ZIP <STRING>
Error msg when zip integrity fails.
Default: "ZiP-Integrity: BAD!"
BANNED_BITRATE <STRING>
Error msg when bitrate of musicfile is banned.
%s = bitrate
Default: "%s kbit codec is not allowed here!"
BANNED_FILE <STRING>
Error msg when file is listed as banned.
Default: "Banned file: Not allowed!"
BANNED_GENRE <STRING>
Error msg when musicfile is of a banned genre.
%s = genre
Default: "%s is banned here!"
BANNED_YEAR <STRING>
Error msg when musicfile is from a banned year.
%s = year
Default: "Releases from %s are not allowed here!"
DOUBLE_SFV <STRING>
Error msg when a second sfv file is uploaded.
Default: "SFV-file: DUPE!"
DUPE_NFO <STRING>
Error msg when a 2nd nfo is uploaded.
Default: "NFO-File: DUPE!"
EMPTY_FILE <STRING>
Error msg when an empty (0byte) file is uploaded.
Default: "0byte-file: Not allowed!"
EMPTY_SFV <STRING>
Error msg when uploaded sfv does not contain any parsable lines.
Default: "SFV-file: BAD!"
GROUPFILE <PATH>
This is the location of glftpd's groupfile.
Default: "/etc/group"
NOT_IN_SFV <STRING>
Error msg when uploaded file is not found in the sfv.
Default: "CRC-Check: Not in sfv!"
PASSWDFILE <PATH>
This is the location of glftpd's passwd file.
Default: "/etc/passwd"
SFV_FIRST <STRING>
Error msg when sfv_first is enabled, and no sfv is uploaded prior to
"normal" files.
Default: "CRC-Check: SFV first!"
SPEEDTEST <STRING>
Output when file is uploaded in a speedtest dir.
Default: "BW: %.1fMiB (%.1fMB) @ %.2fMbps (%.2fMB/s)."
UNKNOWN_FILE <STRING>
Error msg when filetype is not recognized or is listed as unwanted.
%s = file extension
Default: "%s-file: Not allowed!"
ZIP_NFO <STRING>
Error msg when nfo file is uploaded in a zipdir.
Default: "NFO-File: Not allowed here!"
accept_before_complete <TRUE|FALSE>
This option specify if accept_script should run before complete_script
or not.
Default: FALSE
accept_script <PATH>
Put here the path to the external script which should be run after
a file is verified and ok.
Default: "/bin/imdb_parse.sh"
affil_script <STRING>
Enter here the name of the affil_script to be executed on affil
uploads (not in group_dirs). The script will get the filename as arg.
Default: "/bin/affilscript.sh"
allow_dir_chown_in_ng_chown <TRUE|FALSE>
In ng-chown you have to specify a dir or a file to chmod. This setting
allows/denies to change the ownership of that file/dir.
Default: FALSE
allow_error2_in_unzip <TRUE|FALSE>
If unzip exits with error code 1 or 2 (a generic error) - should the file
be allowed anyway? There really shouldn't be any errors, so it's
recommended to leave this setting to the default FALSE.
Default: FALSE
allow_file_resume <TRUE|FALSE>
Broken transfers may be a problem on some sites. Glftpd2 and pzs-ng
allow you to resume such files by setting this to TRUE.
Default: FALSE
allow_files_chown_in_ng_chown <TRUE|FALSE>
In ng-chown you have to specify a dir or a file to chmod. If you specify
a dir, this setting will chown the files in that dir, but not the dir
itself.
Default: FALSE
allow_files_not_in_sfv <TRUE|FALSE>
Should we allow files uploaded that is not in the sfv? This is only
valid on upload (not rescan etc), and is normally not used. Please
note that this is a override option - you may be not like everything
this option allows on your site...
Default: FALSE
allow_gid_change_in_ng_chown <TRUE|FALSE>
Same as with allow_uid_change_in_ng_chown, only with gid.
Default: FALSE
allow_slash_in_sfv <TRUE|FALSE>
Allow slashes '/' in sfv? If TRUE whatever is behind the last slash is
taken as the filename. If FALSE, the sfv is rejected.
Related option(s): sfv_dupecheck sfv_cleanup sfv_cleanup_lowercase
sfv_cleanup_crlf sfv_lenient deny_double_sfv
deny_resume_sfv sfv_cleanup_comments
Default: TRUE
allow_uid_change_in_ng_chown <TRUE|FALSE>
ng-chown is a binary that changes the uid/gid of files dirs. In
order for it to work you have to enable a few things. This variable
will let ng-chown change the uid of files/dirs. ng-chown need to be
chmod'ed +s for it to work too.
Default: FALSE
allowed_constant_bitrates <STRING>
You can restrict uploaded audio releases several ways. For mp3 one
is by bitrate. Only CBR (Constant Bit Rate) mp3-files are of interest
via this setting. The list you define should be comma-separated.
Default: "160,192"
allowed_genres <STRING>
Instead of listing all denied genres, you can list all allowed genres.
Put here a comma-separated list of allowed genres.
Default: "Top 40,Pop Funk,Rock,Pop"
allowed_types <STRING>
This variable holds a comma-separated list of extensions. All files
with any of these extensions are allowed and not checked.
Default: "jpg,jpeg,cue,m3u,txt,vob,png,m2ts,ts,log"
allowed_types_exemption_dirs <PATHS>
In allowed_types we define filetypes that are allowed on site w/o
any checks. Define here paths where these filetypes should be checked
*if* an sfv is uploaded.
Default: "/site/incoming/musicvideos/"
allowed_years <STRING>
Another way to restrict audio-releases is by year. Define here a list
of years allowed on site. The list should be comma-separated.
Default: "2010,2011,2012,2013,2014,2015"
always_scan_audio_syms <TRUE|FALSE>
On cleanup symlinks are removed. However, if cleanup is used as a
cscript, only current dir will be checked. You can make sure to
clean up broken audio-symlinks as well, by setting this variable to
TRUE. Because audio archives can get huge, this is not on by default.
Default: FALSE
announce_norace <TRUE|FALSE>
If this variable is set to FALSE, announces with only one racer will
not be announced.
Default: TRUE
audio_allowed_genre_check <TRUE|FALSE>
Should the audio release be checked against your defined genres?
Only audio_banned_genre_check OR audio_allowed_genre_check should be
set to TRUE - not both.
Default: FALSE
audio_artist_noid3 <TRUE|FALSE>
If you sort audio by artist ID3 tag will be used to get the first
char of the artist. If you would like to use the first char of the
release-name instead, set this to TRUE.
Default: FALSE
audio_artist_nosub <TRUE|FALSE>
If you sort audio by artist, a dir with the first char in the artist is
created under audio_artist_path, and then a link to the actual release
is made. audio_artist_nosub, if set to TRUE, will instead create dirs
based on the full name of the artist, and then put a link in that dir
instead.
Default: FALSE
audio_artist_path <PATH>
If you choose to sort audio releases by artist, this is the place
where the symlinks will be created. This dir must be created in order
for the sorting to work - the zipscript will not create it for you.
Default: "/site/incoming/music.by.artist/"
audio_artist_sort <TRUE|FALSE>
If you wish to sort audio releases by artist, set this to TRUE.
Default: FALSE
audio_artist_sort_various_only <TRUE|FALSE>
An audio release containing multiple artists and having VA-/VA_
start the releasename, will be sorted in artist subdirs for each
appearing artist and in the VA-sortdir. Set this to TRUE to only
sort in the VA-sortdir.
Default: FALSE
audio_banned_genre_check <TRUE|FALSE>
Should the audio release be checked against your defined genres?
Only audio_banned_genre_check OR audio_allowed_genre_check should be
set to TRUE - not both.
Default: TRUE
audio_cbr_check <TRUE|FALSE>
Should the zipscript check for allowed bitrate on CBR audio/mp3
releases? Set to TRUE if yes.
Default: TRUE
audio_cbr_warn <TRUE|FALSE>
If the audio-release is not in the list of allowed cbr bitrates, should
the zipscript log a warning message instead of deleting the file? Set
to TRUE if yes.
Default: TRUE
audio_completebar <STRING|DISABLED>
When a release is complete, a 'complete bar' will be created. Define
here how it should look like on audio releases. If you want multiple
completebars _per release_, separate them with "\n" (Like "foo\nbar").
Default: "[%Z] - ( %.0mM %fF - COMPLETE - %w %Y ) - [%Z]"
audio_genre_path <PATH>
If you choose to sort audio releases by genre, this is the place
where the symlinks will be created. This dir must be created in order
for the sorting to work - the zipscript will not create it for you.
Default: "/site/incoming/music.by.genre/"
audio_genre_sort <TRUE|FALSE>
If you wish to sort audio releases by genre, set this to TRUE.
Default: FALSE
audio_genre_warn <TRUE|FALSE>
If the audio-release is not part of allowed genres, should the
zipscript log a warning message instead of deleting the file? Set to
TRUE if yes.
Default: TRUE
audio_group_path <PATH>
If you choose to sort audio releases by group, this is the place
where the symlinks will be created. This dir must be created in order
for the sorting to work - the zipscript will not create it for you.
Default: "/site/incoming/music.by.group/"
audio_group_sort <TRUE|FALSE>
If you wish to sort audio releases by group, set this to TRUE.
Default: FALSE
audio_ignored_languages <STRING>
To prevent audio language sorting of languages that isn't, well,
languages, list here what should be ignored. Not case sensitive, and
the list is comma separated.
Default: "md,cd,lp,ep,va"
audio_language_path <PATH>
If you choose to sort audio releases by language, this is the place
where the symlinks will be created. This dir must be created in order
for the sorting to work - the zipscript will not create it for you.
Default: "/site/incoming/music.by.language/"
audio_language_sort <TRUE|FALSE>
If you wish to sort audio releases by language, set this to TRUE.
Default: FALSE
audio_nocheck_dirs <PATHS>
Audio-files can be checked against a list of allowed/denied genres,
years etc. Audio-files found in paths defined in this variable will
not be checked against these defines, thus allowing them. Dirs are
separated by a space character.
Default: "/site/groups/ /site/incoming/requests/"
audio_nosort_dirs <PATHS>
If you do not want to sort the audio-files in certain dirs (but still
want to check for validity and announce them in chan) you can define a
list of dirs in this variable.
Default: "/site/incoming/requests/"
audio_types <STRING>
Comma-separated list of files considered to be audio files. Sorting will
apply on directories containing these.
Default: "mp3,flac"
audio_year_check <TRUE|FALSE>
Should the zipscript check for allowed years on audio releases? Set
to TRUE if yes.
Default: TRUE
audio_year_path <PATH>
If you choose to sort audio releases by year, this is the place
where the symlinks will be created. This dir must be created in order
for the sorting to work - the zipscript will not create it for you.
Default: "/site/incoming/music.by.year/"
audio_year_sort <TRUE|FALSE>
If you wish to sort audio releases by year, set this to TRUE.
Default: FALSE
audio_year_warn <TRUE|FALSE>
If the audio-release is not in the list of allowed years, should the
zipscript log a warning message instead of deleting the file? Set to
TRUE if yes.
Default: TRUE
banned_filelist <PATH>
You can ban certain files on site, based on name. The check is not
case-sensitive, and wildcards may be used.
Put here the path to the text-file with a list of the files you do not
want on your site.
For more info, or upgraded lists, see http://project-sl.swecheck.net
Please note - chars like [ and ] are used in the wildcard scheme - if you
search for such chars in the filenames, you need to double-escape them,
ie \\[ and \\] and \\( etc.
For more info on how wildcards are read, read manpage of fnmatch().
Default: "/ftp-data/misc/banned_filelist.txt"
banned_genres <STRING>
You can also restrict by genre. Use this variable to define genres
not allowed on your site. Genres are separated by a comma.
Default: "Christian Rap,Christian Gangsta Rap,Contemporary Christian,Christian Rock"
benchmark_mode <TRUE|FALSE>
This option will show the user uploading an estimate of how long it
took the zipscript to scan the uploaded file.
Default: TRUE
change_spaces_to_underscore_in_ng_chown <TRUE|FALSE>
Some ftp-clients have trouble reading the names of uid/gid if they have
spaces in them. This will search for a uid/gid with a underscore, if
the name (genre) given has a space inside. It is recommended to *NOT*
change this value (from TRUE).
Default: TRUE
charbar_filled <CHAR>
The progressbar consist of two chars, which together marks the progress
of the release. Put here the char to be used to mark uploaded files.
Default: "#"
charbar_missing <CHAR>
The progressbar consist of two chars, which together marks the progress
of the release. Put here the char to be used to mark missing files.
Default: ":"
check_for_banned_files <TRUE|FALSE>
Will check the banned_filelist when uploading files - if one is
encountered, the zipscript will deny the upload.
Default: TRUE
check_for_missing_nfo_dirs <PATHS>
Normally each release has a .nfo included. It has info about the
release written by the release-group, and may contain vital info
like serials etc. The paths defined in this value will be checked
for missing nfo after the release is marked as 'complete'. Separate
dirs with a space character.
Default: "/site/incoming/games/ /site/incoming/apps/"
check_for_missing_sample_dirs <PATHS>
Each movie-release should have a sample included, to show quality.
The paths defined in this value will be checked for missing samples.
Separate dirs with a space character.
Default: "/site/incoming/movies/"
chmod_completebar <TRUE|FALSE>
When TRUE, the permissions on the file/dir is changed to 0222. This is
to prevent it from being transfered on download/fxp.
Note that this will not happen in group-dirs.
Default: FALSE
cleanupdirs <PATHS>
To keep your site tidy and free from stale/dead symlinks created by the
zipscript, you should put here a list of dirs to scan for dead links.
The list is not recursive, and does not take wildcards.
Default: "/site/test/ /site/incoming/games/ /site/incoming/apps/ /site/incoming/musicvideos/"
cleanupdirs_dated <PATHS>
To keep your site tidy and free from stale/dead symlinks created by the
zipscript, you should put here a list of dirs to scan for dead links.
The list is not recursive, and does not take wildcards. This list can
contain format cookies for dated directories, refer to 'man strftime'
for a list of available date cookies.
Default: "/site/incoming/0day/%m%d/ /site/incoming/mp3/%m%d/"
combine_path <TRUE|FALSE>
Some clients do not cwd into the releasedir before uploading file(s).
To allow such clients this option must be set to TRUE.
Default: FALSE
complete_script <PATH>
Put here the path to the external script which should be run after a
release is marked complete.
Default: "/bin/nfo_copy.sh"
crc_algo <CRC_STANDARD|CRC_SLICEBY4|CRC_SLICEBY8>
The crc-algorithm to be used. Normally sliceby8 > sliceby4 > standard,
but on some limited hardware this order is different.
Default: CRC_SLICEBY8
create_incomplete_links_in_group_dirs <TRUE|FALSE>
Should incomplete indicators be created in groupdirs? With the default
settings this should be no problem, but if you change the location of
the links, it may very well be.
Default: TRUE
create_m3u <TRUE|FALSE>
If you wish to create .m3u files on complete audio-releases, set this to
TRUE.
Default: TRUE
create_missing_files <TRUE|FALSE>
To easily see what files are missing in a release, the zipscript can
create a 0-byte file of each missing file (filename-missing). This
file will be removed when the file is uploaded and found free of
errors.
Default: TRUE
create_missing_sample_link <TRUE|FALSE>
Movie-releases should have a sample. This setting will check for
missing samples in releases.
Default: FALSE
create_missing_sfv <TRUE|FALSE>
If this option is set to TRUE, the rescan binary will create sfv files
if none is found in the dir.
Default: FALSE
create_missing_sfv_link <TRUE|FALSE>
normally releases have a sfv, unless they are zip releases. This
setting will check for missing sfv in releases.
Default: TRUE
custom_group_dirs_complete_message <STRING|DISABLED>
If you rather would like to put in a predefined message in the
.message in group-dirs, define here what that message should be.
Setting this variable to DISABLED disables it.
Default: "... Looks like this is a pre. :)\n"
days_back_cleanup <NUMBER>
This setting defines how many days backward should be scanned on
cleanup. 0=disabled, 1=today only, 2=yesterday and today etc.
Default: 2
debug_altlog <TRUE|FALSE>
If debug is on, you can choose wether you wish to have the .debug file
in the releasedir, or in the mirrored tree created in 'storage'. Please
note that if you choose to put the debug file in the 'storage' path,
some debug-info may be lost. Setting this to TRUE will use the
'storage' path, while FALSE will use the upload-dir.
Note that the debug file will be named 'debug' in the 'storage' and
'.debug' in the releasedir.
Related option(s): debug_mode debug_announce
Default: TRUE
debug_announce <TRUE|FALSE>
If this variable is set to TRUE, and debug_mode is set to TRUE the
zipscript will announce to the uploader that the script is running in
debug mode. The announce is done at the very beginning of the script,
which means that it should give some output no matter what, if it
manages to start. Good to find out if the script has actually been
executed.
If the script(s) are unable to write to .debug and debug_announce is
on, the debug msg's will be pasted to the client instead.
Related option(s): debug_mode debug_altlog
Default: FALSE
debug_mode <TRUE|FALSE>
If something seems weird/doesn't work, you should debug. Setting this
variable to TRUE will turn on debugging. A file named .debug will be
created, normally in the same dir as the upload-dir.
Related option(s): debug_altlog debug_announce
Default: FALSE
del_banned_release <TRUE|FALSE>
If you want to make absolutely sure the banned release does not take up
more bandwith or space than necessary, you can choose to completely
remove the releasedir.
NOTE: This will override the *_warn setting - ie, you will get a warning
announce, but the file along with the entire dir will be removed.
Default: FALSE
del_audio_completebar <STRING|DISABLED>
This setting is what the zipscript will search for (and delete) when
it updates the complete bar for audio releases.
Default: "^\\[.*] - \\( .*F - COMPLETE - .*) - \\[.*]$"
del_other_completebar <STRING|DISABLED>
This setting is what the zipscript will search for (and delete) when
it updates the complete bar for other releases.
Default: "^\\[.*] - \\( .*F - COMPLETE ) - \\[.*]$"
del_rar_completebar <STRING|DISABLED>
This setting is what the zipscript will search for (and delete) when
it updates the complete bar for rar releases.
Default: "^\\[.*] - \\( .*F - COMPLETE ) - \\[.*]$"
del_video_completebar <STRING|DISABLED>
This setting is what the zipscript will search for (and delete) when
it updates the complete bar for video releases.
Default: "^\\[.*] - \\( .*F - COMPLETE ) - \\[.*]$"
del_zip_completebar <STRING|DISABLED>
This setting is what the zipscript will search for (and delete) when
it updates the complete bar for zip releases.
Default: "^\\[.*] - \\( .*F - COMPLETE ) - \\[.*]$"
del_progressmeter <STRING>
On upload a complete-bar is created after each file, to show how
complete the release is. Put here what to search for when updating
that bar - the file(s) matching this will be deleted.
Default: "^\\[.*] - .*%% Complete - \\[.*]$"
del_progressmeter_audio <STRING>
On upload a complete-bar is created after each file, to show how
complete the release is. Put here what to search for when updating
that bar - the file(s) matching this will be deleted.
This is for audio releases only.
Default: "^\\[.*] - .*%% Complete - (.*) \\[.*]$"
delbanned_script <PATH>
Enter the name of the script which is called when a release is
banned and will be deleted. The argument given is the full
chrooted path, and if the script exits with a non-zero value,
the dir is not removed. The example script marks a dir as deleted
in glftpd's dirlog.
Default: "/bin/ng-deldir"
delete_old_link <TRUE|FALSE>
If you do NOT want to have the zipscript/rescan/audiosort delete any
links with the same name when it tries to create a new link, set this
to FALSE. This will cause rescan / audiosort to be useless if there
already are sortedlinks for this release.
Default: TRUE
deny_double_nfo <TRUE|FALSE>
This is usually done (better) with a 3rd party app, but ... You can
deny a nfo upload if one already exists in the same dir.
Default: FALSE
deny_double_sfv <TRUE|FALSE>
With sfv releases, there should be only one sfv file allowed. This can
be done two ways - either by force or by being 'smart'. Setting this
option to TRUE will deny any new sfv in the dir, if a sfv already has
been uploaded. Setting it to FALSE will make the zipscript check the
new sfv first, compare it to the old sfv file and make a decision
based on the content of the sfv. If the new sfv contains more files
than the old one, and they match with what is already uploaded in the
dir, it will be allowed and used. If it does not, it will be denied.
Related option(s): sfv_dupecheck sfv_cleanup sfv_cleanup_lowercase
sfv_cleanup_crlf sfv_lenient deny_resume_sfv
allow_slash_in_sfv sfv_cleanup_comments
Default: FALSE
deny_nfo_upload_in_zip <TRUE|FALSE>
Should we deny nfo uploads in zip dirs? Should really only be used in
conjuntion with extract_nfo.
Default: FALSE
deny_resume_sfv <TRUE|FALSE>
This option works like deny_double_sfv, only it will deny even resumed
or overwritten sfv files. If that happens, a backup of the original sfv
will be copied back to the release.
Related option(s): sfv_dupecheck sfv_cleanup sfv_cleanup_lowercase
sfv_cleanup_crlf sfv_lenient deny_double_sfv
allow_slash_in_sfv sfv_cleanup_comments
Default: TRUE
dirlogpath <PATH>
This is the location of glftpd's dirlog. The file must be world
read/writable (+rw), and so must the containing dir (+rwx).
Default: "/ftp-data/logs/dirlog"
disable_audio_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_audio_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_audio_newleader <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_audio_norace_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_audio_norace_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_audio_race <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_audio_sfv <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_audio_update <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_newleader <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_norace_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_norace_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_race <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_sfv <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_other_update <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_newleader <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_norace_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_norace_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_race <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_sfv <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_rar_update <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_newleader <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_norace_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_norace_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_race <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_sfv <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_video_update <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_newleader <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_norace_complete <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_norace_halfway <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_race <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_sfv <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
disable_zip_update <TRUE|FALSE>
You can choose to disable some announces. Set to TRUE to disable the
announce.
Default: FALSE
dupepath <PATH>
This is the location of glftpd's dupefile. The file must be world
read/writable (+rw), and so must the containing dir (+rwx).
Default: "/ftp-data/logs/dupefile"
enable_accept_script <TRUE|FALSE>
An external script can be run after a file is verified and ok. Put
this to TRUE to run the external script.
Default: FALSE
enable_affil_script <TRUE|FALSE>
If you wish to do something on affil upload (not in group_dirs) like
chown'ing the file, you can enable the this here.
Default: FALSE
enable_complete_script <TRUE|FALSE>
An external script can be run after a release is complete. Put this to
TRUE to run the external script.
Default: FALSE
enable_delbanned_script <TRUE|FALSE>
When del_banned_release is TRUE, the banned release will be removed,
but the dirlog stays unaffected. The delbanned_script executes before
the directory is removed and marks it as deleted in the dirlog.
Default: TRUE
enable_files_ahead <TRUE|FALSE>
To limit the amount of logging on races, you can choose to only report
a new leader in a race if a racer is leading with a certain amount of
files. Set to TRUE to enable this feature.
Default: TRUE
enable_audio_script <TRUE|FALSE>
Put here the path to the external script which should be run after
the first uploaded audiofile in an audio-release.
Default: FALSE
enable_nfo_script <TRUE|FALSE>
An external script can be run after a nfo upload. Put his to TRUE to
run the external script.
Default: FALSE
enable_rescan_script <TRUE|FALSE>
An external script can be run after rescan and the release is complete.
Note that this option is not valid on zip releases.
Put this to TRUE to run the external script.
Default: FALSE
enable_sample_script <TRUE|FALSE>
Should a script be executed after sample uploads? Only valid on uploads
in sample dirs (see sample_list for info), and only if file is a
video file.
Default: FALSE
enable_unduper_script <TRUE|FALSE>
If you allow sfv to be uploaded after other files, some files may be
marked as bad when the sfv is read and compared to the crc of the file.
The file is then deleted, and a new one needs be uploaded. In order
for that to happen, the file needs to be unduped, or it will be denied
by glftpd. Set this variable to TRUE to run an external script after
a file has been marked as bad, and which undupes it.
Default: TRUE
exclude_non_sfv_dirs <TRUE|FALSE>
Applies only to audio releases - NEEDS MORE INFO HERE!!!!!
Default: TRUE
extract_nfo <TRUE|FALSE>
Should the zipscript extract the "real" nfo from a zip?
Default: TRUE
force_sfv_first <TRUE|FALSE>
In sfv_dirs, you can either allow files to be uploaded by default and
checked later when the sfv arrives, or you can force the uploader to
first provide a sfv before any other filetype is allowed. Setting this
to TRUE will do the latter.
Default: FALSE
get_competitor_list <TRUE|FALSE>
This setting, if set to TRUE, will put a list of all racers
excluding the current user into a special cookie.
Default: TRUE
get_user_stats <TRUE|FALSE>
If this is set to true, the zipscript will try to fetch stats from the
racers userfiles.
Default: TRUE
gl_sections <STRING>
Here you should put a list of all sections on your site. Sections is
not the same as dirs, but is what you have defined as sections in
glftpd.conf. See glftpd's docs for more info on sections.
First section is normally named 'DEFAULT'. The order in which you put
the names of the sections are important. Separate sections with a
space character.
Default: "DEFAULT"
gl_userfiles <PATH>
This is the place where userfiles are stored. The files must be world
readable (+r).
Default: "/ftp-data/users/"
group_dirs <PATHS>
This is the place(s) where your site's groups/affilliates have space
provided. Normally each (release-)group have a designated area
accessible only to the group's members, in which they upload a new
release and 'pre' it (release it) simultanously on several sites.
Uploads and races in these dirs will not be logged. Dirs are separated
with the space character.
Default: "/site/groups/"
hide_affil_gname <STRING>
What to replace hidden affil groupnames with.
Default: "NoGroup"
hide_affil_groups <STRING>
Comma separated list of groups to hide. Will replace the groupname with
the string in hide_affil_gname if non-empty, and replace the username
with hide_affil_uname if non-empty.
Default: ""
hide_affil_uname <STRING>
What to replace hidden affil usernames with.
Default: "NoUser"
hide_affil_users <STRING>
Comma separated list of users to hide. Will replace the username with
the string in hide_affil_uname if non-empty.
Default: ""
hide_gname <STRING>
Set here something you wish to use instead of the groupname when
hiding users. Setting this empty will not change groupname.
Default: ""
hide_group_uploaders <TRUE|FALSE>
If you wish to hide the names of the member of a releasegroup in the
.message file, this option will 'hide' the uploader.
Default: TRUE
hide_uname <STRING>
Set here something you wish to use instead of the username when
hiding users. Setting this empty will make the username the same
as groupname, unless show_users_in_group_dirs is set to TRUE.
Default: ""
ignore_lock_timeout <TRUE|FALSE>
If a lock cannot be obtained within the time set in
max_seconds_wait_for_lock, the zipscript will usually exit with an
error. You can, however, bypass this so it checks the file as normal.
This can lead to race-conditions, however, so it's set to FALSE by
default. Usually such conditions should *never* occur, but may in
rare conditions, especially if 3rd party scripts/addons are being
used.
Default: FALSE
ignore_zero_size <TRUE|FALSE>
This option is for debugging purposes only. Normally files of size
0 bytes are logged as bad, meaning glftpd will delete them. This
option makes it possible to allow such files.
Default: FALSE
ignore_zero_sized_on_rescan <TRUE|FALSE>
Sometimes a release is approved, which usually is not according to
site rules. One of the ways to approve a dir is to create a 0-sized
file in the dir, with the word APPROVED or ALLOWED somewhere.
This setting will ignore all zero-sized files on rescan.
Default: FALSE
ignored_types <STRING>
Files found with an extension listed in this variable are denied on
upload, and ignored on rescan/postdel/etc. The list is comma-separated.
Defining a file with no extension can be done by starting the list
with a comma. The dot before the extension should not be added.
.diz, .message and .debug is normally generated by the zipscript, so
these types should be listed here. Also add types 3rd party scripts
commonly make, like .imdb, .html, .url, .date etc.
Default: ",diz,debug,message,imdb,html,url,metadata,date,xxxdata,ioftpd"
incomplete_base_nfo_indicator <STRING>
On upload an indicator is created after each file, to show still
incomplete releases. Put here how that indicator will look.
This variable defines indicators on missing nfo in multi-cd releases.
Default: "../../(no-nfo)-%1"
incomplete_base_sample_indicator <STRING>
On upload an indicator is created if sample is missing.
This variable defines indicators on missing sample in multi-cd releases.
Default: "../../(no-sample)-%1"
incomplete_base_sfv_indicator <STRING>
On upload an indicator is created after each file, to show still