Environment variables

Lore is configured with environment variables: in docker-compose.yml with Docker, in /etc/lore/lore.env with the packages, in conf/lore.env with the archive. Only one is required: the database password.

Documentation for version 0.1, in preparation. Commands, variables and API endpoints are proposals: they may change before the release.

On this page

Essential
Database
Import and extraction
Emails (optional) Planned
Other
Where to set them
Example

Essential

Variable	Description
`LORE_DB_PASSWORD`	The PostgreSQL database password. Required.
`LORE_PUBLIC_URL`	The address your team uses to open Lore, for example `https://lore.example.com`, used in invitation and reset links. Optional: without it, Lore uses the address entered during the initial setup. When it is set, it takes precedence and can no longer be changed in the administration.

Database

Variable	Default	Description
`LORE_DB_HOST`	`postgres` (`localhost` in the settings file of the packages and the archive)	PostgreSQL host
`LORE_DB_PORT`	`5432`	Port
`LORE_DB_NAME`	`lore`	Database name
`LORE_DB_USER`	`lore`	User

Import and extraction v0.1

These variables come with document import: Lore does not read them yet.

Variable	Default	Description
`LORE_MAX_UPLOAD_SIZE`	`50MB`	Maximum size of a file
`LORE_FILES_PATH`	`/var/lib/lore/files`	Folder of imported files
`LORE_EXTRACTION_WORKERS`	`2`	Extraction processes running in parallel
`LORE_EXTRACTION_TIMEOUT`	`120s`	Maximum extraction time for a file
`LORE_EXTERNAL_EXTRACTOR_URL`	empty	Address of an optional external extractor

Emails (optional) Planned

Sending invitations and resets by email is planned: Lore does not read these variables yet. Until then, links are passed on by hand, without a mail server.

Variable	Description
`LORE_SMTP_HOST`	SMTP server
`LORE_SMTP_PORT`	Port, often 587
`LORE_SMTP_USER`	Username
`LORE_SMTP_PASSWORD`	Password
`LORE_SMTP_FROM`	Sender address

Other

Variable	Default	Description
`LORE_SESSION_TIMEOUT`	`8h`	Longest a session can stay inactive. Administration › Security and sign-in can lower it, not exceed it.
`LORE_SETUP_CODE`	empty	A fixed initial setup code, for automated installations. When empty, a random code is written to the logs. See Initial setup.
`LORE_LOG_LEVEL`	`INFO`	Logging level
`LORE_PORT`	`8080`	Lore’s port, with the packages and the archive. With Docker, change the published port instead.
`LORE_JAVA_OPTS`	`-XX:MaxRAMPercentage=25`	Java options, with the packages and the archive, for example `-Xmx2g` for the memory

Where to set them

Method	File	After a change
Docker Compose	The `environment` section of the `lore` service, in `docker-compose.yml`	`docker compose up -d`
Packages	`/etc/lore/lore.env`	`sudo systemctl restart lore`
Archive	`conf/lore.env`	Restart Lore

Example

With Docker, secrets stay in the .env file next to docker-compose.yml, and are referenced with the ${…} syntax. With the packages and the archive, the file holds one variable per line:

YAML

services:
  lore:
    environment:
      LORE_PUBLIC_URL: https://lore.example.com
      LORE_DB_PASSWORD: ${DB_PASSWORD}
      LORE_SESSION_TIMEOUT: 4h

Terminal

LORE_PUBLIC_URL=https://lore.example.com
LORE_DB_HOST=localhost
LORE_DB_PASSWORD='a-long-password'
LORE_SESSION_TIMEOUT=4h

In lore.env, put a value in straight single quotes if it contains spaces or special characters. With the archive on Windows, use straight double quotes instead: single quotes would become part of the value.

Edit this page on GitHub Report a problem