Uptime-Kuma

Uptime-Kuma is a really nice little applicatioin for checking the status of your home lab web applications, your self hosted websites, or really any web site or web service.

I've used Ciao for a while now, and it's great, but it hasn't been updated or maintained in quite some time.  Uptime-Kuma is fairly new, and has current development, which is a nice perk when depending on something for notifications about your systems being up or down.

Uptime-Kuma also ahs a very nice user interface.  It gives you a quick look at whether your systems are up or down, and you can click to imply jump in and view a few more status such as up-time, ping times, and more.

Additionally, you have multiple options for getting notifications through various different systems such as Telegram, Push, Email, Slack, and many more.

What you'll need

  • Docker installed

Optionally

  • A Reverse Proxy
  • Notification account with one of the supported services

Installation

Open up a terminal shell.  We want to keep our docker installs organized, so make sure to create a folder inside of the folder where you install / setup all of your docker folders.

Make a directory called "uptime-kuma"

mkdir uptime-kuma

Change into that directory with the command:

cd uptime-kuma

Now make a file called "docker-run.txt"

nano docker-run.txt

In this file, paste teh following text blox:

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

Make any changes in the file, such as the left side of the colon for the port mapping.  Make sure to use a port that is free on your host machine. Also, update the path on the left side of the colon in the volume mapping.  I set mine to "/home/brian/docker/uptime-kuma/data:/app/data".

Save the file with CTRL + O, then press Enter to confirm.  Now exit the nano editor with CTRL + X.

Create a folder called "data" inside your uptime-kuma folder.

mkdir data

Now, cat out the text from your docker-run.txt file with

cat docker-run.txt

Copy the text from the terminal (you can use right click and copy, or in the linux shell you can use CTRL + Shift + C).  Next paste it into the terminal again with right-click and paste, or CTRL + Shift + V; or you can highlight the text, then use the mouse-wheel click to paste it without copying it.

Now press Enter to run the docker command.

Uptime-Kuma should be installed shortly, and you'll access it via the IP address of your host machine, and the port you set on the left side of the colon.

Create an account, and start setting up sites you want to keep an eye on.

Check out the video at the top for an overview of the settings, and Graphical User Interface.

Subscribe to Open Source is Awesome Show Notes

Don’t miss out on the latest issues. Sign up now to get access to the library of members-only issues.
jamie@example.com
Subscribe