Getting started
Prepare your server
Check the operating system, access, network and storage before installation.
Supported environment
| Item | Requirement |
|---|---|
| Operating system | Ubuntu 22.04 or 24.04 |
| Architecture | x86_64 / amd64 |
| Access | root shell |
| Runtime | Docker Engine and Compose v2; missing packages can be installed by the installer |
| Network | Outbound HTTPS for installation, downloads and required external services |
| Public access | HTTP/HTTPS for tracking; SSH restricted to your administration needs |
Use a dedicated server. Existing applications, port assignments, Docker networks or a non-empty installation directory can conflict with installation. Take a recoverable backup before changing a server with existing data.
Inspect the host
Run these read-only checks:
cat /etc/os-release
uname -m
nproc
free -h
df -h
ss -lnt
Check both available disk space and the filesystem where persistent data will live. Images, datasets, logs, database growth and backups all consume storage. Choose capacity based on your traffic and retention policy; monitor actual usage after launch.
DNS and firewall
Keep administrative SSH access working while adjusting firewall rules. Point tracking DNS records to the server's public address. Remove stale IPv6 records if the server does not serve that address. Permit the HTTP/TLS path used for your domains.
Before proceeding
Confirm the OS and architecture match, root access works, outbound downloads are reachable and the server is not hosting workloads you would disrupt. Continue with SSH access.