uptime-kuma README

The project's README from github.com/louislam/uptime-kuma. As one markdown file: README.md.

Uptime Kuma Logo

Uptime Kuma

Uptime Kuma is an easy-to-use self-hosted monitoring tool.

GitHub Sponsors Translation status

Uptime Kuma Dashboard Screenshot

🥔 Live Demo

Try it!

Demo Server (Location: Frankfurt - Germany): https://demo.kuma.pet/start-demo

It is a temporary live demo, all data will be deleted after 10 minutes. Sponsored by Uptime Kuma Sponsors.

⭐ Features

🔧 How to Install

🐳 Docker Compose

mkdir uptime-kuma
cd uptime-kuma
curl -o compose.yaml https://raw.githubusercontent.com/louislam/uptime-kuma/master/compose.yaml
docker compose up -d

Uptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).

[!WARNING] File Systems like NFS (Network File System) are NOT supported. Please map to a local directory or volume.

🐳 Docker Command

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

Uptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).

If you want to limit exposure to localhost only:

docker run ... -p 127.0.0.1:3001:3001 ...

💪🏻 Non-Docker

Requirements:

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

# Option 1. Try it
node server/server.js

# (Recommended) Option 2. Run in the background using PM2
# Install PM2 if you don't have it:
npm install pm2 -g && pm2 install pm2-logrotate

# Start Server
pm2 start server/server.js --name uptime-kuma

Uptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).

More useful PM2 Commands

# If you want to see the current console output
pm2 monit

# If you want to add it to startup
pm2 startup && pm2 save

Advanced Installation

If you need more options or need to browse via a reverse proxy, please read:

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

🆙 How to Update

Please read:

https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update

🆕 What's Next?

I will assign requests/issues to the next milestone.

https://github.com/louislam/uptime-kuma/milestones

❤️ Sponsors

Thank you so much! (GitHub Sponsors will be updated manually. OpenCollective sponsors will be updated automatically, the list will be cached by GitHub though. It may need some time to be updated)

Uptime Kuma Sponsors

🖼 More Screenshots

Light Mode:

Uptime Kuma Light Mode Screenshot of how the Dashboard looks

Status Page:

Uptime Kuma Status Page Screenshot

Settings Page:

Uptime Kuma Settings Page Screenshot

Telegram Notification Sample:

Uptime Kuma Telegram Notification Sample Screenshot

Motivation

If you love this project, please consider giving it a ⭐.

🗣️ Discussion / Ask for Help

⚠️ For any general or technical questions, please don't send me an email, as I am unable to provide support in that manner. I will not respond if you ask questions there.

I recommend using Google, GitHub Issues, or Uptime Kuma's subreddit for finding answers to your question. If you cannot find the information you need, feel free to ask:

My Reddit account: u/louislamlam You can mention me if you ask a question on the subreddit.

Contributions

Create Pull Requests

Pull requests are awesome. To keep reviews fast and effective, please make sure you’ve read our pull request guidelines.

Test Pull Requests

There are a lot of pull requests right now, but I don't have time to test them all.

If you want to help, you can check this: https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests

Test Beta Version

Check out the latest beta release here: https://github.com/louislam/uptime-kuma/releases

Bug Reports / Feature Requests

If you want to report a bug or request a new feature, feel free to open a new issue.

Translations

If you want to translate Uptime Kuma into your language, please visit Weblate Readme.

Spelling & Grammar

Feel free to correct the grammar in the documentation or code. My mother language is not English and my grammar is not that great.

uptime-kuma (louislam/uptime-kuma)

Searching Database…

What is this?Uptime Kuma is a self-hosted uptime and server monitoring tool with a fancy web UI, status pages, and notifications when your services go down.
Is this a web app I host myself, or a hosted service?It's a self-hosted single-page web app with a real-time dashboard, built with Vue 3 and WebSockets instead of a REST API, that you run on your own server.
How do I get it running?The simplest way is the official Docker image; alternatively you can install it without Docker on supported platforms using Node.js, Git and pm2 to keep it running in the background.
Do I need Node.js or Docker first?For non-Docker installs you need Node.js >= 20.4, Git, and pm2; the engines field actually requires Node >= 26.2.0. Docker is the easier route and avoids these requirements.
Any install pitfalls I should know about?Network file systems like NFS are not supported for its data directory—you must map to a local directory or volume instead. FreeBSD/OpenBSD/NetBSD and platforms like Replit/Heroku are also unsupported.
Does it work on Windows too, or just Linux?Yes, besides major Linux distros it officially supports Windows 10 (x64) and Windows Server 2012 R2 (x64) or higher.
Does my monitoring data leave my server?No, everything runs on infrastructure you control since it's fully self-hosted; there's no mention of any external data collection.
Why did the author build Uptime Kuma instead of using an existing tool?The author was looking for a self-hosted alternative to Uptime Robot, found statping unstable and unmaintained, and wanted to build a fancy UI while learning Vue 3, Vite, Bootstrap 5, and WebSocket-based SPA architecture instead of a REST API.
Can I try it before installing?Yes, there is a live demo server hosted in Frankfurt, Germany that you can try without installing anything.
Does it support status pages and notifications?Yes, it includes a public status page feature and notification integrations such as Telegram, as shown in its screenshots.
Can I run it behind a reverse proxy?Yes, the README points to an advanced installation guide for configuring it behind a reverse proxy and other options.
Creator
louislam
Size
38.1 MB
Stars
92.6K
Age
5y
Commits · 90 Days