defaults.env

#
# Welcome to PhotoStructure! These are the settings for version 1.0.0.
#
# Please see <https://photostructure.com/environment-variables> for more
# information about using environment variables with PhotoStructure.
#
# PLEASE NOTE: PhotoStructure does not read the contents of this
# "defaults.env" (or any ".env" variant).
#
# The following settings categories are stored in the system settings.toml:
#
# * System.Desktops
# * System.Logging
# * System.Networking
# * System.Paths
# * System.Processes
# * System.Timeouts
# * System.Tools
# * System.Updates
# * System.Volumes
#
# The following settings categories are stored in the library settings.toml:
#
# * Library.Db
# * Library.Deduping
# * Library.Filters
# * Library.HealthChecks
# * Library.Parsing
# * Library.Previews
# * Library.Reporting
# * Library.Sidecars
# * Library.Subscriptions
# * Library.Sync
# * Library.Tagging
# * 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!
#



##############################################################################
#
# Settings for System.paths:
#


# +-----------------------+
# |  copyAssetsToLibrary  |
# +-----------------------+
#
# Should PhotoStructure copy photos and videos to your PhotoStructure Library?
# This setting holds the value for the welcome page's "May PhotoStructure
# organize your photos and videos?" section. Read more about this setting
# here:
# <https://photostructure.com/getting-started/automatic-library-organization/>.
#
# PS_COPY_ASSETS_TO_LIBRARY="true"


# +--------------+
# |  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
#
# PS_LIBRARY_DIR=""


# +-----------------+
# |  scanAllDrives  |
# +-----------------+
#
# Should PhotoStructure scan all folders on all drives available to this
# computer for photos and videos?
#
# PS_SCAN_ALL_DRIVES="true"


# +------------------+
# |  scanMyPictures  |
# +------------------+
#
# Deprecated, and will be removed in the next version. If set, PhotoStructure
# will automatically add your pictures directory to your `scanPaths` setting
# and then flip this setting back to false.
#
# PS_SCAN_MY_PICTURES="false"


# +-------------+
# |  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"]'`.
#
# PS_SCAN_PATHS=""


# +------------+
# |  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.
#
# PS_CACHE_DIR="$HOME/.cache/photostructure"


# +-----------------------+
# |  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.
#
# For details, see
# <https://forum.photostructure.com/t/whats-force-local-db-replica/837>.
#
# PS_FORCE_LOCAL_DB_REPLICA="false"


# +----------------+
# |  neverIgnored  |
# +----------------+
#
# Paths to files or directories that should not be ignored, even if they are
# hidden or have .nomedia files.
#
# PS_NEVER_IGNORED=""


# +----------------+
# |  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.
#
# 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.
#
# See
# <https://forum.photostructure.com/t/hybrid-photostructure-libraries/775>.
#
# PS_ORIGINALS_DIR="."


# +-----------+
# |  pidfile  |
# +-----------+
#
# This is the absolute path to the PID file for the main process. This is
# optional and only used by PhotoStructure for Servers.
#
# Aliases: PIDFILE
#
# PS_PIDFILE=""


# +---------------+
# |  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.
#
# See
# <https://forum.photostructure.com/t/hybrid-photostructure-libraries/775>.
#
# PS_PREVIEWS_DIR=".photostructure/previews"


# +--------------------+
# |  scanLibraryFirst  |
# +--------------------+
#
# Should PhotoStructure scan your library before all other paths are
# synchronized?
#
# PS_SCAN_LIBRARY_FIRST="false"


# +-------------------+
# |  scanLibraryLast  |
# +-------------------+
#
# Should PhotoStructure scan your library after all other paths are
# synchronized?
#
# PS_SCAN_LIBRARY_LAST="true"



##############################################################################
#
# Settings for System.logging:
#


# +------------+
# |  logColor  |
# +------------+
#
# Output all logs with terminal escape codes to colorize output. If NO_COLOR
# is set, this defaults to false. See <https://no-color.org/>.
#
# PS_LOG_COLOR="true"


# +------------------+
# |  logCompression  |
# +------------------+
#
# Should log files be compressed as they are rotated?
#
# PS_LOG_COMPRESSION="true"


# +----------+
# |  logDir  |
# +----------+
#
# Determines the directory that log files will be written to.
#
# PS_LOG_DIR="$HOME/.config/PhotoStructure/logs"


# +----------------+
# |  logElapsedMs  |
# +----------------+
#
# Prefix log entries by a timestamp (if set to false), or by the number of
# milliseconds since startup (if set to true).
#
# PS_LOG_ELAPSED_MS="false"


# +------------+
# |  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:rpc").
#
# Aliases: PS_LOG,LOG
#
# PS_LOG_LEVEL="error"


# +----------+
# |  logSql  |
# +----------+
#
# Log SQL queries to the default log level. *This is really chatty* and
# impacts performance. Normally these log messages are completely disabled.
#
# PS_LOG_SQL="false"


# +-------------+
# |  logStdout  |
# +-------------+
#
# 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,PS_STDOUT
#
# PS_LOG_STDOUT="false"


# +-------------+
# |  logWebDir  |
# +-------------+
#
# Determines the directory that log files will be written to. If unset, will
# use logDir.
#
# PS_LOG_WEB_DIR=""


# +------------------+
# |  logWebRequests  |
# +------------------+
#
# Write an access log for all web requests?
#
# PS_LOG_WEB_REQUESTS="false"


# +------------+
# |  tailLogs  |
# +------------+
#
# 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"



##############################################################################
#
# Settings for System.timeouts:
#


# +--------------------+
# |  commandTimeoutMs  |
# +--------------------+
#
# How long should PhotoStructure wait for a command that touches the
# filesystem (and doesn't do anything computationally expensive)? Note that
# external hard drives can take 10-15 seconds to spin up, so values less than
# that may result in timeouts.
#
# PS_COMMAND_TIMEOUT_MS="25000"


# +-----------------+
# |  debugTimeouts  |
# +-----------------+
#
# Should PhotoStructure log timeout sources? Note that this instrumentation
# has a performance impact.
#
# PS_DEBUG_TIMEOUTS="false"


# +--------------------+
# |  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.
#
# PS_MOUNTPOINTS_TTL_MS="60000"


# +-----------------------+
# |  volumeMetadataTtlMs  |
# +-----------------------+
#
# How frequently should PhotoStructure reload volume metadata (like
# bytes-free, which is used in a health check)? Values less than a minute are
# not necessary.
#
# PS_VOLUME_METADATA_TTL_MS="900000"



##############################################################################
#
# Settings for System.networking:
#


# +----------------------------+
# |  exposeNetworkWithoutAuth  |
# +----------------------------+
#
# Normally the web service is only accessible to the computer running
# PhotoStructure. Setting this to true will expose your library to all
# computers on your network. You should own or trust all systems on that
# network, as there is no auth in PhotoStructure currently. Future versions of
# PhotoStructure will add authorization mechanisms, at which point this
# setting will be deleted.
#
# **Don't enable this unless you know what you are doing**.
#
# PS_EXPOSE_NETWORK_WITHOUT_AUTH="false"


# +------------+
# |  httpPort  |
# +------------+
#
# Network port for HTTP access to your PhotoStructure library.
#
# PS_HTTP_PORT="1787"


# +-------------+
# |  localhost  |
# +-------------+
#
# If "exposeNetworkWithoutAuth" is false, what value should PhotoStructure use
# for localhost? (Some firewalls are OK with "127.0.0.1", some require
# "localhost"). See <https://letsencrypt.org/docs/certificates-for-localhost/>
# and
# <https://photostructure.com/faq/troubleshooting/#windows-firewall-issues>.
#
# PS_LOCALHOST="127.0.0.1"


# +-----------+
# |  rpcPort  |
# +-----------+
#
# Network port for rpc access to your PhotoStructure library. Only binds to
# loopback (even if exposeNetworkWithoutAuth is true).
#
# PS_RPC_PORT="1807"


# +--------------+
# |  trustProxy  |
# +--------------+
#
# Support for PhotoStructure instances running behind a reverse proxy. See
# <http://expressjs.com/en/guide/behind-proxies.html>. This setting should
# either be "false" (don't trust any proxies), "loopback", (only trust
# localhost), a single subnet (like "127.0.0.0/8"), or a comma-delimited set
# of subnets.
#
# PS_TRUST_PROXY="false"



##############################################################################
#
# Settings for System.processes:
#


# +------------------+
# |  cpuLoadPercent  |
# +------------------+
#
# PhotoStructure runs many things in parallel during library synchronization.
# The maximum number of concurrent file imports that PhotoStructure will
# schedule at a time will be the number of CPUs that this system has
# multiplied by this percent. A higher value here will allow PhotoStructure to
# run more tasks in parallel, but may impact your system's responsiveness. 75%
# should be a reasonable balance between keeping your system responsive and
# importing your library quickly. Setting this value to 0 will still allow 1
# task to run concurrently. System memory will also be taken into account to
# try to prevent swapping.
#
# This setting is ignored if "maxSyncFileJobs" and "sharpThreadsPerJob" are
# set.
#
# Min value: 0
# Max value: 200
#
# PS_CPU_LOAD_PERCENT="75"


# +-------------------------+
# |  exiftoolProcsPerChild  |
# +-------------------------+
#
# Each PhotoStructure process spins up an ExifTool when needed. Note that the
# `web`, `sync`, and `sync-file` services all use exiftool, so the total
# number of exiftool processes can be many times larger than this value.
#
# Min value: 1
# Max value: 8
#
# PS_EXIFTOOL_PROCS_PER_CHILD="2"


# +---------------------------+
# |  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 busyfailing. 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="10"


# +-----------------+
# |  ffmpegThreads  |
# +-----------------+
#
# When transcoding videos, what value should we give to "ffmpeg -threads"?
#
# This defaults to min(1, <# of cpus> * cpuLoadPercent / 4).
#
# Note that "ffmpeg -threads" _most likely doesn't do what you expect_: a
# value of 0 will consume all CPUs (which is why it isn't allowed). A value of
# N will actually mean > N CPUs are used (due to demux threading and other
# details). See <https://stackoverflow.com/a/41010102>.
#
# PS_FFMPEG_THREADS=""


# +-----------+
# |  inspect  |
# +-----------+
#
# Should processes run with --inspect? This should only be enabled
# temporarily, as it impacts both performance and security.
#
# This setting is transient and only set via environment variables.
#
#
# PS_INSPECT="false"


# +---------------+
# |  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.
#
# Min value: 0
# Max value: 8000
#
# PS_MAX_MEMORY_MB="500"


# +------------------+
# |  maxRssMemoryMb  |
# +------------------+
#
# PhotoStructure will restart services if their' resident set size consumes
# more than this value (measured in megabytes, or 1,000,000 bytes).
#
# Min value: 0
# Max value: 8000
#
# PS_MAX_RSS_MEMORY_MB="1024"


