Install Console Hub

Before you start

Use a supported Linux host with Docker Engine and Docker Compose v2.24.0 or newer. The guided installer requires sudo/root, curl, sha256sum and network access to download the installation bundle and container image.

• Choose a private IPv4 address reachable from your managed LAN or VPN.
• Replace every example IP below with the Docker host's actual private address.
• Use a dedicated installation directory. Do not point the installer at an unrelated Compose project.
• Check the published image architectures on Docker Hub before using a different platform.

Guided Linux installation

Download the script and verify its checksum before running it. You can inspect the downloaded script first. The interactive installer walks through the installation directory and connection settings.

curl -fsSLO https://consolehub.io/install/install.sh &&
curl -fsSLO https://consolehub.io/install/install.sh.sha256 &&
sha256sum -c install.sh.sha256

Run the verified script with the download address set as shown. This keeps its Compose and checksum downloads on consolehub.io; the installer creates the environment file from your answers.

sha256sum -c install.sh.sha256 &&
sudo env CONSOLEHUB_ASSET_BASE_URL=https://consolehub.io/install sh install.sh

The default installation directory is /opt/consolehub. Keep the persistent data volumes and installation configuration for continued use.

A quick Docker trial

This minimal command is for a non-production trial on a managed LAN/VPN. It does not include the production Compose configuration, resource limits or production update safeguards. Use the Compose path below for continued operation.

docker run -d --pull always --name consolehub-trial \
  -p 192.168.1.50:3000:3000 \
  -e ALLOWED_ORIGINS=http://192.168.1.50:3000 \
  --mount source=consolehub_trial_sqlite_data,target=/var/lib/consolehub/data \
  --mount source=consolehub_trial_vault_data,target=/var/lib/consolehub/vault \
  consolehub/consolehub:latest

Open http://192.168.1.50:3000 using your actual host address. Trial volumes are separate from the standard Compose volumes; moving to Compose does not automatically migrate their data.

Manual Docker Compose installation

Download the production Compose bundle into a new directory and verify its checksum before configuring your installation.

mkdir consolehub && cd consolehub &&
curl -fsSLO https://consolehub.io/install/docker-compose.prod.yml &&
curl -fsSLO https://consolehub.io/install/docker-compose.prod.yml.sha256 &&
sha256sum -c docker-compose.prod.yml.sha256 &&
curl -fsSLo .env https://consolehub.io/install/consolehub.env.example

Edit .env for your environment. The following example binds the published application port to one private IPv4 address. Do not leave a sample address unchanged.

ALLOWED_ORIGINS=http://192.168.1.50:3000
APP_BIND_ADDRESS=192.168.1.50
APP_PORT=3000

docker compose -f docker-compose.prod.yml config --quiet &&
docker compose -f docker-compose.prod.yml up -d --pull always --wait

The container uses separate persistent database and Vault volumes. Keep both together in your recovery plan. Do not use docker compose down -v unless you intentionally mean to remove the installation's stored data.

Make your first connection

1. Open your Console Hub address in a browser and complete the initial administrator setup.
2. Add one authorized test host and configure its SSH, SFTP, RDP or VNC profile.
3. Review the host identity where prompted, open its workspace and verify the destination.
4. Confirm backups and restrict network access before adding production hosts.

The Free plan allows one active user and five enabled hosts with no time limit.

Manage Docker on a saved host

Installing Console Hub in Docker and using Docker Manager are separate steps. Add a Linux host with a working SSH profile, verify the account's Docker permissions and then open the Docker workspace.