Deploy with Docker

danger

Astuto is still in early development, so these information may become outdated quickly and without notice. If you encounter any problems during installation, open an issue on GitHub.

0. Requirements

• Docker
• Docker Compose

1. Create a Docker Compose file

Create an empty folder and, inside that folder, create a file named docker-compose.yml with the following content:

docker-compose.yml

version: '3.4'
services:
  db:
    image: postgres:14.5
    environment:
      POSTGRES_USER: yourpostgresusername
      POSTGRES_PASSWORD: yourpostgrespassword
    volumes:
      - dbdata:/var/lib/postgresql/data
  web:
    image: riggraz/astuto:latest
    environment:
      POSTGRES_USER: yourpostgresusername
      POSTGRES_PASSWORD: yourpostgrespassword
      BASE_URL: http://yourwebsite.com
      SECRET_KEY_BASE: yoursecretkeybase
    ports:
      - "3000:3000"
    depends_on:
      - db
    
volumes:
  dbdata:

As it can be seen from the docker compose file, Astuto consists of two services: web, which contains the web application, and db, which contains a Postgres instance.

2. Edit the environment variables in the Docker Compose file

In docker-compose.yml, set the following environment variables to suit your needs:

Environment variable	Description
POSTGRES_USER	Username for the Postgres database
POSTGRES_PASSWORD	Password for the Postgres database
BASE_URL	The base URL from where the website will be served
SECRET_KEY_BASE	A secure 64 characters secret (you can generate one from this site)
EMAIL_DELIVERY_METHOD	Possible values: "smtp". If you don't want to configure an email delivery method, don't define this variable.
EMAIL_SMTP_HOST	Hostname of your SMTP server
EMAIL_SMTP_PORT	Port of your SMTP server (optional, defaults to: 25)
EMAIL_SMTP_USER	Username for your SMTP server
EMAIL_SMTP_PASS	Password for your SMTP server
EMAIL_SMTP_HELO_DOMAIN	HELO domain (optional, defaults to: nil)
EMAIL_SMTP_AUTH	SMTP server authentication type (optional, defaults to: plain)
EMAIL_SMTP_TLS	Enables the SMTP connection to use SMTP/TLS (optional, defaults to: nil)
EMAIL_SMTP_OPENSSL_VERIFY_MODE	Set how OpenSSL checks the certificate when using TLS (optional, defaults to: nil)
EMAIL_SMTP_STARTTLS_AUTO	Detects if STARTTLS is enabled in your SMTP server and starts to use it (optional, defaults to: true)

caution

Remember to set POSTGRES_USER and POSTGRES_PASSWORD in both services (web and db)!

3. Run

Run the following command:

docker compose pull && docker compose up

You should now have a running instance of Astuto on port 3000. A default user account has been created with credentials email: admin@example.com, password: password.

Permission denied on Linux

If you are on Linux and you encounter permission denied errors when running Docker commands, try to run them as administrator.