Using environment variables with PhotoStructure

June 30, 2020

You can use environment variables to configure PhotoStructure’s settings. The defaults.env file describes all of PhotoStructure’s settings, and how to change each with an environment variable. This file will also be found in your root app directory (from version 0.9.0 and later) if you’re using a PhotoStructure for Servers edition.

Notes #

You can edit your settings.toml and set environment variables.
Environment variables override any values found in settings.toml.
PhotoStructure does not read from the defaults.env file or .env files.
PhotoStructure only reads from settings.toml files.

Converting between settings names and environment variable names #

To avoid name-colliding with other software, all PhotoStructure environment variables are prefixed with PS_ and converted to UPPER_SNAKE_CASE.

Examples #

The PS_LOG_LEVEL environment variable overrides the logLevel setting.
The PS_LIBRARY_PATH environment variable overrides the libraryPath setting.

Caution: upgrades to your environment variables are not automatic #

When you upgrade to a new version of PhotoStructure, your prior settings.toml files are automatically migrated to contain the settings (and defaults) of the new version, while retaining your custom configurations.

We can’t do this for environment variables, though, as we don’t know where your environment variables are coming from, as they can be set in many different ways.

If you’re using environment variables, it’s up to you to review our release notes and make suitable settings changes when you upgrade. We mark any settings that are deleted, renamed, or have changed semantics with a 💔.

It also might be helpful to look at differences between version tags on github.

How to set environment variables #

It’s up to you to copy, modify, and source the contents into the shell that starts your PhotoStructure process.

macOS and Linux #

Add environment variables to the relevant rc script for your shell. If you’re using bash, that’s ~/.profile:

export PS_LOG_LEVEL=info

Windows #

Hit the Windows key, and type “environment”,
select “Edit the system environment vairables” control panel,
click the Environment Variables... button in the bottom right, and
click New...

Docker #

With docker, use the docker run --env option:

docker run docker run --name photostructure --env PS_LOG_LEVEL=info ...

With docker-compose, use the environment configuration option:

...
    environment:
      - "PS_LOG_LEVEL=info"
...