# +-------------------+
# |  maxSyncFileJobs  |
# +-------------------+
#
# How many concurrent "sync-file" jobs can run during an import? This will be
# clamped between 1 and 24.
#
# If set explicitly, this and "sharpThreadsPerJob" will override
# "cpuLoadPercent" and "maxSyncFileJobsWhenRemote" settings.
#
# PS_MAX_SYNC_FILE_JOBS=""


# +-----------------------------+
# |  maxSyncFileJobsWhenRemote  |
# +-----------------------------+
#
# How many concurrent "sync-file" jobs can run if the library is on a remote
# volume? This defaults to 2 to try to avoid overwhelming HDD I/O on the
# remote NAS.
#
# PS_MAX_SYNC_FILE_JOBS_WHEN_REMOTE="2"


# +----------------------+
# |  maxTasksPerProcess  |
# +----------------------+
#
# PhotoStructure will recycle sync-file processes after they handle this
# number of requests. Smaller values may reduce overall memory pressure.
# Larger values amortize startup costs over fewer restarts.
#
# Min value: 1
# Max value: 5000
#
# PS_MAX_TASKS_PER_PROCESS="250"


# +-----------------+
# |  minDiskFreeGb  |
# +-----------------+
#
# PhotoStructure will pause processing if the GB free on the disk that your
# library is stored on drops below this value. The value provided here will be
# multiplied by 1000^3. Note that many OSes will corrupt themselves when disks
# fill up, and SSDs can fail as they approach full capacity. A value of less
# than 8 may be unsafe (due to hibernation and OS update files).
#
# Set this value to 0 to disable free disk space health checks.
#
# PS_MIN_DISK_FREE_GB="6"


# +-----------------------------------+
# |  minTimeBetweenServiceRestartsMs  |
# +-----------------------------------+
#
# If a service (like web, sync, or sync-file) is restarted due to an error,
# how many ms must elapse before another restart is allowed? This helps
# prevent system load due to service flapping.
#
# PS_MIN_TIME_BETWEEN_SERVICE_RESTARTS_MS="7000"


# +------------------+
# |  pollIntervalMs  |
# +------------------+
#
# The number of milliseconds we wait between polling for changes in remote
# filesystems. This defaults to 1 minute, to minimize remote filesystem load.
#
# PS_POLL_INTERVAL_MS="60000"


# +---------------+
# |  probationMs  |
# +---------------+
#
# Normally when subsystems crash, PhotoStructure restarts them after a delay.
# Unfortunately, if there is a persistent error, this means PhotoStructure
# keeps trying something that won't ever work; it looks busy, but it's just
# busy failing. To prevent this situation, PhotoStructure will shut down if
# there are high error rates within 2 minutes of starting. (2 minutes should
# be long enough to spin up the web process, sync process, and import at least
# one pending file). Setting this to 0 will prevent PhotoStructure from
# exiting due to high error rates.
#
# PS_PROBATION_MS="120000"


# +-------------------+
# |  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.
#
# Valid values: AboveNormal,Normal,BelowNormal,Idle
#
# PS_PROCESS_PRIORITY="BelowNormal"


# +----------------------+
# |  sensitiveEnvRegExp  |
# +----------------------+
#
# PhotoStructure spawns a number of processes (including "exiftool" and
# "ffmpeg"), and passes through environment variables, mostly to ensure locale
# and TZ settings are correct. To prevent environment values that contain
# sensitive information, like API access tokens, from either being logged, or
# being accessed by external tools, all environment variables whose key
# matches this setting will be removed. This regex is applied
# case-insensitively.
#
# PS_SENSITIVE_ENV_REG_EXP="key|secret|pass|_user|aws_"


# +------------------+
# |  setupTimeoutMs  |
# +------------------+
#
# To prevent unhealthy services running as zombies, they self-terminate if the
# setup processes are not complete within this amount of time. Note that only
# the environment variable value is used for this setting.
#
# PS_SETUP_TIMEOUT_MS="35000"


# +----------------------+
# |  sharpThreadsPerJob  |
# +----------------------+
#
# How many image processing threads can be spun per sync-file process? This
# will be clamped between 1 and 6.
#
# This and "maxSyncFileJobs" override "cpuLoadPercent".
#
# PS_SHARP_THREADS_PER_JOB=""



##############################################################################
#
# Settings for System.tools:
#


# +-----------------+
# |  dcraw_emuPath  |
# +-----------------+
#
# This should be the absolute, native path to the "dcraw_emu" binary on this
# system. If this is set to "dcraw_emu", PhotoStructure will search your
# $PATH. See <https://www.libraw.org/docs/Samples-LibRaw.html>.
#
# PS_DCRAW_EMU_PATH="dcraw_emu"


# +--------------+
# |  enableSIMD  |
# +--------------+
#
# Should PhotoStructure enable SIMD extensions when running image operations?
# This defaults to false on macOS due to instability on that platform.
#
# PS_ENABLE_SIMD="true"


# +-------------------+
# |  enableVipsCache  |
# +-------------------+
#
# Should PhotoStructure enable VIPS caching, which may help speed up image
# operations? This defaults to false to reduce memory consumption.
#
# PS_ENABLE_VIPS_CACHE="false"


# +-----------------+
# |  ffmpegHwaccel  |
# +-----------------+
#
# FFmpeg supports both software and hardware encoders. Valid values include
# "auto" which should work for everyone, "cuda" for NVIDIA GPUs, or use
# "disable", "no", "false", or "" to disable. Run "ffmpeg -hwaccels" to see
# supported acceleration methods. See
# <https://forum.photostructure.com/t/hardware-accelerated-encoding-transcoding/166>,
# <https://trac.ffmpeg.org/wiki/HWAccelIntro>, and
# <https://github.com/NVIDIA/nvidia-docker> for more details.
#
# PS_FFMPEG_HWACCEL="disable"


# +--------------+
# |  ffmpegPath  |
# +--------------+
#
# This should be the absolute, native path to the "ffmpeg" binary on this
# system. If this is set to "ffmpeg", PhotoStructure will search your $PATH.
# PhotoStructure prefers using ffmpeg to vlc. See
# <https://photostructure.com/getting-started/video-support/>.
#
# PS_FFMPEG_PATH="ffmpeg"


# +-----------------------+
# |  ffmpegTranscodeArgs  |
# +-----------------------+
#
# The following are the default arguments added to transcode requests made to
# ffmpeg (when ffmpeg is available). The following arguments will follow
# "ffmpeg -loglevel error -threads T -i INPUT_FILE_PATH" (where T is replaced
# by ~half the available CPU threads, and INPUT_FILE_PATH is the full native
# pathname to the source video).
#
# CAUTION: this is an advanced setting. Editing this may cause videos that
# require transcoding to not be imported, or not be viewable on all browsers
# and platforms. See
# <https://forum.photostructure.com/t/poor-transcoding-of-videos-in-wider-color-spaces-rec-2020/646>
# for more details.
#
# PS_FFMPEG_TRANSCODE_ARGS="[\"-c:a\",\"aac\",\"-c:v\",\"libx264\",\"-pix_fmt\",\"yuv420p\",\"-color_trc\",\"smpte2084\",\"-color_primaries\",\"bt2020\",\"-movflags\",\"faststart\",\"-profile:v\",\"high\"]"


# +-------------------+
# |  heifConvertPath  |
# +-------------------+
#
# This should be the absolute, native path to the "heif-convert" binary on
# this system. If this is set to "heif-convert", PhotoStructure will search
# your $PATH. See <https://photostructure.com/getting-started/heif-support/>.
#
# PS_HEIF_CONVERT_PATH="heif-convert"


# +------------------+
# |  powerShellArgs  |
# +------------------+
#
# The following are the default arguments added to spin up PowerShell on
# Windows devices.
#
# See
# <https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_powershell_exe?view=powershell-5.1>
# for all arguments that PowerShell.exe accepts.
#
# See
# <https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-5.1>
# for a description of Bypass.
#
# See
# <https://forum.photostructure.com/t/eliminate-powershell-profile-and-execution-policy-related-errors/184>
# for more details about why this needs to be configurable.
#
# (Versions prior to v1.0.0 only specified "-NoLogo").
#
# PS_POWER_SHELL_ARGS="[\"-NoLogo\",\"-NoProfile\",\"-ExecutionPolicy\",\"Bypass\"]"


# +---------------------+
# |  powerShellCulture  |
# +---------------------+
#
# If set to a non-blank value, PhotoStructure on Windows machines will set
# PowerShell's `[System.Threading.Thread]::CurrentThread.CurrentCulture` to
# this value. This allows PhotoStructure to parse PowerShell output reliably.
#
# PS_POWER_SHELL_CULTURE="en-US"


# +---------------------------+
# |  showFileInFolderCommand  |
# +---------------------------+
#
# If set, the first argument will be used as a command (or path to command),
# and the subsequent arguments (if present) will be used as arguments. The
# native path to the file or the file: URI will be appended, based on the
# value given to the "showFileInFolderUsesFileUri" setting. If this is set to
# an empty array, the default tool for your platform will be used instead:
# "nautilus -s" on linux, "open -R" on mac, and "explorer /select" on Windows.
#
# This is provided to support Linux desktops that don't use Gnome.
#
# PS_SHOW_FILE_IN_FOLDER_COMMAND=""


# +-------------------------------+
# |  showFileInFolderUsesFileUri  |
# +-------------------------------+
#
# Does the showFileInFolderCommand expect a file: URI to the file? If this is
# false, the native path will be appended instead.
#
# PS_SHOW_FILE_IN_FOLDER_USES_FILE_URI="true"


# +------------------------------+
# |  showFileInFolderUsesThunar  |
# +------------------------------+
#
# If we're on Linux, should we use Thunar (via dbus) to "show file in folder"?
#
# PS_SHOW_FILE_IN_FOLDER_USES_THUNAR="false"


# +-------------+
# |  toolPaths  |
# +-------------+
#
# These paths are appended to the PATH to ensure PhotoStructure can find and
# run external tools like ffmpeg. Use your operating system's separator to
# separate paths (":" for mac and linux, ";" for windows).
#
# PS_TOOL_PATHS="[\"/usr/local/bin\",\"/usr/local/sbin\",\"/usr/lib/libraw\",\"/opt/local/bin\",\"/opt/local/sbin\",\"/usr/sbin\",\"/usr/bin\",\"/sbin\",\"/bin\"]"


# +-----------+
# |  vlcPath  |
# +-----------+
#
# This should be the absolute, native path to the "vlc" binary on this system.
# If this is set to "vlc", PhotoStructure will search your $PATH.
#
# PS_VLC_PATH="vlc"



