Skip to main content

[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:

  • Root user or sudo user
  • Debian 12 LXC

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:

  • Node.js 14/16/18/20.4
  • npm 9
  • GIT
  • pm2

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:

  • If you want to see the current console output
pm2 monit
  • If you want to add it to startup
pm2 save && pm2 startup

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

Back to top