🛠️ Installation

This guide will get OpenLabs running on your local machine using Docker.

important

You must have Git and Docker Desktop (or Docker with Compose) installed.

📦 Step 1: Clone the Repository

Open your terminal and run the following command to clone the repository onto your machine.

git clone https://github.com/OpenLabsHQ/OpenLabs

Navigate into the new directory. OpenLabs requires a .env file for configuration.

cd OpenLabs/
cp .env.example .env

# Set credentials
nano .env

Run Docker Compose to build and start all the OpenLabs services.

docker compose --profile frontend up -d

note

The first launch may take several minutes to download the required images. Subsequent launches will be significantly faster.

Visit: http://localhost:3000. You should see the OpenLabs homepage.

Congratulations, OpenLabs is now running!

Now you're ready to deploy your first lab. Head back to the Deploy Your First Range to continue.