ric/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2025-02-25 04:55:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge remote-tracking branch 'production/master'

Louis Lam 2023-05-10 22:56:38 +08:00
commit 772724ae24
7 changed files with 26 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
3rd-Party-Addons-Apps.md Normal file

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

6
3rd-Party-Addons.md

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

1
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_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_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_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_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` | | `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) | | | `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) | |

2
Home.md

@ -1,7 +1,5 @@
Welcome to the Uptime Kuma wiki! Welcome to the Uptime Kuma wiki!
This wiki is also available on https://uptime.kuma.pet/docs/
## 🐻? ## 🐻?
Kuma (クマ/熊) means bear 🐻 in Japanese. Kuma (クマ/熊) means bear 🐻 in Japanese.

2
_Sidebar.md

@ -13,7 +13,7 @@
- [Badge](https://github.com/louislam/uptime-kuma/wiki/Badge) - [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) - [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) - [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) - [API Keys](https://github.com/louislam/uptime-kuma/wiki/API-Keys)
## Network ## Network

2
🆙-How-to-Update.md

@ -34,7 +34,7 @@ cd <uptime-kuma-directory>
# Update from git # Update from git
git fetch --all git fetch --all
git checkout 1.20.2 --force git checkout 1.21.3 --force
# Install dependencies and prebuilt # Install dependencies and prebuilt
npm install --production npm install --production

18
🔧-How-to-Install.md

@ -49,6 +49,11 @@ docker run -d --restart=always -p <YOUR_PORT>:3001 -v <YOUR_DIR OR VOLUME>:/app/
</tbody> </tbody>
</table> </table>
### 🐳 Docker Compose Example
https://github.com/louislam/uptime-kuma/blob/master/docker/docker-compose.yml
### 💪🏻 Without Docker (Recommended for x86/x64 only) ### 💪🏻 Without Docker (Recommended for x86/x64 only)
It should supports Linux/Windows/MacOS. It should supports Linux/Windows/MacOS.
@ -97,9 +102,17 @@ pm2 restart uptime-kuma
pm2 startup 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 ## (Optional) One more step for Reverse Proxy
@ -110,7 +123,6 @@ Unlikely other web apps, Uptime Kuma is based on WebSocket. You need two more he
Please read wiki for more info: Please read wiki for more info:
https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy
## Videos ## Videos
- [Learn Uptime Kuma in 5 Minutes](https://www.youtube.com/watch?v=muZiPdH2JZ8) by DEVOPS UNLOCKED - [Learn Uptime Kuma in 5 Minutes](https://www.youtube.com/watch?v=muZiPdH2JZ8) by DEVOPS UNLOCKED