Docker - Lago

Requirements

Install Docker on your machine;
Make sure Docker Compose is installed and available (it should be the case if you have chosen to install Docker via Docker Desktop); and
Make sure Git is installed on your machine.

Run the Lago App

Run the app with a one-click Docker command

You can start using the app by using a one-click Docker command in a shell:

docker run -d --name lago -p 80:80 -p 3000:3000 getlago/lago:latest

You can now open your browser and go to http://localhost to connect to the application. Just after signing up, Lago’s API is exposed at http://localhost:3000.

Run the app with advanced Docker commands

If you don’t want to use the one-click Docker command, you can start using Lago by running more advanced commands in a shell:

# Get the code
git clone https://github.com/getlago/lago.git

# Go to Lago folder
cd lago

# Fetch all tags
git fetch --tags

# Get the latest tag and checkout
git checkout $(git describe --tags --abbrev=0)

# Set up environment configuration
echo "LAGO_RSA_PRIVATE_KEY=\"`openssl genrsa 2048 | base64 | tr -d '\n'`\"" >> .env

source .env

# Start all the components
docker compose up

You can now open your browser and go to http://localhost to connect to the application. Just after signing up, Lago’s API is exposed at http://localhost:3000.

Signing up

It’s mandatory to create your organization by signing up to Lago. This organization is the core object of your biller as it’s used to invoice your customers.

Write down your organization name;
Use the main billing email of your company; and
Define the admin password for this email.

You will be able to invite other email addresses within the application. If you already have an account, you can also log in. Once you are able to access the app, you can retrieve your API key.

Find your API Key

Your API Key can be found directly in the UI:

Access the Developer section from the sidebar;
The first tab of this section is related to your API keys; and
Click the Copy button to copy it to clipboard.

Configuration

Version

Docker images are always updated to the last stable version in the docker-compose.yml file. You can use a different tag if needed by checking the releases list.

We recommend avoiding the usage of latest tag, you should use the last tagged version, you can track the latest versions on Dockerhub

lago-api : https://hub.docker.com/repository/docker/getlago/api
lago-front : https://hub.docker.com/repository/docker/getlago/front

Environment variables

Lago uses the following environment variables to configure the components of the application. You can override them to customise your setup.