##############################################################################
#
# Settings for System.desktops:
#


# +-------------------+
# |  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"


# +-----------------+
# |  updateChannel  |
# +-----------------+
#
# TL:DR; keep this on "latest." This setting only applies to PhotoStructure
# for Desktops, and controls which builds of PhotoStructure you are eligible
# to automatically update to. Please note that "alpha" builds may not even
# launch, and "beta" builds have not been thoroughly tested. Please only
# consider changing this if customer support asks you to, and that you have
# recent backups of your system.
#
# Valid values: alpha,beta,latest
#
# PS_UPDATE_CHANNEL="latest"


# +----------------------+
# |  updateCheckMinutes  |
# +----------------------+
#
# While running, PhotoStructure will check periodically for updates. The
# default is daily.
#
# PS_UPDATE_CHECK_MINUTES="1440"


# +------------------+
# |  updateOnLaunch  |
# +------------------+
#
# If true, PhotoStructure will check for updates automatically on launch.
#
# PS_UPDATE_ON_LAUNCH="true"



##############################################################################
#
# Settings for System.volumes:
#


# +--------------------------+
# |  ignoreUnhealthyVolumes  |
# +--------------------------+
#
# When true, PhotoStructure ignores volumes that are not healthy (due to
# needing filesystem checks, or remote filesystems that are not available).
#
# PS_IGNORE_UNHEALTHY_VOLUMES="true"


# +-----------------------+
# |  readVolumeUuidFiles  |
# +-----------------------+
#
# When true, PhotoStructure uses ".uuid" files found in the root directory of
# volumes as the volume UUID, which can help with cross-host library
# portability. Set this to false if you don't want PhotoStructure to read
# these ".uuid" files. See https://photostructure.com/faq/what-is-a-volume for
# more information.
#
# PS_READ_VOLUME_UUID_FILES="true"


# +-------------------------+
# |  remoteFilesystemTypes  |
# +-------------------------+
#
# Filesystems with these types should always be considered "remote".
#
# PS_REMOTE_FILESYSTEM_TYPES="[\"sshfs\",\"s3fs\"]"


# +-----------------------+
# |  validateMountpoints  |
# +-----------------------+
#
# When true, PhotoStructure ignores volumes whose mountpoints do not exist.
#
# PS_VALIDATE_MOUNTPOINTS="true"


# +------------------------+
# |  writeVolumeUuidFiles  |
# +------------------------+
#
# When true, PhotoStructure (tries to) write ".uuid" files into the root
# directory of volumes, which enables cross-host library portability. Set this
# to false if you don't want PhotoStructure to try to write these ".uuid"
# files. See https://photostructure.com/faq/what-is-a-volume for more
# information.
#
# PS_WRITE_VOLUME_UUID_FILES="true"



##############################################################################
#
# Settings for Library.db:
#


# +---------------------------+
# |  backupRemoteDbOnSuspend  |
# +---------------------------+
#
# Run a database backup when system suspend is requested and the database is
# on a remote volume.
#
# PS_BACKUP_REMOTE_DB_ON_SUSPEND="true"


# +---------------------------+
# |  dbBackupIntervalMinutes  |
# +---------------------------+
#
# How many minutes should elapse between backing of your library database?
# Note that PhotoStructure vacuums and optimizes the database before a backup
# is taken. You want this period to be frequent enough such that data loss
# isn't too painful. Note that backups can cause the webserver to be
# momentarily unresponsive. Default is every half hour.
#
# Min value: 0.5
# Max value: 720
#
# PS_DB_BACKUP_INTERVAL_MINUTES="30"


# +------------------+
# |  dbBackupsCount  |
# +------------------+
#
# How many prior backups should PhotoStructure retain? These will typically be
# 10-500 MB, depending on the size of your library.
#
# PS_DB_BACKUPS_COUNT="20"


# +---------------------+
# |  dbBatchSelectSize  |
# +---------------------+
#
# How many objects can be selected at at time? The default should be fine.
# (Exposed for performance tests).
#
# Min value: 1
# Max value: 900
#
# PS_DB_BATCH_SELECT_SIZE="128"


# +---------------------+
# |  dbBatchUpsertSize  |
# +---------------------+
#
# How many objects can be upserted at at time? The default should be fine.
# (Exposed for performance tests).
#
# Min value: 1
# Max value: 500
#
# PS_DB_BATCH_UPSERT_SIZE="16"


# +-----------------+
# |  dbCacheSizeMb  |
# +-----------------+
#
# PhotoStructure uses SQLite, and the cache_size pragma should ideally be set
# such that the whole DB can be in memory. See
# https://sqlite.org/pragma.html#pragma_cache_size for more information.
#
# PS_DB_CACHE_SIZE_MB="192"


# +---------------+
# |  dbTimeoutMs  |
# +---------------+
#
# SQLite can time out requests if the db file is unavailable. PhotoStructure
# will retry those requests (up to `maxBusyDbMs`). A shorter time may help
# overall throughput, but may require more work done in retry logic. A longer
# time may be better for slower machines and slower disks. Note that setting
# this value to be lower than disk I/O latency (~1ms-100ms) will cause all
# database queries to fail.
#
# PS_DB_TIMEOUT_MS="1000"


# +---------------+
# |  maxBusyDbMs  |
# +---------------+
#
# SQLite supports concurrent readers but concurrent writers may collide,
# causing a LOCKED or BUSY error. PhotoStructure will retry the db operation
# for maxBusyDbMs milliseconds. This defaults to 2 minutes, which seems like a
# long time, but hard drives and network filesystems can take 10-20 seconds to
# spin up if asleep.
#
# PS_MAX_BUSY_DB_MS="120000"



##############################################################################
#
# Settings for Library.healthchecks:
#


# +-------------+
# |  forceOpen  |
# +-------------+
#
# DANGEROUS: if set, all previously-existing library locks will be removed.
# This should only be necessary if the prior PhotoStructure process was not
# shut down gracefully.
#
# This setting is transient and only set via environment variables.
#
#
# PS_FORCE_OPEN="false"


# +-----------------+
# |  healthCheckDb  |
# +-----------------+
#
# When true, PhotoStructure verifies that the library database can be read
# from and written to.
#
# PS_HEALTH_CHECK_DB="true"


# +-----------------------+
# |  healthCheckExiftool  |
# +-----------------------+
#
# When true, PhotoStructure verifies ExifTool is available and a valid
# version.
#
# PS_HEALTH_CHECK_EXIFTOOL="true"


# +------------------------+
# |  healthCheckFreeSpace  |
# +------------------------+
#
# When true, PhotoStructure verifies that the library and cache volumes have
# sufficient free space.
#
# PS_HEALTH_CHECK_FREE_SPACE="true"


# +--------------------------------+
# |  healthCheckLibraryIsWritable  |
# +--------------------------------+
#
# When true, PhotoStructure verifies the library directory exists, and is
# writable.
#
# PS_HEALTH_CHECK_LIBRARY_IS_WRITABLE="true"


# +----------------------+
# |  healthCheckVolumes  |
# +----------------------+
#
# When true, PhotoStructure verifies volumes as part of periodic health
# checks.
#
# PS_HEALTH_CHECK_VOLUMES="true"


# +------------------------+
# |  openLockStaleMinutes  |
# +------------------------+
#
# If an opened-by lockfile has not been touched in this number of minutes, the
# file is considered stale and invalid. Libraries will refresh their lockfile
# more frequently than this period. The disk that hosts your library won't be
# able to idle if this is set too short.
#
# PS_OPEN_LOCK_STALE_MINUTES="60"


# +------------------------+
# |  skipLibraryOpenLocks  |
# +------------------------+
#
# DANGEROUS: if set, PhotoStructure will not do any library opened-by locking,
# which could result in concurrent library writes, which can cause database
# corruption. If only one system will open this library concurrently, it's OK
# to set this to true.
#
# PS_SKIP_LIBRARY_OPEN_LOCKS="false"



##############################################################################
#
# Settings for Library.filters:
#


# +---------------------+
# |  disableAllFilters  |
# +---------------------+
#
# Setting this to true will force all other filter settings to their most
# permissive value. Note that this also disables file validation tests, so
# corrupt files will be attempted to be imported as well.
#
# PS_DISABLE_ALL_FILTERS="false"


# +-------------------------+
# |  maxAssetFileSizeBytes  |
# +-------------------------+
#
# What's the maximum photo or video size you want imported into your library?
# (This can prevent movies from being pulled into and filling up your
# library).
#
# PS_MAX_ASSET_FILE_SIZE_BYTES="500000000"


# +-------------------------+
# |  minAssetFileSizeBytes  |
# +-------------------------+
#
# What's the minimum photo or video size you want imported into your library?
#
# This setting can prevent small GIFs and screenshots from being imported.
#
# Values less than 1000 will be ignored.
#
# A 20-year-old 1600x1200 JPEG at 50% quality is more than 150k, so 50k is a
# very conservative default.
#
# PS_MIN_ASSET_FILE_SIZE_BYTES="50000"


# +---------------------+
# |  minImageDimension  |
# +---------------------+
#
# What's the minimum number of pixels an image's dimensions must meet or
# exceed to be imported? Note that this value is applied to both the height
# and width of the image. The default comes from the VGA standard of 640x480.
#
# PS_MIN_IMAGE_DIMENSION="480"


# +---------------------+
# |  minVideoDimension  |
# +---------------------+
#
# What's the minimum number of pixels a video's dimensions must meet or exceed
# to be imported? Note that this value is applied to both the height and width
# of the video. The default comes from the QVGA standard of 320x240.
#
# PS_MIN_VIDEO_DIMENSION="240"


# +-----------------------+
# |  minVideoDurationSec  |
# +-----------------------+
#
# What's the minimum number of seconds for a video to be imported?
#
# PS_MIN_VIDEO_DURATION_SEC="2"


# +--------------------+
# |  requireMakeModel  |
# +--------------------+
#
# Normally PhotoStructure requires images to have EXIF tags for Make and
# Model. This prevents unwanted preview images from other photo apps and
# screenshots from being imported. If you have images you want in your library
# that don't have these tags, set this to false. Note that this is ignored for
# video files, as those files seldom have Make and Model set (and would
# prevent most video files from being imported).
#
# PS_REQUIRE_MAKE_MODEL="false"


# +---------------------------------+
# |  siblingInferenceBasenameCoeff  |
# +---------------------------------+
#
# What's the minimum case-insensitive Sørensen–Dice similarity index between
# file basenames, without the extension, to be used for sibling inference?
#
# 0 will accept all siblings, 1 will only accept exact matches.
#
# PS_SIBLING_INFERENCE_BASENAME_COEFF="0.6"


