Knowledge base / Getting started
Overview and requirements
How Kontris is built and what the server needs.
Architecture
Kontris consists of two containers:
- contracthub serves the web interface and the API. The container runs without root privileges and listens on port 3000.
- contracthub-db is a PostgreSQL 16 database. It holds all data, the sessions, the background jobs and the search index.
Documents are kept in a folder on the server or in object storage (S3, Azure). No further services such as Redis or a separate search server are needed.
A reverse proxy that provides HTTPS normally sits in front of Kontris. Without a proxy Kontris can serve HTTPS itself, see HTTPS and reverse proxy.
Requirements
| What | Requirement |
|---|---|
| Operating system | Linux, for example Debian, Ubuntu or RHEL |
| Containers | Docker with the Compose plugin, or Podman 4.4 or newer with podman-compose |
| Resources | 2 CPU cores, 4 GB RAM, 20 GB for images, plus space for documents and backups |
| Address | A DNS name for the application, for example contracthub.example.com |
| Certificate | TLS certificate for that name |
| Sign-in | Local accounts work right away. For single sign-on Microsoft Entra ID or Authentik |
| An SMTP server for reminders and invitations (optional, but recommended) |
Network
Inbound, Kontris only needs HTTPS (port 443) for the users. Outbound depends on what you use:
| Destination | What for |
|---|---|
| SMTP server | Reminders, invitations, reports |
login.microsoftonline.com:443 |
Sign-in via Entra ID |
graph.microsoft.com:443 |
Only for the Copilot connector and the check for disabled Entra accounts |
| Address of Authentik or i-doit | Only when connected |
The license is verified without internet access. Kontris sends no usage data.
Three secrets
During installation you generate three values. Keep them in your password manager:
- the database password,
SESSION_SECRETfor the sessions,SECRETS_ENCRYPTION_KEYfor encrypted content and backups.
Without
SECRETS_ENCRYPTION_KEYbackups cannot be restored. Keep the key separate from the backups.
Continue with the installation.
As of 2026-11-15 · Stuck? Write to us