Skip to main content
Labshock✕
LoginStart Free

Install guide

Install Portal on macOS, Linux or Windows. Start, stop and update your installation.

Prepare Docker

Install Docker Desktop on macOS or Windows, or Docker Engine with the Compose plugin on Linux. On Windows, use Linux containers. Follow Docker’s requirements for your operating system.

Open a terminal and check that both the engine and Compose respond. If the client cannot reach the server, start Docker before continuing.

Check Docker
docker version
docker compose version

Leave enough memory and disk space for the lab you choose. Larger environments, security tools and multiple services need more resources than Portal alone.

Before installing

Use the commands for your system below. Each example creates a new labshock folder in your home directory, downloads the official Compose file and starts Portal. Keep this folder for Start, Stop and Update commands.

If you already have a Labshock installation, use its existing folder instead of downloading another Compose file. The standard installation publishes ports 443 and 80; check that they are available.

macOS

Start Docker Desktop and wait until the engine is ready. Open Terminal and run:

macOS · Terminal
cd ~
mkdir labshock
cd labshock
curl -fL https://raw.githubusercontent.com/zakharb/labshock/main/docker-compose.yml -o docker-compose.yml
docker compose pull
docker compose up -d

Linux

Install and start Docker Engine with the Compose plugin. Use an account configured to access Docker. Open your terminal and run:

Linux · shell
cd ~
mkdir labshock
cd labshock
curl -fL https://raw.githubusercontent.com/zakharb/labshock/main/docker-compose.yml -o docker-compose.yml
docker compose pull
docker compose up -d

Windows CMD

Start Docker Desktop in Linux container mode. Open Command Prompt and run:

Windows · Command Prompt
cd /d "%USERPROFILE%"
mkdir labshock
cd labshock
curl.exe -fL https://raw.githubusercontent.com/zakharb/labshock/main/docker-compose.yml -o docker-compose.yml
docker compose pull
docker compose up -d

Windows PowerShell

Start Docker Desktop in Linux container mode. Open PowerShell and run:

Windows · PowerShell
Set-Location $HOME
New-Item -ItemType Directory -Path labshock
Set-Location labshock
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/zakharb/labshock/main/docker-compose.yml" -OutFile "docker-compose.yml"
docker compose pull
docker compose up -d

Open Portal

On the same machine, open https://localhost. A fresh standard installation uses labshock as the local username and password. Use your configured credentials if they have already been changed.

The local installation creates its own TLS certificate. If you use a LAN name or address, the certificate must cover that address and be trusted by your browser.

Start

Open the existing installation folder. For the examples above, use the command for your terminal:

macOS / Linux
cd ~/labshock
Windows CMD
cd /d "%USERPROFILE%\labshock"
Windows PowerShell
Set-Location "$HOME\labshock"

Then start Portal. These Docker commands are the same in all four terminals:

Start and check status
docker compose up -d
docker compose ps

Open https://localhost on the Docker host. To restart the Portal service in the same installation:

Restart Portal
docker compose restart portal

Stop

Stop any running lab from Portal Control first. Then, from the Portal installation folder, run:

Stop Portal
docker compose stop

Stop keeps the installation data and volumes. Use docker compose up -d to return later. This command targets the Portal Compose project; lab services are managed separately from Control.

Update

For an installed Portal, use Update Portal and Update Launcher in Settings. Wait for each operation to complete, reload the page and check the version.

For a manual installation created with the current Compose file, finish and stop your labs first. From the existing Portal installation folder, download the current images and recreate the installation services. For an older or launcher-managed installation, use the Settings updater instead.

Manual Compose update
docker compose pull
docker compose up -d
docker compose ps

Keep the existing Compose file and volumes. Refresh Info in Settings updates account and content information; it does not update the Portal application.