Configuration

Configure Arcane for your environment

Most of the settings in Arcane can be changed via the Settings UI. Below are a the settings that can be set via the Environment.

Use External Postgres Database

By default Arcane will use a SQLite database with the following connection string:

			file:data/arcane.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(2500)&_txlock=immediate

If you would like to change to a external postgres database, change the DATABASE_URL Env variable to something similar to below:

			postgres://<db_username>:<db_password>@<postgres_url>:<postgres_port>/<postgres_db_name>

Make sure to replace the placeholder values with the real values for your environment.

<db_username>: The username to use to connect to the postgres Database
<db_password>: The password to use to connect to the postgres Database
<postgres_url>: The server where the postgres instance is (can be a dns name or ip address)
<postgres_port>: The port to use to connect to the postgres server
<postgres_db_name>: The name of the database to use on the postgres server

Variable	Purpose	Default/Examples
`PORT`	The port arcane should run on	`3552`
`DATABASE_URL`	The database connection string (SQLite by default)	`file:data/arcane.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(2500)&_txlock=immediate`
`DEV_BACKEND_URL`	The url of the backend for development	`http://localhost:3552`
`PUID`	File owner user ID	`2000`
`PGID`	File owner group ID	`2000`
`DOCKER_GID`	Only set this manually if the autodetected GID is incorrect	`(auto)`
`ENCRYPTION_KEY`	Encryption Key for secure stored sensitive data	`-`
`JWT_SECRET`	Session secret	`-`
`OIDC_ENABLED`	Enable OIDC login	`false`
`OIDC_CLIENT_ID`	Client ID from your OIDC provider	`your_arcane_client_id_from_provider`
`OIDC_CLIENT_SECRET`	Client Secret from provider	`your_client_secret_from_provider`
`OIDC_ISSUER_URL`	Issuer URL from provider	`https://your-provider.com`
`OIDC_SCOPES`	Scopes to request	`openid email profile (default)`