Skip to main content

​
Prerequisites

Before you begin, ensure you have the following installed on your server or local machine:

​
Installation Steps

1

Configure Environment Variables

To connect the worker to your dashboard, you need to provide the WORKER_API_KEY and DASHBOARD_URL.
First, create a worker in your dashboard to generate the WORKER_API_KEY. See Worker Configuration for instructions.
Add the following variables to your .env file:
WORKER_API_KEY=your_api_key
DASHBOARD_URL=http://localhost:3000
2

Add to Docker Compose

You can append the worker service to your existing docker-compose.yml file used for the dashboard. Add the following service definition:
worker:
  image: uptimekit/worker:latest
  restart: always
  env_file: .env
If you are running the worker on a separate server, you will need to set up a full docker-compose.yml similar to the dashboard installation, but only running the worker service.
3

Start the Worker

Update your stack to include the new worker service:
docker-compose up -d --build
4

Verify Worker Status

Check the logs to ensure the worker is processing jobs:
docker-compose logs -f worker