-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsettings.html
1062 lines (1030 loc) · 38.9 KB
/
settings.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Settings — HappyPanda X 0.13.3#170 documentation</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="https://platform.twitter.com/widgets.js"></script>
<script src="_static/script.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Command-Line Arguments" href="switches.html" />
<link rel="prev" title="Translations" href="translation.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html"><span><img src="_static/hpx_logo.svg"></span>
HappyPanda X</a>
<span class="navbar-text navbar-version pull-left"><b>0.13.3#170</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="dropdown globaltoc-container">
<a role="button"
id="dLabelGlobalToc"
data-toggle="dropdown"
data-target="#"
href="index.html">Contents <b class="caret"></b></a>
<ul class="dropdown-menu globaltoc"
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Using HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#installing-plugins">Installing plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#securing-happypanda-x">Securing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html#exposing-happypanda-x">Exposing HappyPanda X</a></li>
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translations</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="switches.html">Command-Line Arguments</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="env.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="env.html#editing-the-documentation">Editing the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="client.html">Creating frontends</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugin.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">TODO</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_general.html">General</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">Server API</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_plugin.html">Plugin API</a></li>
</ul>
</ul>
</li>
<li>
<a href="translation.html" title="Previous Chapter: Translations"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Translations</span>
</a>
</li>
<li>
<a href="switches.html" title="Next Chapter: Command-Line Arguments"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Command-Line ... »</span>
</a>
</li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<ul class="quick-links">
<li>
<strong>Quick links</strong>
</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/twiddli" aria-label="Follow @twiddli on GitHub">Follow @twiddli</a>
</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/happypandax/happypandax/issues" data-icon="octicon-issue-opened" data-show-count="true" aria-label="Issue happypandax/happypandax on GitHub">Issue</a>
</li>
<li class="divider">·</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/happypandax/happypandax" data-icon="octicon-star" data-show-count="true" aria-label="Star happypandax/happypandax on GitHub">Star</a>
</li>
<li class="quick-link">
<a class="github-button" href="https://github.com/happypandax/happypandax/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork happypandax/happypandax on GitHub">Fork</a>
</li>
<li class="divider">·</li>
<li class="quick-link">
<a href="https://twitter.com/twiddly_"
class="twitter-follow-button" data-width="145px"
data-link-color="#0069D6" data-show-count="false">
Follow
@twiddly_
</a>
</li>
<li class="quick-link">
<a href="https://twitter.com/share" class="twitter-share-button"
data-url="" data-count="horizontal"
data-via="twbootstrap"
data-related="twiddly_:Creator of HappyPanda X">Tweet</a>
</li>
</ul>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul>
<li><a class="reference internal" href="#">Settings</a></li>
</ul>
</div>
</div>
<div class="col-md-9 content">
<div class="section" id="settings">
<h1>Settings<a class="headerlink" href="#settings" title="Permalink to this headline">¶</a></h1>
<p>To use these settings, create a configuration file named <code class="docutils literal notranslate"><span class="pre">config.yaml</span></code>.</p>
<p>Most of these settings should also be configurable from a client.</p>
<p>The configuration file supports the expansion of environment variables in the form of <code class="docutils literal notranslate"><span class="pre">${NAME}</span></code>.
This means, for example, <code class="docutils literal notranslate"><span class="pre">key:</span> <span class="pre">${PATH}</span></code> is read by HPX as <code class="docutils literal notranslate"><span class="pre">key:</span> <span class="pre">/your/actual/path</span></code>.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Option</p></th>
<th class="head"><p>Default</p></th>
<th class="head"><p>Scope</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-even"><th class="head" colspan="4"><p>advanced</p></th>
</tr>
</thead>
<tbody>
<tr class="row-odd"><td><p>crop_thumbnail_alignment</p></td>
<td><p>0</p></td>
<td><p>server</p></td>
<td><p>An number between 0 (left) to 1 (right)</p></td>
</tr>
<tr class="row-even"><td><p>crop_wide_thumbnails</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Whether to crop wide thumbnails</p></td>
</tr>
<tr class="row-odd"><td><p>enable_auto_indexing</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Auto index</p></td>
</tr>
<tr class="row-even"><td><p>enable_cache</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Enable the cache</p></td>
</tr>
<tr class="row-odd"><td><p>enabled_loggers</p></td>
<td><p>server</p></td>
<td colspan="2"><p>Loggers to enable. Available loggers: client,command,core,database,gui,network,plugin,search,server,misc</p></td>
</tr>
<tr class="row-even"><td><p>esearch_timeout</p></td>
<td><p>60</p></td>
<td><p>server</p></td>
<td><p>How many seconds to wait for ES to be up before exiting</p></td>
</tr>
<tr class="row-odd"><td><p>image_sizes</p></td>
<td><p>{‘big’: [300, 416], ‘medium’: [200, 276], ‘small’: [100, 136], ‘x2400’: [2400, 0], ‘x1600’: [1600, 0], ‘x1280’: [1280, 0], ‘x960’: [960, 0], ‘x768’: [768, 0]}</p></td>
<td><p>server</p></td>
<td><p>Image sizes, provided as key:value where value is a list [width, height]and key is one of big, medium, small, x2400, x1600, x1200, x960, x768</p></td>
</tr>
<tr class="row-even"><td><p>redis_timeout</p></td>
<td><p>20</p></td>
<td><p>server</p></td>
<td><p>How many seconds to wait for redis to be up before exiting</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head" colspan="4"><p>client</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>translation_locale</p></td>
<td><p>en_us</p></td>
<td><p>client</p></td>
<td><p>The default translation locale when none is specified. See folder /translations for available locales</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head" colspan="4"><p>core</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>allow_alpha_releases</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Allow downloading alpha releases</p></td>
</tr>
<tr class="row-odd"><td><p>allow_beta_releases</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Allow downloading beta releases</p></td>
</tr>
<tr class="row-even"><td><p>auto_backup_interval</p></td>
<td><p>72</p></td>
<td><p>server</p></td>
<td><p>Interval in hours between periodically performing a backup, set to 0 to disable to auto backup (default: 3 days)</p></td>
</tr>
<tr class="row-odd"><td><p>auto_cache_clean_size</p></td>
<td><p>2000</p></td>
<td><p>server</p></td>
<td><p>Maximum size in megabytes to which the cache folder will automatically get emptied when exceeded</p></td>
</tr>
<tr class="row-even"><td><p>auto_install_release</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Automatically download, install and restart when a new update is found</p></td>
</tr>
<tr class="row-odd"><td><p>auto_pages_clean_size</p></td>
<td><p>800</p></td>
<td><p>server</p></td>
<td><p>Maximum size in megabytes to which the pages cache folder will automatically get emptied when exceeded</p></td>
</tr>
<tr class="row-even"><td><p>auto_temp_clean_size</p></td>
<td><p>800</p></td>
<td><p>server</p></td>
<td><p>Maximum size in megabytes to which the temp folder will automatically get emptied when exceeded</p></td>
</tr>
<tr class="row-odd"><td><p>auto_thumb_clean_size</p></td>
<td><p>500</p></td>
<td><p>server</p></td>
<td><p>Maximum size in megabytes to which the thumbnail cache folder will automatically get emptied when exceeded</p></td>
</tr>
<tr class="row-even"><td><p>backup_dir</p></td>
<td><p>backups</p></td>
<td><p>server</p></td>
<td><p>Directory where to create backups</p></td>
</tr>
<tr class="row-odd"><td><p>backup_on_update</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Create a backup before applying a new update</p></td>
</tr>
<tr class="row-even"><td><p>cache_expiration_time</p></td>
<td><p>43200</p></td>
<td><p>client</p></td>
<td><p>How much time in seconds items are to be cached for before they expire (default: 12 hours)</p></td>
</tr>
<tr class="row-odd"><td><p>check_new_releases</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Regularly check for updates</p></td>
</tr>
<tr class="row-even"><td><p>check_release_interval</p></td>
<td><p>30</p></td>
<td><p>server</p></td>
<td><p>Interval in minutes between checking for a new update, set 0 to only check once every startup</p></td>
</tr>
<tr class="row-odd"><td><p>concurrent_image_tasks</p></td>
<td><p>10</p></td>
<td><p>server</p></td>
<td><p>Amount of image service tasks allowed to run at the same time (higher count does not necessarily mean faster generation)</p></td>
</tr>
<tr class="row-even"><td><p>concurrent_network_tasks</p></td>
<td><p>50</p></td>
<td><p>server</p></td>
<td><p>Amount of network service tasks allowed to run at the same time (higher count does not necessarily mean faster network speed)</p></td>
</tr>
<tr class="row-odd"><td><p>debug</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Run in debug mode</p></td>
</tr>
<tr class="row-even"><td><p>interface_cache_time</p></td>
<td><p>21600</p></td>
<td><p>server</p></td>
<td><p>How many seconds to hold on to cached values from client functions (default: 6 hour)</p></td>
</tr>
<tr class="row-odd"><td><p>message_cache_time</p></td>
<td><p>3600</p></td>
<td><p>server</p></td>
<td><p>How many seconds to hold on to cached server messages (default: 1 hour)</p></td>
</tr>
<tr class="row-even"><td><p>pg_dump_tool_path</p></td>
<td><p>pg_dump</p></td>
<td><p>server</p></td>
<td><p>Path to pg_dump tool. On Windows the default path is ‘bin/win32/pg_dump.exe’. On Unix the default path is ‘pg_dump’ which assumes the tool is available in PATH</p></td>
</tr>
<tr class="row-odd"><td><p>pg_restore_tool_path</p></td>
<td><p>pg_restore</p></td>
<td><p>server</p></td>
<td><p>Path to pg_restore tool. On Windows the default path is ‘bin/win32/pg_restore.exe’. On Unix the default path is ‘pg_restore’ which assumes the tool is available in PATH</p></td>
</tr>
<tr class="row-even"><td><p>report_critical_errors</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Send occurring critical errors to me (creator) so I can fix them faster</p></td>
</tr>
<tr class="row-odd"><td><p>send_to_systemtrash</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Send deleted files to the os recycle bin</p></td>
</tr>
<tr class="row-even"><td><p>trash_item_delete_files</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Whether to also delete the files on the filesystem when an item gets removed by the periodic trash sweeper</p></td>
</tr>
<tr class="row-odd"><td><p>trash_item_duration</p></td>
<td><p>168.0</p></td>
<td><p>server</p></td>
<td><p>How many hours an item can stay in the trash before getting deleted PERMANENTLY (default is 7 days)</p></td>
</tr>
<tr class="row-even"><td><p>trash_send_to_systemtrash</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Whether to to send deleted files to the os recycle bin when an item gets removed by the periodic trash sweeper</p></td>
</tr>
<tr class="row-odd"><td><p>unrar_tool_path</p></td>
<td><p>unrar</p></td>
<td><p>server</p></td>
<td><p>Path to unrar tool. On Windows the default path is ‘bin/win32/unrar.exe’. On Unix the default path is ‘unrar’ which assumes the tool is available in PATH</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-even"><th class="head" colspan="4"><p>db</p></th>
</tr>
</thead>
<tbody>
<tr class="row-odd"><td><p>dialect</p></td>
<td><p>sqlite</p></td>
<td><p>server</p></td>
<td><p>Which SQL dialect to use between ‘sqlite’ and ‘postgresql’. Note that HPX will not transfer data from one dialect to another once chosen. It is therefore advised that you choose a dialect early and stick to it throughout. Only Postgres version 9.4 and up is supported</p></td>
</tr>
<tr class="row-even"><td><p>host</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Database host. This setting does not apply when the SQLite dialect is used</p></td>
</tr>
<tr class="row-odd"><td><p>name</p></td>
<td><p>happypanda</p></td>
<td><p>server</p></td>
<td><p>Database name. This setting does not apply when the SQLite dialect is used</p></td>
</tr>
<tr class="row-even"><td><p>password</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Database password. This setting does not apply when the SQLite dialect is used</p></td>
</tr>
<tr class="row-odd"><td><p>pool_size</p></td>
<td><p>15</p></td>
<td><p>server</p></td>
<td><p>The size of the pool to be maintained. This is the largest number of connections that will be kept persistently in the pool. This setting does not apply when the SQLite dialect is used</p></td>
</tr>
<tr class="row-even"><td><p>pool_timeout</p></td>
<td><p>45</p></td>
<td><p>server</p></td>
<td><p>The number of seconds to wait before giving up on returning a connection. This setting does not apply when the SQLite dialect is used</p></td>
</tr>
<tr class="row-odd"><td><p>port</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Database port. This setting does not apply when the SQLite dialect is used</p></td>
</tr>
<tr class="row-even"><td><p>query</p></td>
<td><p>{}</p></td>
<td><p>server</p></td>
<td><p>A mapping of options to be passed to the database upon connect</p></td>
</tr>
<tr class="row-odd"><td><p>sqlite_database_timeout</p></td>
<td><p>30</p></td>
<td><p>server</p></td>
<td><p>Amount of seconds to wait for the database to be writeable</p></td>
</tr>
<tr class="row-even"><td><p>username</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Database user name. This setting does not apply when the SQLite dialect is used</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head" colspan="4"><p>download</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>delete_failed_downloads</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Delete a download item if the processing was incomplete</p></td>
</tr>
<tr class="row-odd"><td><p>disabled</p></td>
<td><p>server</p></td>
<td colspan="2"><p>A list of downloaders that shouldn’t be used, this is a list of download identifiers defined by the respective plugins</p></td>
</tr>
<tr class="row-even"><td><p>download_cache_dir</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Folder where to put temporary downloaded resources</p></td>
</tr>
<tr class="row-odd"><td><p>download_dir</p></td>
<td><p>downloads</p></td>
<td><p>client</p></td>
<td><p>Folder where to put successfully downloaded resources</p></td>
</tr>
<tr class="row-even"><td><p>import</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Import item (if applicable) after it has been downloaded successfully</p></td>
</tr>
<tr class="row-odd"><td><p>options</p></td>
<td><p>{}</p></td>
<td><p>server</p></td>
<td><p>A mapping of setting:value, where setting is a fully qualified name of a config setting that should be overwritten For example: { ‘import.move_gallery’ : true, ‘import.move_dir’: ‘some/other/path’ } to move downloaded galleries to `some/other/path` during import</p></td>
</tr>
<tr class="row-even"><td><p>priority</p></td>
<td><p>server</p></td>
<td colspan="2"><p>A priority list of downloaders, this is a list of download identifiers defined by the respective plugins.</p></td>
</tr>
<tr class="row-odd"><td><p>size</p></td>
<td><p>4</p></td>
<td><p>server</p></td>
<td><p>Size of concurrent downloads</p></td>
</tr>
<tr class="row-even"><td><p>skip_if_downloaded_before</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Skip a download URL if it has been successfully downloaded before</p></td>
</tr>
<tr class="row-odd"><td><p>skip_if_item_exists</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Prevent adding a download item if it already exists in the database</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-even"><th class="head" colspan="4"><p>gallery</p></th>
</tr>
</thead>
<tbody>
<tr class="row-odd"><td><p>auto_rate_on_favorite</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Automatically set unrated galley rating to highest on favorite</p></td>
</tr>
<tr class="row-even"><td><p>auto_remove_readlater</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Automatically remove a gallery from ReadLater when it has been read</p></td>
</tr>
<tr class="row-odd"><td><p>delete_files</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Delete gallery files on the filesystem when removing a gallery from the database</p></td>
</tr>
<tr class="row-even"><td><p>external_image_viewer</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Path to external image viewer executable</p></td>
</tr>
<tr class="row-odd"><td><p>external_image_viewer_args</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Command arguments to supply the image viewer executable</p></td>
</tr>
<tr class="row-even"><td><p>pages_to_read</p></td>
<td><p>80.0</p></td>
<td><p>server</p></td>
<td><p>How many pages (in percent) has to be read before the gallery is considered read</p></td>
</tr>
<tr class="row-odd"><td><p>send_extracted_archive</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Extract archive before sending path to external viewer</p></td>
</tr>
<tr class="row-even"><td><p>send_path_to_first_file</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Send path to first file when opening a gallery in external viewer</p></td>
</tr>
<tr class="row-odd"><td><p>track_guest_read</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Track gallery read status for guests</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-even"><th class="head" colspan="4"><p>gui</p></th>
</tr>
</thead>
<tbody>
<tr class="row-odd"><td><p>autostart_server</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Start the server automatically on HPX GUI startup</p></td>
</tr>
<tr class="row-even"><td><p>open_webclient_on_server_start</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Open the webclient in your default browser on server start</p></td>
</tr>
<tr class="row-odd"><td><p>send_to_tray_on_close</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Put the application in the notification tray on close button</p></td>
</tr>
<tr class="row-even"><td><p>send_to_tray_on_minimize</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Put the application in the notification tray on minimize button</p></td>
</tr>
<tr class="row-odd"><td><p>start_minimized_to_tray</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Start the HPX GUI in a minimized to tray state</p></td>
</tr>
<tr class="row-even"><td><p>start_on_boot</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Start HPX GUI automatically on boot</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head" colspan="4"><p>import</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>add_to_inbox</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Add new galleries to inbox</p></td>
</tr>
<tr class="row-odd"><td><p>fail_on_move_error</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Avoid adding a gallery to the database if the move failed</p></td>
</tr>
<tr class="row-even"><td><p>move_copy</p></td>
<td><p>False</p></td>
<td><p>client</p></td>
<td><p>Copy a gallery to `move_dir` instead of moving it</p></td>
</tr>
<tr class="row-odd"><td><p>move_dir</p></td>
<td><p></p></td>
<td><p>client</p></td>
<td><p>Folder where to move successfully imported galleries</p></td>
</tr>
<tr class="row-even"><td><p>move_gallery</p></td>
<td><p>False</p></td>
<td><p>client</p></td>
<td><p>Move a gallery that has been imported successfully</p></td>
</tr>
<tr class="row-odd"><td><p>send_to_metadata_queue</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Send item (if applicable) to metadata queue after it has been imported successfully</p></td>
</tr>
<tr class="row-even"><td><p>skip_existing_galleries</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Skip galleries that have already been added to HPX</p></td>
</tr>
<tr class="row-odd"><td><p>transparent_nested_folders</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Treat a nested folder as being transparent</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-even"><th class="head" colspan="4"><p>metadata</p></th>
</tr>
</thead>
<tbody>
<tr class="row-odd"><td><p>attributes</p></td>
<td><p>{‘__all__’: True}</p></td>
<td><p>client</p></td>
<td><p>A mapping of item attributes specifying which attributes metadata should be applied to. Set attribte:true to ‘turn on’ the attribute or attribute:false to ‘turn off’. use __all__:true to ‘turn on’ all attributes not specified or __all__:false to ‘turn them off’. The default value if this setting is empty is __all__:true</p></td>
</tr>
<tr class="row-even"><td><p>choose_first_candidate</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Always choose the first candidate to extract metadata from (choosing of candidate is not supported yet)</p></td>
</tr>
<tr class="row-odd"><td><p>continue_fetching</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>If fetching from applied URLs fails, continue item lookup without URLs</p></td>
</tr>
<tr class="row-even"><td><p>disabled</p></td>
<td><p>server</p></td>
<td colspan="2"><p>A list of metadata fetchers that shouldn’t be used, this is a list of metadata identifiers defined by the respective plugins</p></td>
</tr>
<tr class="row-odd"><td><p>only_if_never_fetched</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Only fetch metadata for an item if it has never had a successful fetch before, else skip it. Note that this does not interfere with the auto metadata updater.</p></td>
</tr>
<tr class="row-even"><td><p>overwrites</p></td>
<td><p>{‘__all__’: False}</p></td>
<td><p>client</p></td>
<td><p>A mapping of item attributes specifying how an attribute should be written. Set attribute_name:true to replace the attribute or attribute_name:false to update it if applicable.Use __all__:true to replace all attributes not specified or __all__:false to only update them. The default action if this setting is empty is __all__:False</p></td>
</tr>
<tr class="row-odd"><td><p>priority</p></td>
<td><p>server</p></td>
<td colspan="2"><p>A priority list of metadata fetchers, this is a list of metadata identifiers defined by the respective plugins. Note that the priority is just a hint and not a guarantee.</p></td>
</tr>
<tr class="row-even"><td><p>size</p></td>
<td><p>4</p></td>
<td><p>server</p></td>
<td><p>Size of concurrent metadata fetches</p></td>
</tr>
<tr class="row-odd"><td><p>stop_after_first</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Halt item metadata lookup after first successful lookup</p></td>
</tr>
<tr class="row-even"><td><p>use_applied_urls</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Fetch metadata from the applied URLs</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head" colspan="4"><p>network</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>delays</p></td>
<td><p>{}</p></td>
<td><p>server</p></td>
<td><p>Impose delays when peforming requests on certain urls. A mapping of url:delay in seconds</p></td>
</tr>
<tr class="row-odd"><td><p>delays_jitter</p></td>
<td><p>0.3</p></td>
<td><p>server</p></td>
<td><p>A randomization factor to add when delaying, should be a value between 0 and 1, inclusive</p></td>
</tr>
<tr class="row-even"><td><p>proxy</p></td>
<td><p>{‘http’: ‘’, ‘https’: ‘’}</p></td>
<td><p>server</p></td>
<td><p>Specify network proxies. Proxy URLs must include the scheme. To use HTTP Basic Auth with your proxy, use the http://user:password@host/ syntax</p></td>
</tr>
<tr class="row-odd"><td><p>request_timeout</p></td>
<td><p>30</p></td>
<td><p>server</p></td>
<td><p>Upper limit of a request timeout in seconds</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-even"><th class="head" colspan="4"><p>plugin</p></th>
</tr>
</thead>
<tbody>
<tr class="row-odd"><td><p>auto_install_plugin</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Automatically install a discovered plugin</p></td>
</tr>
<tr class="row-even"><td><p>auto_install_plugin_dependency</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Automatically install a plugin’s dependencies when installing a plugin</p></td>
</tr>
<tr class="row-odd"><td><p>auto_install_plugin_release</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Automatically download and install a new plugin update is found</p></td>
</tr>
<tr class="row-even"><td><p>check_new_plugin_releases</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Regularly check plugins for updates</p></td>
</tr>
<tr class="row-odd"><td><p>check_plugin_release_interval</p></td>
<td><p>45</p></td>
<td><p>server</p></td>
<td><p>Interval in minutes between checking plugins for a new update, set 0 to only check once every startup</p></td>
</tr>
<tr class="row-even"><td><p>plugin_dir</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Additional optional plugin directory to look for plugins</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head" colspan="4"><p>search</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>case_sensitive</p></td>
<td><p>False</p></td>
<td><p>client</p></td>
<td><p>Search filter is case sensitive</p></td>
</tr>
<tr class="row-odd"><td><p>children</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Also match on children</p></td>
</tr>
<tr class="row-even"><td><p>match_all_terms</p></td>
<td><p>True</p></td>
<td><p>client</p></td>
<td><p>Match only items that has all terms</p></td>
</tr>
<tr class="row-odd"><td><p>match_exact</p></td>
<td><p>False</p></td>
<td><p>client</p></td>
<td><p>Match terms exact instead of fuzzy</p></td>
</tr>
<tr class="row-even"><td><p>regex</p></td>
<td><p>False</p></td>
<td><p>client</p></td>
<td><p>Allow regex in search filters</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head" colspan="4"><p>server</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>allow_guests</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Specify if guests are allowed on this server</p></td>
</tr>
<tr class="row-odd"><td><p>allowed_clients</p></td>
<td><p>0</p></td>
<td><p>server</p></td>
<td><p>Limit amount of clients allowed to be connected (0 means no limit)</p></td>
</tr>
<tr class="row-even"><td><p>disable_default_user</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Disable default user</p></td>
</tr>
<tr class="row-odd"><td><p>elasticsearch_host</p></td>
<td><p>127.0.0.1</p></td>
<td><p>server</p></td>
<td><p>ElasticSearch host</p></td>
</tr>
<tr class="row-even"><td><p>elasticsearch_port</p></td>
<td><p>7010</p></td>
<td><p>server</p></td>
<td><p>ElasticSearch port</p></td>
</tr>
<tr class="row-odd"><td><p>elasticsearch_transport_port</p></td>
<td><p>7011</p></td>
<td><p>server</p></td>
<td><p>ElasticSearch transport port</p></td>
</tr>
<tr class="row-even"><td><p>enable_http_endpoint</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Enable the /server HTTP endpoint on the webserver for communicating with HPX</p></td>
</tr>
<tr class="row-odd"><td><p>enable_ssl</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Enable SSL, valid values are true/false or “server”/”web” to only enable for the specific component</p></td>
</tr>
<tr class="row-even"><td><p>expose_server</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Attempt to expose the server through portforwading</p></td>
</tr>
<tr class="row-odd"><td><p>host</p></td>
<td><p>localhost</p></td>
<td><p>server</p></td>
<td><p>Specify which address the server should bind to</p></td>
</tr>
<tr class="row-even"><td><p>host_web</p></td>
<td><p>0.0.0.0</p></td>
<td><p>server</p></td>
<td><p>Specify which address the webserver should bind to</p></td>
</tr>
<tr class="row-odd"><td><p>port</p></td>
<td><p>7007</p></td>
<td><p>server</p></td>
<td><p>Specify which port to start the server on</p></td>
</tr>
<tr class="row-even"><td><p>port_range</p></td>
<td><p>{‘from’: 7010, ‘to’: 7018}</p></td>
<td><p>server</p></td>
<td><p>Specify a range of ports to attempt</p></td>
</tr>
<tr class="row-odd"><td><p>port_web</p></td>
<td><p>7008</p></td>
<td><p>server</p></td>
<td><p>Specify which port to start the webserver on</p></td>
</tr>
<tr class="row-even"><td><p>redis_db</p></td>
<td><p>0</p></td>
<td><p>server</p></td>
<td><p>Redis database</p></td>
</tr>
<tr class="row-odd"><td><p>redis_host</p></td>
<td><p>127.0.0.1</p></td>
<td><p>server</p></td>
<td><p>Redis server host</p></td>
</tr>
<tr class="row-even"><td><p>redis_password</p></td>
<td><p></p></td>
<td><p>server</p></td>
<td><p>Redis server password</p></td>
</tr>
<tr class="row-odd"><td><p>redis_port</p></td>
<td><p>7009</p></td>
<td><p>server</p></td>
<td><p>Redis server port</p></td>
</tr>
<tr class="row-even"><td><p>require_auth</p></td>
<td><p>False</p></td>
<td><p>server</p></td>
<td><p>Client must be authenticated to get write access</p></td>
</tr>
<tr class="row-odd"><td><p>server_cert</p></td>
<td><p>{‘certfile’: None, ‘keyfile’: None}</p></td>
<td><p>server</p></td>
<td><p>Path to a certificate and the corresponding private key. If keyfile is not set, the private key will be taken from certfile. Note that if SSL is enabled and no cert files are provided, a self-signed certificate will be created and used instead. The self-signed certificate can be found at data/certs/</p></td>
</tr>
<tr class="row-even"><td><p>server_name</p></td>
<td><p>momo_hinata_eri</p></td>
<td><p>server</p></td>
<td><p>Specifiy name of the server</p></td>
</tr>
<tr class="row-odd"><td><p>session_span</p></td>
<td><p>0</p></td>
<td><p>server</p></td>
<td><p>Specify the amount of time (in minutes) a session can go unused before expiring or 0 for never</p></td>
</tr>
<tr class="row-even"><td><p>torrent_port</p></td>
<td><p>7006</p></td>
<td><p>server</p></td>
<td><p>Specify which port to start the torrent client on</p></td>
</tr>
<tr class="row-odd"><td><p>use_builtin_elasticsearch</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Use the elasticsearch server bundled with HPX</p></td>
</tr>
<tr class="row-even"><td><p>use_builtin_redis</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Use the redis server bundled with HPX</p></td>
</tr>
<tr class="row-odd"><td><p>web_cert</p></td>
<td><p>{‘certfile’: None, ‘keyfile’: None}</p></td>
<td><p>server</p></td>
<td><p>Same as server_cert. Values are inherited from server_cert If no values are provided and SSL is enabled for ‘web’ too</p></td>
</tr>
</tbody>
<colgroup>
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="row-even"><th class="head" colspan="4"><p>watch</p></th>
</tr>
</thead>
<tbody>
<tr class="row-odd"><td><p>auto_add</p></td>
<td><p>True</p></td>
<td><p>server</p></td>
<td><p>Auto add new items to the database. Only auto-adding is supported at this time</p></td>
</tr>
<tr class="row-even"><td><p>dirs</p></td>
<td><p>server</p></td>
<td colspan="2"><p>A list of folders to watch for changes. The same special token syntax as in the gallery scanner is NOT supported here. If a path is located on a network, remember to add it to the ‘watch.network’ setting</p></td>