Develoopers

Welcome to this guide about, how to install Uptime Kuma! We’ll be using docker in this guide, if you need another type of installation, don’t hesitate to use the official Uptime Kuma documentation!

So first things first, you need to install Docker on your machine. In our case, we’ll use a VPS running Debian 11.

---

Installing docker & docker compose on your machine:

---

Step 1: Repository setup

First you need to set up the repository for installing docker. Update the apt package index and install packages to allow apt to use a repository over HTTPS:

$ sudo apt-get update
$ sudo apt-get install ca-certificates curl gnupg

Then you’ll need to add docker’s official GPG key:

$ sudo install -m 0755 -d /etc/apt/keyrings
$ curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
$ sudo chmod a+r /etc/apt/keyrings/docker.gpg

Then use the following command to set up the repository:

$ echo \
  "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
  "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

Then update the apt package index:

sudo apt-get update

---

Step 2: Install docker engine

So, we’re going to install the latest version, so that we have no compatibility issues while installing Uptime Kuma.

Use this command to install the latest version of Docker:

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

---

You’ve now installed docker engine!

---

Installing Uptime Kuma using docker.

Well you’re going to laugh, but installing Uptime Kuma on docker is as easy as just typing a command in your server console 🙂

To install uptime kuma, use this command. It’ll create a docker container where uptime kuma is going to run:

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

After running that command (and waiting for a few minutes), you should be able to access the application on the port 3001. If you need to change that port, use this command:

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

And voila, your own uptime kuma instance is now running on your own server! Habe fun using it!

---

You’re done installing now 🙂