Variable	Default value	Description
`API_PORT`	3000	Port the back-end application listens to
`API_URL`	http://localhost:3000	URL of the Lago back-end application defined for the front image
`DATABASE_POOL`	10	Max number of connection opened to the postgres database per api, worker and clock instances
`DATABASE_PREPARED_STATEMENTS`	true	Enable or disable prepared statements in the postgres database
`DATABASE_URL`		(Without docker compose) Full url to the postgres server
`FRONT_PORT`	80	Port the front-end application listens to
`GOOGLE_AUTH_CLIENT_ID`		Client ID for Google auth Single Sign On
`GOOGLE_AUTH_CLIENT_SECRET`		Client Secret for Google auth Single Sign On
`LAGO_API_URL`	http://localhost:3000	URL of the Lago back-end application
`LAGO_AWS_S3_ACCESS_KEY_ID`	azerty123456	AWS Access Key id that has access to S3
`LAGO_AWS_S3_BUCKET`	bucket	AWS S3 Bucket name
`LAGO_AWS_S3_ENDPOINT`		S3 compatible storage endpoint. Should be set only if you are using another storage provider than AWS S3
`LAGO_AWS_S3_REGION`	us-east-1	AWS S3 Region
`LAGO_AWS_S3_SECRET_ACCESS_KEY`	azerty123456	AWS Secret Access Key that has access to S3
`LAGO_DATABASE_IDLE_TX_TIMEOUT`		A transaction left idle past the time limit (in milliseconds) is terminated. Maps to `idle_in_transaction_session_timeout` in postgres
`LAGO_DATABASE_LOCK_TIMEOUT`		A statement waiting on a lock past the limit (in milliseconds) fails fast instead of blocking. Maps to `lock_timeout` in postgres
`LAGO_DATABASE_STATEMENT_TIMEOUT`		Any single query exceeding the time limit (in milliseconds) is cancelled. Maps to `statement_timeout` in postgres
`LAGO_DISABLE_PDF_GENERATION`	false	Disable automatic PDF generation for invoices, credit notes, and receipts. As a result, the corresponding download endpoints will be unavailable
`LAGO_DISABLE_SIGNUP`		Disable Sign up when running Lago in self-hosted
`LAGO_DISABLE_WALLET_REFRESH`		Disable automatic refresh of wallet ongoing balance
`LAGO_ENCRYPTION_DETERMINISTIC_KEY`	your-encryption-deterministic-key	Encryption deterministic key used to secure sensitive values stored in the database
`LAGO_ENCRYPTION_KEY_DERIVATION_SALT`	your-encryption-derivation-salt	Encryption key salt used to secure sensitive values stored in the database
`LAGO_ENCRYPTION_PRIMARY_KEY`	your-encryption-primary-key	Encryption primary key used to secure sensitive values stored in the database
`LAGO_FRONT_URL`	http://localhost	URL of the Lago front-end application.Used for CORS configuration
`LAGO_GCS_BUCKET`		GCS Bucket Name
`LAGO_GCS_CREDENTIALS`		GCS Credentials JSON file path
`LAGO_GCS_GSA_EMAIL`		GCS GSA Email
`LAGO_GCS_IAM`	false	GCS IAM Authentication
`LAGO_GCS_PROJECT`		GCS Project name
`LAGO_MEMCACHE_SERVERS`		Comma-separated list of memcache servers
`LAGO_PDF_URL`	http://pdf:3000	PDF Service URL on your infrastructure
`LAGO_RAILS_STDOUT`	true	Set to true to activate logs on containers
`LAGO_REDIS_CACHE_HOST`	redis	Host name of the redis cache server. See Configuring Redis.
`LAGO_REDIS_CACHE_MASTER_NAME`	master	Name of the Redis Sentinel master instance. Only used when `LAGO_REDIS_CACHE_SENTINELS` is set. See Configuring Redis.
`LAGO_REDIS_CACHE_PASSWORD`		Password of the redis cache server. See Configuring Redis.
`LAGO_REDIS_CACHE_POOL_SIZE`	5	Max number of connections in the redis cache connection pool. See Configuring Redis.
`LAGO_REDIS_CACHE_PORT`	6379	Port the redis cache server listens to. See Configuring Redis.
`LAGO_REDIS_CACHE_SENTINELS`		Comma-separated list of Redis Sentinel addresses for Sidekiq high availability (e.g., `sentinel-1:26379,sentinel-2:26379,sentinel-3:26379`). Only applies to Sidekiq, not the cache
`LAGO_REDIS_SIDEKIQ_MASTER_NAME`	master	Name of the Redis Sentinel master instance. Only used when `LAGO_REDIS_SIDEKIQ_SENTINELS` is set. See Configuring Redis.
`LAGO_REDIS_SIDEKIQ_SENTINELS`		Comma-separated list of Redis Sentinel addresses for Sidekiq high availability (e.g., `sentinel-1:26379,sentinel-2:26379,sentinel-3:26379`). Only applies to Sidekiq, not the cache
`LAGO_RSA_PRIVATE_KEY`		Private key used for webhook signatures
`LAGO_SIDEKIQ_WEB`		Activate the Sidekiq web UI, disabled by default
`LAGO_USE_AWS_S3`	false	Use AWS S3 for files storage
`LAGO_USE_GCS`	false	Use Google Cloud Service Cloud Storage for file storage, ⚠️ If you want to use GCS, you have to pass the credentials json key file to the api and worker service
`LAGO_WEBHOOK_ATTEMPTS`	3	Number of failed attempt before stopping to deliver a webhook
`POSTGRES_DB`	lago	(With Docker compose) Name of the postgres database
`POSTGRES_HOST`	db	(With Docker compose) Host name of the postgres server
`POSTGRES_PASSWORD`	changeme	(With Docker compose) Database password for postgres connection
`POSTGRES_PORT`	5432	(With Docker compose) Port the postgres database listens to
`POSTGRES_SCHEMA`	public	Name of the postgres schema
`POSTGRES_USER`	lago	(With Docker compose) Database user for postgres connection
`REDIS_HOST`	redis	Host name of the redis server
`REDIS_PASSWORD`		Password of the redis server
`REDIS_PORT`	6379	Port the redis database listens to
`SECRET_KEY_BASE`	your-secret-key-base-hex-64	Secret key used for session encryption
`SENTRY_DSN_FRONT`		Sentry DSN key for error and performance tracking on Lago front-end
`SENTRY_DSN`		Sentry DSN key for error and performance tracking on Lago back-end

