Skip to content

Docker quickstart

Run an isolated ReportHub instance on your own server with Docker Compose. Choose Community for public reporting or Safety / VZD for internal hazards and corrective actions. Each installation runs one module.

Prefer managed hosting? Contact CELEON to arrange an installation and operational scope.

Already have access to an application? Start with the user guides for Community and Safety / VZD.

Use a Linux server with Docker Engine, the Docker Compose plugin, curl and OpenSSL. You also need a hostname pointing to the server and inbound ports 80 and 443 available for Caddy’s HTTPS setup. Use a separate directory and hostname for each installation.

These commands are for a new installation. Keep the initial setup private until you create the administrator account, for example through a temporary firewall restriction to your IP address.

Terminal window
mkdir reporthub
cd reporthub
curl --fail --location \
--output docker-compose.yml \
https://reporthub.celeon.si/downloads/reporthub/docker-compose.yml
curl --fail --location \
--output Caddyfile \
https://reporthub.celeon.si/downloads/reporthub/Caddyfile.txt
curl --fail --location \
--output .env \
https://reporthub.celeon.si/downloads/reporthub/env.example

docker-compose.yml · Caddyfile · .env

The files use the published ghcr.io/cuaupro/reporthub image; you do not need the source repository or a local Node.js installation. They include Caddy, ReportHub and PostgreSQL/PostGIS. Caddy is the only public entry point; the application and database stay on the internal Compose network.

Edit .env in your text editor. Replace the example hostname and email, and fill both empty secrets:

Setting What to enter
APP_HOST Your instance’s hostname, such as reports.example.org, without https:// or a path. Its DNS must point to this server.
CADDY_EMAIL An email address you monitor, used for HTTPS certificate operations.
POSTGRES_PASSWORD A new strong database password.
ANALYTICS_HASH_SECRET A separate random secret used to pseudonymize consent-based application analytics. Keep it stable across restarts. This does not enable website analytics.
TZ An IANA time zone; the template uses Europe/Ljubljana.
REPORTHUB_TAG The application image tag. The template uses latest; pin a tested release tag for a controlled production rollout.

Generate a value with the following command, then run it again for the second secret. Paste the two different outputs into .env:

Terminal window
openssl rand -hex 32

Keep .env private and outside source control. On Linux, restrict its permissions:

Terminal window
chmod 600 .env

The default file storage is local, in a persistent Docker volume with public and private directories. SMTP and S3-compatible storage are optional. Email confirmation, invitations and email notifications need a working SMTP configuration; email delivery is disabled by default. See the environment reference for every supported setting, mail and S3 examples, and how to apply changes.

From the directory containing the three downloaded files:

Terminal window
docker compose config --quiet
docker compose pull
docker compose up -d
docker compose ps

Compose creates persistent database, upload and Caddy volumes. The application applies its migrations on startup. Wait for the services to become healthy, then open https:// followed by your APP_HOST in a browser. Caddy obtains the HTTPS certificate automatically when DNS and network access are correct.

If startup fails, inspect the application logs:

Terminal window
docker compose logs --tail 100 reporthub

Check the hostname, port availability, DNS and the required .env values. Never use docker compose down -v as a troubleshooting step: it removes the persistent volumes and their data.

  1. On the first visit, choose Community or Safety / VZD.
  2. Create your initial administrator account. The module selection is saved with this account and cannot be changed later in that installation.
  3. Select Start evaluation in Installation / license. The full-featured 30-day evaluation does not require importing a licence file.
  4. For a populated test environment, return to Installation / license (/installation) and choose Prepare demo installation before entering your own configuration or reports. It completes setup and creates synthetic users, locations and reports. Your administrator account is preserved and outgoing email is disabled. Demo accounts use the password shown by the application; keep the demo instance restricted to evaluation users.
  5. Alternatively, complete setup with your own organizations, categories, responsibilities and privacy information.

The evaluation begins when you start it, not when you download or start the containers. Demo preparation starts an unused evaluation automatically. After expiry, reads and exports remain available while submissions and changes stop. You can import a matching commercial licence during or after evaluation. Production use requires a commercial agreement or written approval.

Continue with first steps in the application.

You are responsible for server security, updates, monitoring, database and upload backups, and restore testing unless a service agreement assigns them differently. Back up the database and file storage together; a database backup alone does not include report photos, plans or evidence.

For a temporary pause that keeps the data:

Terminal window
docker compose stop

Start the same installation again with docker compose up -d from the same directory. Keep the same Compose project name and .env; do not replace the database password on an existing initialized volume without a coordinated database change.