Installation

This guide explains how to install and run WrightTest from the official GitHub repository.

WrightTest is a source-available self-hosted application for recording, running, scheduling, and debugging Playwright-based browser checks.

Docker-first installation

Use this path if you want to start WrightTest locally without setting up the application code on the host.


git clone https://github.com/AlexFilippov-it/wrighttest.git
cd wrighttest

Create a local environment file from the example file:


cp .env.example .env


docker compose up --build

If you want to run it in the background:


docker compose up --build -d

In most local setups, open:


http://localhost:5173

The backend exposes health endpoints that can help confirm the API and database are working.


curl http://localhost:3000/health
curl http://localhost:3000/health/db

If your backend is exposed on a different port, use that port instead.

The Docker Compose setup uses these services:

In the current Docker Compose setup, queue worker and scheduler logic run inside the backend process. There is no separate worker container.

Use this path if you are developing WrightTest itself outside the Docker-first flow.


pnpm install
pnpm dev

If you also need the Docker stack for backend, database, or Redis:


docker compose up --build

In the Docker-first setup, Chromium is installed inside the backend image. You normally do not need to install Playwright browsers on the host.

Only use pnpm exec playwright install if you are running Playwright directly on the host during local development.

After opening the application, check that you can:

A basic first check can use:


BASE_URL=https://playwright.dev

Then create a check with:


Start URL: {{BASE_URL}}

To stop the running containers:


docker compose down

To stop and remove volumes, use this carefully:


docker compose down -v

Removing volumes may delete local database data.

After installation, continue with Quick start.