We recommend that you change POSTGRES_PASSWORD, SECRET_KEY_BASE, LAGO_RSA_PRIVATE_KEY, LAGO_ENCRYPTION_PRIMARY_KEY, LAGO_ENCRYPTION_DETERMINISTIC_KEY and LAGO_ENCRYPTION_KEY_DERIVATION_SALT to improve the security of your Lago instance:

SECRET_KEY_BASE can be generated using the openssl rand -hex 64 command.
LAGO_RSA_PRIVATE_KEY can be generated using the openssl genrsa 2048 | base64 command.
LAGO_ENCRYPTION_PRIMARY_KEY, LAGO_ENCRYPTION_DETERMINISTIC_KEY and LAGO_ENCRYPTION_KEY_DERIVATION_SALT can all be generated using the cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1 command.

Components

Lago uses the following containers:

Container	Role
`front`	Front-end application
`api`	API back-end application
`api_worker`	Asynchronous worker for the API application
`api_clock`	Clock worker for the API application
`db`	Postgres database engine used to store application data
`redis`	Redis database engine used as a queuing system for asynchronous tasks
`pdf`	PDF generation powered by Gotenberg

You can also use your own Postgres or Redis server. To do so, remove the db and redis configurations from the docker-compose.yml file and update the environment variables accordingly.

Configuring the database

Connection

`DATABASE_URL`

Lago connects to PostgreSQL through a standard Rails DATABASE_URL environment variable:

DATABASE_URL=postgresql://{user}:{password}@{host}:{port}/{database}?{variable}={value}

The available variables are listed in the sections below.

When using the Docker Compose

When using the Docker Compose, the POSTGRES_* variables are used to build the DATABASE_URL for the Lago applications as follows:

DATABASE_URL=postgresql://${POSTGRES_USER:-lago}:${POSTGRES_PASSWORD:-changeme}@${POSTGRES_HOST:-db}:${POSTGRES_PORT:-5432}/${POSTGRES_DB:-lago}?search_path=${POSTGRES_SCHEMA:-public}

Therefore, you do not need to set DATABASE_URL explicitly in this setup. Although it is possible to use the Docker Compose with an external Postgres instance, the bundled docker-compose.yml also ships a db service which is configured using the POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD and POSTGRES_PORT variables. When using the bundled db service, we suggest to change the default POSTGRES_PASSWORD value.

Note that it is still possible to override DATABASE_URL when using the Docker Compose. The caveat is that the bundled db service will be configured using the POSTGRES_* variables, possibly causing conflicts. So we recommend using the POSTGRES_* over DATABASE_URL when using the bundled db service.

Schema

By default, Lago uses the public schema in Postgres. Lago allows you to isolate Lago’s tables in a dedicated schema if you share your database with other applications. You can change that by setting the POSTGRES_SCHEMA environment variable:

POSTGRES_SCHEMA=lago

It is also possible to set the schema in the DATABASE_URL directly using the search_path variable:

DATABASE_URL="postgresql://user:password@host:port/database?schema_search_path=lago"

Unlike the other POSTGRES_* variables, POSTGRES_SCHEMA applies in all setups.

Connection pool

Variable	Default	Purpose
`DATABASE_POOL`	`10`	Maximum number of connections each API, worker or clock instance opens to Postgres.
`DATABASE_PREPARED_STATEMENTS`	`true`	Enables Postgres prepared statements. You might not want that in some scenarios (e.g. a connection pooler that doesn’t support them).

Total connections to Postgres ≈ DATABASE_POOL × (api/worker/etc.). Keep this comfortably below your Postgres max_connections.

Statement-level safeguards

These three opt-in variables are applied to every Lago Rails connection (API, workers, clock, Rake tasks). They are unset by default, which means Postgres queries runs with no timeout unless explicitly set.

