7f6bf1390a
- Introduced .dockerignore to exclude unnecessary files from Docker context. - Added .env.aio.example for minimal configuration of the AdventureLog All-in-One setup. - Updated .env.example to include optional SITE_URL and GUNICORN_WORKERS settings. - Enhanced deploy.sh script for improved deployment flexibility and backup options. - Updated docker-compose files to use PostGIS 16-3.5 and added health checks for services. - Created docker-compose.aio.yml for All-in-One deployment configuration. - Improved health checks and service dependencies in docker-compose.dev.yml and docker-compose.yml. - Added GitHub workflows for building and pushing Docker images, including smoke tests for AIO setup.
7.2 KiB
Docker 🐋
Docker is the preferred way to run AdventureLog on your local machine. It is a lightweight containerization technology that allows you to run applications in isolated environments called containers.
Looking for the simplest setup? See the All-in-One (AIO) guide — one container, one port, two environment variables.
Note
: This guide mainly focuses on installation with a Linux-based host machine, but the steps are similar for other operating systems.
Prerequisites
- Docker installed on your machine/server. You can learn how to download it here.
- Memory: allocate at least 2 GB RAM for the first boot (world geography data import). Steady-state use typically needs about 1 GB. Optional limits are documented in
docker-compose.override.example.yml.
Getting Started
Get the docker-compose.yml and .env.example files from the AdventureLog repository. You can download them here:
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-compose.yml
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/.env.example
cp .env.example .env
::: tip
If running on an ARM based machine, you will need to use a different PostGIS image. It is recommended to use the imresamu/postgis:16-3.5-alpine image or a custom version found here. The AdventureLog containers are ARM compatible.
:::
URL mental model
AdventureLog uses several URL-related environment variables. Most installs only need to set the public-facing URLs; keep PUBLIC_SERVER_URL at its default.
| Variable | Who uses it | Typical value |
|---|---|---|
PUBLIC_SERVER_URL |
SvelteKit SSR (container-to-container) | http://server:8000 — do not change for standard Docker installs |
ORIGIN |
SvelteKit origin when not using HTTPS | Your frontend URL, e.g. http://localhost:8015 |
PUBLIC_URL |
Django image and OAuth URLs | Your backend URL, e.g. http://localhost:8016 (or your single domain if using a reverse proxy) |
FRONTEND_URL |
Django emails and redirects | Your frontend URL, e.g. http://localhost:8015 |
CSRF_TRUSTED_ORIGINS |
Django CORS and CSRF | Comma-separated list of every browser origin, e.g. http://localhost:8015,http://localhost:8016 |
When frontend and backend share one domain behind a reverse proxy, you can set SITE_URL instead of configuring ORIGIN, FRONTEND_URL, PUBLIC_URL, and CSRF_TRUSTED_ORIGINS individually. See .env.example for details.
To validate your configuration, run:
bash scripts/validate-env.sh
Configuration
The .env file contains all the configuration settings for your AdventureLog instance. Here’s a breakdown of each section:
🌐 Frontend (web)
| Name | Required | Description | Default Value |
|---|---|---|---|
PUBLIC_SERVER_URL |
Yes | Used by the frontend SSR server to connect to the backend. Almost every user user will never have to change this from default! | http://server:8000 |
ORIGIN |
Sometimes | Needed only if not using HTTPS. Set it to the domain or IP you'll use to access the frontend. | http://localhost:8015 |
BODY_SIZE_LIMIT |
Yes | Maximum upload size in bytes. | Infinity |
FRONTEND_PORT |
Yes | Port that the frontend will run on inside Docker. | 8015 |
🐘 PostgreSQL Database
| Name | Required | Description | Default Value |
|---|---|---|---|
PGHOST |
Yes | Internal DB hostname. | db |
POSTGRES_DB |
Yes | DB name. | database |
POSTGRES_USER |
Yes | DB user. | adventure |
POSTGRES_PASSWORD |
Yes | DB password. | changeme123 |
🔒 Backend (server)
| Name | Required | Description | Default Value |
|---|---|---|---|
SECRET_KEY |
Yes | Django secret key. Change this in production! | changeme123 |
DJANGO_ADMIN_USERNAME |
Yes | Default Django admin username. | admin |
DJANGO_ADMIN_PASSWORD |
Yes | Default Django admin password. | admin |
DJANGO_ADMIN_EMAIL |
Yes | Default admin email. | admin@example.com |
PUBLIC_URL |
Yes | Publicly accessible URL of the backend. Used for generating image URLs. | http://localhost:8016 |
CSRF_TRUSTED_ORIGINS |
Yes | Comma-separated list of frontend/backend URLs that are allowed to submit requests. | http://localhost:8016,http://localhost:8015 |
FRONTEND_URL |
Yes | URL to the frontend, used for email generation. | http://localhost:8015 |
BACKEND_PORT |
Yes | Port that the backend will run on inside Docker. | 8016 |
DEBUG |
No | Should be False in production. |
False |
ENABLE_RATE_LIMITS |
No | Enable rate limits on the backend. Should be True in production. |
False |
Optional Configuration
Running the Containers
Once you've configured .env, you can start AdventureLog with:
docker compose up -d
Enjoy using AdventureLog! 🎉