diff --git a/3rd-Party-Addons-Apps.md b/3rd-Party-Addons-Apps.md new file mode 100644 index 0000000..dc21d8c --- /dev/null +++ b/3rd-Party-Addons-Apps.md @@ -0,0 +1,8 @@ +A list of 3rd party addons or applications, plugins or related side projects. + +Feel free to add your project here by making a pull request in this wiki repo: https://github.com/louislam/uptime-kuma-wiki + +- [Streamdeck Uptime Kuma](https://github.com/MarlBurroW/Streamdeck-Uptime-Kuma) - An Uptime Kuma plugin for Elgato Streamdeck +- [xBarApp Uptime Kuma](https://github.com/mariogarridopt/xBar-Uptime-Kuma) - An Uptime Kuma plugin for xBarApp for Mac +- [Uptime Kuma Manager](https://apps.apple.com/us/app/uptime-kuma-manager/id6446004887) - An iOS app that allows you to connect to your Uptime Kuma servers and monitor the services directly from your phone. +- [uptime-kuma-api (Python)](https://github.com/lucasheld/uptime-kuma-api) - A wrapper for the Uptime Kuma Socket.IO API diff --git a/3rd-Party-Addons.md b/3rd-Party-Addons.md deleted file mode 100644 index 7560297..0000000 --- a/3rd-Party-Addons.md +++ /dev/null @@ -1,6 +0,0 @@ -A list of 3rd party addons, plugins or related side projects. - -Feel free to add your project here by making a pull request in this wiki repo: https://github.com/louislam/uptime-kuma-wiki - -- [Streamdeck Uptime Kuma](https://github.com/MarlBurroW/Streamdeck-Uptime-Kuma) - An Uptime Kuma plugin for Elgato Streamdeck -- [xBarApp Uptime Kuma](https://github.com/mariogarridopt/xBar-Uptime-Kuma) - An Uptime Kuma plugin for xBarApp for Mac diff --git a/Environment-Variables.md b/Environment-Variables.md index 2e5b86a..4ea0ec9 100644 --- a/Environment-Variables.md +++ b/Environment-Variables.md @@ -19,6 +19,7 @@ node server/server.js --host=127.0.0.1 --port=8080 | `UPTIME_KUMA_PORT` or `PORT` | `--port=` | Port to listen to | `3001` | | `UPTIME_KUMA_SSL_KEY` or `SSL_KEY` | `--ssl-key=` | Path to SSL key | | | `UPTIME_KUMA_SSL_CERT` or `SSL_CERT` | `--ssl-cert=` | Path to SSL certificate | | +| `UPTIME_KUMA_SSL_KEY_PASSPHRASE` or `SSL_KEY_PASSPHRASE` | `--ssl-key-passphrase=` | (1.21.1) SSL Key Passphrase | | | `UPTIME_KUMA_CLOUDFLARED_TOKEN` | `--cloudflared-token=` | (1.14.0) Cloudflare Tunnel Token | | | `UPTIME_KUMA_DISABLE_FRAME_SAMEORIGIN` | `--disable-frame-sameorigin=` | By default, Uptime Kuma is not allowed in iframe if the domain name is not the same as the parent. It protects your Uptime Kuma to be a phishing website. If you don't need this protection, you can set it to `true` | `false` | | `NODE_EXTRA_CA_CERTS` | | Add your self-signed ca certs. (e.g. /cert/path/CAcert.pem) [Read more](https://github.com/louislam/uptime-kuma/issues/1380) | | diff --git a/Home.md b/Home.md index c476384..9493708 100644 --- a/Home.md +++ b/Home.md @@ -1,7 +1,5 @@ Welcome to the Uptime Kuma wiki! -This wiki is also available on https://uptime.kuma.pet/docs/ - ## 🐻? Kuma (クマ/熊) means bear 🐻 in Japanese. diff --git a/Prometheus-Integration.md b/Prometheus-Integration.md index 30d20ea..c5f2765 100644 --- a/Prometheus-Integration.md +++ b/Prometheus-Integration.md @@ -20,6 +20,7 @@ Put the following into your Prometheus config: - job_name: 'uptime' scrape_interval: 30s scheme: http + metrics_path: '/metrics' static_configs: - targets: ['uptime-kuma.url'] basic_auth: # Only needed if authentication is enabled (default) @@ -42,4 +43,4 @@ sum(monitor_response_time) by (monitor_name) sum(monitor_reponse_time{monitor_url="https://www.bbc.co.uk/"}) # Show the current status of Google.com monitor_status{monitor_name="Google"} -``` \ No newline at end of file +``` diff --git a/Reverse-Proxy.md b/Reverse-Proxy.md index afa9ed3..7f6aa59 100644 --- a/Reverse-Proxy.md +++ b/Reverse-Proxy.md @@ -119,7 +119,7 @@ services: - /srv/uptime:/app/data labels: caddy: status.example.org - caddy.reverse_proxy: "* {{ '{{upstreams 3001}}'}}" + caddy.reverse_proxy: "* {{upstreams 3001}}" caddy: image: "lucaslorentz/caddy-docker-proxy:ci-alpine" ports: diff --git a/_Sidebar.md b/_Sidebar.md index bc22992..3bc8cf4 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -13,7 +13,7 @@ - [Badge](https://github.com/louislam/uptime-kuma/wiki/Badge) - [How to Monitor Docker Containers](https://github.com/louislam/uptime-kuma/wiki/How-to-Monitor-Docker-Containers) - [Maintenance](https://github.com/louislam/uptime-kuma/wiki/Maintenance) -- [3rd Party Addons](https://github.com/louislam/uptime-kuma/wiki/3rd-Party-Addons) +- [3rd Party Addons/Apps](https://github.com/louislam/uptime-kuma/wiki/3rd-Party-Addons-Apps) - [API Keys](https://github.com/louislam/uptime-kuma/wiki/API-Keys) ## Network diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index 0b1ddb1..fb76b7a 100644 --- a/🆙-How-to-Update.md +++ b/🆙-How-to-Update.md @@ -34,7 +34,7 @@ cd # Update from git git fetch --all -git checkout 1.20.2 --force +git checkout 1.21.3 --force # Install dependencies and prebuilt npm install --production diff --git a/🔧-How-to-Install.md b/🔧-How-to-Install.md index 7e35019..7fccabb 100644 --- a/🔧-How-to-Install.md +++ b/🔧-How-to-Install.md @@ -49,6 +49,11 @@ docker run -d --restart=always -p :3001 -v :/app/ +### 🐳 Docker Compose Example + +https://github.com/louislam/uptime-kuma/blob/master/docker/docker-compose.yml + + ### 💪🏻 Without Docker (Recommended for x86/x64 only) It should supports Linux/Windows/MacOS. @@ -103,9 +108,17 @@ pm2 restart uptime-kuma pm2 startup ``` -### Docker Compose Example +### 🪟 Windows Portable -https://github.com/louislam/uptime-kuma/blob/master/docker/docker-compose.yml +![](https://user-images.githubusercontent.com/1336778/227160967-907ba113-c89d-4ec3-bb94-4c4ea6b7cb6f.png) + + +Requirement: +- Arch: x64 +- .NET 4.8 Runtime +- Internet for initialization (Download Node.js runtime and Uptime Kuma source code) + +Download: https://github.com/louislam/uptime-kuma/releases/download/1.21.0/uptime-kuma-win64-portable-1.0.0.zip ## (Optional) One more step for Reverse Proxy @@ -116,7 +129,6 @@ Unlikely other web apps, Uptime Kuma is based on WebSocket. You need two more he Please read wiki for more info: https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy - ## Videos - [Learn Uptime Kuma in 5 Minutes](https://www.youtube.com/watch?v=muZiPdH2JZ8) by DEVOPS UNLOCKED @@ -197,3 +209,8 @@ https://github.com/yzwijsen/deploy-uptime-kuma-azure Run uptime-kuma with S3 persistent sqlite database: https://github.com/fluential/litestream-uptime-kuma/ + +### Install on Zeabur + +Run with one click on [Zeabur](https://zeabur.com/). +https://docs.zeabur.com/marketplace/umami \ No newline at end of file