Skip to content

Configuration CLI

Jump to bottom Edit New page
Ashley Davis edited this page Apr 21, 2026 · 9 revisions

This guide covers all configuration options available for the Photosphere CLI tool

Environment Variables

S3/AWS Configuration

Variable Description Example
AWS_ACCESS_KEY_ID S3 access key ID AKIAIOSFODNN7EXAMPLE
AWS_SECRET_ACCESS_KEY S3 secret access key wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
AWS_REGION S3 region us-east-1
AWS_ENDPOINT S3 endpoint URL (for non-AWS S3) https://nyc3.digitaloceanspaces.com
S3_PROFILE Select S3 profile to use production

Other Environment Variables

Variable Description Default
GOOGLE_API_KEY Google API key for reverse geocoding None

See Environment-Variables for the full list of supported environment variables.

Storage Connection Strings

The CLI supports multiple storage backends:

Type Format Example
Filesystem fs:path/to/directory fs:/var/photosphere/data
Filesystem (implicit) path/to/directory ./my-photos
S3-compatible s3:bucket-name/path s3:my-bucket/photos

Encryption Key Files

Key files are used to encrypt and decrypt Photosphere databases. Pass them via the --key, --dest-key, or --source-key options.

Key file location

  • Pass a full path: --key /path/to/my-photos.key
  • Pass a filename only: Photosphere looks in ~/.config/photosphere/keys/ first, then the current directory. So --key my-photos.key suffices if the key is stored in the config directory.

Multiple keys (comma-separated list)

All key options accept a comma-separated list of key file paths:

--key key1.key,key2.key,key3.key
  • The first key is the default key — used for writing new encrypted data and for reading legacy-format files.
  • All keys are registered by their public-key hash so files encrypted with different keys in the same database can all be read.

See Encryption for full details on how encryption works and how to use psi encrypt / psi decrypt.

Related Configuration

Add a custom footer
Add a custom sidebar

Clone this wiki locally