# +----------------------+
# |  validateJpegImages  |
# +----------------------+
#
# Should JPEG photos be validated before importing? If a JPEG has any decoding
# errors, and this setting is true, that file will not be imported into your
# library. Enabling this feature slows down imports.
#
# PS_VALIDATE_JPEG_IMAGES="true"


# +---------------------+
# |  validateRawImages  |
# +---------------------+
#
# Should raw-format images (like NEF, CR2, ARW, and ORF) be validated before
# importing? If an image has any decoding errors, and this setting is true,
# that file will not be imported into your library. Enabling this feature
# slows down imports.
#
# PS_VALIDATE_RAW_IMAGES="true"


# +------------------+
# |  validateVideos  |
# +------------------+
#
# Should videos be validated before importing? If a video has any decoding
# errors, and this setting is true, that file will not be imported into your
# library. Enabling this feature slows down imports, as videos must be fully
# decoded (or "played") to be validated. Only ffmpeg currently supports video
# validation; if you use VLC, this setting is ignored.
#
# PS_VALIDATE_VIDEOS="false"


# +----------------------------+
# |  validationErrorAllowlist  |
# +----------------------------+
#
# All validation errors that match any of these values they will be ignored.
#
# Note the patterns are case-insensitive, will be converted into a regular
# expression, and only need to partially match the error message.
#
# Also see "validationErrorBlocklist".
#
# PS_VALIDATION_ERROR_ALLOWLIST="[\"Invalid SOS parameters for sequential JPEG\",\"Referenced QT chapter track not found\"]"


# +----------------------------+
# |  validationErrorBlocklist  |
# +----------------------------+
#
# If any of the following patterns match a validation error found in a photo
# or video, and *doesn't* match any of the patterns in the
# validationErrorAllowlist, the file will be considered corrupt and not be
# imported into your library.
#
# Note the patterns are case-insensitive, will be converted into a regular
# expression, and only need to partially match the error message, so, for
# example, a value of "caution" will ignore any error message that contains
# the string "caution".
#
# Also see "validationErrorAllowlist".
#
# PS_VALIDATION_ERROR_BLOCKLIST="[\"Cannot determine format of input stream\",\"corrupt\",\"error\",\"failed\",\"invalid\",\"not a .+ file\",\"nothing was written into output file\",\"partial file\",\"Premature end of .+ file\"]"



##############################################################################
#
# Settings for Library.previews:
#


# +----------------+
# |  dcrawEmuArgs  |
# +----------------+
#
# What options do you want to pass to dcraw_emu? Note that "-T -o 1 -j -Z -"
# will always be added (as we need TIFF, sRGB, raw pixels send to stdout). The
# "-h" arg will be added if the preview image needed is less than half the
# resolution of the original.
#
# Run "dcraw_emu" with no arguments to get usage help.
#
# "-q 1" sets interpolation quality to "0".
#
# "-H 2" turns on highlight blending.
#
# "-w" uses the camera-set white balance.
#
# Note: changing these values can dramatically (> 10x!) increase the time it
# takes to render RAW images.
#
# PS_DCRAW_EMU_ARGS="[\"-q\",\"0\",\"-w\"]"


# +--------------------+
# |  embeddedPreviews  |
# +--------------------+
#
# For larger source images that are greater than 15MP, what embedded image
# preview tags should be used when present? Using these embedded images speeds
# up image preview generation, but if the embedded image doesn't match the
# full-sized image, the image preview will be incorrect.
#
# Set this to an empty array to disable using embedded previews.
#
# PS_EMBEDDED_PREVIEWS="[\"PreviewImage\",\"PreviewTIFF\",\"JpgFromRaw\"]"


# +----------------------+
# |  embeddedThumbnails  |
# +----------------------+
#
# Should embedded image thumbnails be used when available? This speeds up
# image hashing, but if the embedded image thumbnail doesn't match the
# full-sized image, the image hash will be incorrect.
#
# Set this to an empty array to disable using embedded previews.
#
# PS_EMBEDDED_THUMBNAILS="[\"ThumbnailImage\",\"ThumbnailTIFF\"]"


# +----------------------+
# |  iccProfileMappings  |
# +----------------------+
#
# Maps an original image profile to a filename stored in the "icc" directory.
# See that directory's _info.md for more information about this settings.
#
# PS_ICC_PROFILE_MAPPINGS="[\"Display P3:DisplayP3Compat-v2-magic.icc\",\"Adobe RGB:AdobeCompat-v2.icc\"]"


# +---------------+
# |  jpegQuality  |
# +---------------+
#
# JPEG output quality for previews. Smaller values produce smaller images with
# lower quality. The default value of 85 strikes a balance that has almost no
# noticeable compression artifacts, yet still compresses images reasonably
# well. Values less than ~50-70 can produce noticeable artifacts (depending on
# the image).
#
# Min value: 10
# Max value: 100
#
# PS_JPEG_QUALITY="85"


# +----------------------+
# |  previewResolutions  |
# +----------------------+
#
# This controls the resolutions that PhotoStructure creates for every asset.
# Note that resolutions will be skipped if there already is a preview value
# with 2.5x the megapixels, so even though there are a lot of sizes here,
# you'll only see 3-4 images on your disk per asset.
#
# Valid values: uhd8k,uhd5k,uhd4k,qhd,fhd,hd,wvga,qvga,qqvga
#
# PS_PREVIEW_RESOLUTIONS="[\"uhd4k\",\"qhd\",\"fhd\",\"hd\",\"wvga\",\"qvga\"]"


# +---------------+
# |  progressive  |
# +---------------+
#
# Should preview JPEGs be progressively encoded? If set, thumbnails will take
# ~15% longer to generate, but FHD/QHD/UHD previews will be smaller.
#
# PS_PROGRESSIVE="true"


# +-----------+
# |  sharpen  |
# +-----------+
#
# Should previews be sharpened? This can make the images "pop" a bit more, but
# almost doubles the time it takes to make the thumbnails.
#
# PS_SHARPEN="false"


# +----------------+
# |  skipPreviews  |
# +----------------+
#
# No previews will be built. The UI will be broken if this is set.
#
# PS_SKIP_PREVIEWS="false"


# +-----------------------+
# |  squareThumbStrategy  |
# +-----------------------+
#
# When PhotoStructure crops images and videos to square thumbnails, it needs
# to crop non-square images to a square. The default, "attention," focuses on
# faces and higher image energy, but is more expensive than simply cropping to
# the center of the image (which is faster, but will mean less-nice cropping,
# where faces are chopped in half). More details are available here:
# <https://sharp.pixelplumbing.com/api-resize>.
#
# Valid values: center,entropy,attention
#
# PS_SQUARE_THUMB_STRATEGY="attention"


# +-----------------------+
# |  variantSortCriteria  |
# +-----------------------+
#
# How should PhotoStructure pick the "best" asset file variant for a given
# asset? You may reorder the default fields. Only "resolution", "fileSize",
# "mtime", "schemeIdx", "isCover", "count", and "isBrowserSupported" are
# understood: other field names will be ignored. Details about these fields
# are here:
# <https://photostructure.com/faq/what-do-you-mean-by-dedupe/#how-does-photostructure-pick-which-file-to-show>.
#
# PS_VARIANT_SORT_CRITERIA="[\"resolution\",\"mtime\",\"schemeIdx\",\"isCover\",\"count\",\"isBrowserSupported\",\"fileSize\"]"


# +-------------------+
# |  videoFrameAtSec  |
# +-------------------+
#
# When capturing a frame from videos for thumbnails, how many seconds should
# be passed over before capturing a frame? A value of 0 means capture from the
# start of the video. Frequently, though, videos start out of focus, so we
# default to 1 for better frame clarity.
#
# Note that if a video is shorter than this value, the frame will be captured
# from the middle of the video.
#
# PS_VIDEO_FRAME_AT_SEC="1.5"



##############################################################################
#
# Settings for Library.reporting:
#


# +---------+
# |  email  |
# +---------+
#
# If set, this email will be used for license subscriptions and added to error
# reports, so we can contact you to help debug the issue. It is not required.
# Setting a value here does not subscribe you to any marketing emails.
#
# PS_EMAIL=""


# +----------------+
# |  reportErrors  |
# +----------------+
#
# If true, PhotoStructure will send crash reports when it encounters errors.
# Crash reports may include the path to the file that caused an error, system
# metadata, and recent log messages.
#
# PS_REPORT_ERRORS="true"


# +------------+
# |  hostname  |
# +------------+
#
# If set, this overrides the local hostname. Useful under docker and when OSes
# change hostnames due to networking bugs (see macOS).
#
# PS_HOSTNAME=""


# +-------------------+
# |  maxErrorsPerDay  |
# +-------------------+
#
# Set this to zero to remove all bugs in PhotoStructure.
#
# HUR HUR #DADJOKE
#
# If your system generates more than this number of errors in the course of a
# day, the subsequent error reports will not be reported.
#
# PS_MAX_ERRORS_PER_DAY="3"



##############################################################################
#
# Settings for Library.deduping:
#


# +---------------------------+
# |  datesBeforeAreEstimated  |
# +---------------------------+
#
# PhotoStructure automatically interprets captured-at timestamps before this
# ISO-formatted datestamp as "estimated." PhotoStructure also considers
# timestamps whose minutes, seconds, and milliseconds are all 0 as
# "estimated."
#
# When assets have an estimated captured-at time, tighter image correlation is
# required to prevent different images as being incorrectly aggregated into
# the same asset.
#
# The default value is the release date for the Nikon Coolpix 950, which was
# one of the first prosumer digital cameras with ~2MP resolution.
#
# PS_DATES_BEFORE_ARE_ESTIMATED="1999-02-15"


# +------------------+
# |  gpsErrorMeters  |
# +------------------+
#
# What's the maximum number of meters between GPS fixpoints that should be
# considered equivalent locations? Note that JPG+RAW pairs from smartphones
# frequently have different GPS locations due to one being recorded from a
# rough WiFi fix, and another from aGPS.
#
# GPS position error is ~10-100m. Cellular position error is ~500-750m.
#
# PS_GPS_ERROR_METERS="500"


# +---------------------------+
# |  greyscaleColorThreshold  |
# +---------------------------+
#
# Many "black and white" images, which scanned, actually include color
# information, especially if the source has yellowed with age. PhotoStructure
# determines if an image is "greyscale" if sigma+mean of a*b* values is less
# than this value. Smaller values are stricter.
#
# Min value: 0
# Max value: 128
#
# PS_GREYSCALE_COLOR_THRESHOLD="8"


# +--------------------+
# |  minColorCoeffPct  |
# +--------------------+
#
# This is the minimum similarity coefficient found between dominant image
# colors, and controls how aggressively images are merged with each other. A
# higher number requires stronger dominant color correlation. 100 (or 100%)
# requires exact dominant color correlation. A value of less than 50%
# indicates fairly low correlation of dominant colors, and can lead to false
# positives.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_COLOR_COEFF_PCT="75"


