Docker

​

Requirements

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

​

Run the app

To start using Lago, run the following commands in a shell:

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

# Go to Lago folder
cd lago

# Set up environment configuration
echo "LAGO_RSA_PRIVATE_KEY=\"`openssl genrsa 2048 | base64`\"" >> .env
source .env

# Start the api
docker compose up -d api

# Create the database
docker compose exec api rails db:create
docker compose exec api rails db:migrate

# Start all other 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.

1. Write down your organization name;
2. Use the main billing email of your company; and
3. 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:

1. Access the Developer section from the sidebar;
2. The first tab of this section is related to your API keys; and
3. 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.

• 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.

​

Components

Lago uses the following containers:

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

​

SSL Support

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

​

AWS S3

You have to set these variables to use AWS S3.

​

AWS S3 Compatible Endpoints

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

​

Google Cloud Service Cloud Storage

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

In the docker-compose.yml file, you must uncomment the lines and pass the correct GCS credentials json 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.

​

Single Sign On using Google authentication

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