-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathdefaults.env
More file actions
5779 lines (5006 loc) · 190 KB
/
Copy pathdefaults.env
File metadata and controls
5779 lines (5006 loc) · 190 KB
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
#
# Welcome to PhotoStructure! These are the settings for version 2026.1.
#
# Please see https://photostructure.com/environment-variables for more
# information about using environment variables with PhotoStructure.
#
# As of version 2.1, ".env" files (like this one) can be imported by
# PhotoStructure. For more details see https://photostructure.com/go/psenv
#
# The following settings categories are stored in the system settings.toml:
#
# * System.Cache
# * System.Desktops
# * System.Filesystem
# * System.Hardware
# * System.Logging
# * System.Networking
# * System.Paths
# * System.Performance
# * System.Processes
# * System.Security
# * System.Tools
# * System.Update
#
# The following settings categories are stored in the library settings.toml:
#
# * Library.Aggregation
# * Library.Auth
# * Library.Color
# * Library.Db
# * Library.Filters
# * Library.Health
# * Library.Organization
# * Library.Parsing
# * Library.Previews
# * Library.Privacy
# * Library.Reporting
# * Library.Sidecars
# * Library.Subscription
# * Library.Sync
# * Library.Tagging
# * Library.Video
# * Library.Volumes
# * Library.Web
#
# Please visit https://forum.photostructure.com if you find anything that may
# be a bug or have any questions, ideas, or feedback. We'd love to hear from
# you!
# -----------
# PS_ENV_FILE
# -----------
#
# PhotoStructure will attempt to read an .env-formatted filename specified by
# this environment variable. This must be a full pathname.
#
# Any value set by this file will override values in settings.toml files.
#
# For more details see https://photostructure.com/go/psenv
# -------------
# PS_CONFIG_DIR
# -------------
#
# If the environment variable PS_CONFIG_DIR is set, PhotoStructure will use
# that value as your system configuration directory. This can't be overridden
# in the system settings.toml, as it's used to _find_ the system
# settings.toml!
#
# PhotoStructure's system configuration directory is different for every
# operating system:
#
# - Windows defaults to %APPDATA%PhotoStructure (%APPDATA% is normally set to
# %HOME%/AppData/Roaming)
#
# - macOS defaults to ~/Library/Application Support/PhotoStructure
#
# - Linux defaults to ${XDG_CONFIG_DIR:-$HOME/.config}/PhotoStructure
##############################################################################
#
# Paths settings (system-wide)
#
# Specifies file system paths for library, previews, originals, cache, and
# scan locations.
#
# ----------------------------
# PS_LIBRARY_DIR or libraryDir
# ----------------------------
#
# This is the absolute path to your PhotoStructure library. If missing, or set
# to an empty string, the welcome page will be shown when PhotoStructure
# launches. Use native file separators (so on windows, use back-slashes).
#
# Aliases: "PS_LIBRARY_PATH or PS_LIBRARY"
#
# PS_LIBRARY_DIR=""
# -----------------------------------
# PS_SCAN_ALL_DRIVES or scanAllDrives
# -----------------------------------
#
# Should PhotoStructure scan all folders on all drives available to this
# computer for photos and videos?
#
# PS_SCAN_ALL_DRIVES="true"
# --------------------------
# PS_SCAN_PATHS or scanPaths
# --------------------------
#
# This holds an array of absolute paths to scan for assets. If you are setting
# this via an environment variable, you may use either standard PATH
# formatting, like `PS_SCAN_PATHS="/path/one:/path/two"`, or use JSON
# encoding, like `PS_SCAN_PATHS='["/path/one","/path/two"]'`.
#
# Aliases: "PS_SCAN_PATH"
#
# PS_SCAN_PATHS="[]"
# ------------------
# PS_ARGV_SCAN_PATHS
# ------------------
#
# For internal use only: this is an array of absolute paths provided on the
# command line to import. This overrides "scanPaths", and should always be
# scanned for changes. For more details see
# https://forum.photostructure.com/t/1597/4
#
# This setting is transient and only set via environment variables.
#
# PS_ARGV_SCAN_PATHS="[]"
# ------------------------
# PS_CACHE_DIR or cacheDir
# ------------------------
#
# Where would you like PhotoStructure's scratch file directory? This must be a
# fast, local disk with several gigabytes free.
#
# Note that if PS_FORCE_LOCAL_DB_REPLICA is enabled, the local DB replica will
# be stored in this directory while PhotoStructure is running: don't delete
# it!
#
# If this is set to /tmp PhotoStructure will write to a user-specific
# /tmp/.photostructure-cache-$UID directory.
#
# PS_CACHE_DIR="/home/user/.cache/photostructure"
# ------------------------------------------------
# PS_FORCE_LOCAL_DB_REPLICA or forceLocalDbReplica
# ------------------------------------------------
#
# Libraries on remote filesystems can suffer from bad performance and
# inconsistent transactions due to slow file I/O and missing file locking
# mechanics. When opening libraries on remote filesystems, or if this setting
# is `true`, PhotoStructure will copy the library database to the `cacheDir`
# and perform I/O against this local replica. Changes made to the local db
# replica are then periodically copied back to the remote library.
#
# If you've overridden this value in the past, know that v23.5 and after
# should automatically set this to the correct value for you.
#
# For more details, see
# https://forum.photostructure.com/t/whats-force-local-db-replica/837 and
# https://photostructure.com/about/2023-release-notes/#-sqlite-improvements
#
# PS_FORCE_LOCAL_DB_REPLICA="false"
# --------------------------------
# PS_ORIGINALS_DIR or originalsDir
# --------------------------------
#
# This is the directory that PhotoStructure uses to store original images when
# "copyAssetsToLibrary" is enabled. Absolute paths are supported. Relative
# paths are evaluated from your libraryDir. This setting defaults to ".",
# which is the same as your PhotoStructure library directory, unless you are
# on docker, and a /ps/originals directory exists.
#
# If you open your PhotoStructure library on a different computer, and that
# computer doesn't have access to your originals volume, full-screen zoom
# won't work, and non-transcoded videos will not play.
#
# This system setting needs to be set appropriately on different computers (it
# won't be set automatically!)
#
# If you have a large library and want to use an SSD, we recommend you set
# your libraryDir to your SSD, and use this setting to store your originals on
# a larger volume, rather than using the "previewsDir" setting.
#
# For more details see
# https://forum.photostructure.com/t/hybrid-photostructure-libraries/775 and
# https://forum.photostructure.com/t/new-easy-mode-for-docker-coming-in-v2-1/1278/6
#
# Aliases: "PS_ORIGINAL_DIR"
#
# PS_ORIGINALS_DIR="."
# ----------------------
# PS_PID_FILE or pidFile
# ----------------------
#
# This is the absolute path to the PID file for the main process. This is
# optional and only used by PhotoStructure for Servers. Make sure the UID/GID
# that PhotoStructure runs as can read and write to this file.
#
# Aliases: "PIDFILE"
#
# PS_PID_FILE=""
# ------------------------------
# PS_PREVIEWS_DIR or previewsDir
# ------------------------------
#
# This is the directory that PhotoStructure uses to store preview images. This
# defaults to the ".photostructure/previews" directory inside your
# PhotoStructure library. Absolute paths here are supported, but if you keep
# your library and previews directory separated, take care when you open your
# library on different computers, as this setting needs to be adjusted for
# those computers as well.
#
# NOTE: "originalDirs" is recommended instead of this setting; If you get
# "previewsDir" wrong, your library won't work. If you get "originalsDir"
# wrong, you just break full-screen asset zooming and playback for
# non-transcoded videos.
#
# For more details see
# https://forum.photostructure.com/t/hybrid-photostructure-libraries/775
#
# PS_PREVIEWS_DIR=".photostructure/previews"
# --------------
# PS_PROJECT_DIR
# --------------
#
# This directory contains the public/, data/, views/, and tools/ directories
# that PhotoStructure relies on to run. This is determined by PhotoStructure
# automatically.
#
# This setting is transient and only set via environment variables.
#
# PS_PROJECT_DIR=""
# -------------------------------------
# PS_SCAN_MY_PICTURES or scanMyPictures
# -------------------------------------
#
# NOTE: this setting has been deprecated and will be removed in a future
# version of PhotoStructure.
#
# If set, PhotoStructure will automatically add your pictures directory to
# your "scanPaths" setting and then flip this setting back to false. Add your
# Pictures directory directly to your scanPaths setting instead.
#
# PS_SCAN_MY_PICTURES="false"
##############################################################################
#
# Desktops settings (system-wide)
#
# Controls behavior specific to PhotoStructure for Desktops (Electron),
# ignored by Server editions.
#
# ----------------------------------------
# PS_AUTO_HIDE_MENU_BAR or autoHideMenuBar
# ----------------------------------------
#
# If true, PhotoStructure for Desktops on Windows and Linux will auto hide the
# menu bar unless the Alt key is pressed.
#
# PS_AUTO_HIDE_MENU_BAR="false"
# ---------------------------------
# PS_HIDE_ON_LAUNCH or hideOnLaunch
# ---------------------------------
#
# If true, PhotoStructure for Desktops will not open the main window when
# launched. The tray icon will still be visible.
#
# This setting is ignored by PhotoStructure for Server editions.
#
# PS_HIDE_ON_LAUNCH="false"
# ----------------------------------------------
# PS_PAUSE_SYNC_ON_BATTERY or pauseSyncOnBattery
# ----------------------------------------------
#
# If true, PhotoStructure for Desktops will pause sync when the system is on
# battery power.
#
# This setting is ignored by PhotoStructure for Server editions.
#
# PS_PAUSE_SYNC_ON_BATTERY="false"
##############################################################################
#
# Filesystem settings (system-wide)
#
# Controls file system interaction including change detection, timeouts, and
# mount point validation.
#
# -------------------------------------------------------
# PS_EXCLUDED_FILESYSTEM_TYPES or excludedFilesystemTypes
# -------------------------------------------------------
#
# Volumes with these filesystem types will never be scanned or imported.
#
# These are only relevant to Linux and macOS systems.
#
# Defaults to @photostructure/fs-metadata's `SystemFsTypesDefault`: see
# https://photostructure.github.io/fs-metadata/variables/index.SystemFsTypesDefault.html
#
# Aliases: "PS_IGNORED_FILESYSTEM_TYPES"
#
# PS_EXCLUDED_FILESYSTEM_TYPES="[\"autofs\",\"binfmt_misc\",\"bpf\",\"cgroup\",\"cgroup2\",\"configfs\",\"debugfs\",\"devpts\",\"devtmpfs\",\"efivarfs\",\"fusectl\",\"fuse.lxcfs\",\"fuse.portal\",\"fuse.snapfuse\",\"hugetlbfs\",\"mqueue\",\"none\",\"nsfs\",\"proc\",\"pstore\",\"ramfs\",\"rootfs\",\"rpc_pipefs\",\"securityfs\",\"snap*\",\"squashfs\",\"sysfs\",\"tmpfs\",\"tracefs\"]"
# -------------------------------------------------------
# PS_EXCLUDED_MOUNTPOINT_PATHS or excludedMountpointPaths
# -------------------------------------------------------
#
# PhotoStructure won't descend into mountpoints that match these paths.
#
# Defaults to @photostructure/fs-metadata's `SystemPathPatternsDefault`:
# https://photostructure.github.io/fs-metadata/variables/index.SystemPathPatternsDefault.html
#
# Aliases: "PS_IGNORED_MOUNTPOINTS"
#
# PS_EXCLUDED_MOUNTPOINT_PATHS="[\"/dev/shm\",\"/run\",\"/run/lock\",\"/run/qemu\",\"/run/snapd/ns\",\"/tmp\",\"/var/tmp\"]"
# ----------------------------------------------
# PS_FILE_COPY_ONLY_NATIVE or fileCopyOnlyNative
# ----------------------------------------------
#
# Should PhotoStructure skip the built-in file copy code, and only use the "OS
# native" file copy mechanism?
#
# PhotoStructure is typically faster than native file copies by 2x or more.
#
# If true, PhotoStructure will use "ditto" on macOS, "cp" on Linux, and
# "Copy-Item" via PowerShell on Windows.
#
# Aliases: "PS_ONLY_NATIVE_FILE_COPY"
#
# PS_FILE_COPY_ONLY_NATIVE="false"
# -------------------------------------
# PS_FILE_COPY_VERIFY or fileCopyVerify
# -------------------------------------
#
# Should PhotoStructure verify all file copies by comparing SHAs of the source
# and destination? This shouldn't be necessary on most OSes and filesystems,
# and slows down library imports.
#
# Aliases: "PS_VERIFY_FILE_COPY or PS_VERIFY_FILE_COPIES"
#
# PS_FILE_COPY_VERIFY="true"
# ------------------------------------------------
# PS_FILE_COPY_WITH_REFLINK or fileCopyWithReflink
# ------------------------------------------------
#
# Should PhotoStructure use Node.js's COPYFILE_FICLONE flag? If true, file
# copy operations will attempt to create a copy-on-write reflink. If the
# platform does not support copy-on-write, then a fallback copy mechanism is
# used. Note that this defaulted to true in previous versions of
# PhotoStructure, but benchmarks show it to be (much) slower on Windows and it
# may be problematic over NFS, so the default is now false.
#
# Aliases: "PS_COPYFILE_FICLONE"
#
# PS_FILE_COPY_WITH_REFLINK="false"
# -----------------------------------------
# PS_MOUNTPOINTS_TTL_MS or mountpointsTtlMs
# -----------------------------------------
#
# How frequently should PhotoStructure scan for new volumes (so PhotoStructure
# can detect when drives are inserted or ejected)? Shorter than 10-15 seconds
# may cause issues on Windows. A value of 0 will cache indefinitely. This
# defaults to 15 minutes on Windows, which relies on polling. On Linux and
# macOS this is set to 0 because findmnt/gio and diskutil notify mountpoint
# changes without polling.
#
# PS_MOUNTPOINTS_TTL_MS="1m"
# ------------------------------
# PS_STAT_RETRIES or statRetries
# ------------------------------
#
# If a stat or readdir times out, how many times can PhotoStructure retry
# before giving up?.
#
# Set to 0 to disable retries.
#
# PS_STAT_RETRIES="3"
# -----------------------------------
# PS_STAT_TIMEOUT_MS or statTimeoutMs
# -----------------------------------
#
# Filesystem traversal can be dangerous business with scratched CDROMs and old
# busted hard drives. To prevent PhotoStructure from getting "stuck" when
# trying to read these devices, it will timeout directory iteration if stat()
# or readdir() exceeds this value. The default of 30 seconds should cover most
# issues with spun-down hard drives and NAS/WAN latency.
#
# Set to 0 to disable.
#
# Aliases: "PS_COMMAND_TIMEOUT_MS or PS_FS_TIMEOUT_MS"
#
# PS_STAT_TIMEOUT_MS="30s"
# -------------------------------------
# PS_TRY_SOFT_DELETES or trySoftDeletes
# -------------------------------------
#
# If true, "Empty Trash" will _try_ to move files into the "Trash can" or
# "Recycle bin", when possible. If moving a file into the trash can fails (due
# to permissions or filesystem functionality), the file will be "hard" deleted
# (or "unlinked").
#
# This setting defaults to false on docker. For more details, see
# https://photostructure.com/go/docker-soft-delete
#
# PS_TRY_SOFT_DELETES="true"
# -----------------------------
# PS_USE_FS_WATCH or useFsWatch
# -----------------------------
#
# If true, PhotoStructure will use the native filesystem watch APIs to detect
# file changes. This is the default and recommended setting. If false,
# PhotoStructure will poll the filesystem for changes instead. This is not
# recommended, but may be useful if you're running PhotoStructure on an OS or
# filesystem that doesn't support change notifications, like some network
# filesystems.
#
# For more details see https://nodejs.org/api/fs.html#availability
#
# PS_USE_FS_WATCH="true"
# ----------------------------------------------
# PS_VALIDATE_MOUNTPOINTS or validateMountpoints
# ----------------------------------------------
#
# When true, PhotoStructure ignores volumes whose mountpoints do not exist. If
# any volumes are unhealthy, though, this may wedge volume handlers.
#
# PS_VALIDATE_MOUNTPOINTS="true"
# ---------------------------------------
# PS_WATCH_DEBOUNCE_MS or watchDebounceMs
# ---------------------------------------
#
# How long to wait for a file to "settle down" and stop changing before the
# file watcher notifies listeners that the file changed. Some applications
# (like PhotoStructure) use work-in-progress "atomic" writes, but many
# applications overwrite in-place, which can cause the file watcher to see
# incomplete results until the write process is complete.
#
# The default is 500ms (½ second) to handle slow remote NASes and slow-writing
# applications.
#
# Set to 0 to disable.
#
# PS_WATCH_DEBOUNCE_MS="500ms"
##############################################################################
#
# Cache settings (system-wide)
#
# Controls caching behavior for computationally expensive operations and file
# conversions.
#
# ------------------------------------
# PS_FS_CACHE_SLOW_MS or fsCacheSlowMs
# ------------------------------------
#
# If a cache entry takes longer than this value to compute, cache results for
# later reuse to the filesystem.
#
# The default is very short, under the assumption that cache filesystem
# read/writes are <10ms.
#
# Set this to 0 to never cache to the filesystem.
#
# PS_FS_CACHE_SLOW_MS="25ms"
# ---------------------------------
# PS_IMAGE_CACHE_MS or imageCacheMs
# ---------------------------------
#
# Assets requiring conversion may need intermediary file storage as they are
# imported. These intermediary files only need to live as long as the import
# process for that asset. Too short of a time will result in this conversion
# work being re-done during import. Too long of a time will result in
# additional diskspace in your cache directory being consumed.
#
# PS_IMAGE_CACHE_MS="15m"
# ---------------------------------------
# PS_METADATA_CACHE_MS or metadataCacheMs
# ---------------------------------------
#
# How long can file metadata be safely cached?
#
# Set to 0 to disable metadata caching.
#
# PS_METADATA_CACHE_MS="10m"
##############################################################################
#
# Logging settings (system-wide)
#
# Controls diagnostic log output including levels, destinations, formatting,
# and filtering.
#
# ------------------------
# PS_LOG_COLOR or logColor
# ------------------------
#
# Output all logs with terminal escape codes to colorize output. If
# NO_COLOR=1, TERM=dumb, or TERM=unknown, this defaults to false.
#
# Aliases: "PS_LOG_COLOUR"
#
# PS_LOG_COLOR="true"
# ------------------------------------
# PS_LOG_COMPRESSION or logCompression
# ------------------------------------
#
# Should log files be compressed as they are rotated?
#
# PS_LOG_COMPRESSION="true"
# ---------------------------------------
# PS_LOG_CONTEXT_LIMIT or logContextLimit
# ---------------------------------------
#
# PhotoStructure will only log, at most, this number of elements or key/value
# pairs.
#
# PS_LOG_CONTEXT_LIMIT="32"
# --------------------
# PS_LOG_DIR or logDir
# --------------------
#
# Determines the directory that log files will be written to.
#
# PS_LOG_DIR="/home/user/.config/PhotoStructure/logs"
# -----------------------------
# PS_LOG_FLUSH_MS or logFlushMs
# -----------------------------
#
# How frequently should PhotoStructure flush log entries to disk? Lower values
# will result in more frequent writes to disk, but will also reduce the amount
# of data lost in the event of a crash. Higher values will result in less
# frequent writes to disk at the expense of memory consumption (which
# shouldn't be an issue unless you're doing debug or trace logging).
#
# PS_LOG_FLUSH_MS="200ms"
# ------------------------
# PS_LOG_LEVEL or logLevel
# ------------------------
#
# Determines which level of log messages are emitted to log files. May be
# "debug", "info", "warn", "error", "fatal", or several log level directives
# followed by a context (like "debug:web").
#
# Aliases: "PS_LOG, LOG or LOG_LEVEL"
#
# PS_LOG_LEVEL="info"
# --------------------------------
# PS_LOG_RETENTION or logRetention
# --------------------------------
#
# How long should we retain old log files? If set to 0, logs are never
# deleted.
#
# PS_LOG_RETENTION="1w"
# --------------------------
# PS_LOG_SERVER or logServer
# --------------------------
#
# Format as hostname:port or ip_address:port.
#
# If set, processes will emit log entries, formatted as GELF and separated by
# null bytes, via TCP.
#
# If this is set, the default PS_LOG_LEVEL drops from "error" to "info".
#
# For more details see https://docs.greylog.org/v1/docs/gelf
#
# PS_LOG_SERVER=""
# -------------------------------------
# PS_LOG_SERVER_LEVEL or logServerLevel
# -------------------------------------
#
# This is the log level used to filter logs before sending them to
# "PS_LOG_SERVER".
#
# If unset, we'll use the value of "PS_LOG_LEVEL".
#
# PS_LOG_SERVER_LEVEL="info"
# --------------------
# PS_LOG_SQL or logSql
# --------------------
#
# Log SQL queries to the default log level. **Enabling this negatively impacts
# performance.**.
#
# This defaults to false.
#
# PS_LOG_SQL="false"
# -------------
# PS_LOG_STDOUT
# -------------
#
# Log to stdout? This should be false unless you're running a service by hand.
#
# This setting is transient and only set via environment variables.
#
# Aliases: "LOG_STDOUT or PS_STDOUT"
#
# PS_LOG_STDOUT="false"
# ---------------------------
# PS_LOG_WEB_DIR or logWebDir
# ---------------------------
#
# Determines the directory that log files will be written to. If unset, will
# use logDir.
#
# PS_LOG_WEB_DIR=""
# -------------------------------------
# PS_LOG_WEB_REQUESTS or logWebRequests
# -------------------------------------
#
# Write an access log for all web requests?
#
# PS_LOG_WEB_REQUESTS="false"
# -----------------
# PS_QUIET or quiet
# -----------------
#
# If true, the main service won't emit lifecycle messages to stdout. Note that
# logStdout=true or logTail=true will override quiet=true.
#
# PS_QUIET="false"
# ------------
# PS_TAIL_LOGS
# ------------
#
# Output all logs from currently running PhotoStructure processes? This should
# be false unless you're running a service by hand.
#
# This setting is transient and only set via environment variables.
#
# PS_TAIL_LOGS="false"
##############################################################################
#
# Networking settings (system-wide)
#
# Controls network connectivity including ports, hostnames, and network modes.
#
# -----------------------
# PS_HOSTNAME or hostname
# -----------------------
#
# If set, this overrides the local hostname. Useful under docker and when OSes
# change hostnames due to networking bugs (see macOS).
#
# PS_HOSTNAME=""
# ------------------------
# PS_HTTP_PORT or httpPort
# ------------------------
#
# Network port for HTTP access to your PhotoStructure library.
#
# PS_HTTP_PORT="1787"
# -------------------------
# PS_LOCALHOST or localhost
# -------------------------
#
# If "exposeNetworkWithoutAuth" is false, what value should PhotoStructure use
# for localhost? (Some firewalls are OK with "127.0.0.1", some require
# "localhost"). For more details see
# https://letsencrypt.org/docs/certificates-for-localhost/
# https://tools.ietf.org/html/draft-ietf-dnsop-let-localhost-be-localhost-02
# and https://photostructure.com/faq/troubleshooting/#windows-firewall-issues
#
# PS_LOCALHOST="127.0.0.1"
# --------------------------
# PS_NO_NETWORK or noNetwork
# --------------------------
#
# If set, PhotoStructure will assume all outbound network requests will fail.
#
# PS_NO_NETWORK="false"
# ------------------------
# PS_SYNC_PORT or syncPort
# ------------------------
#
# Localhost-only JSON RPC port for task enqueuing, progress status, and
# control of the PhotoStructure sync process. Defaults to httpPort + 100 (to
# avoid collisions from multiple libraries).
#
# PS_SYNC_PORT="1887"
##############################################################################
#
# Processes settings (system-wide)
#
# Controls process spawning, concurrency, resource limits, and subprocess
# management.
#
# -------------------------------------
# PS_CPU_BUSY_PERCENT or cpuBusyPercent
# -------------------------------------
#
# This setting is a rough goal for PhotoStructure to load the system during
# library synchronization. A higher value here will allow PhotoStructure to
# run more tasks in parallel, but may impact your system's responsiveness.
#
# Under normal circumstances, setting this to any value over 100 will result
# in full CPU saturation, and is not recommended, as it will cause spurious
# timeouts leading to some percentage of failed imports.
#
# While syncing, PhotoStructure will not dequeue sync file jobs if the current
# system busy percent exceeds this value.
#
# Setting this value to 0 will run the sync process in "single-process
# mode"--no external worker processes will be spun up by the "sync" process,
# and file imports will be done serially.
#
# Minimum value: 0
# Maximum value: 500
# Aliases: "PS_CPU_LOAD_PERCENT or PS_CPU_PCT"
#
# PS_CPU_BUSY_PERCENT="75"
# ----------------------------------------------------
# PS_EXIFTOOL_PROCS_PER_CHILD or exiftoolProcsPerChild
# ----------------------------------------------------
#
# Controls the number of exiftool child processes allowed by the sync process.
# Note that each PhotoStructure process may spin up an ExifTool child process
# if needed. The "web" and "worker" services are limited to a single exiftool
# child process.
#
# If this is unset, "sync" will default to the number of supported concurrent
# imports.
#
# PS_EXIFTOOL_PROCS_PER_CHILD=""
# ---------------------------------------------------------
# PS_FATAL_ERROR_RATE_PER_MINUTE or fatalErrorRatePerMinute
# ---------------------------------------------------------
#
# If PhotoStructure sees errors at a higher rate per minute than this setting,
# PhotoStructure will shut down. If this value is too high, PhotoStructure may
# look busy, but it's just busy failing. If this value is set too low,
# temporary errors (due to network flakiness or USB hiccups) might shut down
# PhotoStructure needlessly.
#
# PS_FATAL_ERROR_RATE_PER_MINUTE="20"
# ----------------------------------------------------
# PS_HEALTH_CHECK_INTERVAL_MS or healthCheckIntervalMs
# ----------------------------------------------------
#
# How often should the main process check on the health of the web and sync
# subprocesses?
#
# PS_HEALTH_CHECK_INTERVAL_MS="2m"
# -------------------------------------------------
# PS_MAX_CONCURRENT_IMPORTS or maxConcurrentImports
# -------------------------------------------------
#
# How many imports can PhotoStructure schedule concurrently? This will be
# clamped between 1 and 32.
#
# If not set, a sensible value will be computed based on "cpuLoadPercent".
#
# If set explicitly, this and "sharpThreadsPerProcess" will override
# "cpuLoadPercent" and "maxConcurrentImportsWhenRemote" settings.
#
# Aliases: "PS_MAX_SYNC_FILE_JOBS"
#
# PS_MAX_CONCURRENT_IMPORTS=""
# -----------------------------------------------------------------------
# PS_MAX_CONCURRENT_IMPORTS_WHEN_REMOTE or maxConcurrentImportsWhenRemote
# -----------------------------------------------------------------------
#
# How many concurrent files can be imported if the library is on a remote
# volume? This defaults to 2 to try to avoid overwhelming HDD I/O on the
# remote NAS. If this is larger than (cpus.length * cpuLoadPercent) or max
# child processes given available memory, this value will be ignored.
#
# Aliases: "PS_MAX_SYNC_FILE_JOBS_WHEN_REMOTE"
#
# PS_MAX_CONCURRENT_IMPORTS_WHEN_REMOTE="2"
# -------------------------------
# PS_MAX_MEMORY_MB or maxMemoryMb
# -------------------------------
#
# PhotoStructure will restart services if they use more than this value
# (measured in megabytes, or 1,000,000 bytes). Note that this is not the
# allocated memory. See maxRssMemoryMb for total allocated.
#
# Set to 0 to deactivate this check.
#
# PS_MAX_MEMORY_MB="500"
# ----------------------------
# PS_MAX_RETRIES or maxRetries
# ----------------------------
#
# If a task has an error, how many times should we retry before giving up?
#
# If you have a flaky network, this can help ensure imports are comprehensive.
#
# Set this to 0 to disable retries.
#
# PS_MAX_RETRIES="2"
# ----------------------------------------------
# PS_MAX_TASKS_PER_PROCESS or maxTasksPerProcess
# ----------------------------------------------
#
# PhotoStructure will recycle threads and worker processes after they handle
# this number of requests. Smaller values may reduce overall memory pressure.
# Larger values amortize startup costs over fewer restarts.
#
# Minimum value: 1
# Maximum value: 5000
#
# PS_MAX_TASKS_PER_PROCESS="500"
# -----------------------------
# PS_MIN_BUSY_PCT or minBusyPct
# -----------------------------
#
# Every couple of minutes, if a sync is currently running, and the system load
# is below this value, we will assume any task running longer than
# "stuckCheckIntervalMs" is "stuck" and should be canceled.
#
# Set this to 0 to disable this check.
#
# PS_MIN_BUSY_PCT="25"
# -----------------------------------------------------------
# PS_MIN_DELAY_BETWEEN_RETRIES_MS or minDelayBetweenRetriesMs
# -----------------------------------------------------------
#
# If a task has an error, should we wait a bit before retrying? This may help
# temper error cascades.
#
# Aliases: "PS_MIN_DELAY_BETWEEN_SPAWN_MILLIS"
#
# PS_MIN_DELAY_BETWEEN_RETRIES_MS="250ms"
# -------------------------------------------------------
# PS_MIN_DELAY_BETWEEN_SPAWN_MS or minDelayBetweenSpawnMs
# -------------------------------------------------------
#
# The shorter this time is, the faster PhotoStructure will ramp up parallelism
# at the start of a sync. Having a larger value here mitigates initial system
# load from forking. For more details see
# https://photostructure.github.io/batch-cluster.js/classes/BatchClusterOptions.html#minDelayBetweenSpawnMillis
#
# Aliases: "PS_MIN_DELAY_BETWEEN_SPAWN_MILLIS"
#
# PS_MIN_DELAY_BETWEEN_SPAWN_MS="1s500ms"
# --------------------------------------------------------------------------
# PS_MIN_TIME_BETWEEN_SERVICE_RESTARTS_MS or minTimeBetweenServiceRestartsMs
# --------------------------------------------------------------------------
#
# If a service (like web or sync) is restarted due to an error, how many
# milliseconds must elapse before another restart is allowed? This helps
# prevent system load due to service flapping.
#
# PS_MIN_TIME_BETWEEN_SERVICE_RESTARTS_MS="7s"
# --------------------------------------
# PS_PROCESS_PRIORITY or processPriority
# --------------------------------------
#
# By default, PhotoStructure runs child processes with a "below normal"
# priority, so your system remains usable while imports run. Changing this
# value to "normal" or "above normal" may speed up imports but cause your
# system to be unresponsive. Changing this value to "idle" may prevent imports
# from running at all.
#
# For Linux and macOS systems, see
# https://en.wikipedia.org/wiki/Nice_%28Unix%29 .
#
# For Windows, see