Uptime Kuma Installation

All docs related to Uptime Kuma Installation

[How-To] Install Uptime Kuma on Debian 12 LXC

Purpose

The purpose of this document is to show how to install uptime kuma on a Debian 12 LXC in proxmox.

Prerequisites

List of prerequisites:

Installation Instructions - Docker

Using Docker deploy requires you to install docker and docker-compose on the LXC before proceeding.

Step 1: Install Uptime Kuma

Run the following line to install uptime kuma via docker:

docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1

Thats it! Uptime Kuma is now running on HTTP://localhost:3001

Filesystem support for POSIX file locks is required to avoid SQLite database corruption. Be aware of possible file locking problems such as those commonly encountered with NFS. Please map the /app/data-folder to a local directory or volume.

Browse to HTTP://localhost:3001

Step 2: Change Port or Volume (Optional)

Run the following line to adjust the port or volume and replace YOUR_PORT  and YOU_DIR OR VOLUME with your information

docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/data --name uptime-kuma louislam/uptime-kuma:1

Thats it! Uptime Kuma is now running on HTTP://localhost:3001

Installation Instructions - Non-Docker

Step 1: Prerequisites 

Ensure you have the non-docker prerequisite completed:

If you don't use the respective installer line below to get them installed:

Node.js 14/16/18/20.4
scripts
Npm 9
scripts
Git
sudo apt install git -y
Pm2
npm install pm2 -g && pm2 install pm2-logrotate

Step 2: Install Uptime Kuma

Run the following script to verify you version of npm is at the correct version needed:

npm install npm@9 -g

Run the following to clone the repo for Uptime Kuma:

git clone https://github.com/louislam/uptime-kuma.git

Run the following script to change directories into the uptime-kuma folder downloaded and use npm to run setup:

cd uptime-kuma
npm run setup

Step 3: Start the Service

Option 1 to start the service:

node server/server.js

Option 2 to start the service (Recommended) Running it in the background using PM2:

pm2 start server/server.js --name uptime-kuma

Thats it! Uptime Kuma is now running on HTTP://localhost:3001

Useful PM2 Commands

Here are some useful PM2 Commands:

pm2 monit
pm2 save && pm2 startup

https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install

[How-To] Install Uptime Kuma on Ubuntu 24 LTS VM

Purpose

This doc will walk through steps to install Uptime Kuma on a Ubuntu 24 LTS VM.

Prerequisites

List of prerequisites:

Full Installation Guide for Uptime Kuma on Ubuntu 24.04

Uptime Kuma is a self-hosted monitoring tool similar to Uptime Robot. It provides an easy-to-use web UI for monitoring services, websites, and endpoints.

Step 1: Prepare the Ubuntu VM

Ensure your Ubuntu VM is fully updated:

sudo apt update && sudo apt upgrade -y

Install necessary dependencies:

sudo apt install -y curl nano git unzip

Step 2: Create a Dedicated User (Optional)

For security, it's recommended to run Uptime Kuma as a separate user:

sudo useradd -m -s /bin/bash uptimekuma

Switch to the user:

sudo su - uptimekuma

Step 3: Install Node.js & NPM

Uptime Kuma requires Node.js (LTS version). Install Node.js 18+ using nvm (Node Version Manager):

curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash
source ~/.bashrc
nvm install 18

Verify the installation:

node -v
npm -v

✅ You should see versions 18.x.x for Node.js and a matching npm version.

Step 4: Download and Install Uptime Kuma

Clone the Uptime Kuma repository:

git clone https://github.com/louislam/uptime-kuma.git
cd uptime-kuma

Install dependencies:

npm install

Build Uptime Kuma:

npm run setup

Step 5: Run Uptime Kuma Manually (First Test)

Run Uptime Kuma to check if it works:

node server/server.js

You should see output similar to:

Listening on http://127.0.0.1:3001

✅ Open a browser and go to:

http://your-server-ip:3001

If it works, press CTRL + C to stop it and continue to the next step.

Step 6: Create a Systemd Service

To keep Uptime Kuma running in the background, create a systemd service:

sudo nano /etc/systemd/system/uptime-kuma.service

Paste the following:

[Unit]
Description=Uptime Kuma
After=network.target

[Service]
Type=simple
User=uptimekuma
Group=uptimekuma
WorkingDirectory=/home/uptimekuma/uptime-kuma
ExecStart=/home/uptimekuma/.nvm/versions/node/v18.20.6/bin/node /home/uptimekuma/uptime-kuma/server/server.js
Environment="PATH=/home/uptimekuma/.nvm/versions/node/v18.20.6/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

Save and exit (CTRL+X, then Y, then Enter).

Set ownership to new user of uptime kuma directory:

sudo chown -R uptimekuma:uptimekuma /home/uptimekuma/uptime-kuma

Reload systemd and enable the service:

sudo systemctl daemon-reload
sudo systemctl enable --now uptime-kuma

Check if it’s running:

sudo systemctl status uptime-kuma

✅ You should see "Active: running".

Step 7: Access Uptime Kuma

Open a browser and go to:

http://your-server-ip:3001

Follow the setup wizard to create an admin account.

Step 8: (Optional) Set Up Reverse Proxy with Nginx

If you want to access Uptime Kuma via a domain name (e.g., status.yourdomain.com), set up Nginx as a reverse proxy.

1. Install Nginx
sudo apt install -y nginx
2. Configure Nginx for Uptime Kuma

Create a new Nginx config:

sudo nano /etc/nginx/sites-available/uptime-kuma

Add the following:

server {
    listen 80;
    server_name status.yourdomain.com;

    location / {
        proxy_pass http://127.0.0.1:3001;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

Save and exit.

3. Enable the Configuration
sudo ln -s /etc/nginx/sites-available/uptime-kuma /etc/nginx/sites-enabled/

Test and restart Nginx:

sudo nginx -t
sudo systemctl restart nginx

✅ Now, Uptime Kuma is accessible at http://status.yourdomain.com.

Step 9: (Optional) Enable HTTPS with Let’s Encrypt

To secure Uptime Kuma with HTTPS, use Certbot:

sudo apt install -y certbot python3-certbot-nginx

Run:

sudo certbot --nginx -d status.yourdomain.com

Certbot will automatically apply an SSL certificate.

Now, access:

https://status.yourdomain.com

✅ Done! 🎉

Final Notes