# +-------------------------------+
# |  minExposureSettingsCoeffPct  |
# +-------------------------------+
#
# This is the minimum similarity coefficient between exposure setting values
# two images must be to be considered equivalent. Many cameras actually report
# different exposure setting values between JPG and RAW: values within 90% of
# each other should avoid false-positives.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_EXPOSURE_SETTINGS_COEFF_PCT="90"


# +-----------------------------+
# |  minGreyscaleImageCoeffPct  |
# +-----------------------------+
#
# This is the minimum image hash similarity coefficient for greyscale images
# to be considered similar, and controls how aggressively images are merged
# with each other. A higher number requires stronger image correlation. 100
# (or 100%) requires exact image correlation, and is not recommended. A value
# of less than 50% is fairly low image correlation, and can lead to false
# positives.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_GREYSCALE_IMAGE_COEFF_PCT="93"


# +---------------------------------+
# |  minImageCoeffPctWithExactDate  |
# +---------------------------------+
#
# This is the minimum image hash similarity coefficient for images to be
# considered similar, and controls how aggressively images are merged with
# each other.
#
# This value is applied when the captured-at date has a non-zero minute,
# second, or millisecond, and was captured after "datesBeforeAreEstimated," so
# the timestamp is considered to have high precision.
#
# Note that this value _can't_ be very high, because computational imagery
# frequently makes JPG+RAW pairs that have substantial color and brightness
# deltas.
#
# 100 (or 100%) requires exact image correlation, and is not recommended. A
# value of less than 50% is fairly low image correlation, and can lead to
# false positives.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_IMAGE_COEFF_PCT_WITH_EXACT_DATE="70"


# +---------------------------------+
# |  minImageCoeffPctWithFuzzyDate  |
# +---------------------------------+
#
# This is the minimum image hash similarity coefficient for images to be
# considered similar, and controls how aggressively images are merged with
# each other.
#
# This value is applied, instead of "minImageCoeffPctWithExactDate", when the
# captured-at time is considered to have low precision, either due to it being
# before "datesBeforeAreEstimated", or if the minute, second, and millisecond
# values are all zero.
#
# This should be higher than "minImageCoeffPctWithExactDate" to ensure
# different images with the same captured-at time are considered as different
# assets.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_IMAGE_COEFF_PCT_WITH_FUZZY_DATE="80"


# +-------------------+
# |  minMeanCoeffPct  |
# +-------------------+
#
# If the average of image and color similarity coefficients exceeds this
# score, the image will be considered a match.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_MEAN_COEFF_PCT="65"


# +-------------------------+
# |  modeCorrCieDiffWeight  |
# +-------------------------+
#
# Comparing 2 images with N dominant colors requires finding matching color
# pairs. This weight will be applied to the CIE94 color delta e. Smaller
# values apply a larger discount to color deltas.
#
# Min value: 0
# Max value: 2
#
# PS_MODE_CORR_CIE_DIFF_WEIGHT="0.6"


# +---------------------------+
# |  modeCorrIndexDiffWeight  |
# +---------------------------+
#
# Comparing 2 images with N dominant colors requires finding matching color
# pairs. This weight will be applied to difference between the color indexes.
# Smaller values apply a larger discount to index differences.
#
# Min value: 0
# Max value: 2
#
# PS_MODE_CORR_INDEX_DIFF_WEIGHT="0.6"


# +------------------+
# |  strictDeduping  |
# +------------------+
#
# How strict should PhotoStructure de-duplicate files? If this is false, we
# consider files to be equivalent if sufficient metadata matches (even if the
# image hash is different). If this is true, we will always compare image
# hashes. NOTE: This will most likely cause RAW and JPEG pairs to not always
# merge to the same asset, especially if your camera uses extensive
# computational imagery. ALSO NOTE: If this is true, "useImageHashes" will be
# forced to true, and the "*corr*" and "*coeff" settings will be set to 95.
#
# PS_STRICT_DEDUPING="false"


# +------------------+
# |  useImageHashes  |
# +------------------+
#
# Building image hashes slows down imports, but supports more robust asset
# merging heuristics, and allows for dominant color tagging and browsing. If
# you set this from false to true, and you'd previously imported new assets,
# you may want to rebuild your library to re-aggregate your assets.
#
# PS_USE_IMAGE_HASHES="true"


# +----------------------------+
# |  variantSortCriteriaPower  |
# +----------------------------+
#
# Larger variant sort criteria, "resolution" and "fileSize", are scaled to
# ignore smaller (irrelevant) differences. Scalars are raised to this power to
# reduce them, so a value of 1 means the criterion is unchanged from the "raw"
# value.
#
# Min value: 0.000001
# Max value: 1
#
# PS_VARIANT_SORT_CRITERIA_POWER="0.15"



##############################################################################
#
# Settings for Library.sidecars:
#


# +----------------------+
# |  defaultSidecarType  |
# +----------------------+
#
# What type of sidecar file do you want to generate for non-destructive edits?
# XMP is the most popular and well-adopted format.
#
# Valid values: EXIF,EXV,MIE,XMP
#
# PS_DEFAULT_SIDECAR_TYPE="XMP"


# +----------------------------------+
# |  matchSidecarsCaseInsensitively  |
# +----------------------------------+
#
# If set to true, PhotoStructure will look for sidecar files that match file
# basenames (with or without the file extension), regardless of case (for
# example: "IMAGE.XMP" will be a sidecar for "image.jpg").
#
# If set to false, sidecars must match case (so only "image.jpg.xmp" and
# "image.xmp" will match for "image.jpg").
#
# PS_MATCH_SIDECARS_CASE_INSENSITIVELY="true"


# +------------------------+
# |  matchSidecarsFuzzily  |
# +------------------------+
#
# If set to true, PhotoStructure will look for sidecar files that match the
# basename of the asset, plus some common suffixes (like "-edit", "-edited",
# or variant copies, like "-2").
#
# This setting only impacts .XMP, .MIE, and .EXIF sidecars. PhotoStructure
# always matches .JSON files fuzzily, as that is required to handle Google
# Takeouts properly.
#
# PS_MATCH_SIDECARS_FUZZILY="false"


# +----------------------------------+
# |  writeMetadataToSidecarsIfImage  |
# +----------------------------------+
#
# If set to true, PhotoStructure will write metadata changes made to images
# into sidecars. If set to false, PhotoStructure will overwrite original
# images with metadata changes.
#
# PS_WRITE_METADATA_TO_SIDECARS_IF_IMAGE="true"


# +------------------------------------------+
# |  writeMetadataToSidecarsIfSidecarExists  |
# +------------------------------------------+
#
# If set to true, PhotoStructure will write metadata changes into sidecars if
# the file already has a sidecar.
#
# PS_WRITE_METADATA_TO_SIDECARS_IF_SIDECAR_EXISTS="true"


# +----------------------------------+
# |  writeMetadataToSidecarsIfVideo  |
# +----------------------------------+
#
# If set to true, PhotoStructure will write metadata changes made to videos
# into sidecars. If set to false, PhotoStructure will overwrite original
# videos with metadata changes. This defaults to false, as most software does
# not use sidecars except for images.
#
# PS_WRITE_METADATA_TO_SIDECARS_IF_VIDEO="false"



##############################################################################
#
# Settings for Library.sync:
#


# +------------------------------------+
# |  assetSubdirectoryDatestampFormat  |
# +------------------------------------+
#
# If you chose to copy assets into your library, they will be copied into
# <originals directory>/<result of this pattern>/<original imagename>.
#
# - See the originalsDir system setting for what your <originals directory> is
# (it defaults to your library root directory).
#
# - Please encode this path with forward-slashes, even if you're on Windows.
#
# - If you want to add a static path, escape the pathname with single quotes
# (like "'photos'/y/MM/dd").
#
# - This will always be interpreted as a relative path from your
# PhotoStructure library.
#
# - See <https://moment.github.io/luxon/#/formatting?id=table-of-tokens>.
#
# Aliases: PS_ASSET_SUBDIR_FORMAT
#
# PS_ASSET_SUBDIRECTORY_DATESTAMP_FORMAT="y/y-MM-dd"


# +--------------------------+
# |  copyToLibraryMimetypes  |
# +--------------------------+
#
# When "automatic organization" is enabled, files whose mimetypes are included
# in this list will be copied into your originals directory.
#
# Note that mimetypes can include an asterisk to do glob-matching.
#
# See the related system setting "copyAssetsToLibrary".
#
# PS_COPY_TO_LIBRARY_MIMETYPES="[\"image/*\",\"video/*\"]"


# +-----------------------------+
# |  doNotTranscodeAudioCodecs  |
# +-----------------------------+
#
# Videos are transcoded when the "transcodeVideos" is set to true and is not
# one of the following audio codecs. The audio codec is stored in the
# "AudioCodec" tag.
#
# PS_DO_NOT_TRANSCODE_AUDIO_CODECS="[\"mp4a\",\"sowt\"]"


# +---------------------------+
# |  doNotTranscodeMimetypes  |
# +---------------------------+
#
# Videos are transcoded when the "transcodeVideos" is set to true and is not
# one of the following mimetypes. See
# https://www.iana.org/assignments/media-types/media-types.xhtml#video for a
# complete list. If you are setting this via an environment variable, you can
# separate the values either like a PATH (like "video/quicktime:video/mp4") or
# use JSON encoding (like "['video/quicktime','video/mp4']").
#
# PS_DO_NOT_TRANSCODE_MIMETYPES="[\"video/quicktime\",\"video/mp4\",\"video/mpv\",\"video/mp2t\"]"


# +-----------------------------+
# |  doNotTranscodeVideoCodecs  |
# +-----------------------------+
#
# Videos are transcoded when the "transcodeVideos" is set to true and is not
# one of the following video codecs. The video codec may be stored in the
# "VideoCodec", "CompressorID", or "CompressorName" tags.
#
# PS_DO_NOT_TRANSCODE_VIDEO_CODECS="[\"avc1\"]"


# +---------------------------------+
# |  excludeNoMediaAssetsOnRebuild  |
# +---------------------------------+
#
# Should previously-imported assets that are found to have *any* files in
# NoMedia directories be excluded from your library?
#
# PS_EXCLUDE_NO_MEDIA_ASSETS_ON_REBUILD="true"


# +----------------+
# |  exitWhenDone  |
# +----------------+
#
# When set, the sync process will exit after jobs are completed (used
# internally and for tests).
#
# This setting is transient and only set via environment variables.
#
#
# PS_EXIT_WHEN_DONE="false"


