Skip to main content

​
Prerequisites

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

​
Installation Steps

1

Clone the Repository

Start by cloning the repository to your local machine:
git clone git@github.com:uptimekit/uptimekit.git
cd uptimekit
2

Configure Environment Variables

Create a copy of the example environment file:
cp .env.example .env
Open the .env file and configure the following variables. Make sure to replace the placeholder values with your actual configuration.
BETTER_AUTH_SECRET=change_me_to_a_secure_secret
BETTER_AUTH_URL=http://localhost:3000
NEXT_PUBLIC_URL=http://localhost:3000

# Status Page Configuration (Optional)
NEXT_PUBLIC_STATUS_PAGE_DOMAIN=status.example.com
STATUS_PAGE_ACCESS_SECRET=  # Optional, uses BETTER_AUTH_SECRET as fallback

# Optional ports to be exposed
DASH_PORT=3000
STATUS_PAGE_PORT=3001
To generate secure secrets, you can use the following command:
openssl rand -base64 32
BETTER_AUTH_SECRET is required. STATUS_PAGE_ACCESS_SECRET is optional and will use BETTER_AUTH_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.
3

Start with Docker Compose

Run the following command to build and start the application in detached mode:
docker-compose up -d --build
4

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: 
git pull origin main
docker-compose down
docker-compose up -d --build