Skip to content

Environment Variables

Ashley Davis edited this page May 17, 2026 · 4 revisions

This page documents all environment variables recognised by Photosphere.

AWS / S3 Variables

When no S3 credentials are present in databases.json, Photosphere reads AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, and AWS_ENDPOINT directly from process.env to construct S3 credentials.

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-compatible services) https://nyc3.digitaloceanspaces.com

Other Variables

Variable Description Default
GOOGLE_API_KEY Google API key for reverse geocoding None
PSI_ENCRYPTION_KEY Encryption key for encrypted storage (fallback if not passed via -k flag or databases.json) None
PHOTOSPHERE_VAULT_TYPE Selects the vault backend: keychain (OS keychain) or plaintext (JSON files on disk) keychain
PHOTOSPHERE_VAULT_DIR Overrides the vault directory path (only used with the plaintext backend) ~/.config/photosphere/vault/
PHOTOSPHERE_CONFIG_DIR Overrides the Photosphere config directory ~/.config/photosphere/
PHOTOSPHERE_NEWS_URL Overrides the URL of the news feed checked at desktop startup and on psi version. Accepts http://, https://, and file:// URLs. https://raw.githubusercontent.com/ashleydavis/photosphere/main/news.yaml

Example: plaintext vault for scripting or CI

export PHOTOSPHERE_VAULT_TYPE=plaintext
export PHOTOSPHERE_VAULT_DIR=/path/to/vault

Related Configuration

Clone this wiki locally