# +------------------------+
# |  forceRebuildPreviews  |
# +------------------------+
#
# When set, previews and transcoded videos will always be rebuilt.
#
# This setting is transient and only set via environment variables.
#
#
# PS_FORCE_REBUILD_PREVIEWS="false"


# +-------------+
# |  forceSync  |
# +-------------+
#
# When set, all files will be visited, even if the asset seems in sync with
# the filesystem.
#
# This setting is transient and only set via environment variables.
#
#
# PS_FORCE_SYNC="false"


# +----------------------------+
# |  maxDuplicatePathElements  |
# +----------------------------+
#
# How many times can a given path element exist in a directory before it is
# considered within an infinite filesystem loop, and should be skipped from
# import?
#
# PS_MAX_DUPLICATE_PATH_ELEMENTS="7"


# +---------------------+
# |  overwriteOriginal  |
# +---------------------+
#
# Should changes made through the UI, like rotations, captions, and keywords,
# overwrite the original file? This is potentially dangerous, as your original
# may be lost if the disk has errors, or there are issues in rewriting the
# file contents. If this is set to false, the original file will be retained
# in the same directory. "image.jpg" will be stored as "image_original.jpg".
#
# PS_OVERWRITE_ORIGINAL="false"


# +-----------------------+
# |  readdirCacheSeconds  |
# +-----------------------+
#
# readdir() can take a long time over slow network shares and when directories
# are very large. This setting controls how long to cache readdir results that
# are slow (which take >= .5 seconds). Set to 0 to disable readdir() caching.
#
# PS_READDIR_CACHE_SECONDS="300"


# +----------------------+
# |  readdirCacheSlowMs  |
# +----------------------+
#
# If readdir() takes longer than this value, cache the result.
#
# See "readdirCacheSeconds" for details.
#
# PS_READDIR_CACHE_SLOW_MS="500"


# +-----------+
# |  rebuild  |
# +-----------+
#
# When set, all files in your library will be re-imported (caution: slow!).
#
# This setting is transient and only set via environment variables.
#
#
# PS_REBUILD="false"


# +----------------------+
# |  resyncAssetOnVisit  |
# +----------------------+
#
# Should Assets be automatically re-synchronized whenever their info panel is
# viewed? This can make sure Assets are in-sync with the filesystem, but this
# can slow down current imports, and add load to slower computers. This
# defaults to true only if the current machine has >= 8 CPUs.
#
# PS_RESYNC_ASSET_ON_VISIT="true"


# +------------------------+
# |  skipAssetFileUpdates  |
# +------------------------+
#
# Should outdated AssetFiles be ignored on startup? (Only used for tests).
#
# This setting is transient and only set via environment variables.
#
#
# PS_SKIP_ASSET_FILE_UPDATES="false"


# +--------------------+
# |  skipAssetUpdates  |
# +--------------------+
#
# Should outdated Assets be ignored on startup? (Only used for tests).
#
# This setting is transient and only set via environment variables.
#
#
# PS_SKIP_ASSET_UPDATES="false"


# +--------------------+
# |  skipModelUpdates  |
# +--------------------+
#
# When set, skip any pending library database updates.
#
# This setting is transient and only set via environment variables.
#
#
# PS_SKIP_MODEL_UPDATES="false"


# +---------------+
# |  startPaused  |
# +---------------+
#
# Should processing be paused by default when PhotoStructure starts? You'll
# have the manually resume processing via the system tray or nav menu.
#
# PS_START_PAUSED="false"


# +----------------------+
# |  statTimeoutSeconds  |
# +----------------------+
#
# 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 reading
# a directory entry exceeds this value. The default of 30 seconds should cover
# most issues with spun-down hard drives and NAS/WAN latency.
#
# Min value: 1
# Max value: 300
#
# PS_STAT_TIMEOUT_SECONDS="30"


# +---------------------+
# |  syncIntervalHours  |
# +---------------------+
#
# This value controls both how often the sync process discovers new or changed
# files for any given volume.
#
# Note that this value is the duration between the last completion time and
# when the next sync should be scheduled.
#
# WARNING: Setting this value to a small value will mean PhotoStructure is
# constantly scanning your disks, which will add wear and tear and possibly
# reduce the lifespan of your storage media.
#
# Min value: 1
# Max value: 720
#
# PS_SYNC_INTERVAL_HOURS="24"


# +------------------------+
# |  transcodeBitrateQVGA  |
# +------------------------+
#
# What max bitrate should PhotoStructure encode QVGA (320 × 240) videos?
# Videos with resolutions between QVGA and UHD will use an interpolated value
# between these two settings, and will not exceed the encoded bitrate of the
# original video. This value is in kilobytes per second.
#
# PS_TRANSCODE_BITRATE_QVGA="800"


# +-----------------------+
# |  transcodeBitrateUHD  |
# +-----------------------+
#
# What max bitrate should PhotoStructure encode UHD (3840 × 2160) videos?
# Videos with resolutions between QVGA and UHD will use an interpolated value
# between these two settings, and will not exceed the encoded bitrate of the
# original video. This value is in kilobytes per second.
#
# PS_TRANSCODE_BITRATE_UHD="18000"


# +-------------------+
# |  transcodeVideos  |
# +-------------------+
#
# Should videos that are not in a browser-supported format be transcoded
# during import? Note that this is a plus-only feature. FFmpeg or VLC must be
# installed. Note that this *dramatically* slows down imports, and
# *dramatically* increases the disk space your library will need to use, but
# allows you to see videos that aren't directly supported by your browser. If
# this is set to false, your browser will only render videos directly
# supported by your OS.
#
# PS_TRANSCODE_VIDEOS="true"


# +--------------------+
# |  verifyFileCopies  |
# +--------------------+
#
# 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.
#
# PS_VERIFY_FILE_COPIES="true"



##############################################################################
#
# Settings for Library.parsing:
#


# +------------+
# |  badDates  |
# +------------+
#
# The following raw EXIF values will be ignored when extracting a file's
# captured-at time. See
# <https://forum.photostructure.com/t/photostructure-ignored-the-date-metadata-of-some-photos-marked-them-as-taken-in-2002/340/8>
# and
# <https://forum.photostructure.com/t/incorrect-date-assigned-to-photo/419>.
#
# PS_BAD_DATES="[\"2002:12:08 12:00:00\"]"


# +------------------+
# |  capturedAtTags  |
# +------------------+
#
# The following tags are examined to parse a file's captured-at time. The
# earliest valid tag is returned: order doesn't matter. See
# <https://photostructure.com/faq/captured-at/> for details.
#
# PS_CAPTURED_AT_TAGS="[\"SubSecDateTimeOriginal\",\"SubSecCreateDate\",\"SubSecTimeDigitized\",\"SubSecMediaCreateDate\",\"DateTimeOriginal\",\"OriginalCreateDateTime\",\"CreateDate\",\"DateTimeCreated\",\"DateCreated\",\"DateTimeDigitized\",\"MediaCreateDate\",\"DateTime\",\"ModifyDate\",\"photoTakenTime\",\"MetadataDate\",\"CreationTime\"]"


# +--------------------------+
# |  enableSiblingInference  |
# +--------------------------+
#
# When enabled, and the "captured-at" time, Make, or Model isn't found in
# metadata, PhotoStructure will try to use "sibling" files to "fill in the
# blanks." This is disabled automatically for slow directories.
#
# PS_ENABLE_SIBLING_INFERENCE="true"


# +------------------------+
# |  extraDateTimeFormats  |
# +------------------------+
#
# These formats are used to parse datetime strings in EXIF metadata and in
# filenames. See
# <https://moment.github.io/luxon/#/formatting?id=table-of-tokens> for a
# description of these tokens.
#
# PS_EXTRA_DATE_TIME_FORMATS="[\"y-M-d 'at' H.m.s\",\"y-M-d H-m-s\",\"y-MM-dd HHmmss\",\"yMMdd_HHmmss\",\"yMMdd-HHmmss\",\"F\",\"FF\"]"


# +--------------------+
# |  fuzzyDateParsing  |
# +--------------------+
#
# When enabled, PhotoStructure will first attempt to parse datetime strings
# with strict ISO-compliant parsers, and then use additional, "fuzzy" datetime
# parsers. When disabled, only ISO-compliant parsers are used.
#
# PS_FUZZY_DATE_PARSING="true"


# +--------------------+
# |  fuzzyYearParsing  |
# +--------------------+
#
# When enabled, PhotoStructure will use directories starting with a number
# that looks year-like (four digits, 1826-the present) to infer the
# captured-at time, if all other date parsers have failed. Note that setting
# this to true "forces" the "fuzzyDateParsing" setting to be true.
#
# To elaborate: PhotoStructure first looks for metadata with a date, then
# looks for an ISO-compliant YMD timestamp in the filename or path, and then,
# if "fuzzyDateParsing" or this setting is enabled, a YMD or YM datestamp, and
# then finally, if this setting is enabled, it looks for a directory that
# begins with a number that is between 1826-2020.
#
# PS_FUZZY_YEAR_PARSING="false"


# +-------------+
# |  lensMakes  |
# +-------------+
#
# Used to extract and parse lens metadata (useful when Google Takeout has
# stripped metadata).
#
# PS_LENS_MAKES="[\"7artisans\",\"Bower\",\"Canon\",\"Carl Zeiss\",\"Cosina\",\"Fuji\",\"Fujifilm\",\"Goerz\",\"Hasselblad\",\"Hirox\",\"Hoya\",\"Konica\",\"Leica\",\"Leidolf\",\"Lensbaby\",\"Lumix\",\"Meike\",\"Meopta\",\"Minolta\",\"Neewer\",\"Nikon\",\"Olympus\",\"Opteka\",\"Panasonic\",\"Pentacon\",\"Pentax\",\"Ricoh\",\"Rodenstock\",\"Rokinon\",\"Ross\",\"Samsung\",\"Samyang\",\"Seiko\",\"Sigma\",\"Silor\",\"Soligor\",\"Sony\",\"Sunpak\",\"Tamron\",\"Tiffen\",\"Tokina\",\"Topcon\",\"Venus\",\"Voigtländer\",\"Wray\",\"Yongnuo\",\"Zhong Yi\",\"Zuiko\"]"


# +--------------------+
# |  minRatingForFave  |
# +--------------------+
#
# Metadata "ratings" are stored in both EXIF and XMP "Rating" and
# "RatingPercent" tags. Ratings are typically encoded as a value between -1
# and 5 (where -1 is used by some DAMs to mark "rejected").
#
# PhotoStructure will prefer the XMP Rating tag.
#
# If the only tag with a rating is a "RatingPercent", it will be converted to
# a 5-point scale..
#
# If you want only ratings of 5 to be considered a favorite, set this to 5.
#
# This value will be used when assets are favorited via the PhotoStructure UI.
#
# Note that PhotoStructure doesn't import assets with a negative Rating (to
# respect the "rejected" rating).
#
# PS_MIN_RATING_FOR_FAVE="4"


