defaults.env

#
# Welcome to PhotoStructure! These are the settings for version 0.9.1.
#
# 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.Logging
# * System.Paths
# * System.Processes
# * System.Tools
# * System.Updates
# * System.Volumes
#
# The following settings categories are stored in the library settings.toml:
#
# * Library.Db
# * Library.Filters
# * Library.Networking
# * Library.Previews
# * Library.Reporting
# * Library.Sync
# * Library.Tagging
# * Library.Web
#
# Please email <support@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"


# +–––––––––––––––+
# |  libraryPath  |
# +–––––––––––––––+
#
# 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
#
# PS_LIBRARY_PATH=


# +–––––––––––––––––+
# |  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.
#
# 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.
#
# 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=


# +–––––––––––+
# |  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=


# +––––––––––––––––––––+
# |  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', or a log level 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"


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


# +–––––––––––––––+
# |  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.
#
# PS_PREVIEWS_DIR=".photostructure/previews"



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


# +––––––––––––––+
# |  autoLaunch  |
# +––––––––––––––+
#
# Set to true to have PhotoStructure start automatically on login. Only
# supported on PhotoStructure for Desktops on macOS and Windows 10.
#
# PS_AUTO_LAUNCH="false"


# +–––––––––––––––––+
# |  bounceMinutes  |
# +–––––––––––––––––+
#
# PhotoStructure will bounce the web and sync processes periodically. Set to 0
# to disable.
#
# PS_BOUNCE_MINUTES="300"


# +––––––––––––––––––+
# |  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.
#
# Min value: 0
# Max value: 200
#
# PS_CPU_LOAD_PERCENT="75"


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


# +–––––––––––––––+
# |  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: 256
# 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: 250
# Max value: 8000
#
# PS_MAX_RSS_MEMORY_MB="1000"


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


# +–––––––––––––––––+
# |  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).
#
# 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"


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



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


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


# +––––––––––––––+
# |  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.
#
# PS_FFMPEG_PATH="ffmpeg"


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


# +–––––––––––––+
# |  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/sbin\",\"/usr/local/bin\",\"/opt/local/sbin\",\"/opt/local/bin\",\"/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.updates:
#


# +–––––––––––––––––+
# |  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:
#


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


# +–––––––––––––––––––––––+
# |  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.networking:
#


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


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



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


# +–––––––––––––––––––––––––––+
# |  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 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 1 minute, 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.filters:
#


# +–––––––––––––––––––––––––+
# |  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).
#
# Aliases: PS_MAX_ASSET_SIZE_BYTES,PS_MAX_ASSET_SIZE,PS_MAX_FILE_SIZE_BYTES
#
# PS_MAX_ASSET_FILE_SIZE_BYTES="500000000"


# +–––––––––––––––––––––––––+
# |  minAssetFileSizeBytes  |
# +–––––––––––––––––––––––––+
#
# What's the minimum photo or video size you want imported into your library?
# (This can prevent small GIFs and screenshots from being imported).
#
# Aliases: PS_MIN_ASSET_SIZE_BYTES,PS_MIN_ASSET_SIZE,PS_MIN_FILE_SIZE_BYTES
#
# 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 an 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"



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


# +––––––––––––––––––––––+
# |  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\"]"


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


# +–––––––––––––––––––––––+
# |  useEmbeddedPreviews  |
# +–––––––––––––––––––––––+
#
# Should embedded image previews be used when available? This speeds up image
# preview generation, but if the embedded image doesn't match the full-sized
# image, the image preview will be incorrect.
#
# PS_USE_EMBEDDED_PREVIEWS="true"


# +–––––––––––––––––––––––––+
# |  useEmbeddedThumbnails  |
# +–––––––––––––––––––––––––+
#
# 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.
#
# PS_USE_EMBEDDED_THUMBNAILS="true"


# +–––––––––––––––––––+
# |  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 added to error reports, so we can contact you to
# help debug the issue. It is not required, and will not be used for
# marketing.
#
# 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"


# +–––––––––––––––––––+
# |  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.sync:
#


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


# +––––––––––––––––––––––––––––––––––––+
# |  assetSubdirectoryDatestampFormat  |
# +––––––––––––––––––––––––––––––––––––+
#
# If you chose to copy assets into your library, they will be copied into
# <library directory>/<result of this pattern>/<original imagename>.
# - 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/docs/class/src/datetime.js~DateTime.html#instance-method-toFormat>
# and
# <https://moment.github.io/luxon/docs/manual/formatting.html#table-of-tokens>.
#
# Aliases: PS_ASSET_SUBDIR_FORMAT
#
# PS_ASSET_SUBDIRECTORY_DATESTAMP_FORMAT="y/y-MM-dd"


