open-dpp Documentation

Getting started ​

This guide describes a basic self-hosted setup of open-dpp.

Prerequisites ​

  • Docker + Docker Compose
  • openssl (for generating secrets)

Quick setup ​

The setup script downloads the deployment files, generates a local auth secret, and starts the stack:

bash
curl -fsSL https://install.open-dpp.de | bash

In a cloned repository, run ./scripts/setup.sh instead.

If you prefer to prepare everything yourself, follow the manual setup below instead.

Manual setup ​

For deployment, you need docker-compose.yml and a .env file. You can download the files manually from the repository or fetch them with curl:

bash
curl -fsSL -o docker-compose.yml https://raw.githubusercontent.com/open-dpp/open-dpp/main/docker-compose.yml
curl -fsSL -o .env https://raw.githubusercontent.com/open-dpp/open-dpp/main/.env.example

Before starting the services, update .env with values that match your environment — at minimum, set OPEN_DPP_AUTH_SECRET to a secure value. For a complete list of settings, see configuration options. This example stack does not virus-scan uploads; see the Production setup guide to add ClamAV.

Start services ​

Once everything is configured, start the services:

bash
docker compose up -d

To verify startup, check the container status and logs:

bash
docker compose ps
docker compose logs -f

Explore the features ​

After startup, open OPEN_DPP_URL in your browser and explore the platform (http://localhost:3000 by default). If your setup uses a custom port, include it in the URL. The docker compose project also includes a mailpit instance on http://localhost:8025 which allows you to receive emails from your open-dpp instance.

For more details, see configuration options and the guides.

WARNING

The Docker Compose configuration used in this guide is intended for local evaluation only and is not suitable for production use. For guidance on setting up a production environment, see the Production setup guide.