# +----------------+
# |  minValidYear  |
# +----------------+
#
# If PhotoStructure encounters a year that is less than this value, it will
# consider it invalid and look elsewhere for dates. The default value, 1826,
# is the first year a photograph was captured, as per
# <https://en.wikipedia.org/wiki/History_of_photography>. If you have
# paintings or other imagery from before this time, you'll want to make this
# value less than the earliest image in your library.
#
# PS_MIN_VALID_YEAR="1826"


# +------------------------------+
# |  useLibraryDirsToInferDates  |
# +------------------------------+
#
# When enabled, and the "captured-at" time isn't found in metadata,
# PhotoStructure will also look for the captured-at datetime encoded in file
# paths *for files that are in your PhotoStructure library. This defaults to
# false, as prior versions of PhotoStructure may have placed files into
# incorrect datestamped directories.
#
# PS_USE_LIBRARY_DIRS_TO_INFER_DATES="false"


# +------------------------+
# |  usePathsToInferDates  |
# +------------------------+
#
# When enabled, and the "captured-at" time isn't found in metadata,
# PhotoStructure will also look for the captured-at datetime encoded in file
# paths.
#
# PS_USE_PATHS_TO_INFER_DATES="true"


# +-----------------------+
# |  useStatToInferDates  |
# +-----------------------+
#
# When enabled, and the "captured-at" time isn't found in metadata,
# PhotoStructure will also look for the captured-at datetime encoded in the
# file "birthtime" (on Windows), or the lesser value of "mtime" and "ctime"
# (on macOS and Linux). Note that these values are not very reliable, as file
# transfers and backups frequently don't retain these values correctly.
#
# PS_USE_STAT_TO_INFER_DATES="true"



##############################################################################
#
# Settings for Library.tagging:
#


# +--------------------+
# |  excludedRootTags  |
# +--------------------+
#
# Keywords starting with the given roots will be omitted from your
# PhotoStructure library.
#
# PS_EXCLUDED_ROOT_TAGS="[\"http:\",\"https:\",\"file:\"]"


# +---------------------+
# |  keywordDelimiters  |
# +---------------------+
#
# PhotoStructure splits apart keywords, by default, when they are delimited by
# a comma or semicolon. For example, "car, blue, tree" will be interpreted as
# having the keywords "car", "blue", and "tree". After changing this value,
# you must force-resync your library for the changes to take affect.
#
# PS_KEYWORD_DELIMITERS=",;"


# +-------------------------+
# |  keywordPathSeparators  |
# +-------------------------+
#
# PhotoStructure interprets keywords as hierarchical if a path separator
# character is found in a keyword. This allows for tags like
# "Family/Einstein/Albert", "Flora|Fruit|Orange", "Objects⊃Tools⊃Hammer", or
# "Fauna>Oceanic>Pelican". By default, these separators are the forward-slash,
# vertical-bar, and greater-than characters. If you don't want to interpret
# keywords as hierarchical, change this value to an empty string (""). After
# changing this value, you must force-resync your entire library for the
# changes to take affect.
#
# PS_KEYWORD_PATH_SEPARATORS="/|>⊃"


# +----------------------+
# |  keywordReparenting  |
# +----------------------+
#
# How should PhotoStructure handle hierarchical keywords?
#
# If this is set to "move," PhotoStructure will try to put hierarchical
# keywords into their "correct" root tag, like "Who," "Album," or "Where."
#
# If this is set to "retain," PhotoStructure will always place hierarchical
# keywords under the "Keyword" root tag.
#
# If this is set to "copy," PhotoStructure will add both the "correct" root
# tag _and_ the "Keyword" tag. For example, "Person|Doe|Jane" will be tagged
# as "Who|Doe|Jane" as well as "Keyword|Person|Doe|Jane".
#
# See <https://forum.photostructure.com/t/prefix-for-keywords-tag/499> for
# details.
#
# Valid values: move,copy,retain
#
# PS_KEYWORD_REPARENTING="move"


# +---------------+
# |  keywordTags  |
# +---------------+
#
# PhotoStructure should look in the following tags for keywords. Note that
# these values are case-sensitive.
#
# PS_KEYWORD_TAGS="[\"CatalogSets\",\"Categories\",\"HierarchicalSubject\",\"Keywords\",\"LastKeywordXMP\",\"Subject\",\"TagsList\",\"XPKeywords\"]"


# +------------------+
# |  recountAllTags  |
# +------------------+
#
# Should all tags be recounted? PhotoStructure normally only recounts tags
# that have had assets recently added or removed.
#
# This setting is transient and only set via environment variables.
#
#
# PS_RECOUNT_ALL_TAGS="false"


# +------------------------+
# |  rootTagAlbumsAliases  |
# +------------------------+
#
# List hierarchical tag roots that PhotoStructure should interpret to be album
# names. This is matched case-insensitively.
#
# PS_ROOT_TAG_ALBUMS_ALIASES="[\"Album\",\"Albums\"]"


# +--------------------------+
# |  rootTagKeywordsAliases  |
# +--------------------------+
#
# List hierarchical tag roots that PhotoStructure should interpret to be
# keywords. This is matched case-insensitively.
#
# PS_ROOT_TAG_KEYWORDS_ALIASES="[\"Keyword\",\"Keywords\",\"Tag\",\"Tags\"]"


# +---------------------+
# |  rootTagWhoAliases  |
# +---------------------+
#
# When hierarchical tag values are found with any of these root names
# PhotoStructure will replace the root with "Who".
#
# For example, using default values, "People/Jane Doe" will be replaced with
# "Who/Jane Doe" (or "Who/Doe/Jane", if tagNamesFormatter="family/given").
#
# Digicam uses "People". This is matched case-insensitively.
#
# PS_ROOT_TAG_WHO_ALIASES="[\"Person\",\"People\",\"Face\",\"Faces\"]"


# +----------------+
# |  tagAlbumDate  |
# +----------------+
#
# If you have enabled "tagJsonAlbums", what's the name of the field encoded in
# the album file? Object hierarchies are separated with a ".".
#
# PS_TAG_ALBUM_DATE="albumData.date"


# +-----------------------+
# |  tagAlbumDescription  |
# +-----------------------+
#
# If you have enabled "tagJsonAlbums", what's the name of the field encoded in
# the album file? Object hierarchies are separated with a ".".
#
# PS_TAG_ALBUM_DESCRIPTION="albumData.description"


# +---------------------+
# |  tagAlbumFilenames  |
# +---------------------+
#
# If you have enabled "tagJsonAlbums", what's the name of the file that
# PhotoStructure should look for with album metadata? This can be JSON, XMP,
# MIE, or EXIF encoded.
#
# PS_TAG_ALBUM_FILENAMES="[\"metadata.json\"]"


# +-------------+
# |  tagAlbums  |
# +-------------+
#
# Should PhotoStructure look for $tagJsonAlbumFilename (by default,
# "metadata.json") files in the same directory as asset files for album
# titles?
#
# PS_TAG_ALBUMS="true"


# +---------------------+
# |  tagAlbumsExcluded  |
# +---------------------+
#
# For "metadata.json" albums, some are automatically generated. If the title
# or description includes any given string, it will be ignored.
#
# PS_TAG_ALBUMS_EXCLUDED="[\"Album for automatically uploaded content\"]"


# +-----------------+
# |  tagAlbumTitle  |
# +-----------------+
#
# If you have enabled "tagJsonAlbums", what's the name of the field encoded in
# the album file? Object hierarchies are separated with a ".".
#
# PS_TAG_ALBUM_TITLE="albumData.title"


# +----------------------------+
# |  tagAlbumTitleHierarchies  |
# +----------------------------+
#
# If true, album titles will be split as hierarchical keywords. If false,
# album titles will not be split, and all albums will be under the "Albums"
# root tag.
#
# PS_TAG_ALBUM_TITLE_HIERARCHIES="false"


# +-------------+
# |  tagCamera  |
# +-------------+
#
# Should assets be tagged with cameras' make and model?
#
# PS_TAG_CAMERA="true"


# +-------------------+
# |  tagDateFromStat  |
# +-------------------+
#
# Should PhotoStructure tag assets with a date if the captured at time was
# only found in filesystem metadata? Filesystem metadata is not as reliable as
# EXIF metadata, as it can be changed arbitrarily when files are backed up.
#
# PS_TAG_DATE_FROM_STAT="true"


# +--------------------+
# |  tagDisplayNameFS  |
# +--------------------+
#
# What should PhotoStructure call the "root" tag for browsing by filesystem
# paths? Note that this value is only for the UI, and will update the
# "_displayName" of the /fs/ tag: this value won't change the URL path from be
# "/tag/fs/.../". Reasonable options that have been suggested include
# "Folder", "Directory", "Drive", "File", "Path", "Volume", or "Computer".
#
# PS_TAG_DISPLAY_NAME_FS="Folder"


# +--------------------------+
# |  tagDisplayNameFSLabels  |
# +--------------------------+
#
# Should PhotoStructure use volume labels, if available, as display names for
# filesystem tags? As an example, instead of showing "/ Folder / D:", you'd
# see "/ Folder / Photo backup #3" (or whatever the label D: has).
#
# PS_TAG_DISPLAY_NAME_FS_LABELS="true"


# +------------------------+
# |  tagDisplayNameFSRoot  |
# +------------------------+
#
# On POSIX systems, how should PhotoStructure reference the "root" directory
# (/)? "/" is a bit confusing, so "root" may be less confusing? Also see
# "tagDisplayNameFSRootWithHostname".
#
# PS_TAG_DISPLAY_NAME_FS_ROOT="root"


# +------------------------------------+
# |  tagDisplayNameFSRootWithHostname  |
# +------------------------------------+
#
# On non-docker hosts (which typically don't have reliable hostnames), should
# the root directory tag have the hostname appended?
#
# PS_TAG_DISPLAY_NAME_FS_ROOT_WITH_HOSTNAME="true"


# +------------------+
# |  tagFaceRegions  |
# +------------------+
#
# Picasa and other software supports embedding face names within
# "RegionInfo.RegionList.Name" metadata. If this setting is enabled, and
# "RegionInfo.RegionList.Type" is "Face", PhotoStructure will import these
# tags under "Who".
#
# PS_TAG_FACE_REGIONS="true"


# +---------------+
# |  tagFileType  |
# +---------------+
#
# Should assets be tagged with their file type (like "Type/Image/JPEG")?
#
# PS_TAG_FILE_TYPE="true"