# +––––––––––––––––––––––+
# |  defaultSidecarType  |
# +––––––––––––––––––––––+
#
# What type of sidecar file do you want to generate for non-destructive edits?
#
# Valid values: EXIF,EXV,MIE,XMP
#
# PS_DEFAULT_SIDECAR_TYPE="XMP"


# +–––––––––––––––––––––––––––+
# |  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\"]"


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


# +––––––––––––––––––––––––––––+
# |  fuzzyDateImageCorrWeight  |
# +––––––––––––––––––––––––––––+
#
# Image correlation, by default, is somewhat lax to ensure JPG+RAW and
# downsampled or edited images are matched together. This is OK when dates
# must match, and the date is exactly correct. When dates are manually set to
# something "fuzzy", with perhaps only the year, month, and day, or is
# inferred by siblings, we need to be more discriminate with image contents to
# prevent incorrectly grouping photos from that day into a single asset. This
# value is multiplied with minImageCorrPct and minColorCorrPct to make them
# more stringent. For example, by default, the minImageCorrPct is 80%, and
# when the dates are manually set, and this weight is 1.2, the minImageCorrPct
# for manually-set-date files will be 90%.
#
# Min value: 0.5
# Max value: 2
#
# PS_FUZZY_DATE_IMAGE_CORR_WEIGHT="1.5"


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


# +–––––––––––––––––––––––––––+
# |  greyscaleColorThreshold  |
# +–––––––––––––––––––––––––––+
#
# When looking at each pixel in L*a*b* space, a greyscale image is expected to
# have a* and b* values around 0. If the absolute value of every a* and b*
# value is under this setting's value, the image will be considered to be
# greyscale. A value of 0 will force all images to be considered
# non-greyscale.
#
# Min value: 0
# Max value: 128
#
# PS_GREYSCALE_COLOR_THRESHOLD="5"


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


# +–––––––––––––––––––+
# |  minColorCorrPct  |
# +–––––––––––––––––––+
#
# This is the minimum correlation 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 40% indicates fairly low
# correlation of dominant colors, and can lead to false positives.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_COLOR_CORR_PCT="60"


# +–––––––––––––––––––+
# |  minImageCorrPct  |
# +–––––––––––––––––––+
#
# This is the minimum image hash correlation value for 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 60% is
# fairly low image correlation, and can lead to false positives.
#
# Min value: 0
# Max value: 100
#
# PS_MIN_IMAGE_CORR_PCT="75"


# +–––––––––––––––––––––+
# |  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.
#
# PS_OVERWRITE_ORIGINAL="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"


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


# +––––––––––––––––––+
# |  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.
#
# PS_STRICT_DEDUPING="false"


# +–––––––––––––––––––––+
# |  syncIntervalHours  |
# +–––––––––––––––––––––+
#
# This value controls both how often the sync process runs, and how often new
# files are discovered and imported. WARNING: Setting this value to a small
# value (say, less than 10) will mean PhotoStructure is constantly scanning
# your disks, which may reduce the lifespan of your storage media. Note that
# setting this to 0 will disable automatic scheduling of the sync process.
# This defaults to every other day (to balance picking up new files
# automatically and trying to avoid unnecessary wear and tear on your storage
# media).
#
# Min value: 0
# 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 be transcoded during import? 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"


# +––––––––––––––––––+
# |  useImageHashes  |
# +––––––––––––––––––+
#
# Should image hashes be computed? This slows down imports, but supports more
# robust asset merging heuristics, and allows for dominant color tagging and
# browsing.
#
# PS_USE_IMAGE_HASHES="true"


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


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


# +––––––––––––––––––––––––––––––––––+
# |  writeMetadataToSidecarsIfImage  |
# +––––––––––––––––––––––––––––––––––+
#
# For non-video files, should changes made through the UI, like rotations,
# captions, and keywords, be written to a sidecar (which will be created if
# missing), or should metadata be saved to a copy of the original?
#
# PS_WRITE_METADATA_TO_SIDECARS_IF_IMAGE="true"


# +––––––––––––––––––––––––––––––––––+
# |  writeMetadataToSidecarsIfVideo  |
# +––––––––––––––––––––––––––––––––––+
#
# For video files, should changes made through the UI, like rotations,
# captions, and keywords, be written to a sidecar (which will be created if
# missing), or should metadata be saved to a copy of the original? 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.tagging:
#


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


# +–––––––––––––––––––––+
# |  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="/|>≻⊃"


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


# +–––––––––––––––+
# |  tagFileType  |
# +–––––––––––––––+
#
# Should assets be tagged with their file type (like "Type/Image/JPEG")?
#
# Aliases: PS_TAG_TYPE
#
# 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"


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


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



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


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