Environment Variable	`DATABASE_URL` variable	Effect when set
`LAGO_DATABASE_STATEMENT_TIMEOUT`	`statement_timeout`	Any single query exceeding the value (in ms) is cancelled with `PG::QueryCanceled`.
`LAGO_DATABASE_IDLE_TX_TIMEOUT`	`idle_in_transaction_session_timeout`	A transaction left idle past the value (in ms) is terminated, releasing its locks.
`LAGO_DATABASE_LOCK_TIMEOUT`	`lock_timeout`	A statement waiting on a lock past the value (in ms) fails fast instead of blocking.

Setting a variable to 0 explicitly disables that specific cap (same as leaving it unset). You can also set these timeouts via DATABASE_URL:

DATABASE_URL="postgresql://user:password@host:port/database?statement_timeout=15000&idle_in_transaction_session_timeout=60000&lock_timeout=5000"

These timeouts apply to every process that boots the Rails app, including Sidekiq workers, the clock container, and Rake tasks such as migrations. Long-running background jobs and schema migrations can be killed if you set aggressive limits globally. Apply tight caps to the web tier and set them higher on workers, clock and migration entrypoints.

We recommend to set the timeouts lower than your HTTP-layer timeout so Postgres cancels the query before the client gives up.

Enabling SSL

If your PostgreSQL server requires SSL connections (e.g., using a PEM certificate for verify-full mode), you can configure the connection using either libpq environment variables or the DATABASE_URL parameters.

Using libpq environment variables

Set any of the libpq SSL environment variables:

# .env
PGSSLMODE=verify-full
PGSSLROOTCERT=/app/config/rds-ca.pem

For an exhaustive list of environment variables, refer to the libpq environment variables documentation.

Using DATABASE_URL

Alternatively, you can append any of the libpq SSL parameters directly to the DATABASE_URL:

DATABASE_URL=postgresql://lago:changeme@db:5432/lago?sslmode=verify-full&sslrootcert=/app/config/rds-ca.pem

For an exhaustive list of SSL parameters, refer to the libpq documentation.

Best practices

Bring your own Postgres in production. The bundled db service in docker-compose.yml is intended for local trials. For production, run a managed or dedicated Postgres instance and point Lago at it via DATABASE_URL.
Use DATABASE_URL as the single source of truth outside of docker-compose. It is the only variable Lago reads in production; POSTGRES_* only apply when the bundled db service is in use.
Size the pool to your concurrency. A good rule of thumb is DATABASE_POOL ≥ Puma threads per process and ≥ Sidekiq concurrency per worker. Total connections must stay under Postgres max_connections.
Disable prepared statements only when needed. Prepared statements are tied to a single Postgres connection. Transaction-mode poolers (e.g. PgBouncer) reuse backend connections between transactions, so a statement prepared on one may not exist on the next. Set DATABASE_PREPARED_STATEMENTS=false if your pooler doesn’t preserve them across reuses.
Apply timeouts at the web tier first. Roll out LAGO_DATABASE_STATEMENT_TIMEOUT on the API only, monitor cancellations for 24–48 h, then extend to other tiers with more generous values if needed.
Encrypt connections. Configure SSL with verify-full against a known CA. See Enabling SSL above.
Keep Postgres healthy. Once Lago is connected, follow the Database maintenance guide for autovacuum, autoanalyze and slow-query monitoring.

Configuring Redis

Lago uses Redis for two independent purposes:

Job queue - Sidekiq stores background-job state in Redis. The API enqueues jobs that workers and the clock process pick up.
Application cache - Lago uses Redis as a cache-store for compute-heavy values (current usage, etc.).

You can run a single Redis instance for both (the bundled Docker Compose does this) but for a production-ready environment, it is recommended to separate them. Each role has its own set of environment variables so they can be configured independently.

Sidekiq Redis (job queue)

`REDIS_URL`

Lago’s Sidekiq workers connect to Redis through the REDIS_URL environment variable:

REDIS_URL=redis://{host}:{port}/{database}

When using the Docker Compose, the bundled docker-compose.yml ships a redis service. REDIS_URL=redis://redis:6379 already points at it, so you do not need to override the variable in this setup.

Cache Redis (application cache)

`LAGO_REDIS_CACHE_URL`

Lago’s API and workers reach the Rails cache through LAGO_REDIS_CACHE_URL:

LAGO_REDIS_CACHE_URL=redis://{host}:{port}/{database}

When using the Docker Compose, the bundled redis service is reused for the cache in the default Docker Compose setup. LAGO_REDIS_CACHE_URL=redis://redis:6379 is pre-configured.

