Skip to main content

🐳 Deploy with Docker

Want to avoid deployment and maintenance?

Try Astuto paid plan! You get a 7-day free trial without entering any payment method, then you pay as little as 15 €/month with annual subscription. Learn more or start your 7-day trial now.

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
services:
db:
image: postgres:14.5
environment: &db-env
POSTGRES_USER: yourpostgresusername
POSTGRES_PASSWORD: yourpostgrespassword
volumes:
- dbdata:/var/lib/postgresql/data
web:
image: riggraz/astuto:latest
environment:
<<: *db-env
BASE_URL: http://yourwebsite.com
SECRET_KEY_BASE: yoursecretkeybase
ports:
- "3000:3000"
depends_on:
- db

volumes:
dbdata:

2. Edit environment variables

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

Environment variableServiceDescription
POSTGRES_USERdbUsername for the Postgres database
POSTGRES_PASSWORDdbPassword for the Postgres database
BASE_URLwebThe base URL from where the website will be served
SECRET_KEY_BASEwebA secure 64 characters secret (you can generate one from this site)
EMAIL_DELIVERY_METHODwebPossible values: "smtp". If you don't want to configure an email delivery method, don't define this variable.
EMAIL_SMTP_HOSTwebHostname of your SMTP server
EMAIL_SMTP_PORTwebPort of your SMTP server (optional, defaults to: 25)
EMAIL_SMTP_USERwebUsername for your SMTP server (optional, don't define this variable if your SMTP server doesn't require authentication)
EMAIL_SMTP_PASSwebPassword for your SMTP server (optional, don't define this variable if your SMTP server doesn't require authentication)
other SMTP variables...A full list of environment variables for email configuration and other helpful tips can be found at this link
RAILS_LOG_TO_STDOUTwebWhether to log to stdout or not. Useful for debugging purposes. (optional, defaults to false in production)

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.