Merge branch 'master' into push-status-param

# Conflicts:
#	server/routers/api-router.js

.dockerignore

@@ -28,6 +28,8 @@ SECURITY.md
 tsconfig.json
 .env
 /tmp
+/babel.config.js
+/ecosystem.config.js
 
 ### .gitignore content (commented rules are duplicated)
 
@@ -42,4 +44,6 @@ dist-ssr
 #!/data/.gitkeep
 #.vscode
 
+
+
 ### End of .gitignore content

.eslintrc.js

@@ -1,4 +1,9 @@
 module.exports = {
+    ignorePatterns: [
+        "test/*",
+        "server/modules/apicache/*",
+        "src/util.js"
+    ],
     root: true,
     env: {
         browser: true,
@@ -17,39 +22,48 @@ module.exports = {
         requireConfigFile: false,
     },
     rules: {
-        "linebreak-style": ["error", "unix"],
-        "camelcase": ["warn", {
+        "yoda": "error",
+        eqeqeq: [ "warn", "smart" ],
+        "linebreak-style": [ "error", "unix" ],
+        "camelcase": [ "warn", {
             "properties": "never",
             "ignoreImports": true
         }],
-        // override/add rules settings here, such as:
-        // 'vue/no-unused-vars': 'error'
-        "no-unused-vars": "warn",
+        "no-unused-vars": [ "warn", {
+            "args": "none"
+        }],
         indent: [
             "error",
             4,
             {
-                ignoredNodes: ["TemplateLiteral"],
+                ignoredNodes: [ "TemplateLiteral" ],
                 SwitchCase: 1,
             },
         ],
-        quotes: ["warn", "double"],
-        semi: "warn",
-        "vue/html-indent": ["warn", 4], // default: 2
+        quotes: [ "error", "double" ],
+        semi: "error",
+        "vue/html-indent": [ "error", 4 ], // default: 2
         "vue/max-attributes-per-line": "off",
         "vue/singleline-html-element-content-newline": "off",
         "vue/html-self-closing": "off",
+        "vue/require-component-is": "off",      // not allow is="style" https://github.com/vuejs/eslint-plugin-vue/issues/462#issuecomment-430234675
         "vue/attribute-hyphenation": "off",     // This change noNL to "no-n-l" unexpectedly
-        "no-multi-spaces": ["error", {
+        "vue/multi-word-component-names": "off",
+        "no-multi-spaces": [ "error", {
             ignoreEOLComments: true,
         }],
-        "space-before-function-paren": ["error", {
+        "array-bracket-spacing": [ "warn", "always", {
+            "singleValue": true,
+            "objectsInArrays": false,
+            "arraysInArrays": false
+        }],
+        "space-before-function-paren": [ "error", {
             "anonymous": "always",
             "named": "never",
             "asyncArrow": "always"
         }],
         "curly": "error",
-        "object-curly-spacing": ["error", "always"],
+        "object-curly-spacing": [ "error", "always" ],
         "object-curly-newline": "off",
         "object-property-newline": "error",
         "comma-spacing": "error",
@@ -59,37 +73,37 @@ module.exports = {
         "keyword-spacing": "warn",
         "space-infix-ops": "warn",
         "arrow-spacing": "warn",
-        "no-trailing-spaces": "warn",
-        "no-constant-condition": ["error", {
+        "no-trailing-spaces": "error",
+        "no-constant-condition": [ "error", {
             "checkLoops": false,
         }],
         "space-before-blocks": "warn",
         //'no-console': 'warn',
         "no-extra-boolean-cast": "off",
-        "no-multiple-empty-lines": ["warn", {
+        "no-multiple-empty-lines": [ "warn", {
             "max": 1,
             "maxBOF": 0,
         }],
-        "lines-between-class-members": ["warn", "always", {
+        "lines-between-class-members": [ "warn", "always", {
             exceptAfterSingleLine: true,
         }],
         "no-unneeded-ternary": "error",
-        "array-bracket-newline": ["error", "consistent"],
-        "eol-last": ["error", "always"],
+        "array-bracket-newline": [ "error", "consistent" ],
+        "eol-last": [ "error", "always" ],
         //'prefer-template': 'error',
-        "comma-dangle": ["warn", "only-multiline"],
-        "no-empty": ["error", {
+        "comma-dangle": [ "warn", "only-multiline" ],
+        "no-empty": [ "error", {
             "allowEmptyCatch": true
         }],
         "no-control-regex": "off",
-        "one-var": ["error", "never"],
-        "max-statements-per-line": ["error", { "max": 1 }]
+        "one-var": [ "error", "never" ],
+        "max-statements-per-line": [ "error", { "max": 1 }]
     },
     "overrides": [
         {
             "files": [ "src/languages/*.js", "src/icon.js" ],
             "rules": {
-                "comma-dangle": ["error", "always-multiline"],
+                "comma-dangle": [ "error", "always-multiline" ],
             }
         },
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,10 +4,10 @@ Fixes #(issue)
 
 ## Type of change
 
-Please delete options that are not relevant.
+Please delete any options that are not relevant.
 
 - Bug fix (non-breaking change which fixes an issue)
-- User Interface
+- User interface (UI)
 - New feature (non-breaking change which adds functionality)
 - Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - Translation update
@@ -18,8 +18,9 @@ Please delete options that are not relevant.
 
 - [ ] My code follows the style guidelines of this project
 - [ ] I ran ESLint and other linters for modified files
-- [ ] I have performed a self-review of my own code and test it
+- [ ] I have performed a self-review of my own code and tested it
 - [ ] I have commented my code, particularly in hard-to-understand areas
+  (including JSDoc for methods)
 - [ ] My changes generate no new warnings
 - [ ] My code needed automated testing. I have added them (this is optional task)
 

.github/workflows/auto-test.yml

@@ -16,16 +16,17 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest]
-        node-version: [14.x, 16.x, 17.x]
+        node: [14, 16, 17]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v2
+    - run: git config --global core.autocrlf false  # Mainly for Windows
+    - uses: actions/checkout@v3
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+    - name: Use Node.js ${{ matrix.node }}
+      uses: actions/setup-node@v3
       with:
-        node-version: ${{ matrix.node-version }}
+        node-version: ${{ matrix.node }}
         cache: 'npm'
     - run: npm run install-legacy
     - run: npm run build
@@ -33,3 +34,17 @@ jobs:
       env:
         HEADLESS_TEST: 1
         JUST_FOR_TEST: ${{ secrets.JUST_FOR_TEST }}
+  check-linters:
+    runs-on: ubuntu-latest
+
+    steps:
+    - run: git config --global core.autocrlf false  # Mainly for Windows
+    - uses: actions/checkout@v3
+
+    - name: Use Node.js LTS
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16
+        cache: 'npm'
+    - run: npm run install-legacy
+    - run: npm run lint

.github/workflows/stale-bot.yml

@@ -1,22 +0,0 @@
-name: 'Automatically close stale issues and PRs'
-on:
-  schedule:
-    - cron: '0 0 * * *'
-#Run once a day at midnight 
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v4
-        with:
-          stale-issue-message: 'We are clearing up our old issues and your ticket has been open for 6 months with no activity. Remove stale label or comment or this will be closed in 7 days.'
-          stale-pr-message: 'We are clearing up our old Pull Requests and yours has been open for 6 months with no activity. Remove stale label or comment or this will be closed in 7 days.'
-          close-issue-message: 'This issue was closed because it has been stalled for 7 days with no activity.'
-          close-pr-message: 'This PR was closed because it has been stalled for 7 days with no activity.'
-          days-before-stale: 180
-          days-before-close: 7
-          exempt-issue-labels: 'News,Medium,High,discussion,bug,doc,'
-          exempt-pr-labels: 'awaiting-approval,work-in-progress,enhancement,'
-          exempt-issue-assignees: 'louislam'
-          exempt-pr-assignees: 'louislam'

.npmrc

@@ -0,0 +1 @@
+legacy-peer-deps=true

.stylelintrc

@@ -1,9 +1,13 @@
 {
     "extends": "stylelint-config-standard",
+    "customSyntax": "postcss-html",
     "rules": {
         "indentation": 4,
         "no-descending-specificity": null,
         "selector-list-comma-newline-after": null,
-        "declaration-empty-line-before": null
+        "declaration-empty-line-before": null,
+        "alpha-value-notation": "number",
+        "color-function-notation": "legacy",
+        "shorthand-property-no-redundant-values": null
     }
 }

CONTRIBUTING.md

@@ -27,12 +27,25 @@ The frontend code build into "dist" directory. The server (express.js) exposes t
 
 ## Can I create a pull request for Uptime Kuma?
 
-Generally, if the pull request is working fine, and it does not affect any existing logic, workflow and performance, I will merge into the master branch once it is tested.
+⚠️ 2022-03-02 Update:
 
-If you are not sure whether I will accept your pull request, feel free to create an empty pull request draft first.
+Since I found that merging pull requests is a pretty heavy task for me, I try to rearrange it.
+
+✅ Accept:
+- Bug/Security fix
+- Translations
+- Adding notification providers
+
+❌ Avoid:
+- Large pull requests
+- New big features
+
+My long story here: https://www.reddit.com/r/UptimeKuma/comments/t1t6or/comment/hynyijx/
 
 ### Recommended Pull Request Guideline
 
+Before deep into coding, discussion first is preferred. Creating an empty pull request for discussion would be recommended.
+
 1. Fork the project
 1. Clone your fork repo to local
 1. Create a new branch
@@ -42,42 +55,7 @@ If you are not sure whether I will accept your pull request, feel free to create
 1. Create a pull request: https://github.com/louislam/uptime-kuma/compare
 1. Write a proper description
 1. Click "Change to draft"
-
-### Pull Request Examples
-
-Here are some example situations in the past.
-
-#### ✅ High - Medium Priority
-
-Easy to review, no breaking change and not touching the existing code
-
-- Add a new notification
-- Add a chart
-- Fix a bug
-- Translations
-- Add a independent new feature
-
-#### *️⃣ Requires one more reviewer
-
-I do not have such knowledge to test it.
-
-- Add k8s supports
-
-#### ⚠ Low Priority - Harsh Mode
-
-Some pull requests are required to modify the core. To be honest, I do not want anyone to try to do that, because it would spend a lot of your time. I will review your pull request harshly. Also, you may need to write a lot of unit tests to ensure that there is no breaking change.
-
-- Touch large parts of code of any very important features
-- Touch monitoring logic
-- Drop a table or drop a column for any reason
-- Touch the entry point of Docker or Node.js
-- Modify auth
-
-#### *️⃣ Low Priority
-
-It changed my current workflow and require further studies.
-
-- Change my release approach
+1. Discussion
 
 #### ❌ Won't Merge
 
@@ -101,6 +79,7 @@ I personally do not like something need to learn so much and need to config so m
 - 4 spaces indentation
 - Follow `.editorconfig`
 - Follow ESLint
+- Methods and functions should be documented with JSDoc
 
 ## Name convention
 
@@ -111,9 +90,10 @@ I personally do not like something need to learn so much and need to config so m
 ## Tools
 
 - Node.js >= 14
+- NPM >= 8.5
 - Git
 - IDE that supports ESLint and EditorConfig (I am using IntelliJ IDEA)
-- A SQLite tool (SQLite Expert Personal is suggested)
+- A SQLite GUI tool (SQLite Expert Personal is suggested)
 
 ## Install dependencies
 
@@ -121,39 +101,45 @@ I personally do not like something need to learn so much and need to config so m
 npm ci
 ```
 
-## How to start the Backend Dev Server
+## Dev Server
 
-(2021-09-23 Update)
+(2022-04-26 Update)
+
+We can start the frontend dev server and the backend dev server in one command.
+
+Port `3000` and port `3001` will be used.
 
 ```bash
-npm run start-server-dev
+npm run dev
 ```
 
-It binds to `0.0.0.0:3001` by default.
+## Backend Server
 
-### Backend Details
+For development, it binds to `0.0.0.0:3001` by default.
+For production, it binds to  `0.0.0.0:3000` by default.
 
 It is mainly a socket.io app + express.js.
 
-express.js is just used for serving the frontend built files (index.html, .js and .css etc.)
+express.js is used for: 
+- entry point such as redirecting to a status page or the dashboard
+- serving the frontend built files (index.html, .js and .css etc.)
+- serving internal APIs of status page
+
+
+### Structure in /server/
 
 - model/ (Object model, auto mapping to the database table name)
 - modules/ (Modified 3rd-party modules)
 - notification-providers/ (individual notification logic)
 - routers/ (Express Routers)
 - socket-handler (Socket.io Handlers)
-- server.js (Server main logic)
+- server.js (Server entry point and main logic)
 
-## How to start the Frontend Dev Server
+## Frontend Dev Server
 
-1. Set the env var `NODE_ENV` to "development".
-2. Start the frontend dev server by the following command.
+It binds to `0.0.0.0:3000` by default. Frontend dev server is used for development only. 
 
-   ```bash
-   npm run dev
-   ```
-
-   It binds to `0.0.0.0:3000` by default.
+For production, it is not used. It will be compiled to `dist` directory instead. 
 
 You can use Vue.js devtools Chrome extension for debugging.
 
@@ -221,14 +207,13 @@ https://github.com/louislam/uptime-kuma/issues?q=sort%3Aupdated-desc
 ### Release Procedures
 
 1. Draft a release note
-1. Make sure the repo is cleared
-1. `npm run update-version 1.X.X`
-1. `npm run build`
-1. `npm run build-docker`
-1. `git push`
-1. Publish the release note as 1.X.X 
-1. `npm run upload-artifacts`
-1. SSH to demo site server and update to 1.X.X
+2. Make sure the repo is cleared
+3. `npm run release-final with env vars: `VERSION` and `GITHUB_TOKEN`
+4. Wait until the `Press any key to continue`
+5. `git push`
+6. Publish the release note as 1.X.X 
+7. Press any key to continue
+8. SSH to demo site server and update to 1.X.X
 
 Checking:
 
@@ -236,6 +221,15 @@ Checking:
 - Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 / armv7)
 - Try clean installation with Node.js
 
+### Release Beta Procedures
+
+1. Draft a release note, check "This is a pre-release"
+2. Make sure the repo is cleared
+3. `npm run release-beta` with env vars: `VERSION` and `GITHUB_TOKEN`
+4. Wait until the `Press any key to continue`
+5. Publish the release note as 1.X.X-beta.X
+6. Press any key to continue
+
 ### Release Wiki
 
 #### Setup Repo

README.md

@@ -25,19 +25,21 @@ VPS is sponsored by Uptime Kuma sponsors on [Open Collective](https://opencollec
 
 * Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / Ping / DNS Record / Push / Steam Game Server.
 * Fancy, Reactive, Fast UI/UX.
-* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [70+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications).
+* 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/languages)
-* Simple Status Page
+* Multiple Status Pages
+* Map Status Page to Domain
 * Ping Chart
 * Certificate Info
+* Proxy Support
+* 2FA available
 
 ## 🔧 How to Install
 
 ### 🐳 Docker
 
 ```bash
-docker volume create uptime-kuma
 docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
 ```
 
@@ -47,7 +49,10 @@ Browse to http://localhost:3001 after starting.
 
 ### 💪🏻 Non-Docker
 
-Required Tools: Node.js >= 14, git and pm2.
+Required Tools: 
+- [Node.js](https://nodejs.org/en/download/) >= 14
+- [Git](https://git-scm.com/downloads) 
+- [pm2](https://pm2.keymetrics.io/) - For run in background
 
 ```bash
 # Update your npm to the latest version
@@ -61,12 +66,26 @@ npm run setup
 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 start server/server.js --name uptime-kuma
-```
+# 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
+
+```bash
+# 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:
@@ -93,7 +112,7 @@ https://github.com/louislam/uptime-kuma/projects/1
 
 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)
 
-<img src="https://uptime.kuma.pet/sponsors?v=3" alt />
+<img src="https://uptime.kuma.pet/sponsors?v=6" alt />
 
 ## 🖼 More Screenshots
 
@@ -115,7 +134,7 @@ 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 unmaintained.
+* 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.
@@ -138,10 +157,17 @@ https://www.reddit.com/r/UptimeKuma/
 
 ## Contribute
 
-If you want to report a bug or request a new feature. Free feel to open a [new issue](https://github.com/louislam/uptime-kuma/issues).
+### 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](https://github.com/louislam/uptime-kuma/issues).
+
+### Translations
 If you want to translate Uptime Kuma into your language, please read: https://github.com/louislam/uptime-kuma/tree/master/src/languages
 
-If you want to modify Uptime Kuma, this guideline may be useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md
+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.
 
-English proofreading is needed too because my grammar is not that great, sadly. Feel free to correct my grammar in this README, source code, or wiki.
+### Pull Requests
+If you want to modify Uptime Kuma, this guideline may be useful for you: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md

SECURITY.md

@@ -13,10 +13,7 @@ currently being supported with security updates.
 
 ### Uptime Kuma Versions
 
-| Version | Supported          |
-| ------- | ------------------ |
-| 1.9.X  | :white_check_mark: |
-| <= 1.8.X  | ❌ |
+You should use or upgrade to the latest version of Uptime Kuma. All `1.X.X` versions are upgradable to the lastest version.
 
 ### Upgradable Docker Tags
 
@@ -24,8 +21,8 @@ currently being supported with security updates.
 | ------- | ------------------ |
 | 1 | :white_check_mark: |
 | 1-debian | :white_check_mark: |
-| 1-alpine | :white_check_mark: |
 | latest | :white_check_mark: |
 | debian | :white_check_mark: |
-| alpine | :white_check_mark: |
+| 1-alpine | ⚠️ Deprecated |
+| alpine | ⚠️ Deprecated |
 | All other tags  | ❌ |

babel.config.js

@@ -1,11 +1,11 @@
 const config = {};
 
 if (process.env.TEST_FRONTEND) {
-    config.presets = ["@babel/preset-env"];
+    config.presets = [ "@babel/preset-env" ];
 }
 
 if (process.env.TEST_BACKEND) {
-    config.plugins = ["babel-plugin-rewire"];
+    config.plugins = [ "babel-plugin-rewire" ];
 }
 
 module.exports = config;

config/vite.config.js

@@ -10,15 +10,15 @@ export default defineConfig({
     plugins: [
         vue(),
         legacy({
-            targets: ["ie > 11"],
-            additionalLegacyPolyfills: ["regenerator-runtime/runtime"]
+            targets: [ "ie > 11" ],
+            additionalLegacyPolyfills: [ "regenerator-runtime/runtime" ]
         })
     ],
     css: {
         postcss: {
             "parser": postCssScss,
             "map": false,
-            "plugins": [postcssRTLCSS]
+            "plugins": [ postcssRTLCSS ]
         }
     },
 });

db/patch-added-mqtt-monitor.sql

@@ -0,0 +1,16 @@
+-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.
+BEGIN TRANSACTION;
+
+ALTER TABLE monitor
+	ADD mqtt_topic TEXT;
+
+ALTER TABLE monitor
+	ADD mqtt_success_message VARCHAR(255);
+
+ALTER TABLE monitor
+	ADD mqtt_username VARCHAR(255);
+
+ALTER TABLE monitor
+	ADD mqtt_password VARCHAR(255);
+
+COMMIT;

db/patch-monitor-expiry-notification.sql

@@ -0,0 +1,7 @@
+-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.
+BEGIN TRANSACTION;
+
+ALTER TABLE monitor
+    ADD expiry_notification BOOLEAN default 1;
+
+COMMIT;

db/patch-proxy.sql

@@ -0,0 +1,23 @@
+-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.
+BEGIN TRANSACTION;
+
+CREATE TABLE proxy (
+    id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    user_id INT NOT NULL,
+    protocol VARCHAR(10) NOT NULL,
+    host VARCHAR(255) NOT NULL,
+    port SMALLINT NOT NULL,
+    auth BOOLEAN NOT NULL,
+    username VARCHAR(255) NULL,
+    password VARCHAR(255) NULL,
+    active BOOLEAN NOT NULL DEFAULT 1,
+    'default' BOOLEAN NOT NULL DEFAULT 0,
+    created_date DATETIME DEFAULT (DATETIME('now')) NOT NULL
+);
+
+ALTER TABLE monitor ADD COLUMN proxy_id INTEGER REFERENCES proxy(id);
+
+CREATE INDEX proxy_id ON monitor (proxy_id);
+CREATE INDEX proxy_user_id ON proxy (user_id);
+
+COMMIT;

db/patch-status-page-footer-css.sql

@@ -0,0 +1,6 @@
+-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.
+BEGIN TRANSACTION;
+ALTER TABLE status_page ADD footer_text TEXT;
+ALTER TABLE status_page ADD custom_css TEXT;
+ALTER TABLE status_page ADD show_powered_by BOOLEAN NOT NULL DEFAULT 1;
+COMMIT;

db/patch-status-page.sql

@@ -0,0 +1,31 @@
+-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.
+BEGIN TRANSACTION;
+
+CREATE TABLE [status_page](
+    [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+    [slug] VARCHAR(255) NOT NULL UNIQUE,
+    [title] VARCHAR(255) NOT NULL,
+    [description] TEXT,
+    [icon] VARCHAR(255) NOT NULL,
+    [theme] VARCHAR(30) NOT NULL,
+    [published] BOOLEAN NOT NULL DEFAULT 1,
+    [search_engine_index] BOOLEAN NOT NULL DEFAULT 1,
+    [show_tags] BOOLEAN NOT NULL DEFAULT 0,
+    [password] VARCHAR,
+    [created_date] DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    [modified_date] DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+
+CREATE UNIQUE INDEX [slug] ON [status_page]([slug]);
+
+
+CREATE TABLE [status_page_cname](
+    [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+    [status_page_id] INTEGER NOT NULL REFERENCES [status_page]([id]) ON DELETE CASCADE ON UPDATE CASCADE,
+    [domain] VARCHAR NOT NULL UNIQUE
+);
+
+ALTER TABLE incident ADD status_page_id INTEGER;
+ALTER TABLE [group] ADD status_page_id INTEGER;
+
+COMMIT;

docker/alpine-base.dockerfile

@@ -1,8 +1,8 @@
 # DON'T UPDATE TO alpine3.13, 1.14, see #41.
-FROM node:14-alpine3.12
+FROM node:16-alpine3.12
 WORKDIR /app
 
 # Install apprise, iputils for non-root ping, setpriv
 RUN apk add --no-cache iputils setpriv dumb-init python3 py3-cryptography py3-pip py3-six py3-yaml py3-click py3-markdown py3-requests py3-requests-oauthlib && \
-    pip3 --no-cache-dir install apprise==0.9.6 && \
+    pip3 --no-cache-dir install apprise==0.9.8 && \
     rm -rf /root/.cache

docker/debian-base.dockerfile

@@ -1,12 +1,26 @@
 # DON'T UPDATE TO node:14-bullseye-slim, see #372.
 # If the image changed, the second stage image should be changed too
-FROM node:14-buster-slim
+FROM node:16-buster-slim
+ARG TARGETPLATFORM
+
 WORKDIR /app
 
+# Install Curl
 # Install Apprise, add sqlite3 cli for debugging in the future, iputils-ping for ping, util-linux for setpriv
 # Stupid python3 and python3-pip actually install a lot of useless things into Debian, specify --no-install-recommends to skip them, make the base even smaller than alpine!
 RUN apt update && \
     apt --yes --no-install-recommends install python3 python3-pip python3-cryptography python3-six python3-yaml python3-click python3-markdown python3-requests python3-requests-oauthlib \
         sqlite3 iputils-ping util-linux dumb-init && \
-    pip3 --no-cache-dir install apprise==0.9.6 && \
+    pip3 --no-cache-dir install apprise==0.9.8 && \
     rm -rf /var/lib/apt/lists/*
+
+# Install cloudflared
+# dpkg --add-architecture arm: cloudflared do not provide armhf, this is workaround. Read more: https://github.com/cloudflare/cloudflared/issues/583
+COPY extra/download-cloudflared.js ./extra/download-cloudflared.js
+RUN node ./extra/download-cloudflared.js $TARGETPLATFORM && \
+    dpkg --add-architecture arm && \
+    apt update && \
+    apt --yes --no-install-recommends install ./cloudflared.deb && \
+    rm -rf /var/lib/apt/lists/* && \
+    rm -f cloudflared.deb
+

docker/docker-compose.yml

@@ -5,9 +5,10 @@ version: '3.3'
 
 services:
   uptime-kuma:
-    image: louislam/uptime-kuma
+    image: louislam/uptime-kuma:1
     container_name: uptime-kuma
     volumes:
       - ./uptime-kuma:/app/data
     ports:
       - 3001:3001
+    restart: always

ecosystem.config.js

@@ -1,6 +1,6 @@
 module.exports = {
-  apps: [{
-    name: "uptime-kuma",
-    script: "./server/server.js",
-  }]
-}
+    apps: [{
+        name: "uptime-kuma",
+        script: "./server/server.js",
+    }]
+};

extra/beta/update-version.js

@@ -0,0 +1,66 @@
+const pkg = require("../../package.json");
+const fs = require("fs");
+const childProcess = require("child_process");
+const util = require("../../src/util");
+
+util.polyfill();
+
+const version = process.env.VERSION;
+
+console.log("Beta Version: " + version);
+
+if (!version || !version.includes("-beta.")) {
+    console.error("invalid version, beta version only");
+    process.exit(1);
+}
+
+const exists = tagExists(version);
+
+if (! exists) {
+    // Process package.json
+    pkg.version = version;
+    fs.writeFileSync("package.json", JSON.stringify(pkg, null, 4) + "\n");
+
+    // Also update package-lock.json
+    childProcess.spawnSync("npm", [ "install" ]);
+
+    commit(version);
+    tag(version);
+
+} else {
+    console.log("version tag exists, please delete the tag or use another tag");
+    process.exit(1);
+}
+
+function commit(version) {
+    let msg = "Update to " + version;
+
+    let res = childProcess.spawnSync("git", [ "commit", "-m", msg, "-a" ]);
+    let stdout = res.stdout.toString().trim();
+    console.log(stdout);
+
+    if (stdout.includes("no changes added to commit")) {
+        throw new Error("commit error");
+    }
+
+    res = childProcess.spawnSync("git", [ "push", "origin", "master" ]);
+    console.log(res.stdout.toString().trim());
+}
+
+function tag(version) {
+    let res = childProcess.spawnSync("git", [ "tag", version ]);
+    console.log(res.stdout.toString().trim());
+
+    res = childProcess.spawnSync("git", [ "push", "origin", version ]);
+    console.log(res.stdout.toString().trim());
+}
+
+function tagExists(version) {
+    if (! version) {
+        throw new Error("invalid version");
+    }
+
+    let res = childProcess.spawnSync("git", [ "tag", "-l", version ]);
+
+    return res.stdout.toString().trim() === version;
+}

extra/close-incorrect-issue.js

@@ -29,7 +29,7 @@ const github = require("@actions/github");
                 owner: issue.owner,
                 repo: issue.repo,
                 issue_number: issue.number,
-                labels: ["invalid-format"]
+                labels: [ "invalid-format" ]
             });
 
             // Add the issue closing comment
@@ -37,7 +37,7 @@ const github = require("@actions/github");
                 owner: issue.owner,
                 repo: issue.repo,
                 issue_number: issue.number,
-                body: `@${username}: Hello! :wave:\n\nThis issue is being automatically closed because it does not follow the issue template. Please DO NOT open a blank issue`
+                body: `@${username}: Hello! :wave:\n\nThis issue is being automatically closed because it does not follow the issue template. Please DO NOT open a blank issue.`
             });
 
             // Close the issue

extra/download-cloudflared.js

@@ -0,0 +1,44 @@
+//
+
+const http = require("https"); // or 'https' for https:// URLs
+const fs = require("fs");
+
+const platform = process.argv[2];
+
+if (!platform) {
+    console.error("No platform??");
+    process.exit(1);
+}
+
+let arch = null;
+
+if (platform === "linux/amd64") {
+    arch = "amd64";
+} else if (platform === "linux/arm64") {
+    arch = "arm64";
+} else if (platform === "linux/arm/v7") {
+    arch = "arm";
+} else {
+    console.error("Invalid platform?? " + platform);
+}
+
+const file = fs.createWriteStream("cloudflared.deb");
+get("https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-" + arch + ".deb");
+
+function get(url) {
+    http.get(url, function (res) {
+        if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
+            console.log("Redirect to " + res.headers.location);
+            get(res.headers.location);
+        } else if (res.statusCode >= 200 && res.statusCode < 300) {
+            res.pipe(file);
+
+            res.on("end", function () {
+                console.log("Downloaded");
+            });
+        } else {
+            console.error(res.statusCode);
+            process.exit(1);
+        }
+    });
+}

extra/download-dist.js

@@ -4,6 +4,7 @@ const tar = require("tar");
 
 const packageJSON = require("../package.json");
 const fs = require("fs");
+const rmSync = require("./fs-rmSync.js");
 const version = packageJSON.version;
 
 const filename = "dist.tar.gz";
@@ -11,6 +12,12 @@ const filename = "dist.tar.gz";
 const url = `https://github.com/louislam/uptime-kuma/releases/download/${version}/${filename}`;
 download(url);
 
+/**
+ * Downloads the latest version of the dist from a GitHub release.
+ * @param {string} url The URL to download from.
+ *
+ * Generated by Trelent
+ */
 function download(url) {
     console.log(url);
 
@@ -21,7 +28,7 @@ function download(url) {
             if (fs.existsSync("./dist")) {
 
                 if (fs.existsSync("./dist-backup")) {
-                    fs.rmdirSync("./dist-backup", {
+                    rmSync("./dist-backup", {
                         recursive: true
                     });
                 }
@@ -35,7 +42,7 @@ function download(url) {
 
             tarStream.on("close", () => {
                 if (fs.existsSync("./dist-backup")) {
-                    fs.rmdirSync("./dist-backup", {
+                    rmSync("./dist-backup", {
                         recursive: true
                     });
                 }

extra/env2arg.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+const childProcess = require("child_process");
+let env = process.env;
+
+let cmd = process.argv[2];
+let args = process.argv.slice(3);
+let replacedArgs = [];
+
+for (let arg of args) {
+    for (let key in env) {
+        arg = arg.replaceAll(`$${key}`, env[key]);
+    }
+    replacedArgs.push(arg);
+}
+
+let child = childProcess.spawn(cmd, replacedArgs);
+child.stdout.pipe(process.stdout);
+child.stderr.pipe(process.stderr);

extra/fs-rmSync.js

@@ -0,0 +1,23 @@
+const fs = require("fs");
+/**
+ * Detect if `fs.rmSync` is available
+ * to avoid the runtime deprecation warning triggered for using `fs.rmdirSync` with `{ recursive: true }` in Node.js v16,
+ * or the `recursive` property removing completely in the future Node.js version.
+ * See the link below.
+ *
+ * @todo Once we drop the support for Node.js v14 (or at least versions before v14.14.0), we can safely replace this function with `fs.rmSync`, since `fs.rmSync` was add in Node.js v14.14.0 and currently we supports all the Node.js v14 versions that include the versions before the v14.14.0, and this function have almost the same signature with `fs.rmSync`.
+ * @link https://nodejs.org/docs/latest-v16.x/api/deprecations.html#dep0147-fsrmdirpath--recursive-true- the deprecation infomation of `fs.rmdirSync`
+ * @link https://nodejs.org/docs/latest-v16.x/api/fs.html#fsrmsyncpath-options the document of `fs.rmSync`
+ * @param {fs.PathLike} path Valid types for path values in "fs".
+ * @param {fs.RmDirOptions} [options] options for `fs.rmdirSync`, if `fs.rmSync` is available and property `recursive` is true, it will automatically have property `force` with value `true`.
+ */
+const rmSync = (path, options) => {
+    if (typeof fs.rmSync === "function") {
+        if (options.recursive) {
+            options.force = true;
+        }
+        return fs.rmSync(path, options);
+    }
+    return fs.rmdirSync(path, options);
+};
+module.exports = rmSync;

extra/healthcheck.js

@@ -20,7 +20,7 @@ if (sslKey && sslCert) {
 // Dual-stack support for (::)
 let hostname = process.env.UPTIME_KUMA_HOST;
 
-// Also read HOST if not FreeBSD, as HOST is a system environment variable in FreeBSD
+// Also read HOST if not *BSD, as HOST is a system environment variable in FreeBSD
 if (!hostname && !FBSD) {
     hostname = process.env.HOST;
 }

extra/install.batsh

@@ -189,7 +189,7 @@ if (type == "local") {
    bash("check=$(pm2 --version)");
    if (check == "") {
        println("Installing PM2");
-       bash("npm install pm2 -g");
+       bash("npm install pm2 -g && pm2 install pm2-logrotate");
        bash("pm2 startup");
    }
 

extra/mark-as-nightly.js

@@ -4,21 +4,21 @@ const util = require("../src/util");
 
 util.polyfill();
 
-const oldVersion = pkg.version
-const newVersion = oldVersion + "-nightly"
+const oldVersion = pkg.version;
+const newVersion = oldVersion + "-nightly";
 
-console.log("Old Version: " + oldVersion)
-console.log("New Version: " + newVersion)
+console.log("Old Version: " + oldVersion);
+console.log("New Version: " + newVersion);
 
 if (newVersion) {
     // Process package.json
-    pkg.version = newVersion
-    pkg.scripts.setup = pkg.scripts.setup.replaceAll(oldVersion, newVersion)
-    pkg.scripts["build-docker"] = pkg.scripts["build-docker"].replaceAll(oldVersion, newVersion)
-    fs.writeFileSync("package.json", JSON.stringify(pkg, null, 4) + "\n")
+    pkg.version = newVersion;
+    pkg.scripts.setup = pkg.scripts.setup.replaceAll(oldVersion, newVersion);
+    pkg.scripts["build-docker"] = pkg.scripts["build-docker"].replaceAll(oldVersion, newVersion);
+    fs.writeFileSync("package.json", JSON.stringify(pkg, null, 4) + "\n");
 
     // Process README.md
     if (fs.existsSync("README.md")) {
-        fs.writeFileSync("README.md", fs.readFileSync("README.md", "utf8").replaceAll(oldVersion, newVersion))
+        fs.writeFileSync("README.md", fs.readFileSync("README.md", "utf8").replaceAll(oldVersion, newVersion));
     }
 }

extra/press-any-key.js

@@ -0,0 +1,6 @@
+console.log("Git Push and Publish the release note on github, then press any key to continue");
+
+process.stdin.setRawMode(true);
+process.stdin.resume();
+process.stdin.on("data", process.exit.bind(process, 0));
+

extra/reset-password.js

@@ -1,11 +1,10 @@
 console.log("== Uptime Kuma Reset Password Tool ==");
 
-console.log("Loading the database");
-
 const Database = require("../server/database");
 const { R } = require("redbean-node");
 const readline = require("readline");
 const { initJWTSecret } = require("../server/util-server");
+const User = require("../server/model/user");
 const args = require("args-parser")(process.argv);
 const rl = readline.createInterface({
     input: process.stdin,
@@ -13,8 +12,9 @@ const rl = readline.createInterface({
 });
 
 const main = async () => {
+    console.log("Connecting the database");
     Database.init(args);
-    await Database.connect();
+    await Database.connect(false, false, true);
 
     try {
         // No need to actually reset the password for testing, just make sure no connection problem. It is ok for now.
@@ -31,7 +31,7 @@ const main = async () => {
                 let confirmPassword = await question("Confirm New Password: ");
 
                 if (password === confirmPassword) {
-                    await user.resetPassword(password);
+                    await User.resetPassword(user.id, password);
 
                     // Reset all sessions by reset jwt secret
                     await initJWTSecret();

extra/simple-dns-server.js

@@ -26,7 +26,7 @@ server.on("request", (request, send, rinfo) => {
                     ttl: 300,
                     address: "1.2.3.4"
                 });
-            } if (question.type === Packet.TYPE.AAAA) {
+            } else if (question.type === Packet.TYPE.AAAA) {
                 response.answers.push({
                     name: question.name,
                     type: question.type,

extra/simple-mqtt-server.js

@@ -0,0 +1,50 @@
+const { log } = require("../src/util");
+
+const mqttUsername = "louis1";
+const mqttPassword = "!@#$LLam";
+
+class SimpleMqttServer {
+    aedes = require("aedes")();
+    server = require("net").createServer(this.aedes.handle);
+
+    constructor(port) {
+        this.port = port;
+    }
+
+    start() {
+        this.server.listen(this.port, () => {
+            console.log("server started and listening on port ", this.port);
+        });
+    }
+}
+
+let server1 = new SimpleMqttServer(10000);
+
+server1.aedes.authenticate = function (client, username, password, callback) {
+    if (username && password) {
+        console.log(password.toString("utf-8"));
+        callback(null, username === mqttUsername && password.toString("utf-8") === mqttPassword);
+    } else {
+        callback(null, false);
+    }
+};
+
+server1.aedes.on("subscribe", (subscriptions, client) => {
+    console.log(subscriptions);
+
+    for (let s of subscriptions) {
+        if (s.topic === "test") {
+            server1.aedes.publish({
+                topic: "test",
+                payload: Buffer.from("ok"),
+            }, (error) => {
+                if (error) {
+                    log.error("mqtt_server", error);
+                }
+            });
+        }
+    }
+
+});
+
+server1.start();

extra/update-language-files/index.js

@@ -3,6 +3,7 @@
 import fs from "fs";
 import path from "path";
 import util from "util";
+import rmSync from "../fs-rmSync.js";
 
 // https://stackoverflow.com/questions/13786160/copy-folder-recursively-in-node-js
 /**
@@ -30,7 +31,7 @@ console.log("Arguments:", process.argv);
 const baseLangCode = process.argv[2] || "en";
 console.log("Base Lang: " + baseLangCode);
 if (fs.existsSync("./languages")) {
-    fs.rmdirSync("./languages", { recursive: true });
+    rmSync("./languages", { recursive: true });
 }
 copyRecursiveSync("../../src/languages", "./languages");
 
@@ -40,7 +41,7 @@ const files = fs.readdirSync("./languages");
 console.log("Files:", files);
 
 for (const file of files) {
-    if (!file.endsWith(".js")) {
+    if (! file.endsWith(".js")) {
         console.log("Skipping " + file);
         continue;
     }
@@ -82,5 +83,5 @@ for (const file of files) {
     fs.writeFileSync(`../../src/languages/${file}`, code);
 }
 
-fs.rmdirSync("./languages", { recursive: true });
+rmSync("./languages", { recursive: true });
 console.log("Done. Fixing formatting by ESLint...");

extra/update-version.js

@@ -1,14 +1,12 @@
 const pkg = require("../package.json");
 const fs = require("fs");
-const child_process = require("child_process");
+const childProcess = require("child_process");
 const util = require("../src/util");
 
 util.polyfill();
 
-const oldVersion = pkg.version;
-const newVersion = process.argv[2];
+const newVersion = process.env.VERSION;
 
-console.log("Old Version: " + oldVersion);
 console.log("New Version: " + newVersion);
 
 if (! newVersion) {
@@ -22,25 +20,31 @@ if (! exists) {
 
     // Process package.json
     pkg.version = newVersion;
-    pkg.scripts.setup = pkg.scripts.setup.replaceAll(oldVersion, newVersion);
-    pkg.scripts["build-docker"] = pkg.scripts["build-docker"].replaceAll(oldVersion, newVersion);
-    pkg.scripts["build-docker-alpine"] = pkg.scripts["build-docker-alpine"].replaceAll(oldVersion, newVersion);
-    pkg.scripts["build-docker-debian"] = pkg.scripts["build-docker-debian"].replaceAll(oldVersion, newVersion);
+
+    // Replace the version: https://regex101.com/r/hmj2Bc/1
+    pkg.scripts.setup = pkg.scripts.setup.replace(/(git checkout )([^\s]+)/, `$1${newVersion}`);
     fs.writeFileSync("package.json", JSON.stringify(pkg, null, 4) + "\n");
 
+    // Also update package-lock.json
+    childProcess.spawnSync("npm", [ "install" ]);
+
     commit(newVersion);
     tag(newVersion);
 
-    updateWiki(oldVersion, newVersion);
-
 } else {
     console.log("version exists");
 }
 
+/**
+ * Updates the version number in package.json and commits it to git.
+ * @param {string} version - The new version number
+ *
+ * Generated by Trelent
+ */
 function commit(version) {
-    let msg = "update to " + version;
+    let msg = "Update to " + version;
 
-    let res = child_process.spawnSync("git", ["commit", "-m", msg, "-a"]);
+    let res = childProcess.spawnSync("git", [ "commit", "-m", msg, "-a" ]);
     let stdout = res.stdout.toString().trim();
     console.log(stdout);
 
@@ -50,51 +54,22 @@ function commit(version) {
 }
 
 function tag(version) {
-    let res = child_process.spawnSync("git", ["tag", version]);
+    let res = childProcess.spawnSync("git", [ "tag", version ]);
     console.log(res.stdout.toString().trim());
 }
 
+/**
+ * Checks if a given version is already tagged in the git repository.
+ * @param {string} version - The version to check for.
+ *
+ * Generated by Trelent
+ */
 function tagExists(version) {
     if (! version) {
         throw new Error("invalid version");
     }
 
-    let res = child_process.spawnSync("git", ["tag", "-l", version]);
+    let res = childProcess.spawnSync("git", [ "tag", "-l", version ]);
 
     return res.stdout.toString().trim() === version;
 }
-
-function updateWiki(oldVersion, newVersion) {
-    const wikiDir = "./tmp/wiki";
-    const howToUpdateFilename = "./tmp/wiki/🆙-How-to-Update.md";
-
-    safeDelete(wikiDir);
-
-    child_process.spawnSync("git", ["clone", "https://github.com/louislam/uptime-kuma.wiki.git", wikiDir]);
-    let content = fs.readFileSync(howToUpdateFilename).toString();
-    content = content.replaceAll(`git checkout ${oldVersion}`, `git checkout ${newVersion}`);
-    fs.writeFileSync(howToUpdateFilename, content);
-
-    child_process.spawnSync("git", ["add", "-A"], {
-        cwd: wikiDir,
-    });
-
-    child_process.spawnSync("git", ["commit", "-m", `Update to ${newVersion} from ${oldVersion}`], {
-        cwd: wikiDir,
-    });
-
-    console.log("Pushing to Github");
-    child_process.spawnSync("git", ["push"], {
-        cwd: wikiDir,
-    });
-
-    safeDelete(wikiDir);
-}
-
-function safeDelete(dir) {
-    if (fs.existsSync(dir)) {
-        fs.rmdirSync(dir, {
-            recursive: true,
-        });
-    }
-}

extra/update-wiki-version.js

@@ -0,0 +1,48 @@
+const childProcess = require("child_process");
+const fs = require("fs");
+
+const newVersion = process.env.VERSION;
+
+if (!newVersion) {
+    console.log("Missing version");
+    process.exit(1);
+}
+
+updateWiki(newVersion);
+
+function updateWiki(newVersion) {
+    const wikiDir = "./tmp/wiki";
+    const howToUpdateFilename = "./tmp/wiki/🆙-How-to-Update.md";
+
+    safeDelete(wikiDir);
+
+    childProcess.spawnSync("git", [ "clone", "https://github.com/louislam/uptime-kuma.wiki.git", wikiDir ]);
+    let content = fs.readFileSync(howToUpdateFilename).toString();
+
+    // Replace the version: https://regex101.com/r/hmj2Bc/1
+    content = content.replace(/(git checkout )([^\s]+)/, `$1${newVersion}`);
+    fs.writeFileSync(howToUpdateFilename, content);
+
+    childProcess.spawnSync("git", [ "add", "-A" ], {
+        cwd: wikiDir,
+    });
+
+    childProcess.spawnSync("git", [ "commit", "-m", `Update to ${newVersion}` ], {
+        cwd: wikiDir,
+    });
+
+    console.log("Pushing to Github");
+    childProcess.spawnSync("git", [ "push" ], {
+        cwd: wikiDir,
+    });
+
+    safeDelete(wikiDir);
+}
+
+function safeDelete(dir) {
+    if (fs.existsSync(dir)) {
+        fs.rmdirSync(dir, {
+            recursive: true,
+        });
+    }
+}

install.sh

@@ -159,7 +159,7 @@ fi
   check=$(pm2 --version)
   if [ "$check" == "" ]; then
     "echo" "-e" "Installing PM2"
-    npm install pm2 -g
+    npm install pm2 -g && pm2 install pm2-logrotate
     pm2 startup  
 fi
   mkdir -p $installPath

package.json

@@ -1,6 +1,6 @@
 {
     "name": "uptime-kuma",
-    "version": "1.11.1",
+    "version": "1.15.0",
     "license": "MIT",
     "repository": {
         "type": "git",
@@ -13,9 +13,12 @@
         "install-legacy": "npm install --legacy-peer-deps",
         "update-legacy": "npm update --legacy-peer-deps",
         "lint:js": "eslint --ext \".js,.vue\" --ignore-path .gitignore .",
+        "lint-fix:js": "eslint --ext \".js,.vue\" --fix --ignore-path .gitignore .",
         "lint:style": "stylelint \"**/*.{vue,css,scss}\" --ignore-path .gitignore",
+        "lint-fix:style": "stylelint \"**/*.{vue,css,scss}\" --fix --ignore-path .gitignore",
         "lint": "npm run lint:js && npm run lint:style",
-        "dev": "vite --host --config ./config/vite.config.js",
+        "dev": "concurrently -k -r \"wait-on tcp:3000 && npm run start-server-dev \" \"npm run start-frontend-dev\"",
+        "start-frontend-dev": "cross-env NODE_ENV=development vite --host --config ./config/vite.config.js",
         "start": "npm run start-server",
         "start-server": "node server/server.js",
         "start-server-dev": "cross-env NODE_ENV=development node server/server.js",
@@ -27,18 +30,17 @@
         "jest-backend": "cross-env TEST_BACKEND=1 jest --config=./config/jest-backend.config.js",
         "tsc": "tsc",
         "vite-preview-dist": "vite preview --host --config ./config/vite.config.js",
-        "build-docker": "npm run build-docker-debian && npm run build-docker-alpine",
+        "build-docker": "npm run build && npm run build-docker-debian && npm run build-docker-alpine",
         "build-docker-alpine-base": "docker buildx build -f docker/alpine-base.dockerfile --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:base-alpine . --push",
         "build-docker-debian-base": "docker buildx build -f docker/debian-base.dockerfile --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:base-debian . --push",
-        "build-docker-alpine": "docker buildx build -f docker/dockerfile-alpine --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:alpine -t louislam/uptime-kuma:1-alpine -t louislam/uptime-kuma:1.11.1-alpine --target release . --push",
-        "build-docker-debian": "docker buildx build -f docker/dockerfile --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma -t louislam/uptime-kuma:1 -t louislam/uptime-kuma:1.11.1 -t louislam/uptime-kuma:debian -t louislam/uptime-kuma:1-debian -t louislam/uptime-kuma:1.11.1-debian --target release . --push",
-        "build-docker-nightly": "docker buildx build -f docker/dockerfile --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:nightly --target nightly . --push",
+        "build-docker-alpine": "node ./extra/env2arg.js docker buildx build -f docker/dockerfile-alpine --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:alpine -t louislam/uptime-kuma:1-alpine -t louislam/uptime-kuma:$VERSION-alpine --target release . --push",
+        "build-docker-debian": "node ./extra/env2arg.js docker buildx build -f docker/dockerfile --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma -t louislam/uptime-kuma:1 -t louislam/uptime-kuma:$VERSION -t louislam/uptime-kuma:debian -t louislam/uptime-kuma:1-debian -t louislam/uptime-kuma:$VERSION-debian --target release . --push",
+        "build-docker-nightly": "npm run build && docker buildx build -f docker/dockerfile --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:nightly --target nightly . --push",
         "build-docker-nightly-alpine": "docker buildx build -f docker/dockerfile-alpine --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:nightly-alpine --target nightly . --push",
         "build-docker-nightly-amd64": "docker buildx build -f docker/dockerfile --platform linux/amd64 -t louislam/uptime-kuma:nightly-amd64 --target nightly . --push --progress plain",
         "upload-artifacts": "docker buildx build -f docker/dockerfile --platform linux/amd64 -t louislam/uptime-kuma:upload-artifact --build-arg VERSION --build-arg GITHUB_TOKEN --target upload-artifact . --progress plain",
-        "setup": "git checkout 1.11.1 && npm ci --production && npm run download-dist",
+        "setup": "git checkout 1.15.0 && npm ci --production && npm run download-dist",
         "download-dist": "node extra/download-dist.js",
-        "update-version": "node extra/update-version.js",
         "mark-as-nightly": "node extra/mark-as-nightly.js",
         "reset-password": "node extra/reset-password.js",
         "remove-2fa": "node extra/remove-2fa.js",
@@ -49,86 +51,103 @@
         "test-install-script-ubuntu1604": "npm run compile-install-script && docker build --progress plain -f test/test_install_script/ubuntu1604.dockerfile .",
         "test-nodejs16": "docker build --progress plain -f test/ubuntu-nodejs16.dockerfile .",
         "simple-dns-server": "node extra/simple-dns-server.js",
+        "simple-mqtt-server": "node extra/simple-mqtt-server.js",
         "update-language-files-with-base-lang": "cd extra/update-language-files && node index.js %npm_config_base_lang% && eslint ../../src/languages/**.js --fix",
         "update-language-files": "cd extra/update-language-files && node index.js && eslint ../../src/languages/**.js --fix",
-        "ncu-patch": "ncu -u -t patch"
+        "ncu-patch": "npm-check-updates -u -t patch",
+        "release-final": "node extra/update-version.js && npm run build-docker && node ./extra/press-any-key.js && npm run upload-artifacts && node ./extra/update-wiki-version.js",
+        "release-beta": "node extra/beta/update-version.js && npm run build && node ./extra/env2arg.js docker buildx build -f docker/dockerfile --platform linux/amd64,linux/arm64,linux/arm/v7 -t louislam/uptime-kuma:$VERSION -t louislam/uptime-kuma:beta .  --target release --push && node ./extra/press-any-key.js && npm run upload-artifacts",
+        "git-remove-tag": "git tag -d"
     },
     "dependencies": {
         "@fortawesome/fontawesome-svg-core": "~1.2.36",
         "@fortawesome/free-regular-svg-icons": "~5.15.4",
         "@fortawesome/free-solid-svg-icons": "~5.15.4",
         "@fortawesome/vue-fontawesome": "~3.0.0-5",
-        "@louislam/sqlite3": "~6.0.1",
+        "@louislam/sqlite3": "~15.0.3",
         "@popperjs/core": "~2.10.2",
         "args-parser": "~1.3.0",
-        "axios": "~0.21.4",
+        "axios": "~0.26.1",
         "bcryptjs": "~2.4.3",
         "bootstrap": "5.1.3",
-        "bree": "~7.1.0",
+        "bree": "~7.1.5",
         "chardet": "^1.3.0",
-        "chart.js": "~3.6.0",
+        "chart.js": "~3.6.2",
         "chartjs-adapter-dayjs": "~1.0.0",
-        "check-password-strength": "^2.0.3",
+        "check-password-strength": "^2.0.5",
         "command-exists": "~1.2.9",
         "compare-versions": "~3.6.0",
-        "dayjs": "~1.10.7",
-        "express": "~4.17.1",
-        "express-basic-auth": "~1.2.0",
+        "dayjs": "~1.10.8",
+        "express": "~4.17.3",
+        "express-basic-auth": "~1.2.1",
+        "favico.js": "^0.3.10",
         "form-data": "~4.0.0",
-        "http-graceful-shutdown": "~3.1.5",
+        "http-graceful-shutdown": "~3.1.7",
+        "http-proxy-agent": "^5.0.0",
+        "https-proxy-agent": "^5.0.0",
         "iconv-lite": "^0.6.3",
         "jsonwebtoken": "~8.5.1",
         "jwt-decode": "^3.1.2",
         "limiter": "^2.1.0",
+        "mqtt": "^4.2.8",
+        "node-cloudflared-tunnel": "~1.0.9",
         "nodemailer": "~6.6.5",
         "notp": "~2.0.3",
         "password-hash": "~1.2.2",
         "postcss-rtlcss": "~3.4.1",
-        "postcss-scss": "~4.0.2",
+        "postcss-scss": "~4.0.3",
+        "prismjs": "^1.27.0",
         "prom-client": "~13.2.0",
-        "prometheus-api-metrics": "~3.2.0",
+        "prometheus-api-metrics": "~3.2.1",
         "qrcode": "~1.5.0",
         "redbean-node": "0.1.3",
-        "socket.io": "~4.2.0",
-        "socket.io-client": "~4.2.0",
+        "socket.io": "~4.4.1",
+        "socket.io-client": "~4.4.1",
+        "socks-proxy-agent": "^6.1.1",
         "tar": "^6.1.11",
         "tcp-ping": "~0.1.1",
         "thirty-two": "~1.0.2",
         "timezones-list": "~3.0.1",
         "v-pagination-3": "~0.1.7",
         "vue": "next",
-        "vue-chart-3": "~0.5.11",
+        "vue-chart-3": "3.0.9",
         "vue-confirm-dialog": "~1.0.2",
         "vue-contenteditable": "~3.0.4",
         "vue-i18n": "~9.1.9",
         "vue-image-crop-upload": "~3.0.3",
         "vue-multiselect": "~3.0.0-alpha.2",
+        "vue-prism-editor": "^2.0.0-alpha.2",
         "vue-qrcode": "~1.0.0",
-        "vue-router": "~4.0.12",
+        "vue-router": "~4.0.14",
         "vue-toastification": "~2.0.0-rc.5",
         "vuedraggable": "~4.1.0"
     },
     "devDependencies": {
-        "@actions/github": "~5.0.0",
-        "@babel/eslint-parser": "~7.15.8",
+        "@actions/github": "~5.0.1",
+        "@babel/eslint-parser": "~7.17.0",
         "@babel/preset-env": "^7.15.8",
-        "@types/bootstrap": "~5.1.6",
-        "@vitejs/plugin-legacy": "~1.6.3",
+        "@types/bootstrap": "~5.1.9",
+        "@vitejs/plugin-legacy": "~1.6.4",
         "@vitejs/plugin-vue": "~1.9.4",
-        "@vue/compiler-sfc": "~3.2.22",
+        "@vue/compiler-sfc": "~3.2.31",
+        "aedes": "^0.46.3",
         "babel-plugin-rewire": "~1.2.0",
+        "concurrently": "^7.1.0",
         "core-js": "~3.18.3",
         "cross-env": "~7.0.3",
         "dns2": "~2.0.1",
-        "eslint": "~7.32.0",
-        "eslint-plugin-vue": "~7.18.0",
+        "eslint": "~8.14.0",
+        "eslint-plugin-vue": "~8.7.1",
         "jest": "~27.2.5",
-        "jest-puppeteer": "~6.0.0",
-        "puppeteer": "~10.4.0",
+        "jest-puppeteer": "~6.0.3",
+        "npm-check-updates": "^12.5.9",
+        "postcss-html": "^1.3.1",
+        "puppeteer": "~13.1.3",
         "sass": "~1.42.1",
-        "stylelint": "~13.13.1",
-        "stylelint-config-standard": "~22.0.0",
+        "stylelint": "~14.7.1",
+        "stylelint-config-standard": "~25.0.0",
         "typescript": "~4.4.4",
-        "vite": "~2.6.14"
+        "vite": "~2.6.14",
+        "wait-on": "^6.0.1"
     }
 }

server/2fa.js

@@ -1,8 +1,12 @@
-const { checkLogin } = require("./util-server");
 const { R } = require("redbean-node");
 
 class TwoFA {
 
+    /**
+     * Disable 2FA for specified user
+     * @param {number} userID ID of user to disable
+     * @returns {Promise<void>}
+     */
     static async disable2FA(userID) {
         return await R.exec("UPDATE `user` SET twofa_status = 0 WHERE id = ? ", [
             userID,

server/auth.js

@@ -2,16 +2,19 @@ const basicAuth = require("express-basic-auth");
 const passwordHash = require("./password-hash");
 const { R } = require("redbean-node");
 const { setting } = require("./util-server");
-const { debug } = require("../src/util");
 const { loginRateLimiter } = require("./rate-limiter");
 
 /**
- *
- * @param username : string
- * @param password : string
- * @returns {Promise<Bean|null>}
+ * Login to web app
+ * @param {string} username
+ * @param {string} password
+ * @returns {Promise<(Bean|null)>}
  */
 exports.login = async function (username, password) {
+    if (typeof username !== "string" || typeof password !== "string") {
+        return null;
+    }
+
     let user = await R.findOne("user", " username = ? AND active = 1 ", [
         username,
     ]);
@@ -30,32 +33,48 @@ exports.login = async function (username, password) {
     return null;
 };
 
-function myAuthorizer(username, password, callback) {
-    setting("disableAuth").then((result) => {
-        if (result) {
-            callback(null, true);
-        } else {
-            // Login Rate Limit
-            loginRateLimiter.pass(null, 0).then((pass) => {
-                if (pass) {
-                    exports.login(username, password).then((user) => {
-                        callback(null, user != null);
+/**
+ * Callback for myAuthorizer
+ * @callback myAuthorizerCB
+ * @param {any} err Any error encountered
+ * @param {boolean} authorized Is the client authorized?
+ */
 
-                        if (user == null) {
-                            loginRateLimiter.removeTokens(1);
-                        }
-                    });
-                } else {
-                    callback(null, false);
+/**
+ * Custom authorizer for express-basic-auth
+ * @param {string} username
+ * @param {string} password
+ * @param {myAuthorizerCB} callback
+ */
+function myAuthorizer(username, password, callback) {
+    // Login Rate Limit
+    loginRateLimiter.pass(null, 0).then((pass) => {
+        if (pass) {
+            exports.login(username, password).then((user) => {
+                callback(null, user != null);
+
+                if (user == null) {
+                    loginRateLimiter.removeTokens(1);
                 }
             });
-
+        } else {
+            callback(null, false);
         }
     });
 }
 
-exports.basicAuth = basicAuth({
-    authorizer: myAuthorizer,
-    authorizeAsync: true,
-    challenge: true,
-});
+exports.basicAuth = async function (req, res, next) {
+    const middleware = basicAuth({
+        authorizer: myAuthorizer,
+        authorizeAsync: true,
+        challenge: true,
+    });
+
+    const disabledAuth = await setting("disableAuth");
+
+    if (!disabledAuth) {
+        middleware(req, res, next);
+    } else {
+        next();
+    }
+};

server/check-version.js

@@ -1,11 +1,13 @@
-const { setSetting } = require("./util-server");
+const { setSetting, setting } = require("./util-server");
 const axios = require("axios");
+const compareVersions = require("compare-versions");
 
 exports.version = require("../package.json").version;
 exports.latestVersion = null;
 
 let interval;
 
+/** Start 48 hour check interval */
 exports.startInterval = () => {
     let check = async () => {
         try {
@@ -16,6 +18,19 @@ exports.startInterval = () => {
                 res.data.slow = "1000.0.0";
             }
 
+            if (await setting("checkUpdate") === false) {
+                return;
+            }
+
+            let checkBeta = await setting("checkBeta");
+
+            if (checkBeta && res.data.beta) {
+                if (compareVersions.compare(res.data.beta, res.data.beta, ">")) {
+                    exports.latestVersion = res.data.beta;
+                    return;
+                }
+            }
+
             if (res.data.slow) {
                 exports.latestVersion = res.data.slow;
             }
@@ -28,6 +43,11 @@ exports.startInterval = () => {
     interval = setInterval(check, 3600 * 1000 * 48);
 };
 
+/**
+ * Enable the check update feature
+ * @param {boolean} value Should the check update feature be enabled?
+ * @returns {Promise<void>}
+ */
 exports.enableCheckUpdate = async (value) => {
     await setSetting("checkUpdate", value);
 

server/client.js

@@ -3,10 +3,16 @@
  */
 const { TimeLogger } = require("../src/util");
 const { R } = require("redbean-node");
-const { io } = require("./server");
+const { UptimeKumaServer } = require("./uptime-kuma-server");
+const io = UptimeKumaServer.getInstance().io;
 const { setting } = require("./util-server");
 const checkVersion = require("./check-version");
 
+/**
+ * Send list of notification providers to client
+ * @param {Socket} socket Socket.io socket instance
+ * @returns {Promise<Bean[]>}
+ */
 async function sendNotificationList(socket) {
     const timeLogger = new TimeLogger();
 
@@ -28,8 +34,11 @@ async function sendNotificationList(socket) {
 
 /**
  * Send Heartbeat History list to socket
- * @param toUser  True = send to all browsers with the same user id, False = send to the current browser only
- * @param overwrite Overwrite client-side's heartbeat list
+ * @param {Socket} socket Socket.io instance
+ * @param {number} monitorID ID of monitor to send heartbeat history
+ * @param {boolean} [toUser=false]  True = send to all browsers with the same user id, False = send to the current browser only
+ * @param {boolean} [overwrite=false] Overwrite client-side's heartbeat list
+ * @returns {Promise<void>}
  */
 async function sendHeartbeatList(socket, monitorID, toUser = false, overwrite = false) {
     const timeLogger = new TimeLogger();
@@ -55,11 +64,12 @@ async function sendHeartbeatList(socket, monitorID, toUser = false, overwrite =
 }
 
 /**
- *  Important Heart beat list (aka event list)
- * @param socket
- * @param monitorID
- * @param toUser  True = send to all browsers with the same user id, False = send to the current browser only
- * @param overwrite Overwrite client-side's heartbeat list
+ * Important Heart beat list (aka event list)
+ * @param {Socket} socket Socket.io instance
+ * @param {number} monitorID ID of monitor to send heartbeat history
+ * @param {boolean} [toUser=false]  True = send to all browsers with the same user id, False = send to the current browser only
+ * @param {boolean} [overwrite=false] Overwrite client-side's heartbeat list
+ * @returns {Promise<void>}
  */
 async function sendImportantHeartbeatList(socket, monitorID, toUser = false, overwrite = false) {
     const timeLogger = new TimeLogger();
@@ -83,6 +93,27 @@ async function sendImportantHeartbeatList(socket, monitorID, toUser = false, ove
 
 }
 
+/**
+ * Emit proxy list to client
+ * @param {Socket} socket Socket.io socket instance
+ * @return {Promise<Bean[]>}
+ */
+async function sendProxyList(socket) {
+    const timeLogger = new TimeLogger();
+
+    const list = await R.find("proxy", " user_id = ? ", [ socket.userID ]);
+    io.to(socket.userID).emit("proxyList", list.map(bean => bean.export()));
+
+    timeLogger.print("Send Proxy List");
+
+    return list;
+}
+
+/**
+ * Emits the version information to the client.
+ * @param {Socket} socket Socket.io socket instance
+ * @returns {Promise<void>}
+ */
 async function sendInfo(socket) {
     socket.emit("info", {
         version: checkVersion.version,
@@ -95,6 +126,6 @@ module.exports = {
     sendNotificationList,
     sendImportantHeartbeatList,
     sendHeartbeatList,
-    sendInfo
+    sendProxyList,
+    sendInfo,
 };
-

server/database.js

@@ -1,7 +1,7 @@
 const fs = require("fs");
 const { R } = require("redbean-node");
 const { setSetting, setting } = require("./util-server");
-const { debug, sleep } = require("../src/util");
+const { log, sleep } = require("../src/util");
 const dayjs = require("dayjs");
 const knex = require("knex");
 
@@ -53,7 +53,12 @@ class Database {
         "patch-2fa-invalidate-used-token.sql": true,
         "patch-notification_sent_history.sql": true,
         "patch-monitor-basic-auth.sql": true,
-    }
+        "patch-status-page.sql": true,
+        "patch-proxy.sql": true,
+        "patch-monitor-expiry-notification.sql": true,
+        "patch-status-page-footer-css.sql": true,
+        "patch-added-mqtt-monitor.sql": true,
+    };
 
     /**
      * The final version should be 10 after merged tag feature
@@ -63,6 +68,10 @@ class Database {
 
     static noReject = true;
 
+    /**
+     * Initialize the database
+     * @param {Object} args Arguments to initialize DB with
+     */
     static init(args) {
         // Data Directory (must be end with "/")
         Database.dataDir = process.env.DATA_DIR || args["data-dir"] || "./data/";
@@ -77,10 +86,19 @@ class Database {
             fs.mkdirSync(Database.uploadDir, { recursive: true });
         }
 
-        console.log(`Data Dir: ${Database.dataDir}`);
+        log.info("db", `Data Dir: ${Database.dataDir}`);
     }
 
-    static async connect(testMode = false) {
+    /**
+     * Connect to the database
+     * @param {boolean} [testMode=false] Should the connection be
+     * started in test mode?
+     * @param {boolean} [autoloadModels=true] Should models be
+     * automatically loaded?
+     * @param {boolean} [noLog=false] Should logs not be output?
+     * @returns {Promise<void>}
+     */
+    static async connect(testMode = false, autoloadModels = true, noLog = false) {
         const acquireConnectionTimeout = 120 * 1000;
 
         const Dialect = require("knex/lib/dialects/sqlite3/index.js");
@@ -110,7 +128,10 @@ class Database {
 
         // Auto map the model to a bean object
         R.freeze(true);
-        await R.autoloadModels("./server/model");
+
+        if (autoloadModels) {
+            await R.autoloadModels("./server/model");
+        }
 
         await R.exec("PRAGMA foreign_keys = ON");
         if (testMode) {
@@ -123,12 +144,20 @@ class Database {
         await R.exec("PRAGMA cache_size = -12000");
         await R.exec("PRAGMA auto_vacuum = FULL");
 
-        console.log("SQLite config:");
-        console.log(await R.getAll("PRAGMA journal_mode"));
-        console.log(await R.getAll("PRAGMA cache_size"));
-        console.log("SQLite Version: " + await R.getCell("SELECT sqlite_version()"));
+        // This ensures that an operating system crash or power failure will not corrupt the database.
+        // FULL synchronous is very safe, but it is also slower.
+        // Read more: https://sqlite.org/pragma.html#pragma_synchronous
+        await R.exec("PRAGMA synchronous = FULL");
+
+        if (!noLog) {
+            log.info("db", "SQLite config:");
+            log.info("db", await R.getAll("PRAGMA journal_mode"));
+            log.info("db", await R.getAll("PRAGMA cache_size"));
+            log.info("db", "SQLite Version: " + await R.getCell("SELECT sqlite_version()"));
+        }
     }
 
+    /** Patch the database */
     static async patch() {
         let version = parseInt(await setting("database_version"));
 
@@ -136,15 +165,15 @@ class Database {
             version = 0;
         }
 
-        console.info("Your database version: " + version);
-        console.info("Latest database version: " + this.latestVersion);
+        log.info("db", "Your database version: " + version);
+        log.info("db", "Latest database version: " + this.latestVersion);
 
         if (version === this.latestVersion) {
-            console.info("Database patch not needed");
+            log.info("db", "Database patch not needed");
         } else if (version > this.latestVersion) {
-            console.info("Warning: Database version is newer than expected");
+            log.info("db", "Warning: Database version is newer than expected");
         } else {
-            console.info("Database patch is needed");
+            log.info("db", "Database patch is needed");
 
             this.backup(version);
 
@@ -152,17 +181,17 @@ class Database {
             try {
                 for (let i = version + 1; i <= this.latestVersion; i++) {
                     const sqlFile = `./db/patch${i}.sql`;
-                    console.info(`Patching ${sqlFile}`);
+                    log.info("db", `Patching ${sqlFile}`);
                     await Database.importSQLFile(sqlFile);
-                    console.info(`Patched ${sqlFile}`);
+                    log.info("db", `Patched ${sqlFile}`);
                     await setSetting("database_version", i);
                 }
             } catch (ex) {
                 await Database.close();
 
-                console.error(ex);
-                console.error("Start Uptime-Kuma failed due to issue patching the database");
-                console.error("Please submit a bug report if you still encounter the problem after restart: https://github.com/louislam/uptime-kuma/issues");
+                log.error("db", ex);
+                log.error("db", "Start Uptime-Kuma failed due to issue patching the database");
+                log.error("db", "Please submit a bug report if you still encounter the problem after restart: https://github.com/louislam/uptime-kuma/issues");
 
                 this.restore();
                 process.exit(1);
@@ -170,22 +199,25 @@ class Database {
         }
 
         await this.patch2();
+        await this.migrateNewStatusPage();
     }
 
     /**
+     * Patch DB using new process
      * Call it from patch() only
+     * @private
      * @returns {Promise<void>}
      */
     static async patch2() {
-        console.log("Database Patch 2.0 Process");
+        log.info("db", "Database Patch 2.0 Process");
         let databasePatchedFiles = await setting("databasePatchedFiles");
 
         if (! databasePatchedFiles) {
             databasePatchedFiles = {};
         }
 
-        debug("Patched files:");
-        debug(databasePatchedFiles);
+        log.debug("db", "Patched files:");
+        log.debug("db", databasePatchedFiles);
 
         try {
             for (let sqlFilename in this.patchList) {
@@ -193,15 +225,15 @@ class Database {
             }
 
             if (this.patched) {
-                console.log("Database Patched Successfully");
+                log.info("db", "Database Patched Successfully");
             }
 
         } catch (ex) {
             await Database.close();
 
-            console.error(ex);
-            console.error("Start Uptime-Kuma failed due to issue patching the database");
-            console.error("Please submit the bug report if you still encounter the problem after restart: https://github.com/louislam/uptime-kuma/issues");
+            log.error("db", ex);
+            log.error("db", "Start Uptime-Kuma failed due to issue patching the database");
+            log.error("db", "Please submit the bug report if you still encounter the problem after restart: https://github.com/louislam/uptime-kuma/issues");
 
             this.restore();
 
@@ -212,24 +244,95 @@ class Database {
     }
 
     /**
+     * Migrate status page value in setting to "status_page" table
+     * @returns {Promise<void>}
+     */
+    static async migrateNewStatusPage() {
+
+        // Fix 1.13.0 empty slug bug
+        await R.exec("UPDATE status_page SET slug = 'empty-slug-recover' WHERE TRIM(slug) = ''");
+
+        let title = await setting("title");
+
+        if (title) {
+            console.log("Migrating Status Page");
+
+            let statusPageCheck = await R.findOne("status_page", " slug = 'default' ");
+
+            if (statusPageCheck !== null) {
+                console.log("Migrating Status Page - Skip, default slug record is already existing");
+                return;
+            }
+
+            let statusPage = R.dispense("status_page");
+            statusPage.slug = "default";
+            statusPage.title = title;
+            statusPage.description = await setting("description");
+            statusPage.icon = await setting("icon");
+            statusPage.theme = await setting("statusPageTheme");
+            statusPage.published = !!await setting("statusPagePublished");
+            statusPage.search_engine_index = !!await setting("searchEngineIndex");
+            statusPage.show_tags = !!await setting("statusPageTags");
+            statusPage.password = null;
+
+            if (!statusPage.title) {
+                statusPage.title = "My Status Page";
+            }
+
+            if (!statusPage.icon) {
+                statusPage.icon = "";
+            }
+
+            if (!statusPage.theme) {
+                statusPage.theme = "light";
+            }
+
+            let id = await R.store(statusPage);
+
+            await R.exec("UPDATE incident SET status_page_id = ? WHERE status_page_id IS NULL", [
+                id
+            ]);
+
+            await R.exec("UPDATE [group] SET status_page_id = ? WHERE status_page_id IS NULL", [
+                id
+            ]);
+
+            await R.exec("DELETE FROM setting WHERE type = 'statusPage'");
+
+            // Migrate Entry Page if it is status page
+            let entryPage = await setting("entryPage");
+
+            if (entryPage === "statusPage") {
+                await setSetting("entryPage", "statusPage-default", "general");
+            }
+
+            console.log("Migrating Status Page - Done");
+        }
+
+    }
+
+    /**
+     * Patch database using new patching process
      * Used it patch2() only
+     * @private
      * @param sqlFilename
      * @param databasePatchedFiles
+     * @returns {Promise<void>}
      */
     static async patch2Recursion(sqlFilename, databasePatchedFiles) {
         let value = this.patchList[sqlFilename];
 
         if (! value) {
-            console.log(sqlFilename + " skip");
+            log.info("db", sqlFilename + " skip");
             return;
         }
 
         // Check if patched
         if (! databasePatchedFiles[sqlFilename]) {
-            console.log(sqlFilename + " is not patched");
+            log.info("db", sqlFilename + " is not patched");
 
             if (value.parents) {
-                console.log(sqlFilename + " need parents");
+                log.info("db", sqlFilename + " need parents");
                 for (let parentSQLFilename of value.parents) {
                     await this.patch2Recursion(parentSQLFilename, databasePatchedFiles);
                 }
@@ -237,24 +340,24 @@ class Database {
 
             this.backup(dayjs().format("YYYYMMDDHHmmss"));
 
-            console.log(sqlFilename + " is patching");
+            log.info("db", sqlFilename + " is patching");
             this.patched = true;
             await this.importSQLFile("./db/" + sqlFilename);
             databasePatchedFiles[sqlFilename] = true;
-            console.log(sqlFilename + " was patched successfully");
+            log.info("db", sqlFilename + " was patched successfully");
 
         } else {
-            debug(sqlFilename + " is already patched, skip");
+            log.debug("db", sqlFilename + " is already patched, skip");
         }
     }
 
     /**
-     * Sadly, multi sql statements is not supported by many sqlite libraries, I have to implement it myself
-     * @param filename
+     * Load an SQL file and execute it
+     * @param filename Filename of SQL file to import
      * @returns {Promise<void>}
      */
     static async importSQLFile(filename) {
-
+        // Sadly, multi sql statements is not supported by many sqlite libraries, I have to implement it myself
         await R.getCell("SELECT 1");
 
         let text = fs.readFileSync(filename).toString();
@@ -282,6 +385,10 @@ class Database {
         }
     }
 
+    /**
+     * Aquire a direct connection to database
+     * @returns {any}
+     */
     static getBetterSQLite3Database() {
         return R.knex.client.acquireConnection();
     }
@@ -296,7 +403,7 @@ class Database {
         };
         process.addListener("unhandledRejection", listener);
 
-        console.log("Closing the database");
+        log.info("db", "Closing the database");
 
         while (true) {
             Database.noReject = true;
@@ -306,10 +413,10 @@ class Database {
             if (Database.noReject) {
                 break;
             } else {
-                console.log("Waiting to close the database");
+                log.info("db", "Waiting to close the database");
             }
         }
-        console.log("SQLite closed");
+        log.info("db", "SQLite closed");
 
         process.removeListener("unhandledRejection", listener);
     }
@@ -317,11 +424,11 @@ class Database {
     /**
      * One backup one time in this process.
      * Reset this.backupPath if you want to backup again
-     * @param version
+     * @param {string} version Version code of backup
      */
     static backup(version) {
         if (! this.backupPath) {
-            console.info("Backing up the database");
+            log.info("db", "Backing up the database");
             this.backupPath = this.dataDir + "kuma.db.bak" + version;
             fs.copyFileSync(Database.path, this.backupPath);
 
@@ -339,12 +446,10 @@ class Database {
         }
     }
 
-    /**
-     *
-     */
+    /** Restore from most recent backup */
     static restore() {
         if (this.backupPath) {
-            console.error("Patching the database failed!!! Restoring the backup");
+            log.error("db", "Patching the database failed!!! Restoring the backup");
 
             const shmPath = Database.path + "-shm";
             const walPath = Database.path + "-wal";
@@ -363,7 +468,7 @@ class Database {
                     fs.unlinkSync(walPath);
                 }
             } catch (e) {
-                console.log("Restore failed; you may need to restore the backup manually");
+                log.error("db", "Restore failed; you may need to restore the backup manually");
                 process.exit(1);
             }
 
@@ -379,17 +484,22 @@ class Database {
             }
 
         } else {
-            console.log("Nothing to restore");
+            log.info("db", "Nothing to restore");
         }
     }
 
+    /** Get the size of the database */
     static getSize() {
-        debug("Database.getSize()");
+        log.debug("db", "Database.getSize()");
         let stats = fs.statSync(Database.path);
-        debug(stats);
+        log.debug("db", stats);
         return stats.size;
     }
 
+    /**
+     * Shrink the database
+     * @returns {Promise<void>}
+     */
     static async shrink() {
         await R.exec("VACUUM");
     }

server/image-data-uri.js

@@ -3,12 +3,21 @@
     Modified with 0 dependencies
  */
 let fs = require("fs");
+const { log } = require("../src/util");
 
 let ImageDataURI = (() => {
 
+    /**
+     * Decode the data:image/ URI
+     * @param {string} dataURI data:image/ URI to decode
+     * @returns {?Object} An object with properties "imageType" and "dataBase64".
+     * The former is the image type, e.g., "png", and the latter is a base64
+     * encoded string of the image's binary data. If it fails to parse, returns
+     * null instead of an object.
+     */
     function decode(dataURI) {
         if (!/data:image\//.test(dataURI)) {
-            console.log("ImageDataURI :: Error :: It seems that it is not an Image Data URI. Couldn't match \"data:image/\"");
+            log.error("image-data-uri", "It seems that it is not an Image Data URI. Couldn't match \"data:image/\"");
             return null;
         }
 
@@ -20,9 +29,16 @@ let ImageDataURI = (() => {
         };
     }
 
+    /**
+     * Endcode an image into data:image/ URI
+     * @param {(Buffer|string)} data Data to encode
+     * @param {string} mediaType Media type of data
+     * @returns {(string|null)} A string representing the base64-encoded
+     * version of the given Buffer object or null if an error occurred.
+     */
     function encode(data, mediaType) {
         if (!data || !mediaType) {
-            console.log("ImageDataURI :: Error :: Missing some of the required params: data, mediaType ");
+            log.error("image-data-uri", "Missing some of the required params: data, mediaType");
             return null;
         }
 
@@ -33,6 +49,12 @@ let ImageDataURI = (() => {
         return dataImgBase64;
     }
 
+    /**
+     * Write data URI to file
+     * @param {string} dataURI data:image/ URI
+     * @param {string} [filePath] Path to write file to
+     * @returns {Promise<string>}
+     */
     function outputFile(dataURI, filePath) {
         filePath = filePath || "./";
         return new Promise((resolve, reject) => {

server/jobs.js

@@ -1,7 +1,8 @@
 const path = require("path");
 const Bree = require("bree");
 const { SHARE_ENV } = require("worker_threads");
-
+const { log } = require("../src/util");
+let bree;
 const jobs = [
     {
         name: "clear-old-data",
@@ -9,8 +10,13 @@ const jobs = [
     },
 ];
 
+/**
+ * Initialize background jobs
+ * @param {Object} args Arguments to pass to workers
+ * @returns {Bree}
+ */
 const initBackgroundJobs = function (args) {
-    const bree = new Bree({
+    bree = new Bree({
         root: path.resolve("server", "jobs"),
         jobs,
         worker: {
@@ -18,7 +24,7 @@ const initBackgroundJobs = function (args) {
             workerData: args,
         },
         workerMessageHandler: (message) => {
-            console.log("[Background Job]:", message);
+            log.info("jobs", message);
         }
     });
 
@@ -26,6 +32,13 @@ const initBackgroundJobs = function (args) {
     return bree;
 };
 
-module.exports = {
-    initBackgroundJobs
+const stopBackgroundJobs = function () {
+    if (bree) {
+        bree.stop();
+    }
+};
+
+module.exports = {
+    initBackgroundJobs,
+    stopBackgroundJobs
 };

server/jobs/clear-old-data.js

@@ -30,7 +30,7 @@ const DEFAULT_KEEP_PERIOD = 180;
     try {
         await R.exec(
             "DELETE FROM heartbeat WHERE time < DATETIME('now', '-' || ? || ' days') ",
-            [parsedPeriod]
+            [ parsedPeriod ]
         );
     } catch (e) {
         log(`Failed to clear old data: ${e.message}`);

server/jobs/util-worker.js

@@ -2,14 +2,24 @@ const { parentPort, workerData } = require("worker_threads");
 const Database = require("../database");
 const path = require("path");
 
+/**
+ * Send message to parent process for logging
+ * since worker_thread does not have access to stdout, this is used
+ * instead of console.log()
+ * @param {any} any The message to log
+ */
 const log = function (any) {
     if (parentPort) {
         parentPort.postMessage(any);
     }
 };
 
+/**
+ * Exit the worker process
+ * @param {number} error The status code to exit
+ */
 const exit = function (error) {
-    if (error && error != 0) {
+    if (error && error !== 0) {
         process.exit(error);
     } else {
         if (parentPort) {
@@ -20,6 +30,7 @@ const exit = function (error) {
     }
 };
 
+/** Connects to the database */
 const connectDb = async function () {
     const dbPath = path.join(
         process.env.DATA_DIR || workerData["data-dir"] || "./data/"

server/model/group.js

@@ -3,12 +3,18 @@ const { R } = require("redbean-node");
 
 class Group extends BeanModel {
 
-    async toPublicJSON() {
+    /**
+     * Return an object that ready to parse to JSON for public
+     * Only show necessary data to public
+     * @param {boolean} [showTags=false] Should the JSON include monitor tags
+     * @returns {Object}
+     */
+    async toPublicJSON(showTags = false) {
         let monitorBeanList = await this.getMonitorList();
         let monitorList = [];
 
         for (let bean of monitorBeanList) {
-            monitorList.push(await bean.toPublicJSON());
+            monitorList.push(await bean.toPublicJSON(showTags));
         }
 
         return {
@@ -19,6 +25,10 @@ class Group extends BeanModel {
         };
     }
 
+    /**
+     * Get all monitors
+     * @returns {Bean[]}
+     */
     async getMonitorList() {
         return R.convertToBeans("monitor", await R.getAll(`
             SELECT monitor.* FROM monitor, monitor_group

server/model/heartbeat.js

@@ -13,6 +13,11 @@ const { BeanModel } = require("redbean-node/dist/bean-model");
  */
 class Heartbeat extends BeanModel {
 
+    /**
+     * Return an object that ready to parse to JSON for public
+     * Only show necessary data to public
+     * @returns {Object}
+     */
     toPublicJSON() {
         return {
             status: this.status,
@@ -22,6 +27,10 @@ class Heartbeat extends BeanModel {
         };
     }
 
+    /**
+     * Return an object that ready to parse to JSON
+     * @returns {Object}
+     */
     toJSON() {
         return {
             monitorID: this.monitor_id,

server/model/incident.js

@@ -2,6 +2,11 @@ const { BeanModel } = require("redbean-node/dist/bean-model");
 
 class Incident extends BeanModel {
 
+    /**
+     * Return an object that ready to parse to JSON for public
+     * Only show necessary data to public
+     * @returns {Object}
+     */
     toPublicJSON() {
         return {
             id: this.id,

server/model/monitor.js

@@ -6,11 +6,12 @@ dayjs.extend(utc);
 dayjs.extend(timezone);
 const axios = require("axios");
 const { Prometheus } = require("../prometheus");
-const { debug, UP, DOWN, PENDING, flipStatus, TimeLogger } = require("../../src/util");
-const { tcping, ping, dnsResolve, checkCertificate, checkStatusCode, getTotalClientInRoom, setting, errorLog } = require("../util-server");
+const { log, UP, DOWN, PENDING, flipStatus, TimeLogger } = require("../../src/util");
+const { tcping, ping, dnsResolve, checkCertificate, checkStatusCode, getTotalClientInRoom, setting, errorLog, mqttAsync } = require("../util-server");
 const { R } = require("redbean-node");
 const { BeanModel } = require("redbean-node/dist/bean-model");
 const { Notification } = require("../notification");
+const { Proxy } = require("../proxy");
 const { demoMode } = require("../config");
 const version = require("../../package.json").version;
 const apicache = require("../modules/apicache");
@@ -24,20 +25,26 @@ const apicache = require("../modules/apicache");
 class Monitor extends BeanModel {
 
     /**
-     * Return a object that ready to parse to JSON for public
+     * Return an object that ready to parse to JSON for public
      * Only show necessary data to public
+     * @returns {Object}
      */
-    async toPublicJSON() {
-        return {
+    async toPublicJSON(showTags = false) {
+        let obj = {
             id: this.id,
             name: this.name,
         };
+        if (showTags) {
+            obj.tags = await this.getTags();
+        }
+        return obj;
     }
 
     /**
-     * Return a object that ready to parse to JSON
+     * Return an object that ready to parse to JSON
+     * @returns {Object}
      */
-    async toJSON() {
+    async toJSON(includeSensitiveData = true) {
 
         let notificationIDList = {};
 
@@ -49,17 +56,13 @@ class Monitor extends BeanModel {
             notificationIDList[bean.notification_id] = true;
         }
 
-        const tags = await R.getAll("SELECT mt.*, tag.name, tag.color FROM monitor_tag mt JOIN tag ON mt.tag_id = tag.id WHERE mt.monitor_id = ?", [this.id]);
+        const tags = await this.getTags();
 
-        return {
+        let data = {
             id: this.id,
             name: this.name,
             url: this.url,
             method: this.method,
-            body: this.body,
-            headers: this.headers,
-            basic_auth_user: this.basic_auth_user,
-            basic_auth_pass: this.basic_auth_pass,
             hostname: this.hostname,
             port: this.port,
             maxretries: this.maxretries,
@@ -69,6 +72,7 @@ class Monitor extends BeanModel {
             interval: this.interval,
             retryInterval: this.retryInterval,
             keyword: this.keyword,
+            expiryNotification: this.isEnabledExpiryNotification(),
             ignoreTls: this.getIgnoreTls(),
             upsideDown: this.isUpsideDown(),
             maxredirects: this.maxredirects,
@@ -76,10 +80,35 @@ class Monitor extends BeanModel {
             dns_resolve_type: this.dns_resolve_type,
             dns_resolve_server: this.dns_resolve_server,
             dns_last_result: this.dns_last_result,
-            pushToken: this.pushToken,
+            proxyId: this.proxy_id,
             notificationIDList,
             tags: tags,
+            mqttUsername: this.mqttUsername,
+            mqttPassword: this.mqttPassword,
+            mqttTopic: this.mqttTopic,
+            mqttSuccessMessage: this.mqttSuccessMessage
         };
+
+        if (includeSensitiveData) {
+            data = {
+                ...data,
+                headers: this.headers,
+                body: this.body,
+                basic_auth_user: this.basic_auth_user,
+                basic_auth_pass: this.basic_auth_pass,
+                pushToken: this.pushToken,
+            };
+        }
+
+        return data;
+    }
+
+    /**
+     * Get all tags applied to this monitor
+     * @returns {Promise<LooseObject<any>[]>}
+     */
+    async getTags() {
+        return await R.getAll("SELECT mt.*, tag.name, tag.color FROM monitor_tag mt JOIN tag ON mt.tag_id = tag.id WHERE mt.monitor_id = ?", [ this.id ]);
     }
 
     /**
@@ -91,6 +120,14 @@ class Monitor extends BeanModel {
         return Buffer.from(user + ":" + pass).toString("base64");
     }
 
+    /**
+     * Is the TLS expiry notification enabled?
+     * @returns {boolean}
+     */
+    isEnabledExpiryNotification() {
+        return Boolean(this.expiryNotification);
+    }
+
     /**
      * Parse to boolean
      * @returns {boolean}
@@ -107,10 +144,18 @@ class Monitor extends BeanModel {
         return Boolean(this.upsideDown);
     }
 
+    /**
+     * Get accepted status codes
+     * @returns {Object}
+     */
     getAcceptedStatuscodes() {
         return JSON.parse(this.accepted_statuscodes_json);
     }
 
+    /**
+     * Start monitor
+     * @param {Server} io Socket server instance
+     */
     start(io) {
         let previousBeat = null;
         let retries = 0;
@@ -119,11 +164,24 @@ class Monitor extends BeanModel {
 
         const beat = async () => {
 
+            let beatInterval = this.interval;
+
+            if (! beatInterval) {
+                beatInterval = 1;
+            }
+
+            if (demoMode) {
+                if (beatInterval < 20) {
+                    console.log("beat interval too low, reset to 20s");
+                    beatInterval = 20;
+                }
+            }
+
             // Expose here for prometheus update
             // undefined if not https
             let tlsInfo = undefined;
 
-            if (! previousBeat) {
+            if (!previousBeat) {
                 previousBeat = await R.findOne("heartbeat", " monitor_id = ? ORDER BY time DESC", [
                     this.id,
                 ]);
@@ -141,7 +199,7 @@ class Monitor extends BeanModel {
             }
 
             // Duration
-            if (! isFirstBeat) {
+            if (!isFirstBeat) {
                 bean.duration = dayjs(bean.time).diff(dayjs(previousBeat.time), "second");
             } else {
                 bean.duration = 0;
@@ -160,7 +218,12 @@ class Monitor extends BeanModel {
                         };
                     }
 
-                    debug(`[${this.name}] Prepare Options for axios`);
+                    const httpsAgentOptions = {
+                        maxCachedSessions: 0, // Use Custom agent to disable session reuse (https://github.com/nodejs/node/issues/3940)
+                        rejectUnauthorized: !this.getIgnoreTls(),
+                    };
+
+                    log.debug("monitor", `[${this.name}] Prepare Options for axios`);
 
                     const options = {
                         url: this.url,
@@ -173,17 +236,33 @@ class Monitor extends BeanModel {
                             ...(this.headers ? JSON.parse(this.headers) : {}),
                             ...(basicAuthHeader),
                         },
-                        httpsAgent: new https.Agent({
-                            maxCachedSessions: 0,      // Use Custom agent to disable session reuse (https://github.com/nodejs/node/issues/3940)
-                            rejectUnauthorized: ! this.getIgnoreTls(),
-                        }),
                         maxRedirects: this.maxredirects,
                         validateStatus: (status) => {
                             return checkStatusCode(status, this.getAcceptedStatuscodes());
                         },
                     };
 
-                    debug(`[${this.name}] Axios Request`);
+                    if (this.proxy_id) {
+                        const proxy = await R.load("proxy", this.proxy_id);
+
+                        if (proxy && proxy.active) {
+                            const { httpAgent, httpsAgent } = Proxy.createAgents(proxy, {
+                                httpsAgentOptions: httpsAgentOptions,
+                            });
+
+                            options.proxy = false;
+                            options.httpAgent = httpAgent;
+                            options.httpsAgent = httpsAgent;
+                        }
+                    }
+
+                    if (!options.httpsAgent) {
+                        options.httpsAgent = new https.Agent(httpsAgentOptions);
+                    }
+
+                    log.debug("monitor", `[${this.name}] Axios Options: ${JSON.stringify(options)}`);
+                    log.debug("monitor", `[${this.name}] Axios Request`);
+
                     let res = await axios.request(options);
                     bean.msg = `${res.status} - ${res.statusText}`;
                     bean.ping = dayjs().valueOf() - startTime;
@@ -191,29 +270,30 @@ class Monitor extends BeanModel {
                     // Check certificate if https is used
                     let certInfoStartTime = dayjs().valueOf();
                     if (this.getUrl()?.protocol === "https:") {
-                        debug(`[${this.name}] Check cert`);
+                        log.debug("monitor", `[${this.name}] Check cert`);
                         try {
                             let tlsInfoObject = checkCertificate(res);
                             tlsInfo = await this.updateTlsInfo(tlsInfoObject);
 
-                            if (!this.getIgnoreTls()) {
-                                debug(`[${this.name}] call sendCertNotification`);
+                            if (!this.getIgnoreTls() && this.isEnabledExpiryNotification()) {
+                                log.debug("monitor", `[${this.name}] call sendCertNotification`);
                                 await this.sendCertNotification(tlsInfoObject);
                             }
 
                         } catch (e) {
                             if (e.message !== "No TLS certificate in response") {
-                                console.error(e.message);
+                                log.error("monitor", "Caught error");
+                                log.error("monitor", e.message);
                             }
                         }
                     }
 
                     if (process.env.TIMELOGGER === "1") {
-                        debug("Cert Info Query Time: " + (dayjs().valueOf() - certInfoStartTime) + "ms");
+                        log.debug("monitor", "Cert Info Query Time: " + (dayjs().valueOf() - certInfoStartTime) + "ms");
                     }
 
-                    if (process.env.UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID == this.id) {
-                        console.log(res.data);
+                    if (process.env.UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID === this.id) {
+                        log.info("monitor", res.data);
                     }
 
                     if (this.type === "http") {
@@ -252,24 +332,24 @@ class Monitor extends BeanModel {
                     let dnsRes = await dnsResolve(this.hostname, this.dns_resolve_server, this.dns_resolve_type);
                     bean.ping = dayjs().valueOf() - startTime;
 
-                    if (this.dns_resolve_type == "A" || this.dns_resolve_type == "AAAA" || this.dns_resolve_type == "TXT") {
+                    if (this.dns_resolve_type === "A" || this.dns_resolve_type === "AAAA" || this.dns_resolve_type === "TXT") {
                         dnsMessage += "Records: ";
                         dnsMessage += dnsRes.join(" | ");
-                    } else if (this.dns_resolve_type == "CNAME" || this.dns_resolve_type == "PTR") {
+                    } else if (this.dns_resolve_type === "CNAME" || this.dns_resolve_type === "PTR") {
                         dnsMessage = dnsRes[0];
-                    } else if (this.dns_resolve_type == "CAA") {
+                    } else if (this.dns_resolve_type === "CAA") {
                         dnsMessage = dnsRes[0].issue;
-                    } else if (this.dns_resolve_type == "MX") {
+                    } else if (this.dns_resolve_type === "MX") {
                         dnsRes.forEach(record => {
                             dnsMessage += `Hostname: ${record.exchange} - Priority: ${record.priority} | `;
                         });
                         dnsMessage = dnsMessage.slice(0, -2);
-                    } else if (this.dns_resolve_type == "NS") {
+                    } else if (this.dns_resolve_type === "NS") {
                         dnsMessage += "Servers: ";
                         dnsMessage += dnsRes.join(" | ");
-                    } else if (this.dns_resolve_type == "SOA") {
+                    } else if (this.dns_resolve_type === "SOA") {
                         dnsMessage += `NS-Name: ${dnsRes.nsname} | Hostmaster: ${dnsRes.hostmaster} | Serial: ${dnsRes.serial} | Refresh: ${dnsRes.refresh} | Retry: ${dnsRes.retry} | Expire: ${dnsRes.expire} | MinTTL: ${dnsRes.minttl}`;
-                    } else if (this.dns_resolve_type == "SRV") {
+                    } else if (this.dns_resolve_type === "SRV") {
                         dnsRes.forEach(record => {
                             dnsMessage += `Name: ${record.name} | Port: ${record.port} | Priority: ${record.priority} | Weight: ${record.weight} | `;
                         });
@@ -293,7 +373,7 @@ class Monitor extends BeanModel {
                         time
                     ]);
 
-                    debug("heartbeatCount" + heartbeatCount + " " + time);
+                    log.debug("monitor", "heartbeatCount" + heartbeatCount + " " + time);
 
                     if (heartbeatCount <= 0) {
                         // Fix #922, since previous heartbeat could be inserted by api, it should get from database
@@ -303,7 +383,7 @@ class Monitor extends BeanModel {
                     } else {
                         // No need to insert successful heartbeat for push type, so end here
                         retries = 0;
-                        this.heartbeatInterval = setTimeout(beat, this.interval * 1000);
+                        this.heartbeatInterval = setTimeout(beat, beatInterval * 1000);
                         return;
                     }
 
@@ -324,7 +404,7 @@ class Monitor extends BeanModel {
                         },
                         httpsAgent: new https.Agent({
                             maxCachedSessions: 0,      // Use Custom agent to disable session reuse (https://github.com/nodejs/node/issues/3940)
-                            rejectUnauthorized: ! this.getIgnoreTls(),
+                            rejectUnauthorized: !this.getIgnoreTls(),
                         }),
                         maxRedirects: this.maxredirects,
                         validateStatus: (status) => {
@@ -346,7 +426,14 @@ class Monitor extends BeanModel {
                     } else {
                         throw new Error("Server not found on Steam");
                     }
-
+                } else if (this.type === "mqtt") {
+                    bean.msg = await mqttAsync(this.hostname, this.mqttTopic, this.mqttSuccessMessage, {
+                        port: this.port,
+                        username: this.mqttUsername,
+                        password: this.mqttPassword,
+                        interval: this.interval,
+                    });
+                    bean.status = UP;
                 } else {
                     bean.msg = "Unknown Monitor Type";
                     bean.status = PENDING;
@@ -377,9 +464,7 @@ class Monitor extends BeanModel {
                 }
             }
 
-            let beatInterval = this.interval;
-
-            debug(`[${this.name}] Check isImportant`);
+            log.debug("monitor", `[${this.name}] Check isImportant`);
             let isImportant = Monitor.isImportantBeat(isFirstBeat, previousBeat?.status, bean.status);
 
             // Mark as important if status changed, ignore pending pings,
@@ -387,11 +472,11 @@ class Monitor extends BeanModel {
             if (isImportant) {
                 bean.important = true;
 
-                debug(`[${this.name}] sendNotification`);
+                log.debug("monitor", `[${this.name}] sendNotification`);
                 await Monitor.sendNotification(isFirstBeat, this, bean);
 
                 // Clear Status Page Cache
-                debug(`[${this.name}] apicache clear`);
+                log.debug("monitor", `[${this.name}] apicache clear`);
                 apicache.clear();
 
             } else {
@@ -399,55 +484,48 @@ class Monitor extends BeanModel {
             }
 
             if (bean.status === UP) {
-                console.info(`Monitor #${this.id} '${this.name}': Successful Response: ${bean.ping} ms | Interval: ${beatInterval} seconds | Type: ${this.type}`);
+                log.info("monitor", `Monitor #${this.id} '${this.name}': Successful Response: ${bean.ping} ms | Interval: ${beatInterval} seconds | Type: ${this.type}`);
             } else if (bean.status === PENDING) {
                 if (this.retryInterval > 0) {
                     beatInterval = this.retryInterval;
                 }
-                console.warn(`Monitor #${this.id} '${this.name}': Pending: ${bean.msg} | Max retries: ${this.maxretries} | Retry: ${retries} | Retry Interval: ${beatInterval} seconds | Type: ${this.type}`);
+                log.warn("monitor", `Monitor #${this.id} '${this.name}': Pending: ${bean.msg} | Max retries: ${this.maxretries} | Retry: ${retries} | Retry Interval: ${beatInterval} seconds | Type: ${this.type}`);
             } else {
-                console.warn(`Monitor #${this.id} '${this.name}': Failing: ${bean.msg} | Interval: ${beatInterval} seconds | Type: ${this.type}`);
+                log.warn("monitor", `Monitor #${this.id} '${this.name}': Failing: ${bean.msg} | Interval: ${beatInterval} seconds | Type: ${this.type}`);
             }
 
-            debug(`[${this.name}] Send to socket`);
+            log.debug("monitor", `[${this.name}] Send to socket`);
             io.to(this.user_id).emit("heartbeat", bean.toJSON());
             Monitor.sendStats(io, this.id, this.user_id);
 
-            debug(`[${this.name}] Store`);
+            log.debug("monitor", `[${this.name}] Store`);
             await R.store(bean);
 
-            debug(`[${this.name}] prometheus.update`);
+            log.debug("monitor", `[${this.name}] prometheus.update`);
             prometheus.update(bean, tlsInfo);
 
             previousBeat = bean;
 
             if (! this.isStop) {
-
-                if (demoMode) {
-                    if (beatInterval < 20) {
-                        console.log("beat interval too low, reset to 20s");
-                        beatInterval = 20;
-                    }
-                }
-
-                debug(`[${this.name}] SetTimeout for next check.`);
+                log.debug("monitor", `[${this.name}] SetTimeout for next check.`);
                 this.heartbeatInterval = setTimeout(safeBeat, beatInterval * 1000);
             } else {
-                console.log(`[${this.name}] isStop = true, no next check.`);
+                log.info("monitor", `[${this.name}] isStop = true, no next check.`);
             }
 
         };
 
+        /** Get a heartbeat and handle errors */
         const safeBeat = async () => {
             try {
                 await beat();
             } catch (e) {
                 console.trace(e);
                 errorLog(e, false);
-                console.error("Please report to https://github.com/louislam/uptime-kuma/issues");
+                log.error("monitor", "Please report to https://github.com/louislam/uptime-kuma/issues");
 
                 if (! this.isStop) {
-                    console.log("Try to restart the monitor");
+                    log.info("monitor", "Try to restart the monitor");
                     this.heartbeatInterval = setTimeout(safeBeat, this.interval * 1000);
                 }
             }
@@ -463,16 +541,27 @@ class Monitor extends BeanModel {
         }
     }
 
+    /** Stop monitor */
     stop() {
         clearTimeout(this.heartbeatInterval);
         this.isStop = true;
+
+        this.prometheus().remove();
+    }
+
+    /**
+     * Get a new prometheus instance
+     * @returns {Prometheus}
+     */
+    prometheus() {
+        return new Prometheus(this);
     }
 
     /**
      * Helper Method:
      * returns URL object for further usage
      * returns null if url is invalid
-     * @returns {null|URL}
+     * @returns {(null|URL)}
      */
     getUrl() {
         try {
@@ -485,48 +574,54 @@ class Monitor extends BeanModel {
     /**
      * Store TLS info to database
      * @param checkCertificateResult
-     * @returns {Promise<object>}
+     * @returns {Promise<Object>}
      */
     async updateTlsInfo(checkCertificateResult) {
-        let tls_info_bean = await R.findOne("monitor_tls_info", "monitor_id = ?", [
+        let tlsInfoBean = await R.findOne("monitor_tls_info", "monitor_id = ?", [
             this.id,
         ]);
 
-        if (tls_info_bean == null) {
-            tls_info_bean = R.dispense("monitor_tls_info");
-            tls_info_bean.monitor_id = this.id;
+        if (tlsInfoBean == null) {
+            tlsInfoBean = R.dispense("monitor_tls_info");
+            tlsInfoBean.monitor_id = this.id;
         } else {
 
             // Clear sent history if the cert changed.
             try {
-                let oldCertInfo = JSON.parse(tls_info_bean.info_json);
+                let oldCertInfo = JSON.parse(tlsInfoBean.info_json);
 
                 let isValidObjects = oldCertInfo && oldCertInfo.certInfo && checkCertificateResult && checkCertificateResult.certInfo;
 
                 if (isValidObjects) {
                     if (oldCertInfo.certInfo.fingerprint256 !== checkCertificateResult.certInfo.fingerprint256) {
-                        debug("Resetting sent_history");
+                        log.debug("monitor", "Resetting sent_history");
                         await R.exec("DELETE FROM notification_sent_history WHERE type = 'certificate' AND monitor_id = ?", [
                             this.id
                         ]);
                     } else {
-                        debug("No need to reset sent_history");
-                        debug(oldCertInfo.certInfo.fingerprint256);
-                        debug(checkCertificateResult.certInfo.fingerprint256);
+                        log.debug("monitor", "No need to reset sent_history");
+                        log.debug("monitor", oldCertInfo.certInfo.fingerprint256);
+                        log.debug("monitor", checkCertificateResult.certInfo.fingerprint256);
                     }
                 } else {
-                    debug("Not valid object");
+                    log.debug("monitor", "Not valid object");
                 }
             } catch (e) { }
 
         }
 
-        tls_info_bean.info_json = JSON.stringify(checkCertificateResult);
-        await R.store(tls_info_bean);
+        tlsInfoBean.info_json = JSON.stringify(checkCertificateResult);
+        await R.store(tlsInfoBean);
 
         return checkCertificateResult;
     }
 
+    /**
+     * Send statistics to clients
+     * @param {Server} io Socket server instance
+     * @param {number} monitorID ID of monitor to send
+     * @param {number} userID ID of user to send to
+     */
     static async sendStats(io, monitorID, userID) {
         const hasClients = getTotalClientInRoom(io, userID) > 0;
 
@@ -536,13 +631,13 @@ class Monitor extends BeanModel {
             await Monitor.sendUptime(24 * 30, io, monitorID, userID);
             await Monitor.sendCertInfo(io, monitorID, userID);
         } else {
-            debug("No clients in the room, no need to send stats");
+            log.debug("monitor", "No clients in the room, no need to send stats");
         }
     }
 
     /**
-     *
-     * @param duration : int Hours
+     * Send the average ping to user
+     * @param {number} duration Hours
      */
     static async sendAvgPing(duration, io, monitorID, userID) {
         const timeLogger = new TimeLogger();
@@ -562,12 +657,18 @@ class Monitor extends BeanModel {
         io.to(userID).emit("avgPing", monitorID, avgPing);
     }
 
+    /**
+     * Send certificate information to client
+     * @param {Server} io Socket server instance
+     * @param {number} monitorID ID of monitor to send
+     * @param {number} userID ID of user to send to
+     */
     static async sendCertInfo(io, monitorID, userID) {
-        let tls_info = await R.findOne("monitor_tls_info", "monitor_id = ?", [
+        let tlsInfo = await R.findOne("monitor_tls_info", "monitor_id = ?", [
             monitorID,
         ]);
-        if (tls_info != null) {
-            io.to(userID).emit("certInfo", monitorID, tls_info.info_json);
+        if (tlsInfo != null) {
+            io.to(userID).emit("certInfo", monitorID, tlsInfo.info_json);
         }
     }
 
@@ -575,7 +676,8 @@ class Monitor extends BeanModel {
      * Uptime with calculation
      * Calculation based on:
      * https://www.uptrends.com/support/kb/reporting/calculation-of-uptime-and-downtime
-     * @param duration : int Hours
+     * @param {number} duration Hours
+     * @param {number} monitorID ID of monitor to calculate
      */
     static async calcUptime(duration, monitorID) {
         const timeLogger = new TimeLogger();
@@ -641,13 +743,23 @@ class Monitor extends BeanModel {
 
     /**
      * Send Uptime
-     * @param duration : int Hours
+     * @param {number} duration Hours
+     * @param {Server} io Socket server instance
+     * @param {number} monitorID ID of monitor to send
+     * @param {number} userID ID of user to send to
      */
     static async sendUptime(duration, io, monitorID, userID) {
         const uptime = await this.calcUptime(duration, monitorID);
         io.to(userID).emit("uptime", monitorID, duration, uptime);
     }
 
+    /**
+     * Has status of monitor changed since last beat?
+     * @param {boolean} isFirstBeat Is this the first beat of this monitor?
+     * @param {const} previousBeatStatus Status of the previous beat
+     * @param {const} currentBeatStatus Status of the current beat
+     * @returns {boolean} True if is an important beat else false
+     */
     static isImportantBeat(isFirstBeat, previousBeatStatus, currentBeatStatus) {
         // * ? -> ANY STATUS = important [isFirstBeat]
         // UP -> PENDING = not important
@@ -666,6 +778,12 @@ class Monitor extends BeanModel {
         return isImportant;
     }
 
+    /**
+     * Send a notification about a monitor
+     * @param {boolean} isFirstBeat Is this beat the first of this monitor?
+     * @param {Monitor} monitor The monitor to send a notificaton about
+     * @param {Bean} bean Status information about monitor
+     */
     static async sendNotification(isFirstBeat, monitor, bean) {
         if (!isFirstBeat || bean.status === DOWN) {
             const notificationList = await Monitor.getNotificationList(monitor);
@@ -681,15 +799,20 @@ class Monitor extends BeanModel {
 
             for (let notification of notificationList) {
                 try {
-                    await Notification.send(JSON.parse(notification.config), msg, await monitor.toJSON(), bean.toJSON());
+                    await Notification.send(JSON.parse(notification.config), msg, await monitor.toJSON(false), bean.toJSON());
                 } catch (e) {
-                    console.error("Cannot send notification to " + notification.name);
-                    console.log(e);
+                    log.error("monitor", "Cannot send notification to " + notification.name);
+                    log.error("monitor", e);
                 }
             }
         }
     }
 
+    /**
+     * Get list of notification providers for a given monitor
+     * @param {Monitor} monitor Monitor to get notification providers for
+     * @returns {Promise<LooseObject<any>[]>}
+     */
     static async getNotificationList(monitor) {
         let notificationList = await R.getAll("SELECT notification.* FROM notification, monitor_notification WHERE monitor_id = ? AND monitor_notification.notification_id = notification.id ", [
             monitor.id,
@@ -697,21 +820,33 @@ class Monitor extends BeanModel {
         return notificationList;
     }
 
+    /**
+     * Send notification about a certificate
+     * @param {Object} tlsInfoObject Information about certificate
+     */
     async sendCertNotification(tlsInfoObject) {
         if (tlsInfoObject && tlsInfoObject.certInfo && tlsInfoObject.certInfo.daysRemaining) {
             const notificationList = await Monitor.getNotificationList(this);
 
-            debug("call sendCertNotificationByTargetDays");
+            log.debug("monitor", "call sendCertNotificationByTargetDays");
             await this.sendCertNotificationByTargetDays(tlsInfoObject.certInfo.daysRemaining, 21, notificationList);
             await this.sendCertNotificationByTargetDays(tlsInfoObject.certInfo.daysRemaining, 14, notificationList);
             await this.sendCertNotificationByTargetDays(tlsInfoObject.certInfo.daysRemaining, 7, notificationList);
         }
     }
 
+    /**
+     * Send a certificate notification when certificate expires in less
+     * than target days
+     * @param {number} daysRemaining Number of days remaining on certifcate
+     * @param {number} targetDays Number of days to alert after
+     * @param {LooseObject<any>[]} notificationList List of notification providers
+     * @returns {Promise<void>}
+     */
     async sendCertNotificationByTargetDays(daysRemaining, targetDays, notificationList) {
 
         if (daysRemaining > targetDays) {
-            debug(`No need to send cert notification. ${daysRemaining} > ${targetDays}`);
+            log.debug("monitor", `No need to send cert notification. ${daysRemaining} > ${targetDays}`);
             return;
         }
 
@@ -725,21 +860,21 @@ class Monitor extends BeanModel {
 
             // Sent already, no need to send again
             if (row) {
-                debug("Sent already, no need to send again");
+                log.debug("monitor", "Sent already, no need to send again");
                 return;
             }
 
             let sent = false;
-            debug("Send certificate notification");
+            log.debug("monitor", "Send certificate notification");
 
             for (let notification of notificationList) {
                 try {
-                    debug("Sending to " + notification.name);
+                    log.debug("monitor", "Sending to " + notification.name);
                     await Notification.send(JSON.parse(notification.config), `[${this.name}][${this.url}] Certificate will be expired in ${daysRemaining} days`);
                     sent = true;
                 } catch (e) {
-                    console.error("Cannot send cert notification to " + notification.name);
-                    console.error(e);
+                    log.error("monitor", "Cannot send cert notification to " + notification.name);
+                    log.error("monitor", e);
                 }
             }
 
@@ -751,10 +886,15 @@ class Monitor extends BeanModel {
                 ]);
             }
         } else {
-            debug("No notification, no need to send cert notification");
+            log.debug("monitor", "No notification, no need to send cert notification");
         }
     }
 
+    /**
+     * Get the status of the previous heartbeat
+     * @param {number} monitorID ID of monitor to check
+     * @returns {Promise<LooseObject<any>>}
+     */
     static async getPreviousHeartbeat(monitorID) {
         return await R.getRow(`
             SELECT status, time FROM heartbeat

server/model/proxy.js

@@ -0,0 +1,25 @@
+const { BeanModel } = require("redbean-node/dist/bean-model");
+
+class Proxy extends BeanModel {
+    /**
+     * Return an object that ready to parse to JSON
+     * @returns {Object}
+     */
+    toJSON() {
+        return {
+            id: this._id,
+            userId: this._user_id,
+            protocol: this._protocol,
+            host: this._host,
+            port: this._port,
+            auth: !!this._auth,
+            username: this._username,
+            password: this._password,
+            active: !!this._active,
+            default: !!this._default,
+            createdDate: this._created_date,
+        };
+    }
+}
+
+module.exports = Proxy;

server/model/status_page.js

@@ -0,0 +1,165 @@
+const { BeanModel } = require("redbean-node/dist/bean-model");
+const { R } = require("redbean-node");
+
+class StatusPage extends BeanModel {
+
+    static domainMappingList = { };
+
+    /**
+     * Loads domain mapping from DB
+     * Return object like this: { "test-uptime.kuma.pet": "default" }
+     * @returns {Promise<void>}
+     */
+    static async loadDomainMappingList() {
+        StatusPage.domainMappingList = await R.getAssoc(`
+            SELECT domain, slug
+            FROM status_page, status_page_cname
+            WHERE status_page.id = status_page_cname.status_page_id
+        `);
+    }
+
+    /**
+     * Send status page list to client
+     * @param {Server} io io Socket server instance
+     * @param {Socket} socket Socket.io instance
+     * @returns {Promise<Bean[]>}
+     */
+    static async sendStatusPageList(io, socket) {
+        let result = {};
+
+        let list = await R.findAll("status_page", " ORDER BY title ");
+
+        for (let item of list) {
+            result[item.id] = await item.toJSON();
+        }
+
+        io.to(socket.userID).emit("statusPageList", result);
+        return list;
+    }
+
+    /**
+     * Update list of domain names
+     * @param {string[]} domainNameList
+     * @returns {Promise<void>}
+     */
+    async updateDomainNameList(domainNameList) {
+
+        if (!Array.isArray(domainNameList)) {
+            throw new Error("Invalid array");
+        }
+
+        let trx = await R.begin();
+
+        await trx.exec("DELETE FROM status_page_cname WHERE status_page_id = ?", [
+            this.id,
+        ]);
+
+        try {
+            for (let domain of domainNameList) {
+                if (typeof domain !== "string") {
+                    throw new Error("Invalid domain");
+                }
+
+                if (domain.trim() === "") {
+                    continue;
+                }
+
+                // If the domain name is used in another status page, delete it
+                await trx.exec("DELETE FROM status_page_cname WHERE domain = ?", [
+                    domain,
+                ]);
+
+                let mapping = trx.dispense("status_page_cname");
+                mapping.status_page_id = this.id;
+                mapping.domain = domain;
+                await trx.store(mapping);
+            }
+            await trx.commit();
+        } catch (error) {
+            await trx.rollback();
+            throw error;
+        }
+    }
+
+    /**
+     * Get list of domain names
+     * @returns {Object[]}
+     */
+    getDomainNameList() {
+        let domainList = [];
+        for (let domain in StatusPage.domainMappingList) {
+            let s = StatusPage.domainMappingList[domain];
+
+            if (this.slug === s) {
+                domainList.push(domain);
+            }
+        }
+        return domainList;
+    }
+
+    /**
+     * Return an object that ready to parse to JSON
+     * @returns {Object}
+     */
+    async toJSON() {
+        return {
+            id: this.id,
+            slug: this.slug,
+            title: this.title,
+            description: this.description,
+            icon: this.getIcon(),
+            theme: this.theme,
+            published: !!this.published,
+            showTags: !!this.show_tags,
+            domainNameList: this.getDomainNameList(),
+            customCSS: this.custom_css,
+            footerText: this.footer_text,
+            showPoweredBy: !!this.show_powered_by,
+        };
+    }
+
+    /**
+     * Return an object that ready to parse to JSON for public
+     * Only show necessary data to public
+     * @returns {Object}
+     */
+    async toPublicJSON() {
+        return {
+            slug: this.slug,
+            title: this.title,
+            description: this.description,
+            icon: this.getIcon(),
+            theme: this.theme,
+            published: !!this.published,
+            showTags: !!this.show_tags,
+            customCSS: this.custom_css,
+            footerText: this.footer_text,
+            showPoweredBy: !!this.show_powered_by,
+        };
+    }
+
+    /**
+     * Convert slug to status page ID
+     * @param {string} slug
+     */
+    static async slugToID(slug) {
+        return await R.getCell("SELECT id FROM status_page WHERE slug = ? ", [
+            slug
+        ]);
+    }
+
+    /**
+     * Get path to the icon for the page
+     * @returns {string}
+     */
+    getIcon() {
+        if (!this.icon) {
+            return "/icon.svg";
+        } else {
+            return this.icon;
+        }
+    }
+
+}
+
+module.exports = StatusPage;

server/model/tag.js

@@ -1,6 +1,11 @@
 const { BeanModel } = require("redbean-node/dist/bean-model");
 
 class Tag extends BeanModel {
+
+    /**
+     * Return an object that ready to parse to JSON
+     * @returns {Object}
+     */
     toJSON() {
         return {
             id: this._id,

server/model/user.js

@@ -3,19 +3,30 @@ const passwordHash = require("../password-hash");
 const { R } = require("redbean-node");
 
 class User extends BeanModel {
+    /**
+     * Reset user password
+     * Fix #1510, as in the context reset-password.js, there is no auto model mapping. Call this static function instead.
+     * @param {number} userID ID of user to update
+     * @param {string} newPassword
+     * @returns {Promise<void>}
+     */
+    static async resetPassword(userID, newPassword) {
+        await R.exec("UPDATE `user` SET password = ? WHERE id = ? ", [
+            passwordHash.generate(newPassword),
+            userID
+        ]);
+    }
 
     /**
-     * Direct execute, no need R.store()
-     * @param newPassword
+     * Reset this users password
+     * @param {string} newPassword
      * @returns {Promise<void>}
      */
     async resetPassword(newPassword) {
-        await R.exec("UPDATE `user` SET password = ? WHERE id = ? ", [
-            passwordHash.generate(newPassword),
-            this.id
-        ]);
+        await User.resetPassword(this.id, newPassword);
         this.password = newPassword;
     }
+
 }
 
 module.exports = User;

server/modules/apicache/apicache.js

@@ -13,27 +13,49 @@ let t = {
 
 let instances = [];
 
+/**
+ * Does a === b
+ * @param {any} a
+ * @returns {function(any): boolean}
+ */
 let matches = function (a) {
     return function (b) {
         return a === b;
     };
 };
 
+/**
+ * Does a!==b
+ * @param {any} a
+ * @returns {function(any): boolean}
+ */
 let doesntMatch = function (a) {
     return function (b) {
         return !matches(a)(b);
     };
 };
 
+/**
+ * Get log duration
+ * @param {number} d Time in ms
+ * @param {string} prefix Prefix for log
+ * @returns {string} Coloured log string
+ */
 let logDuration = function (d, prefix) {
     let str = d > 1000 ? (d / 1000).toFixed(2) + "sec" : d + "ms";
     return "\x1b[33m- " + (prefix ? prefix + " " : "") + str + "\x1b[0m";
 };
 
+/**
+ * Get safe headers
+ * @param {Object} res Express response object
+ * @returns {Object}
+ */
 function getSafeHeaders(res) {
     return res.getHeaders ? res.getHeaders() : res._headers;
 }
 
+/** Constructor for ApiCache instance */
 function ApiCache() {
     let memCache = new MemoryCache();
 
@@ -68,6 +90,15 @@ function ApiCache() {
     instances.push(this);
     this.id = instances.length;
 
+    /**
+     * Logs a message to the console if the `DEBUG` environment variable is set.
+     * @param {string} a The first argument to log.
+     * @param {string} b The second argument to log.
+     * @param {string} c The third argument to log.
+     * @param {string} d The fourth argument to log, and so on... (optional)
+     *
+     * Generated by Trelent
+     */
     function debug(a, b, c, d) {
         let arr = ["\x1b[36m[apicache]\x1b[0m", a, b, c, d].filter(function (arg) {
             return arg !== undefined;
@@ -77,6 +108,13 @@ function ApiCache() {
         return (globalOptions.debug || debugEnv) && console.log.apply(null, arr);
     }
 
+    /**
+     * Returns true if the given request and response should be logged.
+     * @param {Object} request The HTTP request object.
+     * @param {Object} response The HTTP response object.
+     * @param {function(Object, Object):boolean} toggle
+     * @returns {boolean}
+     */
     function shouldCacheResponse(request, response, toggle) {
         let opt = globalOptions;
         let codes = opt.statusCodes;
@@ -99,6 +137,11 @@ function ApiCache() {
         return true;
     }
 
+    /**
+     * Add key to index array
+     * @param {string} key Key to add
+     * @param {Object} req Express request object
+     */
     function addIndexEntries(key, req) {
         let groupName = req.apicacheGroup;
 
@@ -111,6 +154,16 @@ function ApiCache() {
         index.all.unshift(key);
     }
 
+    /**
+     * Returns a new object containing only the whitelisted headers.
+     * @param {Object} headers The original object of header names and
+     * values.
+     * @param {string[]} globalOptions.headerWhitelist An array of
+     * strings representing the whitelisted header names to keep in the
+     * output object.
+     *
+     * Generated by Trelent
+     */
     function filterBlacklistedHeaders(headers) {
         return Object.keys(headers)
             .filter(function (key) {
@@ -122,6 +175,14 @@ function ApiCache() {
             }, {});
     }
 
+    /**
+     * Create a cache object
+     * @param {Object} headers The response headers to filter.
+     * @returns {Object} A new object containing only the whitelisted
+     * response headers.
+     *
+     * Generated by Trelent
+     */
     function createCacheObject(status, headers, data, encoding) {
         return {
             status: status,
@@ -132,6 +193,15 @@ function ApiCache() {
         };
     }
 
+    /**
+     * Sets a cache value for the given key.
+     * @param {string} key The cache key to set.
+     * @param {any} value The cache value to set.
+     * @param {number} duration How long in milliseconds the cached
+     * response should be valid for (defaults to 1 hour).
+     *
+     * Generated by Trelent
+     */
     function cacheResponse(key, value, duration) {
         let redis = globalOptions.redisClient;
         let expireCallback = globalOptions.events.expire;
@@ -154,6 +224,13 @@ function ApiCache() {
         }, Math.min(duration, 2147483647));
     }
 
+    /**
+     * Appends content to the response.
+     * @param {Object} res Express response object
+     * @param {(string|Buffer)} content The content to append.
+     *
+     * Generated by Trelent
+     */
     function accumulateContent(res, content) {
         if (content) {
             if (typeof content == "string") {
@@ -179,6 +256,17 @@ function ApiCache() {
         }
     }
 
+    /**
+     * Monkeypatches the response object to add cache control headers
+     * and create a cache object.
+     * @param {Object} req Express request object
+     * @param {Object} res Express response object
+     * @param {function} next Function to call next
+     * @param {string} key Key to add response as
+     * @param {number} duration Time to cache response for
+     * @param {string} strDuration Duration in string form
+     * @param {function(Object, Object):boolean} toggle
+     */
     function makeResponseCacheable(req, res, next, key, duration, strDuration, toggle) {
     // monkeypatch res.end to create cache object
         res._apicache = {
@@ -245,6 +333,17 @@ function ApiCache() {
         next();
     }
 
+    /**
+     * Send a cached response to client
+     * @param {Request} request Express request object
+     * @param {Response} response Express response object
+     * @param {object} cacheObject Cache object to send
+     * @param {function(Object, Object):boolean} toggle
+     * @param {function} next Function to call next
+     * @param {number} duration Not used
+     * @returns {boolean|undefined} true if the request should be
+     * cached, false otherwise. If undefined, defaults to true.
+     */
     function sendCachedResponse(request, response, cacheObject, toggle, next, duration) {
         if (toggle && !toggle(request, response)) {
             return next();
@@ -285,12 +384,19 @@ function ApiCache() {
         return response.end(data, cacheObject.encoding);
     }
 
+    /** Sync caching options */
     function syncOptions() {
         for (let i in middlewareOptions) {
             Object.assign(middlewareOptions[i].options, globalOptions, middlewareOptions[i].localOptions);
         }
     }
 
+    /**
+     * Clear key from cache
+     * @param {string} target Key to clear
+     * @param {boolean} isAutomatic Is the key being cleared automatically
+     * @returns {number}
+     */
     this.clear = function (target, isAutomatic) {
         let group = index.groups[target];
         let redis = globalOptions.redisClient;
@@ -365,6 +471,14 @@ function ApiCache() {
         return this.getIndex();
     };
 
+    /**
+     * Converts a duration string to an integer number of milliseconds.
+     * @param {(string|number)} duration The string to convert.
+     * @param {number} defaultDuration The default duration to return if
+     * can't parse duration
+     * @returns {number} The converted value in milliseconds, or the
+     * defaultDuration if it can't be parsed.
+     */
     function parseDuration(duration, defaultDuration) {
         if (typeof duration === "number") {
             return duration;
@@ -387,17 +501,24 @@ function ApiCache() {
         return defaultDuration;
     }
 
+    /**
+     * Parse duration
+     * @param {(number|string)} duration
+     * @returns {number} Duration parsed to a number
+     */
     this.getDuration = function (duration) {
         return parseDuration(duration, globalOptions.defaultDuration);
     };
 
     /**
-   * Return cache performance statistics (hit rate).  Suitable for putting into a route:
+   * Return cache performance statistics (hit rate).  Suitable for
+   * putting into a route:
    * <code>
    * app.get('/api/cache/performance', (req, res) => {
    *    res.json(apicache.getPerformance())
    * })
    * </code>
+   * @returns {any[]}
    */
     this.getPerformance = function () {
         return performanceArray.map(function (p) {
@@ -405,6 +526,11 @@ function ApiCache() {
         });
     };
 
+    /**
+     * Get index of a group
+     * @param {string} group 
+     * @returns {number}
+     */
     this.getIndex = function (group) {
         if (group) {
             return index.groups[group];
@@ -413,6 +539,14 @@ function ApiCache() {
         }
     };
 
+    /**
+     * Express middleware
+     * @param {(string|number)} strDuration Duration to cache responses
+     * for.
+     * @param {function(Object, Object):boolean} middlewareToggle 
+     * @param {Object} localOptions Options for APICache
+     * @returns 
+     */
     this.middleware = function cache(strDuration, middlewareToggle, localOptions) {
         let duration = instance.getDuration(strDuration);
         let opt = {};
@@ -436,63 +570,72 @@ function ApiCache() {
         options(localOptions);
 
         /**
-     * A Function for non tracking performance
-     */
+         * A Function for non tracking performance
+         */
         function NOOPCachePerformance() {
             this.report = this.hit = this.miss = function () {}; // noop;
         }
 
         /**
-     * A function for tracking and reporting hit rate.  These statistics are returned by the getPerformance() call above.
-     */
+         * A function for tracking and reporting hit rate.  These
+         * statistics are returned by the getPerformance() call above.
+         */
         function CachePerformance() {
             /**
-       * Tracks the hit rate for the last 100 requests.
-       * If there have been fewer than 100 requests, the hit rate just considers the requests that have happened.
-       */
+             * Tracks the hit rate for the last 100 requests. If there
+             * have been fewer than 100 requests, the hit rate just
+             * considers the requests that have happened.
+             */
             this.hitsLast100 = new Uint8Array(100 / 4); // each hit is 2 bits
 
             /**
-       * Tracks the hit rate for the last 1000 requests.
-       * If there have been fewer than 1000 requests, the hit rate just considers the requests that have happened.
-       */
+             * Tracks the hit rate for the last 1000 requests. If there
+             * have been fewer than 1000 requests, the hit rate just
+             * considers the requests that have happened.
+             */
             this.hitsLast1000 = new Uint8Array(1000 / 4); // each hit is 2 bits
 
             /**
-       * Tracks the hit rate for the last 10000 requests.
-       * If there have been fewer than 10000 requests, the hit rate just considers the requests that have happened.
-       */
+             * Tracks the hit rate for the last 10000 requests. If there
+             * have been fewer than 10000 requests, the hit rate just
+             * considers the requests that have happened.
+             */
             this.hitsLast10000 = new Uint8Array(10000 / 4); // each hit is 2 bits
 
             /**
-       * Tracks the hit rate for the last 100000 requests.
-       * If there have been fewer than 100000 requests, the hit rate just considers the requests that have happened.
-       */
+             * Tracks the hit rate for the last 100000 requests. If
+             * there have been fewer than 100000 requests, the hit rate
+             * just considers the requests that have happened.
+             */
             this.hitsLast100000 = new Uint8Array(100000 / 4); // each hit is 2 bits
 
             /**
-       * The number of calls that have passed through the middleware since the server started.
-       */
+             * The number of calls that have passed through the
+             * middleware since the server started.
+             */
             this.callCount = 0;
 
             /**
-       * The total number of hits since the server started
-       */
+             * The total number of hits since the server started
+             */
             this.hitCount = 0;
 
             /**
-       * The key from the last cache hit.  This is useful in identifying which route these statistics apply to.
-       */
+             * The key from the last cache hit.  This is useful in
+             * identifying which route these statistics apply to.
+             */
             this.lastCacheHit = null;
 
             /**
-       * The key from the last cache miss.  This is useful in identifying which route these statistics apply to.
-       */
+             * The key from the last cache miss.  This is useful in
+             * identifying which route these statistics apply to.
+             */
             this.lastCacheMiss = null;
 
             /**
-       * Return performance statistics
-       */
+             * Return performance statistics
+             * @returns {Object}
+             */
             this.report = function () {
                 return {
                     lastCacheHit: this.lastCacheHit,
@@ -509,10 +652,13 @@ function ApiCache() {
             };
 
             /**
-       * Computes a cache hit rate from an array of hits and misses.
-       * @param {Uint8Array} array An array representing hits and misses.
-       * @returns a number between 0 and 1, or null if the array has no hits or misses
-       */
+             * Computes a cache hit rate from an array of hits and
+             * misses.
+             * @param {Uint8Array} array An array representing hits and
+             * misses.
+             * @returns {?number} a number between 0 and 1, or null if
+             * the array has no hits or misses
+             */
             this.hitRate = function (array) {
                 let hits = 0;
                 let misses = 0;
@@ -538,16 +684,17 @@ function ApiCache() {
             };
 
             /**
-       * Record a hit or miss in the given array.  It will be recorded at a position determined
-       * by the current value of the callCount variable.
-       * @param {Uint8Array} array An array representing hits and misses.
-       * @param {boolean} hit true for a hit, false for a miss
-       * Each element in the array is 8 bits, and encodes 4 hit/miss records.
-       * Each hit or miss is encoded as to bits as follows:
-       * 00 means no hit or miss has been recorded in these bits
-       * 01 encodes a hit
-       * 10 encodes a miss
-       */
+             * Record a hit or miss in the given array.  It will be
+             * recorded at a position determined by the current value of
+             * the callCount variable.
+             * @param {Uint8Array} array An array representing hits and
+             * misses.
+             * @param {boolean} hit true for a hit, false for a miss
+             * Each element in the array is 8 bits, and encodes 4
+             * hit/miss records. Each hit or miss is encoded as to bits
+             * as follows: 00 means no hit or miss has been recorded in
+             * these bits 01 encodes a hit 10 encodes a miss
+             */
             this.recordHitInArray = function (array, hit) {
                 let arrayIndex = ~~(this.callCount / 4) % array.length;
                 let bitOffset = (this.callCount % 4) * 2; // 2 bits per record, 4 records per uint8 array element
@@ -557,9 +704,11 @@ function ApiCache() {
             };
 
             /**
-       * Records the hit or miss in the tracking arrays and increments the call count.
-       * @param {boolean} hit true records a hit, false records a miss
-       */
+             * Records the hit or miss in the tracking arrays and
+             * increments the call count.
+             * @param {boolean} hit true records a hit, false records a
+             * miss
+             */
             this.recordHit = function (hit) {
                 this.recordHitInArray(this.hitsLast100, hit);
                 this.recordHitInArray(this.hitsLast1000, hit);
@@ -572,18 +721,18 @@ function ApiCache() {
             };
 
             /**
-       * Records a hit event, setting lastCacheMiss to the given key
-       * @param {string} key The key that had the cache hit
-       */
+             * Records a hit event, setting lastCacheMiss to the given key
+             * @param {string} key The key that had the cache hit
+             */
             this.hit = function (key) {
                 this.recordHit(true);
                 this.lastCacheHit = key;
             };
 
             /**
-       * Records a miss event, setting lastCacheMiss to the given key
-       * @param {string} key The key that had the cache miss
-       */
+             * Records a miss event, setting lastCacheMiss to the given key
+             * @param {string} key The key that had the cache miss
+             */
             this.miss = function (key) {
                 this.recordHit(false);
                 this.lastCacheMiss = key;
@@ -594,6 +743,13 @@ function ApiCache() {
 
         performanceArray.push(perf);
 
+        /**
+         * Cache a request
+         * @param {Object} req Express request object
+         * @param {Object} res Express response object
+         * @param {function} next Function to call next
+         * @returns {any}
+         */
         let cache = function (req, res, next) {
             function bypass() {
                 debug("bypass detected, skipping cache.");
@@ -701,6 +857,11 @@ function ApiCache() {
         return cache;
     };
 
+    /**
+     * Process options
+     * @param {Object} options 
+     * @returns {Object}
+     */
     this.options = function (options) {
         if (options) {
             Object.assign(globalOptions, options);
@@ -721,6 +882,7 @@ function ApiCache() {
         }
     };
 
+    /** Reset the index */
     this.resetIndex = function () {
         index = {
             all: [],
@@ -728,6 +890,11 @@ function ApiCache() {
         };
     };
 
+    /**
+     * Create a new instance of ApiCache
+     * @param {Object} config Config to pass
+     * @returns {ApiCache}
+     */
     this.newInstance = function (config) {
         let instance = new ApiCache();
 
@@ -738,6 +905,7 @@ function ApiCache() {
         return instance;
     };
 
+    /** Clone this instance */
     this.clone = function () {
         return this.newInstance(this.options());
     };

server/modules/apicache/memory-cache.js

@@ -3,6 +3,15 @@ function MemoryCache() {
     this.size = 0;
 }
 
+/**
+ * 
+ * @param {string} key Key to store cache as
+ * @param {any} value Value to store
+ * @param {number} time Time to store for
+ * @param {function(any, string)} timeoutCallback Callback to call in
+ * case of timeout
+ * @returns {Object}
+ */
 MemoryCache.prototype.add = function (key, value, time, timeoutCallback) {
     let old = this.cache[key];
     let instance = this;
@@ -22,6 +31,11 @@ MemoryCache.prototype.add = function (key, value, time, timeoutCallback) {
     return entry;
 };
 
+/**
+ * Delete a cache entry
+ * @param {string} key Key to delete
+ * @returns {null}
+ */
 MemoryCache.prototype.delete = function (key) {
     let entry = this.cache[key];
 
@@ -36,18 +50,32 @@ MemoryCache.prototype.delete = function (key) {
     return null;
 };
 
+/**
+ * Get value of key
+ * @param {string} key 
+ * @returns {Object}
+ */
 MemoryCache.prototype.get = function (key) {
     let entry = this.cache[key];
 
     return entry;
 };
 
+/**
+ * Get value of cache entry
+ * @param {string} key 
+ * @returns {any}
+ */
 MemoryCache.prototype.getValue = function (key) {
     let entry = this.get(key);
 
     return entry && entry.value;
 };
 
+/**
+ * Clear cache
+ * @returns {boolean}
+ */
 MemoryCache.prototype.clear = function () {
     Object.keys(this.cache).forEach(function (key) {
         this.delete(key);

server/notification-providers/alerta.js

@@ -0,0 +1,67 @@
+const NotificationProvider = require("./notification-provider");
+const { DOWN, UP } = require("../../src/util");
+const axios = require("axios");
+
+class Alerta extends NotificationProvider {
+
+    name = "alerta";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+
+        try {
+            let alertaUrl = `${notification.alertaApiEndpoint}`;
+            let config = {
+                headers: {
+                    "Content-Type": "application/json;charset=UTF-8",
+                    "Authorization": "Key " + notification.alertaApiKey,
+                }
+            };
+            let data = {
+                environment: notification.alertaEnvironment,
+                severity: "critical",
+                correlate: [],
+                service: [ "UptimeKuma" ],
+                value: "Timeout",
+                tags: [ "uptimekuma" ],
+                attributes: {},
+                origin: "uptimekuma",
+                type: "exceptionAlert",
+            };
+
+            if (heartbeatJSON == null) {
+                let postData = Object.assign({
+                    event: "msg",
+                    text: msg,
+                    group: "uptimekuma-msg",
+                    resource: "Message",
+                }, data);
+
+                await axios.post(alertaUrl, postData, config);
+            } else {
+                let datadup = Object.assign( {
+                    correlate: [ "service_up", "service_down" ],
+                    event: monitorJSON["type"],
+                    group: "uptimekuma-" + monitorJSON["type"],
+                    resource: monitorJSON["name"],
+                }, data );
+
+                if (heartbeatJSON["status"] === DOWN) {
+                    datadup.severity = notification.alertaAlertState; // critical
+                    datadup.text = "Service " + monitorJSON["type"] + " is down.";
+                    await axios.post(alertaUrl, datadup, config);
+                } else if (heartbeatJSON["status"] === UP) {
+                    datadup.severity = notification.alertaRecoverState; // cleaned
+                    datadup.text = "Service " + monitorJSON["type"] + " is up.";
+                    await axios.post(alertaUrl, datadup, config);
+                }
+            }
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+
+    }
+}
+
+module.exports = Alerta;

server/notification-providers/aliyun-sms.js

@@ -37,6 +37,12 @@ class AliyunSMS extends NotificationProvider {
         }
     }
 
+    /**
+     * Send the SMS notification
+     * @param {BeanModel} notification Notification details
+     * @param {string} msgbody Message template
+     * @returns {boolean} True if successful else false
+     */
     async sendSms(notification, msgbody) {
         let params = {
             PhoneNumbers: notification.phonenumber,
@@ -64,13 +70,18 @@ class AliyunSMS extends NotificationProvider {
         };
 
         let result = await axios(config);
-        if (result.data.Message == "OK") {
+        if (result.data.Message === "OK") {
             return true;
         }
         return false;
     }
 
-    /** Aliyun request sign */
+    /**
+     * Aliyun request sign
+     * @param {Object} param Parameters object to sign
+     * @param {string} AccessKeySecret Secret key to sign parameters with
+     * @returns {string}
+     */
     sign(param, AccessKeySecret) {
         let param2 = {};
         let data = [];
@@ -93,6 +104,11 @@ class AliyunSMS extends NotificationProvider {
             .digest("base64");
     }
 
+    /**
+     * Convert status constant to string
+     * @param {const} status The status constant
+     * @returns {string}
+     */
     statusToString(status) {
         switch (status) {
             case DOWN:

server/notification-providers/apprise.js

@@ -1,12 +1,12 @@
 const NotificationProvider = require("./notification-provider");
-const child_process = require("child_process");
+const childProcess = require("child_process");
 
 class Apprise extends NotificationProvider {
 
     name = "apprise";
 
     async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
-        let s = child_process.spawnSync("apprise", [ "-vv", "-b", msg, notification.appriseURL])
+        let s = childProcess.spawnSync("apprise", [ "-vv", "-b", msg, notification.appriseURL ]);
 
         let output = (s.stdout) ? s.stdout.toString() : "ERROR: maybe apprise not found";
 
@@ -16,7 +16,7 @@ class Apprise extends NotificationProvider {
                 return "Sent Successfully";
             }
 
-            throw new Error(output)
+            throw new Error(output);
         } else {
             return "No output from apprise";
         }

server/notification-providers/bark.js

@@ -21,35 +21,35 @@ class Bark extends NotificationProvider {
     name = "Bark";
 
     async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
-        try {
-            var barkEndpoint = notification.barkEndpoint;
+        let barkEndpoint = notification.barkEndpoint;
 
-            // check if the endpoint has a "/" suffix, if so, delete it first
-            if (barkEndpoint.endsWith("/")) {
-                barkEndpoint = barkEndpoint.substring(0, barkEndpoint.length - 1);
-            }
+        // check if the endpoint has a "/" suffix, if so, delete it first
+        if (barkEndpoint.endsWith("/")) {
+            barkEndpoint = barkEndpoint.substring(0, barkEndpoint.length - 1);
+        }
 
-            if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] == UP) {
-                let title = "UptimeKuma Monitor Up";
-                return await this.postNotification(title, msg, barkEndpoint);
-            }
+        if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === UP) {
+            let title = "UptimeKuma Monitor Up";
+            return await this.postNotification(title, msg, barkEndpoint);
+        }
 
-            if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] == DOWN) {
-                let title = "UptimeKuma Monitor Down";
-                return await this.postNotification(title, msg, barkEndpoint);
-            }
+        if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === DOWN) {
+            let title = "UptimeKuma Monitor Down";
+            return await this.postNotification(title, msg, barkEndpoint);
+        }
 
-            if (msg != null) {
-                let title = "UptimeKuma Message";
-                return await this.postNotification(title, msg, barkEndpoint);
-            }
-
-        } catch (error) {
-            throw error;
+        if (msg != null) {
+            let title = "UptimeKuma Message";
+            return await this.postNotification(title, msg, barkEndpoint);
         }
     }
 
-    // add additional parameter for better on device styles (iOS 15 optimized)
+    /**
+     * Add additional parameter for better on device styles (iOS 15
+     * optimized)
+     * @param {string} postUrl URL to append parameters to
+     * @returns {string}
+     */
     appendAdditionalParameters(postUrl) {
         // grouping all our notifications
         postUrl += "?group=" + barkNotificationGroup;
@@ -60,7 +60,11 @@ class Bark extends NotificationProvider {
         return postUrl;
     }
 
-    // thrown if failed to check result, result code should be in range 2xx
+    /**
+     * Check if result is successful
+     * @param {Object} result Axios response object
+     * @throws {Error} The status code is not in range 2xx
+     */
     checkResult(result) {
         if (result.status == null) {
             throw new Error("Bark notification failed with invalid response!");
@@ -70,6 +74,13 @@ class Bark extends NotificationProvider {
         }
     }
 
+    /**
+     * Send the message
+     * @param {string} title Message title
+     * @param {string} subtitle Message
+     * @param {string} endpoint Endpoint to send request to
+     * @returns {string}
+     */
     async postNotification(title, subtitle, endpoint) {
         // url encode title and subtitle
         title = encodeURIComponent(title);

server/notification-providers/clicksendsms.js

@@ -12,7 +12,7 @@ class ClickSendSMS extends NotificationProvider {
             let config = {
                 headers: {
                     "Content-Type": "application/json",
-                    "Authorization": "Basic " + Buffer.from(notification.clicksendsmsLogin + ":" + notification.clicksendsmsPassword).toString('base64'),
+                    "Authorization": "Basic " + Buffer.from(notification.clicksendsmsLogin + ":" + notification.clicksendsmsPassword).toString("base64"),
                     "Accept": "text/json",
                 }
             };

server/notification-providers/dingding.js

@@ -37,6 +37,12 @@ class DingDing extends NotificationProvider {
         }
     }
 
+    /**
+     * Send message to DingDing
+     * @param {BeanModel} notification
+     * @param {Object} params Parameters of message
+     * @returns {boolean} True if successful else false
+     */
     async sendToDingDing(notification, params) {
         let timestamp = Date.now();
 
@@ -50,13 +56,18 @@ class DingDing extends NotificationProvider {
         };
 
         let result = await axios(config);
-        if (result.data.errmsg == "ok") {
+        if (result.data.errmsg === "ok") {
             return true;
         }
         return false;
     }
 
-    /** DingDing sign */
+    /**
+     * DingDing sign
+     * @param {Date} timestamp Timestamp of message
+     * @param {string} secretKey Secret key to sign data with
+     * @returns {string}
+     */
     sign(timestamp, secretKey) {
         return Crypto
             .createHmac("sha256", Buffer.from(secretKey, "utf8"))
@@ -64,7 +75,13 @@ class DingDing extends NotificationProvider {
             .digest("base64");
     }
 
+    /**
+     * Convert status constant to string
+     * @param {const} status The status constant
+     * @returns {string}
+     */
     statusToString(status) {
+        // TODO: Move to notification-provider.js to avoid repetition in classes
         switch (status) {
             case DOWN:
                 return "DOWN";

server/notification-providers/discord.js

@@ -17,8 +17,8 @@ class Discord extends NotificationProvider {
                 let discordtestdata = {
                     username: discordDisplayName,
                     content: msg,
-                }
-                await axios.post(notification.discordWebhookUrl, discordtestdata)
+                };
+                await axios.post(notification.discordWebhookUrl, discordtestdata);
                 return okMsg;
             }
 
@@ -35,7 +35,7 @@ class Discord extends NotificationProvider {
             }
 
             // If heartbeatJSON is not null, we go into the normal alerting loop.
-            if (heartbeatJSON["status"] == DOWN) {
+            if (heartbeatJSON["status"] === DOWN) {
                 let discorddowndata = {
                     username: discordDisplayName,
                     embeds: [{
@@ -61,16 +61,16 @@ class Discord extends NotificationProvider {
                             },
                         ],
                     }],
-                }
+                };
 
                 if (notification.discordPrefixMessage) {
                     discorddowndata.content = notification.discordPrefixMessage;
                 }
 
-                await axios.post(notification.discordWebhookUrl, discorddowndata)
+                await axios.post(notification.discordWebhookUrl, discorddowndata);
                 return okMsg;
 
-            } else if (heartbeatJSON["status"] == UP) {
+            } else if (heartbeatJSON["status"] === UP) {
                 let discordupdata = {
                     username: discordDisplayName,
                     embeds: [{
@@ -96,17 +96,17 @@ class Discord extends NotificationProvider {
                             },
                         ],
                     }],
-                }
+                };
 
                 if (notification.discordPrefixMessage) {
                     discordupdata.content = notification.discordPrefixMessage;
                 }
 
-                await axios.post(notification.discordWebhookUrl, discordupdata)
+                await axios.post(notification.discordWebhookUrl, discordupdata);
                 return okMsg;
             }
         } catch (error) {
-            this.throwGeneralAxiosError(error)
+            this.throwGeneralAxiosError(error);
         }
     }
 

server/notification-providers/feishu.js

@@ -21,7 +21,7 @@ class Feishu extends NotificationProvider {
                 return okMsg;
             }
 
-            if (heartbeatJSON["status"] == DOWN) {
+            if (heartbeatJSON["status"] === DOWN) {
                 let downdata = {
                     msg_type: "post",
                     content: {
@@ -48,7 +48,7 @@ class Feishu extends NotificationProvider {
                 return okMsg;
             }
 
-            if (heartbeatJSON["status"] == UP) {
+            if (heartbeatJSON["status"] === UP) {
                 let updata = {
                     msg_type: "post",
                     content: {

server/notification-providers/google-chat.js

@@ -0,0 +1,47 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+const { setting } = require("../util-server");
+const { getMonitorRelativeURL } = require("../../src/util");
+const { DOWN, UP } = require("../../src/util");
+
+class GoogleChat extends NotificationProvider {
+
+    name = "GoogleChat";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+        try {
+            // Google Chat message formatting: https://developers.google.com/chat/api/guides/message-formats/basic
+
+            let textMsg = "";
+            if (heartbeatJSON && heartbeatJSON.status === UP) {
+                textMsg = "✅ Application is back online\n";
+            } else if (heartbeatJSON && heartbeatJSON.status === DOWN) {
+                textMsg = "🔴 Application went down\n";
+            }
+
+            if (monitorJSON && monitorJSON.name) {
+                textMsg += `*${monitorJSON.name}*\n`;
+            }
+
+            textMsg += `${msg}`;
+
+            const baseURL = await setting("primaryBaseURL");
+            if (baseURL && monitorJSON) {
+                textMsg += `\n${baseURL + getMonitorRelativeURL(monitorJSON.id)}`;
+            }
+
+            const data = {
+                "text": textMsg,
+            };
+
+            await axios.post(notification.googleChatWebhookURL, data);
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+
+    }
+}
+
+module.exports = GoogleChat;

server/notification-providers/gorush.js

@@ -0,0 +1,42 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class Gorush extends NotificationProvider {
+
+    name = "gorush";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+
+        let platformMapping = {
+            "ios": 1,
+            "android": 2,
+            "huawei": 3,
+        };
+
+        try {
+            let data = {
+                "notifications": [
+                    {
+                        "tokens": [ notification.gorushDeviceToken ],
+                        "platform": platformMapping[notification.gorushPlatform],
+                        "message": msg,
+                        // Optional
+                        "title": notification.gorushTitle,
+                        "priority": notification.gorushPriority,
+                        "retry": parseInt(notification.gorushRetry) || 0,
+                        "topic": notification.gorushTopic,
+                    }
+                ]
+            };
+            let config = {};
+
+            await axios.post(`${notification.gorushServerURL}/api/push`, data, config);
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = Gorush;

server/notification-providers/gotify.js

@@ -15,7 +15,7 @@ class Gotify extends NotificationProvider {
                 "message": msg,
                 "priority": notification.gotifyPriority || 8,
                 "title": "Uptime-Kuma",
-            })
+            });
 
             return okMsg;
 

server/notification-providers/line.js

@@ -25,9 +25,9 @@ class Line extends NotificationProvider {
                             "text": "Test Successful!"
                         }
                     ]
-                }
-                await axios.post(lineAPIUrl, testMessage, config)
-            } else if (heartbeatJSON["status"] == DOWN) {
+                };
+                await axios.post(lineAPIUrl, testMessage, config);
+            } else if (heartbeatJSON["status"] === DOWN) {
                 let downMessage = {
                     "to": notification.lineUserID,
                     "messages": [
@@ -36,9 +36,9 @@ class Line extends NotificationProvider {
                             "text": "UptimeKuma Alert: [🔴 Down]\n" + "Name: " + monitorJSON["name"] + " \n" + heartbeatJSON["msg"] + "\nTime (UTC): " + heartbeatJSON["time"]
                         }
                     ]
-                }
-                await axios.post(lineAPIUrl, downMessage, config)
-            } else if (heartbeatJSON["status"] == UP) {
+                };
+                await axios.post(lineAPIUrl, downMessage, config);
+            } else if (heartbeatJSON["status"] === UP) {
                 let upMessage = {
                     "to": notification.lineUserID,
                     "messages": [
@@ -47,12 +47,12 @@ class Line extends NotificationProvider {
                             "text": "UptimeKuma Alert: [✅ Up]\n" + "Name: " + monitorJSON["name"] + " \n" + heartbeatJSON["msg"] + "\nTime (UTC): " + heartbeatJSON["time"]
                         }
                     ]
-                }
-                await axios.post(lineAPIUrl, upMessage, config)
+                };
+                await axios.post(lineAPIUrl, upMessage, config);
             }
             return okMsg;
         } catch (error) {
-            this.throwGeneralAxiosError(error)
+            this.throwGeneralAxiosError(error);
         }
     }
 }

server/notification-providers/lunasea.js

@@ -8,38 +8,38 @@ class LunaSea extends NotificationProvider {
 
     async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
         let okMsg = "Sent Successfully.";
-        let lunaseadevice = "https://notify.lunasea.app/v1/custom/device/" + notification.lunaseaDevice
+        let lunaseadevice = "https://notify.lunasea.app/v1/custom/device/" + notification.lunaseaDevice;
 
         try {
             if (heartbeatJSON == null) {
                 let testdata = {
                     "title": "Uptime Kuma Alert",
                     "body": "Testing Successful.",
-                }
-                await axios.post(lunaseadevice, testdata)
+                };
+                await axios.post(lunaseadevice, testdata);
                 return okMsg;
             }
 
-            if (heartbeatJSON["status"] == DOWN) {
+            if (heartbeatJSON["status"] === DOWN) {
                 let downdata = {
                     "title": "UptimeKuma Alert: " + monitorJSON["name"],
                     "body": "[🔴 Down] " + heartbeatJSON["msg"] + "\nTime (UTC): " + heartbeatJSON["time"],
-                }
-                await axios.post(lunaseadevice, downdata)
+                };
+                await axios.post(lunaseadevice, downdata);
                 return okMsg;
             }
 
-            if (heartbeatJSON["status"] == UP) {
+            if (heartbeatJSON["status"] === UP) {
                 let updata = {
                     "title": "UptimeKuma Alert: " + monitorJSON["name"],
                     "body": "[✅ Up] " + heartbeatJSON["msg"] + "\nTime (UTC): " + heartbeatJSON["time"],
-                }
-                await axios.post(lunaseadevice, updata)
+                };
+                await axios.post(lunaseadevice, updata);
                 return okMsg;
             }
 
         } catch (error) {
-            this.throwGeneralAxiosError(error)
+            this.throwGeneralAxiosError(error);
         }
 
     }

server/notification-providers/matrix.js

@@ -1,7 +1,7 @@
 const NotificationProvider = require("./notification-provider");
 const axios = require("axios");
 const Crypto = require("crypto");
-const { debug } = require("../../src/util");
+const { log } = require("../../src/util");
 
 class Matrix extends NotificationProvider {
     name = "matrix";
@@ -17,11 +17,11 @@ class Matrix extends NotificationProvider {
                 .slice(0, size)
         );
 
-        debug("Random String: " + randomString);
+        log.debug("notification", "Random String: " + randomString);
 
         const roomId = encodeURIComponent(notification.internalRoomId);
 
-        debug("Matrix Room ID: " + roomId);
+        log.debug("notification", "Matrix Room ID: " + roomId);
 
         try {
             let config = {

server/notification-providers/mattermost.js

@@ -15,16 +15,21 @@ class Mattermost extends NotificationProvider {
                 let mattermostTestData = {
                     username: mattermostUserName,
                     text: msg,
-                }
-                await axios.post(notification.mattermostWebhookUrl, mattermostTestData)
+                };
+                await axios.post(notification.mattermostWebhookUrl, mattermostTestData);
                 return okMsg;
             }
 
-            const mattermostChannel = notification.mattermostchannel;
+            let mattermostChannel;
+
+            if (typeof notification.mattermostchannel === "string") {
+                mattermostChannel = notification.mattermostchannel.toLowerCase();
+            }
+
             const mattermostIconEmoji = notification.mattermosticonemo;
             const mattermostIconUrl = notification.mattermosticonurl;
 
-            if (heartbeatJSON["status"] == DOWN) {
+            if (heartbeatJSON["status"] === DOWN) {
                 let mattermostdowndata = {
                     username: mattermostUserName,
                     text: "Uptime Kuma Alert",
@@ -68,7 +73,7 @@ class Mattermost extends NotificationProvider {
                     mattermostdowndata
                 );
                 return okMsg;
-            } else if (heartbeatJSON["status"] == UP) {
+            } else if (heartbeatJSON["status"] === UP) {
                 let mattermostupdata = {
                     username: mattermostUserName,
                     text: "Uptime Kuma Alert",

server/notification-providers/notification-provider.js

@@ -7,17 +7,23 @@ class NotificationProvider {
     name = undefined;
 
     /**
-     * @param notification : BeanModel
-     * @param msg : string General Message
-     * @param monitorJSON : object Monitor details (For Up/Down only)
-     * @param heartbeatJSON : object Heartbeat details (For Up/Down only)
+     * Send a notification
+     * @param {BeanModel} notification
+     * @param {string} msg General Message
+     * @param {?Object} monitorJSON Monitor details (For Up/Down only)
+     * @param {?Object} heartbeatJSON Heartbeat details (For Up/Down only)
      * @returns {Promise<string>} Return Successful Message
-     * Throw Error with fail msg
+     * @throws Error with fail msg
      */
     async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
         throw new Error("Have to override Notification.send(...)");
     }
 
+    /**
+     * Throws an error
+     * @param {any} error The error to throw
+     * @throws {any} The error specified
+     */
     throwGeneralAxiosError(error) {
         let msg = "Error: " + error + " ";
 
@@ -25,11 +31,11 @@ class NotificationProvider {
             if (typeof error.response.data === "string") {
                 msg += error.response.data;
             } else {
-                msg += JSON.stringify(error.response.data)
+                msg += JSON.stringify(error.response.data);
             }
         }
 
-        throw new Error(msg)
+        throw new Error(msg);
     }
 }
 

server/notification-providers/octopush.js

@@ -10,7 +10,7 @@ class Octopush extends NotificationProvider {
 
         try {
         // Default - V2
-            if (notification.octopushVersion == 2 || !notification.octopushVersion) {
+            if (notification.octopushVersion === 2 || !notification.octopushVersion) {
                 let config = {
                     headers: {
                         "api-key": notification.octopushAPIKey,
@@ -30,14 +30,14 @@ class Octopush extends NotificationProvider {
                     "purpose": "alert",
                     "sender": notification.octopushSenderName
                 };
-                await axios.post("https://api.octopush.com/v1/public/sms-campaign/send", data, config)
-            } else if (notification.octopushVersion == 1) {
+                await axios.post("https://api.octopush.com/v1/public/sms-campaign/send", data, config);
+            } else if (notification.octopushVersion === 1) {
                 let data = {
                     "user_login": notification.octopushDMLogin,
                     "api_key": notification.octopushDMAPIKey,
                     "sms_recipients": notification.octopushDMPhoneNumber,
                     "sms_sender": notification.octopushDMSenderName,
-                    "sms_type": (notification.octopushDMSMSType == "sms_premium") ? "FR" : "XXX",
+                    "sms_type": (notification.octopushDMSMSType === "sms_premium") ? "FR" : "XXX",
                     "transactional": "1",
                     //octopush not supporting non ascii char
                     "sms_text": msg.replace(/[^\x00-\x7F]/g, ""),
@@ -49,7 +49,7 @@ class Octopush extends NotificationProvider {
                     },
                     params: data
                 };
-                await axios.post("https://www.octopush-dm.com/api/sms/json", {}, config)
+                await axios.post("https://www.octopush-dm.com/api/sms/json", {}, config);
             } else {
                 throw new Error("Unknown Octopush version!");
             }

server/notification-providers/onebot.js

@@ -0,0 +1,45 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class OneBot extends NotificationProvider {
+
+    name = "OneBot";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+        try {
+            let httpAddr = notification.httpAddr;
+            if (!httpAddr.startsWith("http")) {
+                httpAddr = "http://" + httpAddr;
+            }
+            if (!httpAddr.endsWith("/")) {
+                httpAddr += "/";
+            }
+            let onebotAPIUrl = httpAddr + "send_msg";
+            let config = {
+                headers: {
+                    "Content-Type": "application/json",
+                    "Authorization": "Bearer " + notification.accessToken,
+                }
+            };
+            let pushText = "UptimeKuma Alert: " + msg;
+            let data = {
+                "auto_escape": true,
+                "message": pushText,
+            };
+            if (notification.msgType === "group") {
+                data["message_type"] = "group";
+                data["group_id"] = notification.recieverId;
+            } else {
+                data["message_type"] = "private";
+                data["user_id"] = notification.recieverId;
+            }
+            await axios.post(onebotAPIUrl, data, config);
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = OneBot;

server/notification-providers/promosms.js

@@ -12,7 +12,7 @@ class PromoSMS extends NotificationProvider {
             let config = {
                 headers: {
                     "Content-Type": "application/json",
-                    "Authorization": "Basic " + Buffer.from(notification.promosmsLogin + ":" + notification.promosmsPassword).toString('base64'),
+                    "Authorization": "Basic " + Buffer.from(notification.promosmsLogin + ":" + notification.promosmsPassword).toString("base64"),
                     "Accept": "text/json",
                 }
             };
@@ -30,7 +30,7 @@ class PromoSMS extends NotificationProvider {
                 let error = "Something gone wrong. Api returned " + resp.data.response.status + ".";
                 this.throwGeneralAxiosError(error);
             }
-            
+
             return okMsg;
         } catch (error) {
             this.throwGeneralAxiosError(error);

server/notification-providers/pushbullet.js

@@ -23,26 +23,26 @@ class Pushbullet extends NotificationProvider {
                     "type": "note",
                     "title": "Uptime Kuma Alert",
                     "body": "Testing Successful.",
-                }
-                await axios.post(pushbulletUrl, testdata, config)
-            } else if (heartbeatJSON["status"] == DOWN) {
+                };
+                await axios.post(pushbulletUrl, testdata, config);
+            } else if (heartbeatJSON["status"] === DOWN) {
                 let downdata = {
                     "type": "note",
                     "title": "UptimeKuma Alert: " + monitorJSON["name"],
                     "body": "[🔴 Down] " + heartbeatJSON["msg"] + "\nTime (UTC): " + heartbeatJSON["time"],
-                }
-                await axios.post(pushbulletUrl, downdata, config)
-            } else if (heartbeatJSON["status"] == UP) {
+                };
+                await axios.post(pushbulletUrl, downdata, config);
+            } else if (heartbeatJSON["status"] === UP) {
                 let updata = {
                     "type": "note",
                     "title": "UptimeKuma Alert: " + monitorJSON["name"],
                     "body": "[✅ Up] " + heartbeatJSON["msg"] + "\nTime (UTC): " + heartbeatJSON["time"],
-                }
-                await axios.post(pushbulletUrl, updata, config)
+                };
+                await axios.post(pushbulletUrl, updata, config);
             }
             return okMsg;
         } catch (error) {
-            this.throwGeneralAxiosError(error)
+            this.throwGeneralAxiosError(error);
         }
     }
 }

server/notification-providers/pushdeer.js

@@ -0,0 +1,52 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+const { DOWN, UP } = require("../../src/util");
+
+class PushDeer extends NotificationProvider {
+
+    name = "PushDeer";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+        let pushdeerlink = "https://api2.pushdeer.com/message/push";
+
+        let valid = msg != null && monitorJSON != null && heartbeatJSON != null;
+
+        let title;
+        if (valid && heartbeatJSON.status === UP) {
+            title = "## Uptime Kuma: " + monitorJSON.name + " up";
+        } else if (valid && heartbeatJSON.status === DOWN) {
+            title = "## Uptime Kuma: " + monitorJSON.name + " down";
+        } else {
+            title = "## Uptime Kuma Message";
+        }
+
+        let data = {
+            "pushkey": notification.pushdeerKey,
+            "text": title,
+            "desp": msg.replace(/\n/g, "\n\n"),
+            "type": "markdown",
+        };
+
+        try {
+            let res = await axios.post(pushdeerlink, data);
+
+            if ("error" in res.data) {
+                let error = res.data.error;
+                this.throwGeneralAxiosError(error);
+            }
+            if (res.data.content.result.length === 0) {
+                let error = "Invalid PushDeer key";
+                this.throwGeneralAxiosError(error);
+            } else if (JSON.parse(res.data.content.result[0]).success !== "ok") {
+                let error = "Unknown error";
+                this.throwGeneralAxiosError(error);
+            }
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = PushDeer;

server/notification-providers/pushover.js

@@ -9,36 +9,31 @@ class Pushover extends NotificationProvider {
         let okMsg = "Sent Successfully.";
         let pushoverlink = "https://api.pushover.net/1/messages.json";
 
+        let data = {
+            "message": "<b>Uptime Kuma Alert</b>\n\n<b>Message</b>:" + msg,
+            "user": notification.pushoveruserkey,
+            "token": notification.pushoverapptoken,
+            "sound": notification.pushoversounds,
+            "priority": notification.pushoverpriority,
+            "title": notification.pushovertitle,
+            "retry": "30",
+            "expire": "3600",
+            "html": 1,
+        };
+
+        if (notification.pushoverdevice) {
+            data.device = notification.pushoverdevice;
+        }
+
         try {
             if (heartbeatJSON == null) {
-                let data = {
-                    "message": msg,
-                    "user": notification.pushoveruserkey,
-                    "token": notification.pushoverapptoken,
-                    "sound": notification.pushoversounds,
-                    "priority": notification.pushoverpriority,
-                    "title": notification.pushovertitle,
-                    "retry": "30",
-                    "expire": "3600",
-                    "html": 1,
-                };
+                await axios.post(pushoverlink, data);
+                return okMsg;
+            } else {
+                data.message += "\n<b>Time (UTC)</b>:" + heartbeatJSON["time"];
                 await axios.post(pushoverlink, data);
                 return okMsg;
             }
-
-            let data = {
-                "message": "<b>Uptime Kuma Alert</b>\n\n<b>Message</b>:" + msg + "\n<b>Time (UTC)</b>:" + heartbeatJSON["time"],
-                "user": notification.pushoveruserkey,
-                "token": notification.pushoverapptoken,
-                "sound": notification.pushoversounds,
-                "priority": notification.pushoverpriority,
-                "title": notification.pushovertitle,
-                "retry": "30",
-                "expire": "3600",
-                "html": 1,
-            };
-            await axios.post(pushoverlink, data);
-            return okMsg;
         } catch (error) {
             this.throwGeneralAxiosError(error);
         }

server/notification-providers/pushy.js

@@ -19,10 +19,10 @@ class Pushy extends NotificationProvider {
                     "badge": 1,
                     "sound": "ping.aiff"
                 }
-            })
+            });
             return okMsg;
         } catch (error) {
-            this.throwGeneralAxiosError(error)
+            this.throwGeneralAxiosError(error);
         }
     }
 }

server/notification-providers/rocket-chat.js

@@ -2,7 +2,7 @@ const NotificationProvider = require("./notification-provider");
 const axios = require("axios");
 const Slack = require("./slack");
 const { setting } = require("../util-server");
-const { getMonitorRelativeURL, UP, DOWN } = require("../../src/util");
+const { getMonitorRelativeURL, DOWN } = require("../../src/util");
 
 class RocketChat extends NotificationProvider {
 

server/notification-providers/signal.js

@@ -16,10 +16,10 @@ class Signal extends NotificationProvider {
             };
             let config = {};
 
-            await axios.post(notification.signalURL, data, config)
+            await axios.post(notification.signalURL, data, config);
             return okMsg;
         } catch (error) {
-            this.throwGeneralAxiosError(error)
+            this.throwGeneralAxiosError(error);
         }
     }
 }

server/notification-providers/slack.js

@@ -10,6 +10,7 @@ class Slack extends NotificationProvider {
     /**
      * Deprecated property notification.slackbutton
      * Set it as primary base url if this is not yet set.
+     * @param {string} url The primary base URL to use
      */
     static async deprecateURL(url) {
         let currentPrimaryBaseURL = await setting("primaryBaseURL");

server/notification-providers/smtp.js

@@ -1,6 +1,6 @@
 const nodemailer = require("nodemailer");
 const NotificationProvider = require("./notification-provider");
-const { DOWN, UP } = require("../../src/util");
+const { DOWN } = require("../../src/util");
 
 class SMTP extends NotificationProvider {
 
@@ -14,9 +14,21 @@ class SMTP extends NotificationProvider {
             secure: notification.smtpSecure,
             tls: {
                 rejectUnauthorized: notification.smtpIgnoreTLSError || false,
-            },
+            }
         };
 
+        // Fix #1129
+        if (notification.smtpDkimDomain) {
+            config.dkim = {
+                domainName: notification.smtpDkimDomain,
+                keySelector: notification.smtpDkimKeySelector,
+                privateKey: notification.smtpDkimPrivateKey,
+                hashAlgo: notification.smtpDkimHashAlgo,
+                headerFieldNames: notification.smtpDkimheaderFieldNames,
+                skipFields: notification.smtpDkimskipFields,
+            };
+        }
+
         // Should fix the issue in https://github.com/louislam/uptime-kuma/issues/26#issuecomment-896373904
         if (notification.smtpUsername || notification.smtpPassword) {
             config.auth = {

server/notification-providers/teams.js

@@ -5,6 +5,12 @@ const { DOWN, UP } = require("../../src/util");
 class Teams extends NotificationProvider {
     name = "teams";
 
+    /**
+     * Generate the message to send
+     * @param {const} status The status constant
+     * @param {string} monitorName Name of monitor
+     * @returns {string}
+     */
     _statusMessageFactory = (status, monitorName) => {
         if (status === DOWN) {
             return `🔴 Application [${monitorName}] went down`;
@@ -14,6 +20,11 @@ class Teams extends NotificationProvider {
         return "Notification";
     };
 
+    /**
+     * Select theme color to use based on status
+     * @param {const} status The status constant
+     * @returns {string} Selected color in hex RGB format
+     */
     _getThemeColor = (status) => {
         if (status === DOWN) {
             return "ff0000";
@@ -24,6 +35,14 @@ class Teams extends NotificationProvider {
         return "008cff";
     };
 
+    /**
+     * Generate payload for notification
+     * @param {const} status The status of the monitor
+     * @param {string} monitorMessage Message to send
+     * @param {string} monitorName Name of monitor affected
+     * @param {string} monitorUrl URL of monitor affected
+     * @returns {Object}
+     */
     _notificationPayloadFactory = ({
         status,
         monitorMessage,
@@ -74,10 +93,21 @@ class Teams extends NotificationProvider {
         };
     };
 
+    /**
+     * Send the notification
+     * @param {string} webhookUrl URL to send the request to
+     * @param {Object} payload Payload generated by _notificationPayloadFactory
+     */
     _sendNotification = async (webhookUrl, payload) => {
         await axios.post(webhookUrl, payload);
     };
 
+    /**
+     * Send a general notification
+     * @param {string} webhookUrl URL to send request to
+     * @param {string} msg Message to send
+     * @returns {Promise<void>}
+     */
     _handleGeneralNotification = (webhookUrl, msg) => {
         const payload = this._notificationPayloadFactory({
             monitorMessage: msg

server/notification-providers/techulus-push.js

@@ -0,0 +1,23 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class TechulusPush extends NotificationProvider {
+
+    name = "PushByTechulus";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+
+        try {
+            await axios.post(`https://push.techulus.com/api/v1/notify/${notification.pushAPIKey}`, {
+                "title": "Uptime-Kuma",
+                "body": msg,
+            });
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = TechulusPush;

server/notification-providers/telegram.js

@@ -14,12 +14,12 @@ class Telegram extends NotificationProvider {
                     chat_id: notification.telegramChatID,
                     text: msg,
                 },
-            })
+            });
             return okMsg;
 
         } catch (error) {
-            let msg = (error.response.data.description) ? error.response.data.description : "Error without description"
-            throw new Error(msg)
+            let msg = (error.response.data.description) ? error.response.data.description : "Error without description";
+            throw new Error(msg);
         }
     }
 }

server/notification-providers/webhook.js

@@ -24,17 +24,17 @@ class Webhook extends NotificationProvider {
 
                 config = {
                     headers: finalData.getHeaders(),
-                }
+                };
 
             } else {
                 finalData = data;
             }
 
-            await axios.post(notification.webhookURL, finalData, config)
+            await axios.post(notification.webhookURL, finalData, config);
             return okMsg;
 
         } catch (error) {
-            this.throwGeneralAxiosError(error)
+            this.throwGeneralAxiosError(error);
         }
 
     }

server/notification-providers/wecom.js

@@ -0,0 +1,53 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+const { DOWN, UP } = require("../../src/util");
+
+class WeCom extends NotificationProvider {
+
+    name = "WeCom";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        let okMsg = "Sent Successfully.";
+
+        try {
+            let WeComUrl = "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=" + notification.weComBotKey;
+            let config = {
+                headers: {
+                    "Content-Type": "application/json"
+                }
+            };
+            let body = this.composeMessage(heartbeatJSON, msg);
+            await axios.post(WeComUrl, body, config);
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+
+    /**
+     * Generate the message to send
+     * @param {Object} heartbeatJSON Heartbeat details (For Up/Down only)
+     * @param {string} msg General message
+     * @returns {Object}
+     */
+    composeMessage(heartbeatJSON, msg) {
+        let title;
+        if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === UP) {
+            title = "UptimeKuma Monitor Up";
+        }
+        if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === DOWN) {
+            title = "UptimeKuma Monitor Down";
+        }
+        if (msg != null) {
+            title = "UptimeKuma Message";
+        }
+        return {
+            msgtype: "text",
+            text: {
+                content: title + msg
+            }
+        };
+    }
+}
+
+module.exports = WeCom;

server/notification.js

@@ -12,6 +12,7 @@ const ClickSendSMS = require("./notification-providers/clicksendsms");
 const Pushbullet = require("./notification-providers/pushbullet");
 const Pushover = require("./notification-providers/pushover");
 const Pushy = require("./notification-providers/pushy");
+const TechulusPush = require("./notification-providers/techulus-push");
 const RocketChat = require("./notification-providers/rocket-chat");
 const Signal = require("./notification-providers/signal");
 const Slack = require("./notification-providers/slack");
@@ -23,15 +24,23 @@ const Feishu = require("./notification-providers/feishu");
 const AliyunSms = require("./notification-providers/aliyun-sms");
 const DingDing = require("./notification-providers/dingding");
 const Bark = require("./notification-providers/bark");
+const { log } = require("../src/util");
 const SerwerSMS = require("./notification-providers/serwersms");
 const Stackfield = require("./notification-providers/stackfield");
+const WeCom = require("./notification-providers/wecom");
+const GoogleChat = require("./notification-providers/google-chat");
+const Gorush = require("./notification-providers/gorush");
+const Alerta = require("./notification-providers/alerta");
+const OneBot = require("./notification-providers/onebot");
+const PushDeer = require("./notification-providers/pushdeer");
 
 class Notification {
 
     providerList = {};
 
+    /** Initialize the notification providers */
     static init() {
-        console.log("Prepare Notification Providers");
+        log.info("notification", "Prepare Notification Providers");
 
         this.providerList = {};
 
@@ -53,6 +62,7 @@ class Notification {
             new Pushbullet(),
             new Pushover(),
             new Pushy(),
+            new TechulusPush(),
             new RocketChat(),
             new Signal(),
             new Slack(),
@@ -62,6 +72,12 @@ class Notification {
             new Bark(),
             new SerwerSMS(),
             new Stackfield(),
+            new WeCom(),
+            new GoogleChat(),
+            new Gorush(),
+            new Alerta(),
+            new OneBot(),
+            new PushDeer(),
         ];
 
         for (let item of list) {
@@ -77,13 +93,13 @@ class Notification {
     }
 
     /**
-     *
-     * @param notification : BeanModel
-     * @param msg : string General Message
-     * @param monitorJSON : object Monitor details (For Up/Down only)
-     * @param heartbeatJSON : object Heartbeat details (For Up/Down only)
+     * Send a notification
+     * @param {BeanModel} notification
+     * @param {string} msg General Message
+     * @param {Object} monitorJSON Monitor details (For Up/Down only)
+     * @param {Object} heartbeatJSON Heartbeat details (For Up/Down only)
      * @returns {Promise<string>} Successful msg
-     * Throw Error with fail msg
+     * @throws Error with fail msg
      */
     static async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
         if (this.providerList[notification.type]) {
@@ -93,28 +109,35 @@ class Notification {
         }
     }
 
+    /**
+     * Save a notification
+     * @param {Object} notification Notification to save
+     * @param {?number} notificationID ID of notification to update
+     * @param {number} userID ID of user who adds notification
+     * @returns {Promise<Bean>}
+     */
     static async save(notification, notificationID, userID) {
-        let bean
+        let bean;
 
         if (notificationID) {
             bean = await R.findOne("notification", " id = ? AND user_id = ? ", [
                 notificationID,
                 userID,
-            ])
+            ]);
 
             if (! bean) {
-                throw new Error("notification not found")
+                throw new Error("notification not found");
             }
 
         } else {
-            bean = R.dispense("notification")
+            bean = R.dispense("notification");
         }
 
         bean.name = notification.name;
         bean.user_id = userID;
         bean.config = JSON.stringify(notification);
         bean.is_default = notification.isDefault || false;
-        await R.store(bean)
+        await R.store(bean);
 
         if (notification.applyExisting) {
             await applyNotificationEveryMonitor(bean.id, userID);
@@ -123,19 +146,29 @@ class Notification {
         return bean;
     }
 
+    /**
+     * Delete a notification
+     * @param {number} notificationID ID of notification to delete
+     * @param {number} userID ID of user who created notification
+     * @returns {Promise<void>}
+     */
     static async delete(notificationID, userID) {
         let bean = await R.findOne("notification", " id = ? AND user_id = ? ", [
             notificationID,
             userID,
-        ])
+        ]);
 
         if (! bean) {
-            throw new Error("notification not found")
+            throw new Error("notification not found");
         }
 
-        await R.trash(bean)
+        await R.trash(bean);
     }
 
+    /**
+     * Check if apprise exists
+     * @returns {boolean} Does the command apprise exist?
+     */
     static checkApprise() {
         let commandExistsSync = require("command-exists").sync;
         let exists = commandExistsSync("apprise");
@@ -144,6 +177,12 @@ class Notification {
 
 }
 
+/**
+ * Apply the notification to every monitor
+ * @param {number} notificationID ID of notification to apply
+ * @param {number} userID ID of user who created notification
+ * @returns {Promise<void>}
+ */
 async function applyNotificationEveryMonitor(notificationID, userID) {
     let monitors = await R.getAll("SELECT id FROM monitor WHERE user_id = ?", [
         userID
@@ -153,17 +192,17 @@ async function applyNotificationEveryMonitor(notificationID, userID) {
         let checkNotification = await R.findOne("monitor_notification", " monitor_id = ? AND notification_id = ? ", [
             monitors[i].id,
             notificationID,
-        ])
+        ]);
 
         if (! checkNotification) {
             let relation = R.dispense("monitor_notification");
             relation.monitor_id = monitors[i].id;
             relation.notification_id = notificationID;
-            await R.store(relation)
+            await R.store(relation);
         }
     }
 }
 
 module.exports = {
     Notification,
-}
+};

server/password-hash.js

@@ -2,22 +2,42 @@ const passwordHashOld = require("password-hash");
 const bcrypt = require("bcryptjs");
 const saltRounds = 10;
 
+/**
+ * Hash a password
+ * @param {string} password
+ * @returns {string}
+ */
 exports.generate = function (password) {
     return bcrypt.hashSync(password, saltRounds);
-}
+};
 
+/**
+ * Verify a password against a hash
+ * @param {string} password
+ * @param {string} hash
+ * @returns {boolean} Does the password match the hash?
+ */
 exports.verify = function (password, hash) {
     if (isSHA1(hash)) {
-        return passwordHashOld.verify(password, hash)
+        return passwordHashOld.verify(password, hash);
     }
 
     return bcrypt.compareSync(password, hash);
-}
+};
 
+/**
+ * Is the hash a SHA1 hash
+ * @param {string} hash
+ * @returns {boolean}
+ */
 function isSHA1(hash) {
-    return (typeof hash === "string" && hash.startsWith("sha1"))
+    return (typeof hash === "string" && hash.startsWith("sha1"));
 }
 
+/**
+ * Does the hash need to be rehashed?
+ * @returns {boolean}
+ */
 exports.needRehash = function (hash) {
     return isSHA1(hash);
-}
+};

server/ping-lite.js

@@ -8,6 +8,12 @@ const util = require("./util-server");
 
 module.exports = Ping;
 
+/**
+ * Constructor for ping class
+ * @param {string} host Host to ping
+ * @param {object} [options] Options for the ping command
+ * @param {array|string} [options.args] - Arguments to pass to the ping command
+ */
 function Ping(host, options) {
     if (!host) {
         throw new Error("You must specify a host to ping!");
@@ -48,7 +54,7 @@ function Ping(host, options) {
         this._args = (options.args) ? options.args : [ "-n", "-t", timeout, "-c", "1", host ];
         this._regmatch = /=([0-9.]+?) ms/;
 
-    } else if (util.FBSD) {
+    } else if (util.BSD) {
         this._bin = "/sbin/ping";
 
         const defaultArgs = [ "-n", "-t", timeout, "-c", "1", host ];
@@ -75,8 +81,17 @@ function Ping(host, options) {
 
 Ping.prototype.__proto__ = events.EventEmitter.prototype;
 
-// SEND A PING
-// ===========
+/**
+ * Callback for send
+ * @callback pingCB
+ * @param {any} err Any error encountered
+ * @param {number} ms Ping time in ms
+ */
+
+/**
+ * Send a ping
+ * @param {pingCB} callback Callback to call with results
+ */
 Ping.prototype.send = function (callback) {
     let self = this;
     callback = callback || function (err, ms) {
@@ -125,6 +140,11 @@ Ping.prototype.send = function (callback) {
         }
     });
 
+    /**
+     * @param {Function} callback
+     *
+     * Generated by Trelent
+     */
     function onEnd() {
         let stdout = this.stdout._stdout;
         let stderr = this.stderr._stderr;
@@ -145,8 +165,10 @@ Ping.prototype.send = function (callback) {
     }
 };
 
-// CALL Ping#send(callback) ON A TIMER
-// ===================================
+/**
+ * Ping every interval
+ * @param {pingCB} callback Callback to call with results
+ */
 Ping.prototype.start = function (callback) {
     let self = this;
     this._i = setInterval(function () {
@@ -155,8 +177,7 @@ Ping.prototype.start = function (callback) {
     self.send(callback);
 };
 
-// STOP SENDING PINGS
-// ==================
+/** Stop sending pings */
 Ping.prototype.stop = function () {
     clearInterval(this._i);
 };
@@ -165,7 +186,7 @@ Ping.prototype.stop = function () {
  * Try to convert to UTF-8 for Windows, as the ping's output on Windows is not UTF-8 and could be in other languages
  * Thank @pemassi
  * https://github.com/louislam/uptime-kuma/issues/570#issuecomment-941984094
- * @param data
+ * @param {any} data
  * @returns {string}
  */
 function convertOutput(data) {

server/prometheus.js

@@ -1,4 +1,5 @@
 const PrometheusClient = require("prom-client");
+const { log } = require("../src/util");
 
 const commonLabels = [
     "monitor_name",
@@ -8,32 +9,35 @@ const commonLabels = [
     "monitor_port",
 ];
 
-const monitor_cert_days_remaining = new PrometheusClient.Gauge({
+const monitorCertDaysRemaining = new PrometheusClient.Gauge({
     name: "monitor_cert_days_remaining",
     help: "The number of days remaining until the certificate expires",
     labelNames: commonLabels
 });
 
-const monitor_cert_is_valid = new PrometheusClient.Gauge({
+const monitorCertIsValid = new PrometheusClient.Gauge({
     name: "monitor_cert_is_valid",
     help: "Is the certificate still valid? (1 = Yes, 0= No)",
     labelNames: commonLabels
 });
-const monitor_response_time = new PrometheusClient.Gauge({
+const monitorResponseTime = new PrometheusClient.Gauge({
     name: "monitor_response_time",
     help: "Monitor Response Time (ms)",
     labelNames: commonLabels
 });
 
-const monitor_status = new PrometheusClient.Gauge({
+const monitorStatus = new PrometheusClient.Gauge({
     name: "monitor_status",
     help: "Monitor Status (1 = UP, 0= DOWN)",
     labelNames: commonLabels
 });
 
 class Prometheus {
-    monitorLabelValues = {}
+    monitorLabelValues = {};
 
+    /**
+     * @param {Object} monitor Monitor object to monitor
+     */
     constructor(monitor) {
         this.monitorLabelValues = {
             monitor_name: monitor.name,
@@ -44,46 +48,67 @@ class Prometheus {
         };
     }
 
+    /**
+     * Update the metrics page
+     * @param {Object} heartbeat Heartbeat details
+     * @param {Object} tlsInfo TLS details
+     */
     update(heartbeat, tlsInfo) {
 
         if (typeof tlsInfo !== "undefined") {
             try {
-                let is_valid = 0;
-                if (tlsInfo.valid == true) {
-                    is_valid = 1;
+                let isValid;
+                if (tlsInfo.valid === true) {
+                    isValid = 1;
                 } else {
-                    is_valid = 0;
+                    isValid = 0;
                 }
-                monitor_cert_is_valid.set(this.monitorLabelValues, is_valid);
+                monitorCertIsValid.set(this.monitorLabelValues, isValid);
             } catch (e) {
-                console.error(e);
+                log.error("prometheus", "Caught error");
+                log.error("prometheus", e);
             }
 
             try {
-                monitor_cert_days_remaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining);
+                if (tlsInfo.certInfo != null) {
+                    monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining);
+                }
             } catch (e) {
-                console.error(e);
+                log.error("prometheus", "Caught error");
+                log.error("prometheus", e);
             }
         }
 
         try {
-            monitor_status.set(this.monitorLabelValues, heartbeat.status);
+            monitorStatus.set(this.monitorLabelValues, heartbeat.status);
         } catch (e) {
-            console.error(e);
+            log.error("prometheus", "Caught error");
+            log.error("prometheus", e);
         }
 
         try {
             if (typeof heartbeat.ping === "number") {
-                monitor_response_time.set(this.monitorLabelValues, heartbeat.ping);
+                monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping);
             } else {
                 // Is it good?
-                monitor_response_time.set(this.monitorLabelValues, -1);
+                monitorResponseTime.set(this.monitorLabelValues, -1);
             }
+        } catch (e) {
+            log.error("prometheus", "Caught error");
+            log.error("prometheus", e);
+        }
+    }
+
+    remove() {
+        try {
+            monitorCertDaysRemaining.remove(this.monitorLabelValues);
+            monitorCertIsValid.remove(this.monitorLabelValues);
+            monitorResponseTime.remove(this.monitorLabelValues);
+            monitorStatus.remove(this.monitorLabelValues);
         } catch (e) {
             console.error(e);
         }
     }
-
 }
 
 module.exports = {

server/proxy.js

@@ -0,0 +1,189 @@
+const { R } = require("redbean-node");
+const HttpProxyAgent = require("http-proxy-agent");
+const HttpsProxyAgent = require("https-proxy-agent");
+const SocksProxyAgent = require("socks-proxy-agent");
+const { debug } = require("../src/util");
+const { UptimeKumaServer } = require("./uptime-kuma-server");
+
+class Proxy {
+
+    static SUPPORTED_PROXY_PROTOCOLS = [ "http", "https", "socks", "socks5", "socks4" ];
+
+    /**
+     * Saves and updates given proxy entity
+     *
+     * @param proxy
+     * @param proxyID
+     * @param userID
+     * @return {Promise<Bean>}
+     */
+    static async save(proxy, proxyID, userID) {
+        let bean;
+
+        if (proxyID) {
+            bean = await R.findOne("proxy", " id = ? AND user_id = ? ", [ proxyID, userID ]);
+
+            if (!bean) {
+                throw new Error("proxy not found");
+            }
+
+        } else {
+            bean = R.dispense("proxy");
+        }
+
+        // Make sure given proxy protocol is supported
+        if (!this.SUPPORTED_PROXY_PROTOCOLS.includes(proxy.protocol)) {
+            throw new Error(`
+                Unsupported proxy protocol "${proxy.protocol}.
+                Supported protocols are ${this.SUPPORTED_PROXY_PROTOCOLS.join(", ")}."`
+            );
+        }
+
+        // When proxy is default update deactivate old default proxy
+        if (proxy.default) {
+            await R.exec("UPDATE proxy SET `default` = 0 WHERE `default` = 1");
+        }
+
+        bean.user_id = userID;
+        bean.protocol = proxy.protocol;
+        bean.host = proxy.host;
+        bean.port = proxy.port;
+        bean.auth = proxy.auth;
+        bean.username = proxy.username;
+        bean.password = proxy.password;
+        bean.active = proxy.active || true;
+        bean.default = proxy.default || false;
+
+        await R.store(bean);
+
+        if (proxy.applyExisting) {
+            await applyProxyEveryMonitor(bean.id, userID);
+        }
+
+        return bean;
+    }
+
+    /**
+     * Deletes proxy with given id and removes it from monitors
+     *
+     * @param proxyID
+     * @param userID
+     * @return {Promise<void>}
+     */
+    static async delete(proxyID, userID) {
+        const bean = await R.findOne("proxy", " id = ? AND user_id = ? ", [ proxyID, userID ]);
+
+        if (!bean) {
+            throw new Error("proxy not found");
+        }
+
+        // Delete removed proxy from monitors if exists
+        await R.exec("UPDATE monitor SET proxy_id = null WHERE proxy_id = ?", [ proxyID ]);
+
+        // Delete proxy from list
+        await R.trash(bean);
+    }
+
+    /**
+     * Create HTTP and HTTPS agents related with given proxy bean object
+     *
+     * @param proxy proxy bean object
+     * @param options http and https agent options
+     * @return {{httpAgent: Agent, httpsAgent: Agent}}
+     */
+    static createAgents(proxy, options) {
+        const { httpAgentOptions, httpsAgentOptions } = options || {};
+        let agent;
+        let httpAgent;
+        let httpsAgent;
+
+        const proxyOptions = {
+            protocol: proxy.protocol,
+            host: proxy.host,
+            port: proxy.port,
+        };
+
+        if (proxy.auth) {
+            proxyOptions.auth = `${proxy.username}:${proxy.password}`;
+        }
+
+        debug(`Proxy Options: ${JSON.stringify(proxyOptions)}`);
+        debug(`HTTP Agent Options: ${JSON.stringify(httpAgentOptions)}`);
+        debug(`HTTPS Agent Options: ${JSON.stringify(httpsAgentOptions)}`);
+
+        switch (proxy.protocol) {
+            case "http":
+            case "https":
+                httpAgent = new HttpProxyAgent({
+                    ...httpAgentOptions || {},
+                    ...proxyOptions
+                });
+
+                httpsAgent = new HttpsProxyAgent({
+                    ...httpsAgentOptions || {},
+                    ...proxyOptions,
+                });
+                break;
+            case "socks":
+            case "socks5":
+            case "socks4":
+                agent = new SocksProxyAgent({
+                    ...httpAgentOptions,
+                    ...httpsAgentOptions,
+                    ...proxyOptions,
+                });
+
+                httpAgent = agent;
+                httpsAgent = agent;
+                break;
+
+            default: throw new Error(`Unsupported proxy protocol provided. ${proxy.protocol}`);
+        }
+
+        return {
+            httpAgent,
+            httpsAgent
+        };
+    }
+
+    /**
+     * Reload proxy settings for current monitors
+     * @returns {Promise<void>}
+     */
+    static async reloadProxy() {
+        const server = UptimeKumaServer.getInstance();
+
+        let updatedList = await R.getAssoc("SELECT id, proxy_id FROM monitor");
+
+        for (let monitorID in server.monitorList) {
+            let monitor = server.monitorList[monitorID];
+
+            if (updatedList[monitorID]) {
+                monitor.proxy_id = updatedList[monitorID].proxy_id;
+            }
+        }
+    }
+}
+
+/**
+ * Applies given proxy id to monitors
+ *
+ * @param proxyID
+ * @param userID
+ * @return {Promise<void>}
+ */
+async function applyProxyEveryMonitor(proxyID, userID) {
+    // Find all monitors with id and proxy id
+    const monitors = await R.getAll("SELECT id, proxy_id FROM monitor WHERE user_id = ?", [ userID ]);
+
+    // Update proxy id not match with given proxy id
+    for (const monitor of monitors) {
+        if (monitor.proxy_id !== proxyID) {
+            await R.exec("UPDATE monitor SET proxy_id = ? WHERE id = ?", [ proxyID, monitor.id ]);
+        }
+    }
+}
+
+module.exports = {
+    Proxy,
+};

server/rate-limiter.js

@@ -1,15 +1,30 @@
 const { RateLimiter } = require("limiter");
-const { debug } = require("../src/util");
+const { log } = require("../src/util");
 
 class KumaRateLimiter {
+    /**
+     * @param {Object} config Rate limiter configuration object
+     */
     constructor(config) {
         this.errorMessage = config.errorMessage;
         this.rateLimiter = new RateLimiter(config);
     }
 
+    /**
+     * Callback for pass
+     * @callback passCB
+     * @param {Object} err Too many requests
+     */
+
+    /**
+     * Should the request be passed through
+     * @param {passCB} callback
+     * @param {number} [num=1] Number of tokens to remove
+     * @returns {Promise<boolean>}
+     */
     async pass(callback, num = 1) {
         const remainingRequests = await this.removeTokens(num);
-        debug("Rate Limit (remainingRequests):" + remainingRequests);
+        log.info("rate-limit", "remaining requests: " + remainingRequests);
         if (remainingRequests < 0) {
             if (callback) {
                 callback({
@@ -22,6 +37,11 @@ class KumaRateLimiter {
         return true;
     }
 
+    /**
+     * Remove a given number of tokens
+     * @param {number} [num=1] Number of tokens to remove
+     * @returns {Promise<number>}
+     */
     async removeTokens(num = 1) {
         return await this.rateLimiter.removeTokens(num);
     }
@@ -34,6 +54,14 @@ const loginRateLimiter = new KumaRateLimiter({
     errorMessage: "Too frequently, try again later."
 });
 
+const twoFaRateLimiter = new KumaRateLimiter({
+    tokensPerInterval: 30,
+    interval: "minute",
+    fireImmediately: true,
+    errorMessage: "Too frequently, try again later."
+});
+
 module.exports = {
-    loginRateLimiter
+    loginRateLimiter,
+    twoFaRateLimiter,
 };

server/routers/api-router.js

@@ -1,19 +1,31 @@
 let express = require("express");
-const { allowDevAllOrigin, getSettings, setting } = require("../util-server");
+const { allowDevAllOrigin } = require("../util-server");
 const { R } = require("redbean-node");
-const server = require("../server");
 const apicache = require("../modules/apicache");
 const Monitor = require("../model/monitor");
 const dayjs = require("dayjs");
-const { UP, DOWN, flipStatus, debug } = require("../../src/util");
+const { UP, DOWN, flipStatus, log } = require("../../src/util");
+const StatusPage = require("../model/status_page");
+const { UptimeKumaServer } = require("../uptime-kuma-server");
 let router = express.Router();
 
 let cache = apicache.middleware;
+const server = UptimeKumaServer.getInstance();
 let io = server.io;
 
-router.get("/api/entry-page", async (_, response) => {
+router.get("/api/entry-page", async (request, response) => {
     allowDevAllOrigin(response);
-    response.json(server.entryPage);
+
+    let result = { };
+
+    if (request.hostname in StatusPage.domainMappingList) {
+        result.type = "statusPageMatchedDomain";
+        result.statusPageSlug = StatusPage.domainMappingList[request.hostname];
+    } else {
+        result.type = "entryPage";
+        result.entryPage = server.entryPage;
+    }
+    response.json(result);
 });
 
 router.get("/api/push/:pushToken", async (request, response) => {
@@ -52,8 +64,8 @@ router.get("/api/push/:pushToken", async (request, response) => {
             duration = dayjs(bean.time).diff(dayjs(previousHeartbeat.time), "second");
         }
 
-        debug("PreviousStatus: " + previousStatus);
-        debug("Current Status: " + status);
+        log.debug("router", "PreviousStatus: " + previousStatus);
+        log.debug("router", "Current Status: " + status);
 
         bean.important = Monitor.isImportantBeat(isFirstBeat, previousStatus, status);
         bean.monitor_id = monitor.id;
@@ -83,110 +95,80 @@ router.get("/api/push/:pushToken", async (request, response) => {
     }
 });
 
-// Status Page Config
-router.get("/api/status-page/config", async (_request, response) => {
+// Status page config, incident, monitor list
+router.get("/api/status-page/:slug", cache("5 minutes"), async (request, response) => {
     allowDevAllOrigin(response);
+    let slug = request.params.slug;
 
-    let config = await getSettings("statusPage");
+    // Get Status Page
+    let statusPage = await R.findOne("status_page", " slug = ? ", [
+        slug
+    ]);
 
-    if (! config.statusPageTheme) {
-        config.statusPageTheme = "light";
+    if (!statusPage) {
+        response.statusCode = 404;
+        response.json({
+            msg: "Not Found"
+        });
+        return;
     }
 
-    if (! config.statusPagePublished) {
-        config.statusPagePublished = true;
-    }
-
-    if (! config.statusPageTags) {
-        config.statusPageTags = false;
-    }
-
-    if (! config.title) {
-        config.title = "Uptime Kuma";
-    }
-
-    response.json(config);
-});
-
-// Status Page - Get the current Incident
-// Can fetch only if published
-router.get("/api/status-page/incident", async (_, response) => {
-    allowDevAllOrigin(response);
-
     try {
-        await checkPublished();
-
-        let incident = await R.findOne("incident", " pin = 1 AND active = 1");
+        // Incident
+        let incident = await R.findOne("incident", " pin = 1 AND active = 1 AND status_page_id = ? ", [
+            statusPage.id,
+        ]);
 
         if (incident) {
             incident = incident.toPublicJSON();
         }
 
+        // Public Group List
+        const publicGroupList = [];
+        const showTags = !!statusPage.show_tags;
+
+        const list = await R.find("group", " public = 1 AND status_page_id = ? ORDER BY weight ", [
+            statusPage.id
+        ]);
+
+        for (let groupBean of list) {
+            let monitorGroup = await groupBean.toPublicJSON(showTags);
+            publicGroupList.push(monitorGroup);
+        }
+
+        // Response
         response.json({
-            ok: true,
+            config: await statusPage.toPublicJSON(),
             incident,
+            publicGroupList
         });
 
     } catch (error) {
         send403(response, error.message);
     }
-});
 
-// Status Page - Monitor List
-// Can fetch only if published
-router.get("/api/status-page/monitor-list", cache("5 minutes"), async (_request, response) => {
-    allowDevAllOrigin(response);
-
-    try {
-        await checkPublished();
-        const publicGroupList = [];
-        const tagsVisible = (await getSettings("statusPage")).statusPageTags;
-        const list = await R.find("group", " public = 1 ORDER BY weight ");
-        for (let groupBean of list) {
-            let monitorGroup = await groupBean.toPublicJSON();
-            if (tagsVisible) {
-                monitorGroup.monitorList = await Promise.all(monitorGroup.monitorList.map(async (monitor) => {
-                    // Includes tags as an array in response, allows for tags to be displayed on public status page
-                    const tags = await R.getAll(
-                            `SELECT monitor_tag.monitor_id, monitor_tag.value, tag.name, tag.color
-                            FROM monitor_tag
-                            JOIN tag
-                            ON monitor_tag.tag_id = tag.id
-                            WHERE monitor_tag.monitor_id = ?`, [monitor.id]
-                    );
-                    return {
-                        ...monitor,
-                        tags: tags
-                    };
-                }));
-            }
-
-            publicGroupList.push(monitorGroup);
-        }
-
-        response.json(publicGroupList);
-
-    } catch (error) {
-        send403(response, error.message);
-    }
 });
 
 // Status Page Polling Data
 // Can fetch only if published
-router.get("/api/status-page/heartbeat", cache("5 minutes"), async (_request, response) => {
+router.get("/api/status-page/heartbeat/:slug", cache("1 minutes"), async (request, response) => {
     allowDevAllOrigin(response);
 
     try {
-        await checkPublished();
-
         let heartbeatList = {};
         let uptimeList = {};
 
+        let slug = request.params.slug;
+        let statusPageID = await StatusPage.slugToID(slug);
+
         let monitorIDList = await R.getCol(`
             SELECT monitor_group.monitor_id FROM monitor_group, \`group\`
             WHERE monitor_group.group_id = \`group\`.id
             AND public = 1
-        `);
+            AND \`group\`.status_page_id = ?
+        `, [
+            statusPageID
+        ]);
 
         for (let monitorID of monitorIDList) {
             let list = await R.getAll(`
@@ -215,24 +197,11 @@ router.get("/api/status-page/heartbeat", cache("5 minutes"), async (_request, re
     }
 });
 
-async function checkPublished() {
-    if (! await isPublished()) {
-        throw new Error("The status page is not published");
-    }
-}
-
 /**
- * Default is published
- * @returns {Promise<boolean>}
+ * Send a 403 response
+ * @param {Object} res Express response object
+ * @param {string} [msg=""] Message to send
  */
-async function isPublished() {
-    const value = await setting("statusPagePublished");
-    if (value === null) {
-        return true;
-    }
-    return value;
-}
-
 function send403(res, msg = "") {
     res.status(403).json({
         "status": "fail",

server/socket-handlers/cloudflared-socket-handler.js

@@ -0,0 +1,111 @@
+const { checkLogin, setSetting, setting, doubleCheckPassword } = require("../util-server");
+const { CloudflaredTunnel } = require("node-cloudflared-tunnel");
+const { UptimeKumaServer } = require("../uptime-kuma-server");
+const io = UptimeKumaServer.getInstance().io;
+
+const prefix = "cloudflared_";
+const cloudflared = new CloudflaredTunnel();
+
+/**
+ * Change running state
+ * @param {string} running Is it running?
+ * @param {string} message Message to pass
+ */
+cloudflared.change = (running, message) => {
+    io.to("cloudflared").emit(prefix + "running", running);
+    io.to("cloudflared").emit(prefix + "message", message);
+};
+
+/**
+ * Emit an error message
+ * @param {string} errorMessage
+ */
+cloudflared.error = (errorMessage) => {
+    io.to("cloudflared").emit(prefix + "errorMessage", errorMessage);
+};
+
+/**
+ * Handler for cloudflared
+ * @param {Socket} socket Socket.io instance
+ */
+module.exports.cloudflaredSocketHandler = (socket) => {
+
+    socket.on(prefix + "join", async () => {
+        try {
+            checkLogin(socket);
+            socket.join("cloudflared");
+            io.to(socket.userID).emit(prefix + "installed", cloudflared.checkInstalled());
+            io.to(socket.userID).emit(prefix + "running", cloudflared.running);
+            io.to(socket.userID).emit(prefix + "token", await setting("cloudflaredTunnelToken"));
+        } catch (error) { }
+    });
+
+    socket.on(prefix + "leave", async () => {
+        try {
+            checkLogin(socket);
+            socket.leave("cloudflared");
+        } catch (error) { }
+    });
+
+    socket.on(prefix + "start", async (token) => {
+        try {
+            checkLogin(socket);
+            if (token && typeof token === "string") {
+                await setSetting("cloudflaredTunnelToken", token);
+                cloudflared.token = token;
+            } else {
+                cloudflared.token = null;
+            }
+            cloudflared.start();
+        } catch (error) { }
+    });
+
+    socket.on(prefix + "stop", async (currentPassword, callback) => {
+        try {
+            checkLogin(socket);
+            await doubleCheckPassword(socket, currentPassword);
+            cloudflared.stop();
+        } catch (error) {
+            callback({
+                ok: false,
+                msg: error.message,
+            });
+        }
+    });
+
+    socket.on(prefix + "removeToken", async () => {
+        try {
+            checkLogin(socket);
+            await setSetting("cloudflaredTunnelToken", "");
+        } catch (error) { }
+    });
+
+};
+
+/**
+ * Automatically start cloudflared
+ * @param {string} token Cloudflared tunnel token
+ */
+module.exports.autoStart = async (token) => {
+    if (!token) {
+        token = await setting("cloudflaredTunnelToken");
+    } else {
+        // Override the current token via args or env var
+        await setSetting("cloudflaredTunnelToken", token);
+        console.log("Use cloudflared token from args or env var");
+    }
+
+    if (token) {
+        console.log("Start cloudflared");
+        cloudflared.token = token;
+        cloudflared.start();
+    }
+};
+
+/** Stop cloudflared */
+module.exports.stop = async () => {
+    console.log("Stop cloudflared");
+    if (cloudflared) {
+        cloudflared.stop();
+    }
+};