Dashboard Installation

Prerequisites

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

Docker Engine

Installation Steps

Clone the Repository

Start by downloading docker-compose.yml and .env.example

Configure Environment Variables

Create a copy of the example environment file:

curl -L https://raw.githubusercontent.com/uptimekit/uptimekit/refs/heads/main/docker-compose.production.yml -o docker-compose.production.yml

Open the .env file and configure the following variables. Make sure to replace the placeholder values with your actual configuration.

APP_SECRET=change_me_to_a_secure_secret
APP_URL=http://localhost:3000

# Status Pages Configuration (Optional)
APP_STATUS_PAGE_DOMAIN=status.example.com

To generate secure secrets, you can use the following command:

openssl rand -base64 32

APP_SECRET is required. STATUS_PAGE_ACCESS_SECRET is optional and will use APP_SECRET as a fallback if not set.

For more details on configuring custom domains and password-protected status pages, see the Status Pages Configuration guide.

Start with Docker Compose

Run the following command to build and start the application in detached mode:

docker compose up -d

Verify Installation

Once the containers are running, you can access the dashboard at:http://localhost:3000 (or http://<YOUR_SERVER_IP>:3000)To check the logs and ensure everything is running smoothly:

docker compose logs -f

Updating the Dashboard

To update to the latest version, pull the latest changes from git and restart the containers:

docker compose pull
docker compose down
docker compose up -d --force-recreate

Changelog

Worker Installation

⌘I

Getting started

Installation

Configuration

Features

Integrations

Dashboard Installation

Prerequisites

Installation Steps

Updating the Dashboard

​Prerequisites

​Installation Steps

​Updating the Dashboard

Prerequisites

Installation Steps

Updating the Dashboard