Mirror of louislam/uptime-kuma@github.com
Go to file
Matthew Nickson f67d7cdf3f
Make update-language-files command more useful (#2198)
* [empty commit] pull request for Fix language update script

* Avoid mass changes with update-language-files

This commit updates the update-language-files script to prevent mass
changes as seen on a number of recent PRs where the contributer has
ran the script and comitted the results.
The script has been updated to now require the --language argument to
specify which language file to update. This ensures that only that file
is updated instead of all files. If the provided language code does not
already exist, a new file with that code is created. This should make
it easier to add new languages as you only need to pass the language
code to the script.
The base lang code is now also passed as an optional argument to negate
the need for a seperate script entry in package.json.
The script has been restructures into a couple of functions to make it
easier to understand.
ESlint now only checks the changed file instead of
them all in order to improve performance.

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>

* Updated translation docs for new command

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>

* [update-language-files] Add cross-env-shell

Signed-off-by: Matthew Nickson <mnickson@sidingsmedia.com>
Co-authored-by: Louis Lam <louislam@users.noreply.github.com>
2022-10-08 15:01:47 +08:00
.github Update stale-bot.yml 2022-09-24 00:11:22 +08:00
config Drop Jest e2e testing (#2174) 2022-10-05 14:26:30 +08:00
data
db Merge remote-tracking branch 'origin/master' into introduce-resend-interval 2022-08-13 13:24:00 +08:00
docker Fix checkout-pr by using fetch & checkout instead of pull 2022-09-09 15:49:39 +08:00
extra Make update-language-files command more useful (#2198) 2022-10-08 15:01:47 +08:00
public Clean up logo svg file 2022-06-29 13:20:26 -06:00
server Fix #2186 2022-10-07 15:02:19 +08:00
src Make update-language-files command more useful (#2198) 2022-10-08 15:01:47 +08:00
test Correctly handle multiple IPs in X-Forwarded-For (#2177) 2022-10-05 23:45:21 +08:00
.dockerignore Ignore /cypress in .dockerignore 2022-09-09 16:36:32 +08:00
.editorconfig
.eslintrc.js Update linters 2022-04-26 01:26:57 +02:00
.gitignore added cypress framework and tests for setup page 2022-07-18 20:51:13 +02:00
.npmrc
.stylelintrc [stylelint] Turn off color-hex-length 2022-06-28 22:26:27 +08:00
CNAME eslint fixes too much 2022-05-09 21:05:10 +02:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md fix typos 2022-10-02 13:38:33 +02:00
LICENSE
README.md Update README.md 2022-10-05 14:19:50 +08:00
SECURITY.md Remove template comment 2022-06-13 11:34:36 +02:00
babel.config.js
ecosystem.config.js
index.html
install.sh
package-lock.json Fix #2186 2022-10-07 15:02:19 +08:00
package.json Make update-language-files command more useful (#2198) 2022-10-08 15:01:47 +08:00
tsconfig.json Move Cypress directory and convert it to JavaScript (#2170) 2022-10-04 22:23:57 +08:00

README.md

Uptime Kuma

GitHub Sponsors

It is a self-hosted monitoring tool like "Uptime Robot".

🥔 Live Demo

Try it!

It is a temporary live demo, all data will be deleted after 10 minutes. Use the one that is closer to you, but I suggest that you should install and try it out for the best demo experience.

Features

  • Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / 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 Page to Domain
  • Ping Chart
  • Certificate Info
  • Proxy Support
  • 2FA available

🔧 How to Install

🐳 Docker

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

⚠️ Please use a local volume only. Other types such as NFS are not supported.

Browse to http://localhost:3001 after starting.

💪🏻 Non-Docker

Required Tools:

# Update your npm to the latest version
npm install npm -g

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


Browse to http://localhost:3001 after starting.

More useful PM2 Commands

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

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

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 mark requests/issues to the next milestone.

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

Project Plan:

https://github.com/users/louislam/projects/4/views/1

❤️ 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)

🖼 More Screenshots

Light Mode:

Status Page:

Settings Page:

Telegram Notification Sample:

Motivation

  • I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one. One of the close ones is statping. Unfortunately, it is not stable and no longer maintained.
  • Want 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 REST API.
  • Deploy my first Docker image to Docker Hub.

If you love this project, please consider giving me a .

🗣️ Discussion

Issues Page

You can discuss or ask for help in issues.

Subreddit

My Reddit account: u/louislamlam.
You can mention me if you ask a question on Reddit. r/Uptime kuma

Contribute

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 read: https://github.com/louislam/uptime-kuma/tree/master/src/languages

Feel free to correct my grammar in this README, source code, or wiki, as my mother language is not English and my grammar is not that great.

Create Pull Requests

If you want to modify Uptime Kuma, please read this guide and follow the rules here: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md