Download

Install Promulga on Windows, macOS or Linux

Promulga runs as a few Docker containers on any computer or server. A laptop is enough to evaluate it; a small virtual machine (2 vCPU, 4 GB) is enough for production.

Promulga 0.2

The Docker Compose package (docker-compose.yml, configuration template, setup and check scripts, documentation). The application image is downloaded by Docker from the GitHub Container Registry.

Download promulga-docker.zip All releases

Docker image: ghcr.io/olivierbouchezdatagovernance/promulga:latest (linux/amd64, linux/arm64). Source code: GitHub.

Requirements

Docker with the Compose plugin (Docker Desktop, Docker Engine, OrbStack...)
2 GB of free RAM (4 GB with the online editor), 2 GB of disk + your documents
A modern browser (Edge, Chrome, Firefox, Safari)
For a server: ports 80 and 443 and a DNS name, for automatic HTTPS
Optional: an SMTP account for e-mails (otherwise they stay in the Outbox)

Step by step

Installation

Windows 10 / 11 (WSL 2)

Install WSL 2 and Ubuntu: open PowerShell as administrator, run the command below, restart the computer, then open the new Ubuntu app and create your Linux user.
```
wsl --install -d Ubuntu-24.04
```
Install Docker: either Docker Desktop for Windows with Settings > Resources > WSL integration enabled for Ubuntu (free for personal use, education and small companies; a paid subscription is required in larger companies, see Docker's terms), or Docker Engine directly inside Ubuntu (free):
```
curl -fsSL https://get.docker.com | sudo sh && sudo usermod -aG docker $USER
```
Close and reopen the Ubuntu window, then run the next steps in Ubuntu.

Download and unpack Promulga (Docker Compose package: application, PDF converter, HTTPS proxy, optional online editor):

curl -L -o promulga.zip https://github.com/OlivierBouchezDataGovernance/promulga/releases/latest/download/promulga-docker.zip
unzip promulga.zip -d promulga && cd promulga

Prepare the configuration: setup.sh creates .env and the secrets/ folder with private permissions.
```
./deploy/setup.sh && nano .env
```
For a test on this computer, set:
```
SITE_DOMAIN=:80
BASE_URL=http://localhost
SECURE_COOKIES=false
ADMIN_EMAIL=you@example.org
```
Start (add --profile editor for the online editor, about 2 GB of RAM more):
```
docker compose pull && docker compose up -d
```
Choose your administrator password with the one-time link printed in the logs, then open http://localhost:
```
docker compose logs app | grep set-password
```
Optional: demo content (taxonomies, example users, documents in every stage):
```
docker compose exec app promulga demo-data
```

macOS (Apple silicon or Intel)

Install Docker Desktop for Mac from docker.com, choosing Apple silicon or Intel, and start it once. (Docker Desktop is free for personal use, education and small companies; check Docker's terms for larger companies. OrbStack and Colima are alternatives.) Promulga images are built for both Apple silicon (arm64) and Intel (amd64).
Open the Terminal app and run the next steps.

Download and unpack Promulga (Docker Compose package: application, PDF converter, HTTPS proxy, optional online editor):

curl -L -o promulga.zip https://github.com/OlivierBouchezDataGovernance/promulga/releases/latest/download/promulga-docker.zip
unzip promulga.zip -d promulga && cd promulga

Prepare the configuration: setup.sh creates .env and the secrets/ folder with private permissions.
```
./deploy/setup.sh && nano .env
```
For a test on this computer, set:
```
SITE_DOMAIN=:80
BASE_URL=http://localhost
SECURE_COOKIES=false
ADMIN_EMAIL=you@example.org
```
Start (add --profile editor for the online editor, about 2 GB of RAM more):
```
docker compose pull && docker compose up -d
```
Choose your administrator password with the one-time link printed in the logs, then open http://localhost:
```
docker compose logs app | grep set-password
```
Optional: demo content (taxonomies, example users, documents in every stage):
```
docker compose exec app promulga demo-data
```

Linux (desktop or server)

Install Docker Engine and the Compose plugin (Ubuntu, Debian, Fedora, RHEL...):
```
curl -fsSL https://get.docker.com | sudo sh && sudo usermod -aG docker $USER
```
Log out and in again, then check docker compose version.
For a server reachable from the internet, point a DNS name to it, set SITE_DOMAIN and BASE_URL=https://... in step 4: Caddy obtains the HTTPS certificate automatically. See the administrator guide.

Download and unpack Promulga (Docker Compose package: application, PDF converter, HTTPS proxy, optional online editor):

curl -L -o promulga.zip https://github.com/OlivierBouchezDataGovernance/promulga/releases/latest/download/promulga-docker.zip
unzip promulga.zip -d promulga && cd promulga

Prepare the configuration: setup.sh creates .env and the secrets/ folder with private permissions.
```
./deploy/setup.sh && nano .env
```
For a test on this computer, set:
```
SITE_DOMAIN=:80
BASE_URL=http://localhost
SECURE_COOKIES=false
ADMIN_EMAIL=you@example.org
```
Start (add --profile editor for the online editor, about 2 GB of RAM more):
```
docker compose pull && docker compose up -d
```
Choose your administrator password with the one-time link printed in the logs, then open http://localhost:
```
docker compose logs app | grep set-password
```
Optional: demo content (taxonomies, example users, documents in every stage):
```
docker compose exec app promulga demo-data
```

Promulga is provided as is, without warranty. You run and secure your own installation: back it up (promulga backup) and keep it updated. Professional installation and training are available on request: sales@promulga.com.

Update

docker compose exec app promulga backup, then docker compose pull && docker compose up -d. The database is migrated automatically.

Put it online

A cloud VM (Google Cloud, Azure, AWS, OVH, Hetzner...) with a DNS name: the administrator guide walks you through it.

First steps

Colours and logo, deadlines, tags, users, first document: see the first steps and the user guide.