uptime-kuma Documentation

File: README.md Copy Chapter

Uptime Kuma

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

🥔 Live Demo Copy Chapter

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 Copy Chapter

• Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Websocket / Ping / DNS Record / Push / Steam Game Server / Docker Containers
• Fancy, Reactive, Fast UI/UX
• Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 90+ notification services, click here for the full list
• 20-second intervals
• Multi Languages
• Multiple status pages
• Map status pages to specific domains
• Ping chart
• Certificate info
• Proxy support
• 2FA support

🔧 How to Install Copy Chapter

🐳 Docker Compose Copy Section

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 Copy Section

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 Copy Section

Requirements:

• Platform
  • ✅ Major Linux distros such as Debian, Ubuntu, Fedora and ArchLinux etc.
  • ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher
  • ❌ FreeBSD / OpenBSD / NetBSD
  • ❌ Replit / Heroku
• Node.js >= 20.4
• Git
• pm2 - For running Uptime Kuma in the background

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 Copy Section

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 Copy Chapter

Please read:

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

🆕 What's Next? Copy Chapter

I will assign requests/issues to the next milestone.

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

❤️ Sponsors Copy Chapter

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)

🖼 More Screenshots Copy Chapter

Light Mode:

Status Page:

Settings Page:

Telegram Notification Sample:

Motivation Copy Chapter

• I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one. One of the closest ones is statping. Unfortunately, it is not stable and no longer maintained.
• Wanted to build a fancy UI.
• Learn Vue 3 and vite.js.
• Show the power of Bootstrap 5.
• Try to use WebSocket with SPA instead of a REST API.
• Deploy my first Docker image to Docker Hub.

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

🗣️ Discussion / Ask for Help Copy Chapter

⚠️ 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:

• GitHub Issues
• Subreddit (r/UptimeKuma)

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

Contributions Copy Chapter

Create Pull Requests Copy Section

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

Test Pull Requests Copy Section

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 Copy Section

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

Bug Reports / Feature Requests Copy Section

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

Translations Copy Section

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

Spelling & Grammar Copy Section

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

File: db/knex_migrations/README.md Copy Chapter

Info

https://knexjs.org/guide/migrations.html#knexfile-in-other-languages

Basic rules Copy Chapter

• All tables must have a primary key named id
• Filename format: YYYY-MM-DD-HHMM-patch-name.js
• Avoid native SQL syntax, use knex methods, because Uptime Kuma supports SQLite and MariaDB.

Template Copy Chapter

exports.up = function (knex) {};

exports.down = function (knex) {};

// exports.config = { transaction: false };

Example Copy Chapter

Filename: 2023-06-30-1348-create-user-and-product.js

exports.up = function (knex) {
  return knex.schema
    .createTable("user", function (table) {
      table.increments("id");
      table.string("first_name", 255).notNullable();
      table.string("last_name", 255).notNullable();
    })
    .createTable("product", function (table) {
      table.increments("id");
      table.decimal("price").notNullable();
      table.string("name", 1000).notNullable();
    })
    .then(() => {
      knex("products").insert([
        { price: 10, name: "Apple" },
        { price: 20, name: "Orange" },
      ]);
    });
};

exports.down = function (knex) {
  return knex.schema.dropTable("product").dropTable("user");
};

https://knexjs.org/guide/migrations.html#transactions-in-migrations

File: db/old_migrations/README.md Copy Chapter

Don't create a new migration file here

Please go to ./db/knex_migrations/README.md

File: extra/push-examples/typescript-fetch/README.md Copy Chapter

How to run

Node.js (ts-node)

ts-node index.ts

Deno

deno run --allow-net index.ts

Bun.js

bun index.ts

File: src/lang/README.md Copy Chapter

Translations

How to translate Copy Chapter

(2023-01-24 Updated)

1. Go to https://weblate.kuma.pet
2. Register an account on Weblate
3. Make sure your GitHub email is matched with Weblate's account, so that it could show you as a contributor on GitHub
4. Choose your language on Weblate and start translating.

How to add a new language in the dropdown Copy Chapter

1. Add your language at https://weblate.kuma.pet/projects/uptime-kuma/uptime-kuma/
2. Find the language code (You can find it at the end of the URL)
3. Go to https://github.com/louislam/uptime-kuma/blob/master/src/i18n.js and click Edit icon
4. Add your language at the end of languageList, format: "zh-TW": "繁體中文 (台灣)",
5. Commit and make a pull request for me to approve

If you do not have programming skills, let me know in the issues section. I will assist you. 😏