Authentication

It is possible to configure Redis with password-only or ACL-based authentication. In such case, you can configure Lago to authenticate with Redis.

Sidekiq Redis (job queue)

If you use password-only authentication, you can set REDIS_PASSWORD or include the password in REDIS_URL:

REDIS_URL=redis://:{password}@{host}:{port}/{database}

When using ACL-based authentication, you must include the username and password in REDIS_URL:

REDIS_URL=redis://{user}:{password}@{host}:{port}/{database}

Cache Redis (application cache)

If you use password-only authentication, you can set LAGO_REDIS_CACHE_PASSWORD or include the password in LAGO_REDIS_CACHE_URL:

LAGO_REDIS_CACHE_URL=redis://:{password}@{host}:{port}/{database}

When using ACL-based authentication, you must include the username and password in LAGO_REDIS_CACHE_URL:

LAGO_REDIS_CACHE_URL=redis://{user}:{password}@{host}:{port}/{database}

Enabling SSL on Redis

If your Redis server requires SSL connections, you can enable it by using the rediss:// scheme in your Redis URLs:

REDIS_URL=rediss://{host}:{port}/{database}
LAGO_REDIS_CACHE_URL=rediss://{host}:{port}/{database}

Managed Redis services

We recommened using Lago with managed Redis providers, such as Amazon ElastiCache. These services handle replication, automatic failover, backups, and monitoring on your behalf, providing a highly available Redis setup with minimal operational overhead. Point Lago at the provider’s primary endpoint via the standard URL variable. Failover is transparent: when the provider promotes a replica, the endpoint stays the same, and the next reconnect lands on the new master.

High availability with Redis Sentinel

When using a dedicated Redis setup that you manage yourself, you can achieve high availability with Redis Sentinel. Sentinel is Redis’s built-in monitoring and failover mechanism: a small cluster of Sentinel processes watches the Redis nodes, agrees by quorum when the master is unreachable, and promotes one of the existing replicas. Lago connects to the Sentinels instead of directly to a Redis node, and automatically reconnects to the new master if a failover occurs - no restart or operator action required. You can enable Sentinel for the Sidekiq queue, the cache, or both. Each consumer reads its own variables, so mixing modes is supported (for example, Sidekiq through Sentinel and the cache through a static URL). If you’d like to use Redis Sentinel, we recommend that you properly read through its documentation and define monitoring and alerting on Sentinel events. Furthermore we suggest to the test failover (e.g., by simulating consecutive master failures) thoroughly and regularly during low-traffic/maintenance periods or on a staging environment to make sure your setup works as expected.

Redis also provides high availability through Redis Cluster, but Sidekiq doesn’t support it. Sentinel is the only recommended HA solution for self-hosted Lago deployments using dedicated Redis.

Sidekiq Sentinel configuration

Variable	Purpose
`LAGO_REDIS_SIDEKIQ_SENTINELS`	Comma-separated list of Sentinel addresses (`host:port,host:port,...`). Setting this activates Sentinel mode for Sidekiq.
`LAGO_REDIS_SIDEKIQ_MASTER_NAME`	The `master_name` declared on the Sentinels. Optional - defaults to `master`. Set this only if your Sentinel cluster uses a different name.

