Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Stashix is configured with environment variables. With Docker Compose they live in the .env file next to docker-compose.yml. See Installation for a first setup.

Required

Variable	Default	What it does
`SECRET_KEY_BASE`	none	Encrypts and signs sessions and cookies. Generate with `openssl rand -base64 48`.
`JWT_SECRET`	none	Signs login tokens. Use a different value from `SECRET_KEY_BASE`.
`STASHIX_ENCRYPTION_KEY`	none	Base64 32-byte key that encrypts stored metadata source credentials. Generate with `openssl rand -base64 32`.
`DATABASE_URL`	`postgresql://stashix:stashix@db/stashix`	PostgreSQL connection, as `ecto://user:password@host/database`.
`LIBRARIES_PATH`	`./libraries`	Your media folder on the host, not a path inside the container. Compose mounts it read-write at `/libraries`, and each library in Stashix points at a folder under that, such as `/libraries/comics`. Read-write so metadata can be saved to your files; see Metadata in your files.

LIBRARIES_PATH is used only by Docker Compose to mount the folder; Stashix itself never reads it. It used to be called LIBRARY_PATH, and .env files with the old name keep working.

Reference on Stashix

Configuration

Required