On-Premise Deployment with Docker

This guide explains how to install and run Proxus on-premise with Docker. The installer generates the deployment files for your machine, asks for culture and timezone, and can start the platform immediately.

Prerequisites

Before proceeding, ensure your system meets the System Requirements.

You also need:

• Docker Engine or Docker Desktop: Install the version compatible with your operating system from the official Docker website.
• Docker Compose v2: Included with Docker Desktop on Windows/macOS. Linux users may need to install Docker Compose separately.
• A running Docker daemon: Start Docker Desktop or the Docker service before running the installer.

Installation

Run the installer for your operating system. It creates a proxus-platform directory, generates docker-compose.yml, writes the required local configuration files, and asks whether to start the platform.

curl -fsSL https://proxus.io/install.sh | bash

irm https://proxus.io/install.ps1 | iex

During installation you will be asked to confirm:

• Culture: Controls number and date formatting in the UI.
• Timezone: Controls container time and displayed timestamps.
• Start now: Choose Y to pull images and start services immediately, or n if you want to start later.

Start or Restart the Platform

If you skipped startup during installation, or want to start the stack later:

cd proxus-platform
docker compose up -d

To check container status:

docker compose ps

Health checks may need 1-2 minutes to turn green after the first start because Docker must pull the images and initialize the services.

Access the Interface

Once the containers are running, open:

• Username: Admin
• Password: (Leave blank)

Maintenance & Updates

Updating the Platform

From the generated deployment directory:

cd proxus-platform
docker compose pull
docker compose up -d

Modifying Configuration

To edit Proxus-config.toml inside the running Docker volume:

VOLUME_PATH=$(docker volume inspect proxus-platform_config --format '{{ .Mountpoint }}')
CONFIG_FILE="${VOLUME_PATH}/Proxus-config.toml"
nano "$CONFIG_FILE"

Copying Local Files to Containers

If you prefer to edit locally or need to add an external driver file:

docker cp Proxus-config.toml proxus-ui:/app/config/Proxus-config.toml
docker cp DriverFile.dll proxus-server:/app/DriverFile.dll

Backup & Restore

Stop Services

cd proxus-platform
docker compose down

Backup Script

This creates a compressed archive for each platform volume in a proxus_backup directory.

backup_dir="$(pwd)/proxus_backup"
mkdir -p "$backup_dir"

for volume in proxus-platform_proxus-db-volume proxus-platform_nats proxus-platform_config proxus-platform_proxus_modules proxus-platform_clickhouse_data; do
  echo "Backing up $volume..."
  docker run --rm \
    -v "$volume:/data" \
    -v "$backup_dir:/backup" \
    busybox tar czf "/backup/${volume}_backup.tar.gz" -C /data .
done

Restore Script

Restores archives from the proxus_backup directory back into Docker volumes.

backup_dir="$(pwd)/proxus_backup"

for backup_file in "${backup_dir}"/*_backup.tar.gz; do
  volume="$(basename "${backup_file}" _backup.tar.gz)"
  echo "Restoring ${volume}..."
  docker run --rm \
    -v "${volume}:/data" \
    -v "${backup_dir}:/backup" \
    busybox tar xzf "/backup/${volume}_backup.tar.gz" -C /data
done

Troubleshooting

If the UI or Server fails to start, check the logs:

cd proxus-platform
docker compose logs proxus-ui
docker compose logs proxus-server

If Docker is not installed, the daemon is not running, or Docker Compose v2 is missing, the installer stops with a visible error before writing the deployment files.