This guide covers the deployment of the full Proxus stack (UI, Server, Database, NATS) on a single machine using Docker Compose.
Prerequisites- Docker Engine (20.10+)
- Docker Compose (v2.0+)
- 4GB RAM (Minimum) / 8GB RAM (Recommended)
Download Configuration
You need the docker-compose.yml and the default configuration files. Run this command to download everything to your current directory.
Linux / macOS:
BASE_URL="https://raw.githubusercontent.com/proxusiiotplatform/docs/main/"
CONFIGS_DIR="Configs"
# Download Compose File
wget -O docker-compose.yml "${BASE_URL}docker-compose.yml"
# Download Configs
mkdir -p "${CONFIGS_DIR}"
for file in dashboard.yml datasource.yml dotnet-otel-dashboard.json \
jaeger-ui.json logs-dashboard.json loki.yml \
otel-collector-config.yml prometheus.yml grafana.ini \
accounts.conf hub.conf; do
wget -O "${CONFIGS_DIR}/${file}" "${BASE_URL}Configs/${file}"
doneWindows (PowerShell):
$b = "https://raw.githubusercontent.com/proxusiiotplatform/docs/main/"
$c = "Configs"
Invoke-WebRequest "${b}docker-compose.yml" -OutFile "docker-compose.yml"
New-Item -ItemType Directory -Force -Path $c
"dashboard.yml datasource.yml dotnet-otel-dashboard.json jaeger-ui.json logs-dashboard.json loki.yml otel-collector-config.yml prometheus.yml grafana.ini accounts.conf hub.conf".Split() | ForEach-Object {
Invoke-WebRequest "${b}Configs/{_}" -OutFile "${c}/{_}"
}Verify File Structure
After downloading, your directory should look like this:
- draft docker-compose.yml
- folder Configs
- draft prometheus.yml
- draft grafana.ini
- draft loki.yml
- draft ...
-
Start Services
Run the following command to start the stack in detached mode.
docker-compose -p "proxus" up -dIf you are using Docker Desktop on Windows, ensure you are running PowerShell as Administrator.
Access the Platform
Once the containers are healthy (usually takes 30-60 seconds), access the UI:
- URL:
http://localhost:8080 - Username:
Admin - Password: (Leave empty for first login)
Post-Installation
Updating the Platform
To update to the latest version, pull the new images and restart. Data in volumes will be preserved.
docker compose -p "proxus" pull
docker compose -p "proxus" up -dModifying Configuration
The main configuration file Proxus-config.toml is stored in a Docker volume. To edit it:
VOLUME_PATH=$(docker volume inspect proxus_config --format '{{ .Mountpoint }}')
CONFIG_FILE="${VOLUME_PATH}/Proxus-config.toml"
nano "${CONFIG_FILE}"After editing, restart the services:
docker restart proxus-server proxus-uiTroubleshooting
If you cannot access the UI, check the logs:
docker logs proxus-ui
docker logs proxus-server