# +--------------------+
# |  tagFullLensModel  |
# +--------------------+
#
# Should PhotoStructure tag assets with the full lens model (like "Canon EF-M
# 15-45mm f/3.5-6.3 IS STM") or a just the lens information ("15-45mm
# f/3.5-6.3")? (If you change this value, you'll need to "Rebuild" your
# library to make the setting take effect).
#
# PS_TAG_FULL_LENS_MODEL="true"


# +----------------+
# |  tagJsonFaces  |
# +----------------+
#
# Google Takeout provides .json sidecars that may contain the names of the
# people (or pets) found in the image. Should PhotoStructure import these tags
# under "Who"?.
#
# PS_TAG_JSON_FACES="true"


# +---------------------------+
# |  tagKeywordsFromMetadata  |
# +---------------------------+
#
# Should assets be tagged with keywords extracted from file metadata, as well
# as sidecar metadata?
#
# PS_TAG_KEYWORDS_FROM_METADATA="true"


# +-----------------------+
# |  tagKeywordsFromPath  |
# +-----------------------+
#
# Should assets be tagged with keywords extracted from file pathnames?
#
# PS_TAG_KEYWORDS_FROM_PATH="true"


# +-----------+
# |  tagLens  |
# +-----------+
#
# Should assets be tagged with lens' make and model?
#
# PS_TAG_LENS="true"


# +-------------------------------+
# |  tagNamesCapitalizedAsFamily  |
# +-------------------------------+
#
# Assume uppercased names are family names (this is common practice in
# geneology).
#
# PS_TAG_NAMES_CAPITALIZED_AS_FAMILY="true"


# +-------------------------+
# |  tagNamesDefaultFamily  |
# +-------------------------+
#
# If a name is missing a family name, if this value is not blank, it will be
# provided as a default. If this value is blank, the name tag will be
# Who/given. Note that this setting is only used if "tagNamesFormatter" is set
# to "family/given".
#
# PS_TAG_NAMES_DEFAULT_FAMILY="-"


# +---------------------------+
# |  tagNamesFamilySurrounds  |
# +---------------------------+
#
# This setting contains pairs of characters. When name portions are surrounded
# by these pairs, the contents will be added as a family name. As an example,
# if you use the default "()", then "Michelle LaVaughn (Robinson) Obama" will
# be name tagged with both "Who/Robinson/Michelle LaVaughn" and
# "Who/Obama/Michell LaVaugn". This setting is used by the "tagNamesFormatter"
# if it is set to "family/given".
#
# PS_TAG_NAMES_FAMILY_SURROUNDS="[\"()\"]"


# +---------------------+
# |  tagNamesFormatter  |
# +---------------------+
#
# How should PhotoStructure format the "Who" tags for assets whose files are
# tagged with "people" strings?
#
# "as-is" will tag names directly to "Who", so, "Who/Albert Einstein".
#
# "family/given" will tag "Who/Einstein/Albert" (for regions that provide
# given names first). The default is "as-is," because discerning given and
# family names aren't reliably inferable.
#
# See <https://en.wikipedia.org/wiki/Personal_name#Name_order>.
#
# Valid values: as-is,family/given
#
# PS_TAG_NAMES_FORMATTER="as-is"


# +-----------------+
# |  tagNamesGiven  |
# +-----------------+
#
# List all given names you expect in tags that are not single words.
# Hyphenated given names (like "Rose-Ann") do not need to be listed here. If
# your language doesn't separate family names and given names with whitespace,
# either include all given names, or include all familyNames (whatever's
# easier for you). This setting is used by the "tagNamesFormatter" if it is
# set to "family/given".
#
# PS_TAG_NAMES_GIVEN=""


# +--------------------------+
# |  tagNamesGivenSurrounds  |
# +--------------------------+
#
# This setting contains pairs of characters. When name portions are surrounded
# by these pairs, the contents will be added to the end of the given name with
# the surrounds retained. As an example, if you use the defaults of "[]" and
# double-quotes, then "Joe "Joey" Smith" will be name tagged with
# Who/Smith/Joe "Joey". This setting is used by the "tagNamesFormatter" if it
# is set to "family/given".
#
# PS_TAG_NAMES_GIVEN_SURROUNDS="[\"[]\",\"\\\"\\\"\"]"


# +-------------------+
# |  tagNamesLexical  |
# +-------------------+
#
# Assume any name with a comma is in "lexical name order", which is always
# "lastname, given name(s)". If the given name is found to be "sr.", "senior",
# "jr.", or "junior", the name will be considered to be in western order
# ($givenNames $familyName, $modifier), and the $modifier will be added to the
# $givenNames. If this is set to false, commas are ignored.
#
# PS_TAG_NAMES_LEXICAL="true"


# +-----------------+
# |  tagNamesOrder  |
# +-----------------+
#
# How should PhotoStructure parse people's names? Note that this setting is
# only used if "tagNamesFormatter" is set to "family/given". See
# <https://en.wikipedia.org/wiki/Personal_name#Name_order>.
#
# Valid values: western,eastern
#
# PS_TAG_NAMES_ORDER="western"


# +---------------------------+
# |  tagNamesSurnamePrefixes  |
# +---------------------------+
#
# List all family name prefixes to be considered part of the family name.
# These are matched case-insensitively. This setting is used by the
# "tagNamesFormatter" if it is set to "family/given".
#
# PS_TAG_NAMES_SURNAME_PREFIXES="[\"A\",\"D’\",\"Da\",\"De la\",\"De las\",\"De\",\"Del\",\"Della\",\"Den\",\"Des\",\"Di\",\"Du\",\"La\",\"Las\",\"Le\",\"Li\",\"Lo\",\"Mc\",\"Mac\",\"op de\",\"ten\",\"ter\",\"Van ‘t\",\"van der\",\"van\",\"von der\",\"von\",\"z\",\"zu\"]"


# +--------------------+
# |  tagNamesSurnames  |
# +--------------------+
#
# List all family names you expect in tags that are not single words that are
# found at the end of a tagged name. Hyphenated family names (like
# "Ocasio-Cortez") do not need to be listed here: only compound family names,
# and if your language doesn't separate family names with whitespace. In the
# latter case, either include all family names, or include all givenNames
# (whatever's easier for you). This setting is used by the "tagNamesFormatter"
# if it is set to "family/given".
#
# PS_TAG_NAMES_SURNAMES=""


# +----------+
# |  tagYMD  |
# +----------+
#
# Should assets be tagged with "When > Year" (the "y" option), or "When > Year
# > Month" (the "ym" option), or "When > Year > Month > Day" (the "ymd"
# option)? Setting this to "" will disable date tagging.
#
# Valid values: y,ym,ymd,
#
# PS_TAG_YMD="ym"


# +-----------+
# |  whoTags  |
# +-----------+
#
# This is a list of tags that will be examined for strings or string arrays.
# All values associated to these fields will be interpreted as names. Note
# that "dotted notation" is supported.
#
# PS_WHO_TAGS="[\"People\",\"PersonInImage\",\"PersonInImageWDetails.PersonName\",\"PersonInImageName\",\"RegionInfoMP.Regions.PersonDisplayName\"]"



##############################################################################
#
# Settings for Library.web:
#


# +----------------+
# |  cspDirective  |
# +----------------+
#
# If you're seeing CSP errors with older browsers, add your
# externally-available base URL to this setting, and it will be appended to
# the CSP directives. See
# <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src>.
#
# PS_CSP_DIRECTIVE=""


# +-----------------+
# |  cspReportOnly  |
# +-----------------+
#
# Only report CSP violations. See
# <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.
#
# PS_CSP_REPORT_ONLY="false"


# +------------------------+
# |  fastForwardEmptyTags  |
# +------------------------+
#
# When browsing tags in the UI, should tags that only have one child tag and
# no direct assets be skipped, or "fast-forwarded," over? See
# <https://forum.photostructure.com/t/volume-id-shows-as-a-tag/754/5?u=mrm>
# for context.
#
# PS_FAST_FORWARD_EMPTY_TAGS="true"


# +------------------+
# |  hiddenHomeTags  |
# +------------------+
#
# The given root tags will be omitted from the home page. (Valid values
# include "When", "Camera", "Lens", "Type", and "Keyword").
#
# PS_HIDDEN_HOME_TAGS="[\"Type\"]"


# +--------------------+
# |  minStreamCorrPct  |
# +--------------------+
#
# Streams (shown on the asset page) are coalesced when the dice coefficient of
# their contents are greater than this value. A value of 100 requires streams
# to match exactly. A value of ~50 allows streams with a couple differences to
# be considered the "same" stream.
#
# Min value: 1
# Max value: 100
#
# PS_MIN_STREAM_CORR_PCT="50"


# +---------------------+
# |  placeholderThumbs  |
# +---------------------+
#
# Render missing asset previews as placeholder images (only useful for
# customer support).
#
# This setting is transient and only set via environment variables.
#
#
# PS_PLACEHOLDER_THUMBS="false"



##############################################################################
#
# Settings for Library.subscriptions:
#


# +----------------------+
# |  autoRefreshLicense  |
# +----------------------+
#
# PhotoStructure uses cryptographically signed licenses to locally store your
# current plan subscription status. These licenses are only valid for the
# current subscription period, and must be refreshed when your subscription
# renews or converts from a free trial to a paid subscription. To minimize the
# hassle of license renewals, PhotoStructure can automatically renew expired
# licenses in the background.
#
# If the current license has expired and this value is true, PhotoStructure
# will make one secure POST request to https://account.photostructure.com/
# that contains several lossy one-way hashes of current system metadata. We
# hash all identifying metadata to only 15 characters to alleviate any privacy
# concerns. If your plan subscription is active, a new license will be added
# to your library.
#
# Set this to false and set the "reportErrors" setting to false if you don't
# want PhotoStructure "phoning home" for any reason.
#
# Note that if this is disabled, license renewals will require manual
# intervention: click "Upgrade" from the main menu, pick your plan,
# authenticate, and the license will automatically refresh.
#
# PS_AUTO_REFRESH_LICENSE="true"


# +-----------+
# |  license  |
# +-----------+
#
# Subscription licenses are normally saved automatically into both your
# library and system configuration directories. This setting just provides
# users with an alternative way to provide a license, if it's more convenient.
# Any value provided to this setting will be considered in addition to
# existing license files when PhotoStructure is trying to find the "best"
# license available.
#
# PS_LICENSE=""


# +---------------------+
# |  pickPlanOnWelcome  |
# +---------------------+
#
# If set to true, the welcome page flow will redirect to
# https://account.photostructure.com/plans to have you pick between "plus" and
# "lite". If set to false, the welcome page will continue directly to the
# settings page with a "lite" license. You can still upgrade to a paid plan
# later from the main menu or the about page, even if this is false.
#
# PS_PICK_PLAN_ON_WELCOME="true"