Configuration reference
Most of Bitsmith is configured from the web interface. A handful of low-level settings are read from environment variables at startup, for cases the interface doesn’t cover (changing the port, relocating data, or scripting an install). You won’t need these for normal use.
Where settings live
Section titled “Where settings live”On an installed system, these are set in the environment file at
/etc/bitsmith/bitsmith.env. Edit the file, then restart the service for
changes to take effect:
sudo systemctl restart bitsmithCommon settings
Section titled “Common settings”| Variable | Default | What it does |
|---|---|---|
PORT | 443 | Port the interface listens on. |
BASE_URL | derived | Public URL of the server, used for links and OIDC callbacks. |
ENABLE_DOCKER_RUNTIME | off | Turns on the Docker-backed apps feature. |
Single sign-on (OIDC)
Section titled “Single sign-on (OIDC)”These mirror the OIDC settings screen and are usually set there rather than by hand:
| Variable | What it does |
|---|---|
AUTH_OIDC_ISSUER | Provider issuer URL. Setting it enables OIDC. |
AUTH_OIDC_CLIENT_ID | Client ID from your provider. |
AUTH_OIDC_CLIENT_SECRET | Client secret from your provider. |
AUTH_OIDC_PROVIDER_NAME | Name shown on the sign-in button. |
Bitsmith reads these only until it first saves sign-in or email settings to
/etc/bitsmith/auth.conf. That first save copies them into the file, and from
then on Bitsmith reads only the file. To change single sign-on after that, use
the OIDC settings screen.
AUTH_LOCAL_DISABLED is no longer read. If it is true when a server starts
this version for the first time, Bitsmith turns off Sign in with a password
on the OIDC settings screen, keeps the single sign-on set by the variables
above, and removes the line from bitsmith.env.
Data locations
Section titled “Data locations”Bitsmith stores its database, storage mounts, apps, and VM data under standard
paths. These can be overridden, for example to keep state on a specific disk:
DB_PATH, STORAGE_ROOT, MOUNT_ROOT, SECRETS_ROOT, APPS_ROOT,
VM_ROOT, VM_IMAGE_CACHE_DIR, VM_ISO_DIR, and VM_BACKUP_DIR.