REDIS_PASSWORD continues to authenticate against the underlying Redis nodes when Sentinel is enabled. You do not need to set REDIS_URL when Sentinel mode is enabled. Lago discovers the current Redis master dynamically from LAGO_REDIS_SIDEKIQ_SENTINELS. If REDIS_URL is also set, Lago only reuses its connection options, such as the scheme (redis:// or rediss://), password, and database number. The host and port from REDIS_URL are ignored because Sentinel provides the active master address.

Cache Sentinel configuration

Variable	Purpose
`LAGO_REDIS_CACHE_SENTINELS`	Comma-separated list of Sentinel addresses (`host:port,host:port,...`). Setting this activates Sentinel mode for the cache.
`LAGO_REDIS_CACHE_MASTER_NAME`	The `master_name` declared on the Sentinels. Optional - defaults to `master`.

REDIS_PASSWORD continues to authenticate against the underlying Redis nodes when Sentinel is enabled. You do not need to set LAGO_REDIS_CACHE_URL when Sentinel mode is enabled. Lago discovers the current Redis master dynamically from LAGO_REDIS_CACHE_SENTINELS. If LAGO_REDIS_CACHE_URL is also set, Lago only reuses its connection options, such as the scheme (redis:// or rediss://), password, and database number. The host and port from LAGO_REDIS_CACHE_URL are ignored because Sentinel provides the active master address.

Best practices

Bring your own Redis in production. The bundled redis service in docker-compose.yml is intended for local trials. For production, run a managed or dedicated Redis (or multiple Redis instance fronted by Sentinel) and point Lago at it.
Use separate Redis instances for the cache and the queue in production. This prevents a surge in one workload (e.g., heavy Sidekiq activity) from impacting the other (e.g., API cache performance). It also allows you to properly configure each Redis instance according to its needs (memory, eviction policy, etc.).
Use managed instances or Redis Sentinel for HA. A single Redis master is a single point of failure. For production loads with availability requirements, use Sentinel or a managed Redis service that provides equivalent automatic failover.
Encrypt connections. Use the rediss:// scheme in REDIS_URL / LAGO_REDIS_CACHE_URL to enable TLS to your Redis nodes.

Enabling SSL on the Frontend

Lago Front application can be configured to support SSL certificates. You have two options to achieve this:

by using a self-signed certificate
by using a signed certificate generated by Let’s Encrypt

Self Signed Certificate

Run the script to generate the certificates

# Be sure to be in your lago folder
./extra/init-selfsigned.sh

# This should create certificates in the ./extra/ssl/ folder

Take a look at the docker-compose.yml file and uncomment the part related to the Self-Signed certificate

volumes:
  - ./extra/nginx-selfsigned.conf:/etc/nginx/conf.d/default.conf
  - ./extra/ssl/nginx-selfsigned.crt:/etc/ssl/certs/nginx-selfsigned.crt
  - ./extra/ssl/nginx-selfsigned.key:/etc/ssl/private/nginx-selfsigned.key
  - ./extra/ssl/dhparam.pem:/etc/ssl/certs/dhparam.pem

You can now start the front application with a self signed SSL certificate support

docker-compose up front

Let’s Encrypt Certificate

Edit the file extra/init-letsencrypt.sh
- You must replace lago.example with your domain name
- You must enter a valid email address
Edit the file extra/nginx-letsencrypt.conf
- You must replace lago.example with your domain name
Uncomment the Cerbot lines in the docker-compose.yml file
Run the following script

# Be sure to be in your lago folder
./extra/init-letsencrypt.sh

# You will be asked to provide some information
# After that you should be able to see the extra/certbot folder

Take a look at the docker-compose.yml file and uncomment all the parts related to the Let’s Encrypt’s support

command:
  '/bin/sh -c ''while :; do sleep 6h & wait $${!}; nginx -s reload; done & nginx
  -g "daemon off;"'''
---
volumes:
  - ./extra/nginx-letsencrypt.conf:/etc/nginx/conf.d/default.conf
  - ./extra/certbot/conf:/etc/letsencrypt
  - ./extra/certbot/www:/var/www/certbot

You can now start the front application with the signed certificate support

docker-compose up front

Storage

By default, Lago uses the internal storage of the container. You can customize it by defining different environment variables. We currently support :

AWS S3
AWS S3 Compatibles Endpoints
Google Cloud Service Cloud Storage

If you use S3 compatibles endpoints, you should set the LAGO_AWS_S3_REGION to a default value (e.g., us-east-1), it is required to work properly!

AWS S3

You have to set these variables to use AWS S3.

Name	Description
`LAGO_USE_AWS_S3`	Set to “true” if you want to use AWS S3
`LAGO_AWS_S3_ACCESS_KEY_ID`	AWS S3 Credentials Access Key Id
`LAGO_AWS_S3_SECRET_ACCESS_KEY`	AWS S3 Credentials Secret Access Key
`LAGO_AWS_S3_REGION`	AWS S3 Region
`LAGO_AWS_S3_BUCKET`	AWS S3 Bucket

AWS S3 Compatible Endpoints

You have to set these variables to use AWS S3 Compatible Endpoints.

Name	Description
`LAGO_USE_AWS_S3`	Set to “true” if you want to use AWS S3 Compatible Endpoints
`LAGO_AWS_S3_ENDPOINT`	AWS S3 Compatible Endpoint
`LAGO_AWS_S3_ACCESS_KEY_ID`	AWS S3 Credentials Access Key Id
`LAGO_AWS_S3_SECRET_ACCESS_KEY`	AWS S3 Credentials Secret Access Key
`LAGO_AWS_S3_BUCKET`	AWS S3 Bucket
`LAGO_AWS_S3_REGION`	Not used but required by the AWS SDK

Google Cloud Service Cloud Storage

You have to set those variables to use GCS Cloud Storage.

Name	Description
`LAGO_USE_GCS`	Set to “true” if you want to use GCS Cloud Storage
`LAGO_GCS_PROJECT`	GCS Project name
`LAGO_GCS_BUCKET`	GCS Bucket name
`LAGO_GCS_CREDENTIALS`	GCS Credentials JSON file path
`LAGO_GCS_IAM`	GCS IAM Authentication
`LAGO_GCS_GSA_EMAIL`	GCS GSA Email

In the docker-compose.yml file, you must uncomment the lines and pass the correct GCS credentials json file.

# Example using GCS Credentials File
api:
  volumes:
    - gcs_keyfile.json:/app/gcs_keyfile.json

api-worker:
  volumes:
    - gcs_keyfile.json:/app/gcs_keyfile.json

SMTP Configuration

In order to use the email feature, you need to configure some environment variables.

In addition to this configuration, defining an organization email in Settings > Organization is mandatory; without it, emails will not be sent.

Name	Description
`LAGO_FROM_EMAIL`	Required to send emails (i.e: noreply@getlago.com)
`LAGO_SMTP_ADDRESS`	Address of the SMTP server
`LAGO_SMTP_PORT`	Port of the SMTP Server
`LAGO_SMTP_USERNAME`	Username of the SMTP Server
`LAGO_SMTP_PASSWORD`	Password of the SMTP Server

Single Sign On using Google authentication

In order to enable Google authentication for single sign on, you have to set those variables.

Name	Description
`GOOGLE_AUTH_CLIENT_ID`	Client ID for Google auth Single Sign On
`GOOGLE_AUTH_CLIENT_SECRET`	Client Secret for Google auth Single Sign On

Documentation Index

​Requirements

​Run the Lago App

​Run the app with a one-click Docker command

​Run the app with advanced Docker commands

​Signing up

​Find your API Key

​Configuration

​Version

​Environment variables

​Components

​Configuring the database

​Connection

DATABASE_URL

When using the Docker Compose

​Schema

​Connection pool

​Statement-level safeguards

​Enabling SSL

Using libpq environment variables

Using DATABASE_URL

​Best practices

​Configuring Redis

​Sidekiq Redis (job queue)

REDIS_URL

​Cache Redis (application cache)

LAGO_REDIS_CACHE_URL

​Authentication

Sidekiq Redis (job queue)

Cache Redis (application cache)

​Enabling SSL on Redis

​Managed Redis services

​High availability with Redis Sentinel

Sidekiq Sentinel configuration

Cache Sentinel configuration

​Best practices

​Enabling SSL on the Frontend

​Self Signed Certificate

​Let’s Encrypt Certificate

​Storage

​AWS S3

​AWS S3 Compatible Endpoints

​Google Cloud Service Cloud Storage

​SMTP Configuration

​Single Sign On using Google authentication

Requirements

Run the Lago App

Run the app with a one-click Docker command

Run the app with advanced Docker commands

Signing up

Find your API Key

Configuration

Version

Environment variables

Components

Configuring the database

Connection

`DATABASE_URL`

Schema

Connection pool

Statement-level safeguards

Enabling SSL

Best practices

Configuring Redis

Sidekiq Redis (job queue)

`REDIS_URL`

Cache Redis (application cache)

`LAGO_REDIS_CACHE_URL`

Authentication

Enabling SSL on Redis

Managed Redis services

High availability with Redis Sentinel

Best practices

Enabling SSL on the Frontend

Self Signed Certificate

Let’s Encrypt Certificate

Storage

AWS S3

AWS S3 Compatible Endpoints

Google Cloud Service Cloud Storage

SMTP Configuration

Single Sign On using Google authentication