uptime-kuma/README.md

196 lines
7.3 KiB
Markdown
Raw Normal View History

2023-08-02 03:11:18 -05:00
<div align="center" width="100%">
<img src="./public/icon.svg" width="128" alt="" />
</div>
2021-07-01 04:00:23 -05:00
# Uptime Kuma
2023-08-02 03:11:18 -05:00
Uptime Kuma is an easy-to-use self-hosted monitoring tool.
2024-01-03 13:13:31 -06:00
<a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/stars/louislam/uptime-kuma?style=flat" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/pulls/louislam/uptime-kuma" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/v/louislam/uptime-kuma/latest?label=docker%20image%20ver." /></a> <a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/last-commit/louislam/uptime-kuma" /></a> <a target="_blank" href="https://opencollective.com/uptime-kuma"><img src="https://opencollective.com/uptime-kuma/total/badge.svg?label=Open%20Collective%20Backers&color=brightgreen" /></a>
2023-02-02 23:39:45 -06:00
[![GitHub Sponsors](https://img.shields.io/github/sponsors/louislam?label=GitHub%20Sponsors)](https://github.com/sponsors/louislam) <a href="https://weblate.kuma.pet/projects/uptime-kuma/uptime-kuma/">
2023-01-24 04:13:31 -06:00
<img src="https://weblate.kuma.pet/widgets/uptime-kuma/-/svg-badge.svg" alt="Translation status" />
</a>
2021-09-30 13:38:41 -05:00
2023-01-13 01:34:48 -06:00
<img src="https://user-images.githubusercontent.com/1336778/212262296-e6205815-ad62-488c-83ec-a5b0d0689f7c.jpg" width="700" alt="" />
2021-07-11 05:32:04 -05:00
2021-09-02 13:55:36 -05:00
## 🥔 Live Demo
Try it!
2024-01-07 09:24:28 -06:00
Demo Server (Location: Frankfurt - Germany): https://demo.kuma.pet/start-demo
2021-09-02 13:55:36 -05:00
2024-01-07 09:24:28 -06:00
It is a temporary live demo, all data will be deleted after 10 minutes. Sponsored by [Uptime Kuma Sponsors](https://github.com/louislam/uptime-kuma#%EF%B8%8F-sponsors).
2021-09-02 13:55:36 -05:00
2021-08-15 12:38:37 -05:00
## ⭐ Features
2021-07-01 04:00:23 -05:00
2023-10-02 16:48:21 -05:00
- Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / 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](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications)
- 20-second intervals
- [Multi Languages](https://github.com/louislam/uptime-kuma/tree/master/src/lang)
- Multiple status pages
- Map status pages to specific domains
- Ping chart
- Certificate info
- Proxy support
- 2FA support
2021-07-01 04:00:23 -05:00
2021-08-15 12:38:37 -05:00
## 🔧 How to Install
2021-07-01 04:00:23 -05:00
2021-08-30 08:56:33 -05:00
### 🐳 Docker
2021-07-12 07:08:51 -05:00
2021-08-19 01:13:30 -05:00
```bash
2021-08-30 08:56:33 -05:00
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
2021-07-11 03:02:06 -05:00
```
2021-07-11 05:34:29 -05:00
Uptime Kuma is now running on <http://0.0.0.0:3001>.
2021-08-30 08:56:33 -05:00
2023-10-08 08:52:45 -05:00
> [!WARNING]
2023-10-17 07:23:58 -05:00
> File Systems like **NFS** (Network File System) are **NOT** supported. Please map to a local directory or volume.
2023-10-08 08:52:45 -05:00
> [!NOTE]
> If you want to limit exppoure to localhost (without exposing port for other users or to use a [reverse proxyx](https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy)), you can expose the port like this:
>
> ```bash
> docker run -d --restart=always -p 127.0.0.1:3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
> ```
2021-10-26 11:07:17 -05:00
### 💪🏻 Non-Docker
2021-08-30 08:56:33 -05:00
✨ feat: json-query monitor added (#3253) * ✨ feat: json-query monitor added Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: import warning error Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: br tag and remove comment Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: supporting compare string with other types Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: switch to a better lib for json query Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: better description on json query and using `v-html` in jsonQueryDescription element to fix `a` tags Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: result variable in error message Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: typos in json query description Co-authored-by: Frank Elsinga <frank@elsinga.de> * 📝 docs: `HTTP(s) Json Query` added to monitor list in `README.md` Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: needed white space in `README.md` Co-authored-by: Frank Elsinga <frank@elsinga.de> * Nostr dm notifications (#3051) * Add nostr DM notification provider * require crypto for node 18 compatibility * remove whitespace Co-authored-by: Frank Elsinga <frank@elsinga.de> * move closer to where it is used * simplify success or failure logic * don't clobber the non-alert msg * Update server/notification-providers/nostr.js Co-authored-by: Frank Elsinga <frank@elsinga.de> * polyfills required for node <= 18 * resolve linter warnings * missing comma --------- Co-authored-by: Frank Elsinga <frank@elsinga.de> * Drop nostr * Rebuild package-lock.json * Lint --------- Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> Co-authored-by: Frank Elsinga <frank@elsinga.de> Co-authored-by: zappityzap <128872140+zappityzap@users.noreply.github.com> Co-authored-by: Louis Lam <louislam@users.noreply.github.com>
2023-07-13 10:37:26 -05:00
Requirements:
2023-10-02 16:48:21 -05:00
2023-06-03 03:22:51 -05:00
- Platform
✨ feat: json-query monitor added (#3253) * ✨ feat: json-query monitor added Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: import warning error Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: br tag and remove comment Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: supporting compare string with other types Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: switch to a better lib for json query Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: better description on json query and using `v-html` in jsonQueryDescription element to fix `a` tags Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: result variable in error message Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: typos in json query description Co-authored-by: Frank Elsinga <frank@elsinga.de> * 📝 docs: `HTTP(s) Json Query` added to monitor list in `README.md` Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: needed white space in `README.md` Co-authored-by: Frank Elsinga <frank@elsinga.de> * Nostr dm notifications (#3051) * Add nostr DM notification provider * require crypto for node 18 compatibility * remove whitespace Co-authored-by: Frank Elsinga <frank@elsinga.de> * move closer to where it is used * simplify success or failure logic * don't clobber the non-alert msg * Update server/notification-providers/nostr.js Co-authored-by: Frank Elsinga <frank@elsinga.de> * polyfills required for node <= 18 * resolve linter warnings * missing comma --------- Co-authored-by: Frank Elsinga <frank@elsinga.de> * Drop nostr * Rebuild package-lock.json * Lint --------- Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> Co-authored-by: Frank Elsinga <frank@elsinga.de> Co-authored-by: zappityzap <128872140+zappityzap@users.noreply.github.com> Co-authored-by: Louis Lam <louislam@users.noreply.github.com>
2023-07-13 10:37:26 -05:00
- ✅ Major Linux distros such as Debian, Ubuntu, CentOS, Fedora and ArchLinux etc.
2023-06-03 03:22:51 -05:00
- ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher
- ❌ Replit / Heroku
- [Node.js](https://nodejs.org/en/download/) 18 / 20.4
2023-10-08 08:52:45 -05:00
- [npm](https://docs.npmjs.com/cli/) 9
✨ feat: json-query monitor added (#3253) * ✨ feat: json-query monitor added Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: import warning error Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: br tag and remove comment Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: supporting compare string with other types Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: switch to a better lib for json query Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: better description on json query and using `v-html` in jsonQueryDescription element to fix `a` tags Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: result variable in error message Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: typos in json query description Co-authored-by: Frank Elsinga <frank@elsinga.de> * 📝 docs: `HTTP(s) Json Query` added to monitor list in `README.md` Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: needed white space in `README.md` Co-authored-by: Frank Elsinga <frank@elsinga.de> * Nostr dm notifications (#3051) * Add nostr DM notification provider * require crypto for node 18 compatibility * remove whitespace Co-authored-by: Frank Elsinga <frank@elsinga.de> * move closer to where it is used * simplify success or failure logic * don't clobber the non-alert msg * Update server/notification-providers/nostr.js Co-authored-by: Frank Elsinga <frank@elsinga.de> * polyfills required for node <= 18 * resolve linter warnings * missing comma --------- Co-authored-by: Frank Elsinga <frank@elsinga.de> * Drop nostr * Rebuild package-lock.json * Lint --------- Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> Co-authored-by: Frank Elsinga <frank@elsinga.de> Co-authored-by: zappityzap <128872140+zappityzap@users.noreply.github.com> Co-authored-by: Louis Lam <louislam@users.noreply.github.com>
2023-07-13 10:37:26 -05:00
- [Git](https://git-scm.com/downloads)
2023-01-03 08:37:32 -06:00
- [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background
2021-07-11 05:34:29 -05:00
2021-07-11 05:32:04 -05:00
```bash
2021-08-30 08:56:33 -05:00
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
✨ feat: json-query monitor added (#3253) * ✨ feat: json-query monitor added Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: import warning error Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: br tag and remove comment Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: supporting compare string with other types Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: switch to a better lib for json query Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: better description on json query and using `v-html` in jsonQueryDescription element to fix `a` tags Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: result variable in error message Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: typos in json query description Co-authored-by: Frank Elsinga <frank@elsinga.de> * 📝 docs: `HTTP(s) Json Query` added to monitor list in `README.md` Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> * 🐛 fix: needed white space in `README.md` Co-authored-by: Frank Elsinga <frank@elsinga.de> * Nostr dm notifications (#3051) * Add nostr DM notification provider * require crypto for node 18 compatibility * remove whitespace Co-authored-by: Frank Elsinga <frank@elsinga.de> * move closer to where it is used * simplify success or failure logic * don't clobber the non-alert msg * Update server/notification-providers/nostr.js Co-authored-by: Frank Elsinga <frank@elsinga.de> * polyfills required for node <= 18 * resolve linter warnings * missing comma --------- Co-authored-by: Frank Elsinga <frank@elsinga.de> * Drop nostr * Rebuild package-lock.json * Lint --------- Signed-off-by: Muhammed Hussein Karimi <info@karimi.dev> Co-authored-by: Frank Elsinga <frank@elsinga.de> Co-authored-by: zappityzap <128872140+zappityzap@users.noreply.github.com> Co-authored-by: Louis Lam <louislam@users.noreply.github.com>
2023-07-13 10:37:26 -05:00
# Install PM2 if you don't have it:
2022-03-22 22:17:23 -05:00
npm install pm2 -g && pm2 install pm2-logrotate
# Start Server
2021-08-30 08:56:33 -05:00
pm2 start server/server.js --name uptime-kuma
2022-04-06 00:18:12 -05:00
```
2023-10-02 16:48:21 -05:00
2023-01-05 07:03:28 -06:00
Uptime Kuma is now running on http://localhost:3001
2022-04-06 00:18:12 -05:00
More useful PM2 Commands
```bash
2022-03-22 22:17:23 -05:00
# If you want to see the current console output
pm2 monit
2021-08-08 10:51:23 -05:00
2022-04-06 00:18:12 -05:00
# If you want to add it to startup
pm2 save && pm2 startup
```
2021-08-19 04:55:43 -05:00
2021-08-19 01:13:30 -05:00
### Advanced Installation
2021-07-12 05:59:48 -05:00
2021-12-01 03:43:58 -06:00
If you need more options or need to browse via a reverse proxy, please read:
2021-07-12 05:59:48 -05:00
2021-08-19 01:13:30 -05:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install
2021-08-08 11:24:30 -05:00
2021-08-19 01:13:30 -05:00
## 🆙 How to Update
2021-07-13 12:48:55 -05:00
2021-08-19 01:13:30 -05:00
Please read:
2021-07-12 05:59:48 -05:00
2021-08-19 01:13:30 -05:00
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update
2021-07-12 05:59:48 -05:00
2021-08-15 12:38:37 -05:00
## 🆕 What's Next?
2021-07-20 07:27:15 -05:00
I will assign requests/issues to the next milestone.
2021-08-19 01:13:30 -05:00
2021-07-20 07:27:15 -05:00
https://github.com/louislam/uptime-kuma/milestones
2021-12-14 12:46:13 -06:00
## ❤️ 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)
2022-04-01 10:22:15 -05:00
<img src="https://uptime.kuma.pet/sponsors?v=6" alt />
2021-12-14 12:46:13 -06:00
2021-08-15 12:38:37 -05:00
## 🖼 More Screenshots
2021-07-11 05:32:04 -05:00
2021-10-07 09:33:39 -05:00
Light Mode:
2021-08-09 09:31:32 -05:00
2021-10-07 09:33:39 -05:00
<img src="https://uptime.kuma.pet/img/light.jpg" width="512" alt="" />
Status Page:
2021-10-09 03:54:26 -05:00
<img src="https://user-images.githubusercontent.com/1336778/134628766-a3fe0981-0926-4285-ab46-891a21c3e4cb.png" width="512" alt="" />
2021-08-09 09:31:32 -05:00
2021-07-11 07:12:37 -05:00
Settings Page:
2021-07-11 05:32:04 -05:00
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
2021-07-11 07:12:37 -05:00
Telegram Notification Sample:
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
2021-08-08 11:24:30 -05:00
## Motivation
2021-07-01 04:00:23 -05:00
- 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.
2023-10-02 16:48:21 -05:00
- Learn Vue 3 and vite.js.
- Show the power of Bootstrap 5.
- Try to use WebSocket with SPA instead of a REST API.
2023-10-02 16:48:21 -05:00
- Deploy my first Docker image to Docker Hub.
2021-07-01 04:00:23 -05:00
If you love this project, please consider giving it a ⭐.
2021-07-01 04:00:23 -05:00
2023-05-30 04:37:53 -05:00
## 🗣️ Discussion / Ask for Help
2021-09-09 05:01:15 -05:00
⚠️ 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.
2021-10-12 19:01:34 -05:00
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:
2021-09-09 05:01:15 -05:00
2023-05-30 04:37:53 -05:00
- [GitHub Issues](https://github.com/louislam/uptime-kuma/issues)
- [Subreddit (r/UptimeKuma)](https://www.reddit.com/r/UptimeKuma/)
2021-10-12 19:01:34 -05:00
My Reddit account: [u/louislamlam](https://reddit.com/u/louislamlam)
You can mention me if you ask a question on the subreddit.
2023-05-30 04:37:53 -05:00
2023-11-30 06:37:07 -06:00
## Contributions
### Create Pull Requests
We DO NOT accept all types of pull requests and do not want to waste your time. Please be sure that you have read and follow pull request rules:
[CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma)
2021-07-18 11:34:48 -05:00
2022-09-09 03:23:15 -05:00
### Test Pull Requests
2022-09-09 03:24:08 -05:00
There are a lot of pull requests right now, but I don't have time to test them all.
2022-09-09 03:23:15 -05:00
If you want to help, you can check this:
https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests
### Test Beta Version
2021-07-18 11:34:48 -05:00
2022-04-18 06:15:50 -05:00
Check out the latest beta release here: https://github.com/louislam/uptime-kuma/releases
### Bug Reports / Feature Requests
2023-10-02 16:48:21 -05:00
2022-04-27 13:10:47 -05:00
If you want to report a bug or request a new feature, feel free to open a [new issue](https://github.com/louislam/uptime-kuma/issues).
2021-07-18 11:34:48 -05:00
2022-04-20 21:22:18 -05:00
### Translations
2023-10-02 16:48:21 -05:00
2023-01-24 11:29:29 -06:00
If you want to translate Uptime Kuma into your language, please visit [Weblate Readme](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).
2021-09-09 05:02:58 -05:00
2023-09-11 05:22:03 -05:00
### 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.
2021-07-18 11:34:48 -05:00
2023-10-02 16:48:21 -05:00