From 1a4f5d4bf3ec34a435e82ecb6216206d5ee994d6 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Tue, 3 Jan 2023 13:48:19 +0800 Subject: [PATCH 01/31] Updated Status Page (markdown) --- Status-Page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Status-Page.md b/Status-Page.md index 4f401d7..e68f2c8 100644 --- a/Status-Page.md +++ b/Status-Page.md @@ -3,7 +3,7 @@ - Status page is intended for public users to check the status of your services - Status page will caches result for 60 seconds -- Status page is just like a traditional web page. Update won't be so responsive like the dashboard does. +- Status page is just like a traditional web page. Updates won't be as responsive as the dashboard. - Status page will refresh the page every 5 minutes - `default` is a special slug - `http://example.com/status` is pointing to `http://example.com/status/default` From e5d7e9482da4968b045dedc0d88decf50867ee95 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Tue, 3 Jan 2023 17:43:17 +0800 Subject: [PATCH 02/31] Updated _Sidebar (markdown) --- _Sidebar.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_Sidebar.md b/_Sidebar.md index d1a3b0d..6754173 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -35,3 +35,4 @@ ## More - [Supported Versions](https://github.com/louislam/uptime-kuma/blob/master/SECURITY.md) - [MIT License](https://github.com/louislam/uptime-kuma/blob/master/LICENSE) +- [Videos By Youtubers](https://www.youtube.com/playlist?list=PLjfSRxTTcLFm0mAw3fKNZzieXixScm9th) From da6cd6de12807e797f8ea0ac8aa57db12c5e6225 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Tue, 3 Jan 2023 18:17:56 +0800 Subject: [PATCH 03/31] =?UTF-8?q?Updated=20=F0=9F=86=99=20How=20to=20Updat?= =?UTF-8?q?e=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index 90a9c12..8f69ddc 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.19.2 --force +git checkout 1.19.3 --force # Install dependencies and prebuilt npm install --omit=dev From dfcec91bf6b1e3e9d6c6f4d622359c1399e298aa Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 9 Jan 2023 20:18:04 +0800 Subject: [PATCH 04/31] Updated Status Page (markdown) --- Status-Page.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Status-Page.md b/Status-Page.md index e68f2c8..6d8c29f 100644 --- a/Status-Page.md +++ b/Status-Page.md @@ -2,7 +2,7 @@ ## Things You Should Know - Status page is intended for public users to check the status of your services -- Status page will caches result for 60 seconds +- Status page will caches result for 5 minutes - Status page is just like a traditional web page. Updates won't be as responsive as the dashboard. - Status page will refresh the page every 5 minutes - `default` is a special slug From 3b2dcc5e5539d96c2631febd6d6b027aa862ff11 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 9 Jan 2023 21:00:01 +0800 Subject: [PATCH 05/31] Updated Home (markdown) --- Home.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 978e0f2..388a4f1 100644 --- a/Home.md +++ b/Home.md @@ -48,4 +48,4 @@ https://github.com/louislam/uptime-kuma-wiki * (2022-03-02) Docker Pull is over 25M! 14,050 Stargazers! * (2022-04-10) 15,629 Stargazers! * (2022-10-09) 21,975 Stargazers! Over 20K! Another Milestone!🐻👍 - +* (2023-01-09) {"⭐": 27783, "🐳": 31688853 } From 7114bff08fa301c72d3fa794cef5cc83841406d4 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 9 Jan 2023 21:14:15 +0800 Subject: [PATCH 06/31] =?UTF-8?q?Updated=20=F0=9F=86=99=20How=20to=20Updat?= =?UTF-8?q?e=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index 8f69ddc..ba65c71 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.19.3 --force +git checkout 1.19.4 --force # Install dependencies and prebuilt npm install --omit=dev From 928a2e22fb8056cbe640f8178501bf89be10ada0 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Tue, 17 Jan 2023 20:52:52 +0800 Subject: [PATCH 07/31] Update to 1.19.5 --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index ba65c71..a1cf408 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.19.4 --force +git checkout 1.19.5 --force # Install dependencies and prebuilt npm install --omit=dev From 0dafcd1b6dcddba7f67920f04f34b349b1dd7ace Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Thu, 19 Jan 2023 02:26:47 +0800 Subject: [PATCH 08/31] Update to 1.19.6 --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index a1cf408..890280b 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.19.5 --force +git checkout 1.19.6 --force # Install dependencies and prebuilt npm install --omit=dev From 2ace2fc8e904990f5292b475f0eb036e6d37722a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rio=20Garrido?= <1191102+mariogarridopt@users.noreply.github.com> Date: Wed, 25 Jan 2023 01:02:36 +0000 Subject: [PATCH 09/31] Add plugin to xBarApp for Mac --- 3rd-Party-Addons.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/3rd-Party-Addons.md b/3rd-Party-Addons.md index a90e2e9..7560297 100644 --- a/3rd-Party-Addons.md +++ b/3rd-Party-Addons.md @@ -2,4 +2,5 @@ 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 \ No newline at end of file +- [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 From 45e0aeccd69b74eb9c83829831dfcf952fc35f4b Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 1 Feb 2023 20:12:28 +0800 Subject: [PATCH 10/31] Updated Environment Variables (markdown) --- Environment-Variables.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Environment-Variables.md b/Environment-Variables.md index ec86ec2..56f1547 100644 --- a/Environment-Variables.md +++ b/Environment-Variables.md @@ -1,3 +1,11 @@ +(1.20.0) For non-Docker users, you can create a new file named `.env` in the root directory. The format is like this: + +```.env +UPTIME_KUMA_HOST=127.0.0.1 +UPTIME_KUMA_PORT=8080 +``` + + ## Server Environment Variables | Environment Variable | Server Argument | Description | Default | @@ -7,7 +15,7 @@ | `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_CLOUDFLARED_TOKEN` | `cloudflared-token` | Cloudflare Tunnel Token (Available in 1.14.0) | | +| `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) | | | `NODE_TLS_REJECT_UNAUTHORIZED` | | Ignore all TLS errors | `0` | From 43b158c808d09e01538270bc52326fe29c12dcc1 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 1 Feb 2023 20:18:58 +0800 Subject: [PATCH 11/31] Updated Environment Variables (markdown) --- Environment-Variables.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/Environment-Variables.md b/Environment-Variables.md index 56f1547..cc88dcd 100644 --- a/Environment-Variables.md +++ b/Environment-Variables.md @@ -5,18 +5,22 @@ UPTIME_KUMA_HOST=127.0.0.1 UPTIME_KUMA_PORT=8080 ``` +Server Argument Usage: +```bash +node server/server.js --host=127.0.0.1 --port=8080 +``` ## Server Environment Variables | Environment Variable | Server Argument | Description | Default | | ------------------------------------------ | -------------------------- | --------------------------------------------------------------------- | ---------: | -| `DATA_DIR` | `data-dir` | Set the directory where the data should be stored (could be relative) | `./data/` | -| `UPTIME_KUMA_HOST` or `HOST` | `host` | Host to bind to, could be an ip. | `::` | -| `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_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` | +| `DATA_DIR` | `--data-dir=` | Set the directory where the data should be stored (could be relative) | `./data/` | +| `UPTIME_KUMA_HOST` or `HOST` | `--host=` | Host to bind to, could be an ip. | `::` | +| `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_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) | | | `NODE_TLS_REJECT_UNAUTHORIZED` | | Ignore all TLS errors | `0` | | `NODE_OPTIONS` | | Set it to `--insecure-http-parser`, if you encountered error `Invalid header value char` when your website using WAF | | @@ -33,7 +37,7 @@ UPTIME_KUMA_PORT=8080 | Environment variable | Server argument | Description | Default | | ------------------------------------------ | -------------------------- | --------------------------------------------------------------------- | ---------: | -| `NODE_ENV` | | Set the NodeJS environment flag | production | +| `NODE_ENV` | | Set the NodeJS environment flag. `development`, `production` | production | | `UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID` | | Monitor ID - If provided, it will output the monitor's response to your console | | -| `UPTIME_KUMA_HIDE_LOG` | | (1.15.0) Examples: debug_monitor,info_monitor,debug_cert,warn_monitor | | +| `UPTIME_KUMA_HIDE_LOG` | | (1.15.0) Examples: `debug_monitor,info_monitor,debug_cert,warn_monitor` | | | `SQL_LOG` | | Set `1` to enable | | | From c19ee3e64d9ef3895db7484987a7208ec3b3bcfc Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 1 Feb 2023 20:22:05 +0800 Subject: [PATCH 12/31] Updated _Sidebar (markdown) --- _Sidebar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_Sidebar.md b/_Sidebar.md index 6754173..c0c266d 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -27,7 +27,7 @@ ## Development & Contributions - [CONTRIBUTING Rules & Guide](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md) -- [How to Translation](https://github.com/louislam/uptime-kuma/tree/master/src/languages) +- [How to Translation](https://github.com/louislam/uptime-kuma/tree/master/src/lang) - [Setup Development Environment](https://github.com/louislam/uptime-kuma/wiki/Setup-Development-Environment) - [Test Pull Requests](https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests) - [Development Side Notes](https://github.com/louislam/uptime-kuma/wiki/Development-Side-Notes) From c9accdb654b23595872ca16579ce966b25a79d4c Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 1 Feb 2023 20:22:23 +0800 Subject: [PATCH 13/31] Updated _Sidebar (markdown) --- _Sidebar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_Sidebar.md b/_Sidebar.md index c0c266d..78c16af 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -27,7 +27,7 @@ ## Development & Contributions - [CONTRIBUTING Rules & Guide](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md) -- [How to Translation](https://github.com/louislam/uptime-kuma/tree/master/src/lang) +- [How to Translate](https://github.com/louislam/uptime-kuma/tree/master/src/lang) - [Setup Development Environment](https://github.com/louislam/uptime-kuma/wiki/Setup-Development-Environment) - [Test Pull Requests](https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests) - [Development Side Notes](https://github.com/louislam/uptime-kuma/wiki/Development-Side-Notes) From 874b1623f45c58b5071e52bd65d65a87453b5633 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 1 Feb 2023 20:22:49 +0800 Subject: [PATCH 14/31] Updated _Sidebar (markdown) --- _Sidebar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_Sidebar.md b/_Sidebar.md index 78c16af..75ecd9f 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -27,7 +27,7 @@ ## Development & Contributions - [CONTRIBUTING Rules & Guide](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md) -- [How to Translate](https://github.com/louislam/uptime-kuma/tree/master/src/lang) +- [How to Translate](https://github.com/louislam/uptime-kuma/tree/master/src/lang#how-to-translate) - [Setup Development Environment](https://github.com/louislam/uptime-kuma/wiki/Setup-Development-Environment) - [Test Pull Requests](https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests) - [Development Side Notes](https://github.com/louislam/uptime-kuma/wiki/Development-Side-Notes) From 516eb020471fd82f13226c86641b697d3f43d928 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 6 Feb 2023 16:47:37 +0800 Subject: [PATCH 15/31] Updated Home (markdown) --- Home.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Home.md b/Home.md index 388a4f1..6722830 100644 --- a/Home.md +++ b/Home.md @@ -49,3 +49,4 @@ https://github.com/louislam/uptime-kuma-wiki * (2022-04-10) 15,629 Stargazers! * (2022-10-09) 21,975 Stargazers! Over 20K! Another Milestone!🐻👍 * (2023-01-09) {"⭐": 27783, "🐳": 31688853 } +* (2023-02-06) let starCount = 29141; let dockerPullCount = 32185677; \ No newline at end of file From 7afd35e246c190656e8c950e39fbcf046d77fc3d Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Tue, 7 Feb 2023 17:18:20 +0800 Subject: [PATCH 16/31] Updated Troubleshooting (markdown) --- Troubleshooting.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/Troubleshooting.md b/Troubleshooting.md index 2b50807..fa92ea2 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -5,12 +5,18 @@ If your Uptime Kuma reports DOWN of your service, sometimes you would like to kn Go into your container's bash. -``` +```bash docker exec -it uptime-kuma bash ``` -Then you can test with these commands for example: +Install `curl` + +```bash +apt update && apt --yes install curl ``` + +Then you can test with these commands for example: +```bash curl https://google.com ping google.com ``` From d0935045bb49bed4d6f76015d91a28690931db0e Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Tue, 7 Feb 2023 17:18:59 +0800 Subject: [PATCH 17/31] Updated Troubleshooting (markdown) --- Troubleshooting.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/Troubleshooting.md b/Troubleshooting.md index fa92ea2..7893d78 100644 --- a/Troubleshooting.md +++ b/Troubleshooting.md @@ -20,11 +20,3 @@ Then you can test with these commands for example: curl https://google.com ping google.com ``` - -If running a ping results in a DNS-related error, try configuring your container to run using the host's network. To do this, run the `docker run` command with the `--network="host"` flag. For example: - -``` -docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma --network="host" louislam/uptime-kuma:1 -``` - -More information here: https://docs.docker.com/engine/reference/run/#network-host From 0e2485a5a50f83ce77c706f2f1166dba6bf2840f Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 8 Feb 2023 15:28:14 +0800 Subject: [PATCH 18/31] Updated Environment Variables (markdown) --- Environment-Variables.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Environment-Variables.md b/Environment-Variables.md index cc88dcd..2e5b86a 100644 --- a/Environment-Variables.md +++ b/Environment-Variables.md @@ -41,3 +41,4 @@ node server/server.js --host=127.0.0.1 --port=8080 | `UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID` | | Monitor ID - If provided, it will output the monitor's response to your console | | | `UPTIME_KUMA_HIDE_LOG` | | (1.15.0) Examples: `debug_monitor,info_monitor,debug_cert,warn_monitor` | | | `SQL_LOG` | | Set `1` to enable | | | +| `UPTIME_KUMA_ENABLE_EMBEDDED_MARIADB`| | (2.0.0) Set `1` to enable | | | From f070099e663d3d7ffe0e9b4a7855dd4ab1f7d564 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Mon, 13 Feb 2023 17:33:37 +0800 Subject: [PATCH 19/31] Update to 1.20.0 --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index 890280b..ddf069b 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.19.6 --force +git checkout 1.20.0 --force # Install dependencies and prebuilt npm install --omit=dev From 93ab4a4e6bcdbf21c14bf0a7af9fb06553cd1929 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Tue, 14 Feb 2023 08:52:26 +0800 Subject: [PATCH 20/31] =?UTF-8?q?Updated=20=F0=9F=86=99=20How=20to=20Updat?= =?UTF-8?q?e=20(markdown)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index ddf069b..c13f51e 100644 --- a/🆙-How-to-Update.md +++ b/🆙-How-to-Update.md @@ -37,7 +37,7 @@ git fetch --all git checkout 1.20.0 --force # Install dependencies and prebuilt -npm install --omit=dev +npm install --production npm run download-dist # Restart From ccaa9f47cadc829e0e246136c83266aa0a5002a1 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 15 Feb 2023 03:35:13 +0800 Subject: [PATCH 21/31] Update to 1.20.1 --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index c13f51e..bf2225f 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.0 --force +git checkout 1.20.1 --force # Install dependencies and prebuilt npm install --production From e97fd64eb80fd4d3162489f4cc8699c1ba68e50f Mon Sep 17 00:00:00 2001 From: Matthew Nickson Date: Wed, 15 Feb 2023 22:18:36 +0000 Subject: [PATCH 22/31] Added documentation for louislam/uptime-kuma#2558 Signed-off-by: Matthew Nickson --- APIKeys.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 APIKeys.md diff --git a/APIKeys.md b/APIKeys.md new file mode 100644 index 0000000..381b82a --- /dev/null +++ b/APIKeys.md @@ -0,0 +1,65 @@ +# API Keys + +API keys can be used to access secured HTTP APIs, including the +Prometheus metrics endpoint. + +## Adding an API key + +Management of API keys is done through the API Key management page, +accessible from the drop down menu, just below the maintenance link. This +page will show you all of your API keys, including expired keys. The +green button in the top left can be used to add a new key. + +You can set the name of the key, as well as it's expiry date, or +optionally set the key to never expire. When you click generate, you +will be shown the API key in a pop up dialog, you should make sure to +make a copy of the key as it will not be shown again. The API key cannot +be used to access the web interface but you should treat API keys like +you treat your passwords as they can still be used to access potentially +sensitive data. + +Note: whilst basic authentication will continue to work after you +update, you will be unable to use basic authentication as soon as you +add your first API key. After you have added your first API key, basic +authentication for endpoints will be permanently disabled. + +## Disabling keys + +It is possible to temporarily disable keys. This can be done through the +management page. This will prevent the key from being used for +authentication until it is enabled again. + +## Expired keys + +If a key has expired, it will not be automatically deleted. This is to +aid in debugging systems that suddenly stop working. You can delete an +expired key, or any key for that matter, by simply hitting the red +delete button from the management page. + +## Authenticating using an API key + +Authentication is done by passing the API key in the `Authorization` +header. For example, here is a request made with curl to the `metrics` +endpoint. + +``` +curl -u":" uptime.kuma/metrics +``` + +Note, the `:` is required before the key as basic authentication +requires a username and password separated by a `:`, however we don't +make use of the username field. + +Here is an example config for Prometheus: + +``` + - job_name: 'uptime' + scrape_interval: 30s + scheme: http + static_configs: + - targets: ['uptime.url'] + basic_auth: + password: +``` + +Note: we don't need to set a password field as it is not used. From 9e521ea8da64733d427f2e18d7854f0794981e03 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sat, 25 Feb 2023 00:23:55 +0800 Subject: [PATCH 23/31] Created API Keys (markdown) --- API-Keys.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 API-Keys.md diff --git a/API-Keys.md b/API-Keys.md new file mode 100644 index 0000000..f2c0e74 --- /dev/null +++ b/API-Keys.md @@ -0,0 +1,2 @@ +(>= 1.21.0) +(Not Available yet) From 788923ec28503d5b669078eee7eb0617da441546 Mon Sep 17 00:00:00 2001 From: Yannick Zwijsen Date: Fri, 24 Feb 2023 18:28:49 +0100 Subject: [PATCH 24/31] add Azure AppService with persistent storage --- 🔧-How-to-Install.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/🔧-How-to-Install.md b/🔧-How-to-Install.md index e6dbf0d..63a443d 100644 --- a/🔧-How-to-Install.md +++ b/🔧-How-to-Install.md @@ -181,6 +181,11 @@ https://haci.io/posts/uptime-kuma-azure-container-instance/ Unofficial tutorial by Leandro: https://www.leandroscardua.com/blog/deploy-uptime-kuma-on-azure/ +### Install on Azure AppService with persistent storage + +Unofficial bicep deployment script by Yannick Zwijsen: +https://github.com/yzwijsen/deploy-uptime-kuma-azure + ### SQLite S3 persistent storage with Litestream.io [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/UfDasl?referralCode=373) From 892a67b055eb333077b38d7b72e4a49fac603e1e Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sun, 26 Feb 2023 17:13:41 +0800 Subject: [PATCH 25/31] Update to 1.20.2 --- 🆙-How-to-Update.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/🆙-How-to-Update.md b/🆙-How-to-Update.md index bf2225f..0b1ddb1 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.1 --force +git checkout 1.20.2 --force # Install dependencies and prebuilt npm install --production From 954d985cd5098788af4afbae36e4ac1590722dbb Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Sun, 26 Feb 2023 18:13:23 +0800 Subject: [PATCH 26/31] Updated Home (markdown) --- Home.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index 6722830..c476384 100644 --- a/Home.md +++ b/Home.md @@ -49,4 +49,5 @@ https://github.com/louislam/uptime-kuma-wiki * (2022-04-10) 15,629 Stargazers! * (2022-10-09) 21,975 Stargazers! Over 20K! Another Milestone!🐻👍 * (2023-01-09) {"⭐": 27783, "🐳": 31688853 } -* (2023-02-06) let starCount = 29141; let dockerPullCount = 32185677; \ No newline at end of file +* (2023-02-06) let starCount = 29141; let dockerPullCount = 32185677; +* (2023-02-26) `
30,063
32,606,170
` \ No newline at end of file From 28158ca06bd6eb1c641de4f94f2f216faedbc108 Mon Sep 17 00:00:00 2001 From: Matthew Nickson Date: Sun, 26 Feb 2023 18:19:31 +0000 Subject: [PATCH 27/31] Updated API Key docs to match new UI Updated the API Key docs to match the UI changes made in 11fa690e0915b9be166b861cf704c76db864e59d Signed-off-by: Matthew Nickson --- APIKeys.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/APIKeys.md b/APIKeys.md index 381b82a..654fe84 100644 --- a/APIKeys.md +++ b/APIKeys.md @@ -5,10 +5,8 @@ Prometheus metrics endpoint. ## Adding an API key -Management of API keys is done through the API Key management page, -accessible from the drop down menu, just below the maintenance link. This -page will show you all of your API keys, including expired keys. The -green button in the top left can be used to add a new key. +Management of API keys is done through the API Keys page in settings +This page will show you all of your API keys, including expired keys. You can set the name of the key, as well as it's expiry date, or optionally set the key to never expire. When you click generate, you @@ -26,7 +24,7 @@ authentication for endpoints will be permanently disabled. ## Disabling keys It is possible to temporarily disable keys. This can be done through the -management page. This will prevent the key from being used for +settings page. This will prevent the key from being used for authentication until it is enabled again. ## Expired keys @@ -34,7 +32,7 @@ authentication until it is enabled again. If a key has expired, it will not be automatically deleted. This is to aid in debugging systems that suddenly stop working. You can delete an expired key, or any key for that matter, by simply hitting the red -delete button from the management page. +delete button from the settings page. ## Authenticating using an API key From 01237b4fa9166877ed736fd5e7b9fdd08d48ca55 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Thu, 2 Mar 2023 16:45:54 +0800 Subject: [PATCH 28/31] Rename --- APIKeys.md => API-Keys.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename APIKeys.md => API-Keys.md (100%) diff --git a/APIKeys.md b/API-Keys.md similarity index 100% rename from APIKeys.md rename to API-Keys.md From 705b78e014714ef7fe108e90b80db51beac05db5 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Thu, 2 Mar 2023 16:47:57 +0800 Subject: [PATCH 29/31] Update --- API-Keys.md | 1 + _Sidebar.md | 1 + 2 files changed, 2 insertions(+) diff --git a/API-Keys.md b/API-Keys.md index 654fe84..879371b 100644 --- a/API-Keys.md +++ b/API-Keys.md @@ -1,4 +1,5 @@ # API Keys +(Version >= 1.21.0) API keys can be used to access secured HTTP APIs, including the Prometheus metrics endpoint. diff --git a/_Sidebar.md b/_Sidebar.md index 6754173..0c21e97 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -14,6 +14,7 @@ - [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) +- [API Keys](https://github.com/louislam/uptime-kuma/wiki/API-Keys) ## Network - [Reverse Proxy](https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy) From 5e33fa667dff0023230c5554bdb3d6127e364155 Mon Sep 17 00:00:00 2001 From: Matthew Nickson Date: Fri, 3 Mar 2023 21:56:12 +0000 Subject: [PATCH 30/31] Fixed which field isn't set for API key auth Signed-off-by: Matthew Nickson --- API-Keys.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API-Keys.md b/API-Keys.md index 879371b..60e935e 100644 --- a/API-Keys.md +++ b/API-Keys.md @@ -61,4 +61,4 @@ Here is an example config for Prometheus: password: ``` -Note: we don't need to set a password field as it is not used. +Note: we don't need to set a username field as it is not used. From a8135e8c85c985764cd96b0b6f7b3028a0cf2def Mon Sep 17 00:00:00 2001 From: Raymond Hackley Date: Tue, 7 Mar 2023 10:41:06 +0000 Subject: [PATCH 31/31] OpenRC-Script.md: initialize kuma.db - Initialize `kuma.db` if missing, and fix `$directory/data/kuma.db\*` created during `start_pre()` at first run - Merge log files, and fix `$log_dir/*.log` created during `start_pre()` at first run - Fix typo --- OpenRC-Script.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/OpenRC-Script.md b/OpenRC-Script.md index 8874c83..0465960 100644 --- a/OpenRC-Script.md +++ b/OpenRC-Script.md @@ -11,8 +11,9 @@ directory=${directory:-/usr/share/uptime-kuma} pidfile=${pidfile:-/run/$RC_SVCNAME.pid} log_dir="/var/log/$RC_SVCNAME" -output_log="${output_log:-$log_dir/output.log}" -error_log="${error_log:-$log_dir/error.log}" +logfile=${logfile:-$log_dir/$RC_SVCNAME.log} +output_log="${output_log:-$logfile}" +error_log="${error_log:-$logfile}" command=${command:-/usr/bin/node} command_args="$directory/server/server.js" @@ -27,9 +28,12 @@ start_pre() { checkpath --owner=$command_user --directory $log_dir \ $directory/data \ $directory/data/upload - checkpath --owner=$command_user --file $log_dir/*.log \ + checkpath --owner=$command_user --file $logfile \ $directory/data/error.log + [ ! -e $directory/data/kuma.db ] && + cp $directory/db/kuma.db $directory/data/ + checkpath --owner=$command_user --mode 600 --file $directory/data/kuma.db* } @@ -52,14 +56,7 @@ sudo addgroup -S uptime-kuma sudo adduser -S -D -h /var/lib/uptime-kuma -s /sbin/nologin -G uptime-kuma -g uptime-kuma uptime-kuma ``` -If the database is not initialized, it has to be run fisrt. - -```sh -cd /usr/share/uptime-kuma -sudo -u uptime-kuma node server/server.js -``` - -Start the service and add it to default runlevel if prefered. +Start the service and add it to default runlevel if preferred. ```sh sudo rc-service uptime-kuma start