diff --git a/.devcontainer/README.md b/.devcontainer/README.md
deleted file mode 100644
index 4a34b21153..0000000000
--- a/.devcontainer/README.md
+++ /dev/null
@@ -1,28 +0,0 @@
-# Codespaces
-
-You can modifiy Uptime Kuma in your browser without setting up a local development.
-
-
-
-1. Click `Code` -> `Create codespace on master`
-2. Wait a few minutes until you see there are two exposed ports
-3. Go to the `3000` url, see if it is working
-
-
-
-## Frontend
-
-Since the frontend is using [Vite.js](https://vitejs.dev/), all changes in this area will be hot-reloaded.
-You don't need to restart the frontend, unless you try to add a new frontend dependency.
-
-## Backend
-
-The backend does not automatically hot-reload.
-You will need to restart the backend after changing something using these steps:
-
-1. Click `Terminal`
-2. Click `Codespaces: server-dev` in the right panel
-3. Press `Ctrl + C` to stop the server
-4. Press `Up` to run `npm run start-server-dev`
-
-
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
deleted file mode 100644
index 5b3ceabc82..0000000000
--- a/.devcontainer/devcontainer.json
+++ /dev/null
@@ -1,22 +0,0 @@
-{
- "image": "mcr.microsoft.com/devcontainers/javascript-node:dev-18-bookworm",
- "features": {
- "ghcr.io/devcontainers/features/github-cli:1": {}
- },
- "updateContentCommand": "npm ci",
- "postCreateCommand": "",
- "postAttachCommand": {
- "frontend-dev": "npm run start-frontend-devcontainer",
- "server-dev": "npm run start-server-dev",
- "open-port": "gh codespace ports visibility 3001:public -c $CODESPACE_NAME"
- },
- "customizations": {
- "vscode": {
- "extensions": [
- "streetsidesoftware.code-spell-checker",
- "dbaeumer.vscode-eslint"
- ]
- }
- },
- "forwardPorts": [3000, 3001]
-}
diff --git a/.dockerignore b/.dockerignore
index 226f8e22fa..5db08b7bf6 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -1,7 +1,6 @@
/.idea
/node_modules
-/data
-/cypress
+/data*
/out
/test
/kubernetes
@@ -18,7 +17,6 @@ README.md
.vscode
.eslint*
.stylelint*
-/.devcontainer
/.github
yarn.lock
app.json
@@ -30,7 +28,6 @@ SECURITY.md
tsconfig.json
.env
/tmp
-/babel.config.js
/ecosystem.config.js
/extra/healthcheck.exe
/extra/healthcheck
diff --git a/.eslintrc.js b/.eslintrc.js
index 9b30158d66..5da22e72d7 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -1,7 +1,7 @@
module.exports = {
ignorePatterns: [
- "test/*",
- "server/modules/apicache/*",
+ "test/*.js",
+ "server/modules/*",
"src/util.js"
],
root: true,
@@ -14,13 +14,18 @@ module.exports = {
extends: [
"eslint:recommended",
"plugin:vue/vue3-recommended",
+ "plugin:jsdoc/recommended-error",
],
parser: "vue-eslint-parser",
parserOptions: {
- parser: "@babel/eslint-parser",
+ parser: "@typescript-eslint/parser",
sourceType: "module",
requireConfigFile: false,
},
+ plugins: [
+ "jsdoc",
+ "@typescript-eslint",
+ ],
rules: {
"yoda": "error",
eqeqeq: [ "warn", "smart" ],
@@ -71,7 +76,7 @@ module.exports = {
"no-var": "error",
"key-spacing": "warn",
"keyword-spacing": "warn",
- "space-infix-ops": "warn",
+ "space-infix-ops": "error",
"arrow-spacing": "warn",
"no-trailing-spaces": "error",
"no-constant-condition": [ "error", {
@@ -98,7 +103,43 @@ module.exports = {
}],
"no-control-regex": "off",
"one-var": [ "error", "never" ],
- "max-statements-per-line": [ "error", { "max": 1 }]
+ "max-statements-per-line": [ "error", { "max": 1 }],
+ "jsdoc/check-tag-names": [
+ "error",
+ {
+ "definedTags": [ "link" ]
+ }
+ ],
+ "jsdoc/no-undefined-types": "off",
+ "jsdoc/no-defaults": [
+ "error",
+ { "noOptionalParamNames": true }
+ ],
+ "jsdoc/require-throws": "warn",
+ "jsdoc/require-jsdoc": [
+ "error",
+ {
+ "require": {
+ "FunctionDeclaration": true,
+ "MethodDefinition": true,
+ }
+ }
+ ],
+ "jsdoc/no-blank-block-descriptions": "error",
+ "jsdoc/require-returns-description": "warn",
+ "jsdoc/require-returns-check": [
+ "error",
+ { "reportMissingReturnForUndefinedTypes": false }
+ ],
+ "jsdoc/require-returns": [
+ "warn",
+ {
+ "forceRequireReturn": true,
+ "forceReturnsWithAsync": true
+ }
+ ],
+ "jsdoc/require-param-type": "warn",
+ "jsdoc/require-param-description": "warn"
},
"overrides": [
{
@@ -108,21 +149,20 @@ module.exports = {
}
},
- // Override for jest puppeteer
+ // Override for TypeScript
{
"files": [
- "**/*.spec.js",
- "**/*.spec.jsx"
+ "**/*.ts",
],
- env: {
- jest: true,
- },
- globals: {
- page: true,
- browser: true,
- context: true,
- jestPuppeteer: true,
- },
+ extends: [
+ "plugin:@typescript-eslint/recommended",
+ ],
+ "rules": {
+ "jsdoc/require-returns-type": "off",
+ "jsdoc/require-param-type": "off",
+ "@typescript-eslint/no-explicit-any": "off",
+ "prefer-const": "off",
+ }
}
]
};
diff --git a/.github/ISSUE_TEMPLATE/ask-for-help.yaml b/.github/ISSUE_TEMPLATE/ask-for-help.yaml
index c082b2e34b..a708dbf233 100644
--- a/.github/ISSUE_TEMPLATE/ask-for-help.yaml
+++ b/.github/ISSUE_TEMPLATE/ask-for-help.yaml
@@ -6,7 +6,7 @@ body:
- type: checkboxes
id: no-duplicate-issues
attributes:
- label: "⚠️ Please verify that this bug has NOT been raised before."
+ label: "⚠️ Please verify that this question has NOT been raised before."
description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
options:
- label: "I checked and didn't find similar issue"
@@ -24,7 +24,7 @@ body:
required: true
attributes:
label: "📝 Describe your problem"
- description: "Please walk us through it step by step."
+ description: "Please walk us through it step by step. Include all important details and add screenshots where appropriate"
placeholder: "Describe what are you asking for..."
- type: textarea
id: error-msg
@@ -56,19 +56,20 @@ body:
placeholder: "Ex. Google Chrome 95.0.4638.69"
validations:
required: true
- - type: input
- id: docker-version
- attributes:
- label: "🐋 Docker Version"
- description: "If running with Docker, which version are you running?"
- placeholder: "Ex. Docker 20.10.9 / K8S / Podman"
- validations:
- required: false
- - type: input
- id: nodejs-version
+ - type: textarea
+ id: deployment-info
attributes:
- label: "🟩 NodeJS Version"
- description: "If running with Node.js? which version are you running?"
- placeholder: "Ex. 14.18.0"
+ label: "🖥️ Deployment Environment"
+ description: |
+ examples:
+ - **Runtime**: Docker 20.10.9 / nodejs 14.18.0 / K8S via ... v1.3.3 / ..
+ - **Database**: sqlite/embedded mariadb/external mariadb
+ - **Filesystem used to store the database on**: Windows/ZFS/btrfs/NFSv3 on a SSD/HDD/eMMC
+ - **number of monitors**: 42
+ value: |
+ - Runtime:
+ - Database:
+ - Filesystem used to store the database on:
+ - number of monitors:
validations:
- required: false
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
index 0724442054..9745a76a62 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yaml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -3,14 +3,14 @@ description: "Submit a bug report to help us improve"
#title: "[Bug] "
labels: [bug]
body:
- - type: checkboxes
- id: no-duplicate-issues
+ - type: textarea
+ id: related-issues
+ validations:
+ required: true
attributes:
- label: "⚠️ Please verify that this bug has NOT been raised before."
- description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
- options:
- - label: "I checked and didn't find similar issue"
- required: true
+ label: "📑 I have found these related issues/pull requests"
+ description: "Search related issues by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain what the difference between them or explain that you are unable to find any related issues"
+ placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
- type: checkboxes
attributes:
label: "🛡️ Security Policy"
@@ -31,7 +31,7 @@ body:
required: true
attributes:
label: "👟 Reproduction steps"
- description: "How do you trigger this bug? Please walk us through it step by step."
+ description: "How do you trigger this bug? Please walk us through it step by step. Include all important details and add screenshots where appropriate"
placeholder: "..."
- type: textarea
id: expected-behavior
@@ -73,22 +73,23 @@ body:
placeholder: "Ex. Google Chrome 95.0.4638.69"
validations:
required: true
- - type: input
- id: docker-version
- attributes:
- label: "🐋 Docker Version"
- description: "If running with Docker, which version are you running?"
- placeholder: "Ex. Docker 20.10.9 / K8S / Podman"
- validations:
- required: false
- - type: input
- id: nodejs-version
+ - type: textarea
+ id: deployment-info
attributes:
- label: "🟩 NodeJS Version"
- description: "If running with Node.js? which version are you running?"
- placeholder: "Ex. 14.18.0"
+ label: "🖥️ Deployment Environment"
+ description: |
+ examples:
+ - **Runtime**: Docker 20.10.9 / nodejs 18.17.1 / K8S via ... v1.3.3 / ..
+ - **Database**: sqlite/embedded mariadb/external mariadb
+ - **Filesystem used to store the database on**: Windows/ZFS/btrfs/NFSv3 on a SSD/HDD/eMMC
+ - **number of monitors**: 42
+ value: |
+ - Runtime:
+ - Database:
+ - Filesystem used to store the database on:
+ - number of monitors:
validations:
- required: false
+ required: true
- type: textarea
id: logs
attributes:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
index b26841c425..531a2c25ee 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yaml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -3,14 +3,14 @@ description: "Submit a proposal for a new feature"
#title: "[Feature] "
labels: [feature-request]
body:
- - type: checkboxes
- id: no-duplicate-issues
+ - type: textarea
+ id: related-issues
+ validations:
+ required: true
attributes:
- label: "⚠️ Please verify that this feature request has NOT been suggested before."
- description: "Search in the issues sections by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
- options:
- - label: "I checked and didn't find similar feature request"
- required: true
+ label: "📑 I have found these related issues/pull requests"
+ description: "Search related issues by clicking [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain what the difference between them or explain that you are unable to find any related issues"
+ placeholder: "Related to #1 by also touching the ... system. They should not be merged because ..."
- type: dropdown
id: feature-area
attributes:
@@ -18,10 +18,17 @@ body:
description: "What kind of feature request is this?"
multiple: true
options:
- - API
- - New Notification
- - New Monitor
- - UI Feature
+ - API / automation options
+ - New notification-provider
+ - Change to existing notification-provider
+ - New monitor
+ - Change to existing monitor
+ - Dashboard
+ - Status-page
+ - Maintenance
+ - Deployment
+ - Certificate expiry
+ - Settings
- Other
validations:
required: true
diff --git a/.github/ISSUE_TEMPLATE/security.md b/.github/ISSUE_TEMPLATE/security.md
index 26450ed3a2..708670e857 100644
--- a/.github/ISSUE_TEMPLATE/security.md
+++ b/.github/ISSUE_TEMPLATE/security.md
@@ -12,8 +12,6 @@ labels:
DO NOT PROVIDE ANY DETAILS HERE. Please privately report to https://github.com/louislam/uptime-kuma/security/advisories/new.
-
Why need this issue? It is because GitHub Advisory do not send a notification to @louislam, it is a workaround to do so.
Your GitHub Advisory URL:
-
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 87e7f5ff7b..0dfb5faed5 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,7 @@
⚠️⚠️⚠️ Since we do not accept all types of pull requests and do not want to waste your time. Please be sure that you have read pull request rules:
https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma
-Tick the checkbox if you understand [x]:
+Tick the checkbox if you understand [x]:
- [ ] I have read and understand the pull request rules.
# Description
@@ -15,7 +15,7 @@ Please delete any options that are not relevant.
- Bug fix (non-breaking change which fixes an issue)
- 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)
+- Breaking change (a fix or feature that would cause existing functionality to not work as expected)
- Other
- This change requires a documentation update
@@ -24,9 +24,8 @@ Please delete any 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 tested it
-- [ ] I have commented my code, particularly in hard-to-understand areas
- (including JSDoc for methods)
-- [ ] My changes generate no new warnings
+- [ ] I have commented my code, particularly in hard-to-understand areas (including JSDoc for methods)
+- [ ] My changes generates no new warnings
- [ ] My code needed automated testing. I have added them (this is optional task)
## Screenshots (if any)
diff --git a/.github/workflows/auto-test.yml b/.github/workflows/auto-test.yml
index 071cc7df80..bf76d9eb6c 100644
--- a/.github/workflows/auto-test.yml
+++ b/.github/workflows/auto-test.yml
@@ -22,7 +22,7 @@ jobs:
strategy:
matrix:
os: [macos-latest, ubuntu-latest, windows-latest, ARM64]
- node: [ 16, 20.5 ]
+ node: [ 18, 20 ]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
steps:
@@ -33,23 +33,23 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
- - run: npm ci
+ - run: npm install
- run: npm run build
- - run: npm test
+ - run: npm run test-backend
env:
HEADLESS_TEST: 1
JUST_FOR_TEST: ${{ secrets.JUST_FOR_TEST }}
# As a lot of dev dependencies are not supported on ARMv7, we have to test it separately and just test if `npm ci --production` works
armv7-simple-test:
- needs: [ check-linters ]
+ needs: [ ]
runs-on: ${{ matrix.os }}
timeout-minutes: 15
-
+ if: ${{ github.repository == 'louislam/uptime-kuma' }}
strategy:
matrix:
os: [ ARMv7 ]
- node: [ 16, 20.5 ]
+ node: [ 18, 20 ]
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
steps:
@@ -72,36 +72,22 @@ jobs:
- name: Use Node.js 20
uses: actions/setup-node@v4
with:
- node-version: 20.5
- - run: npm ci
+ node-version: 20
+ - run: npm install
- run: npm run lint:prod
- e2e-tests:
- needs: [ check-linters ]
- runs-on: ubuntu-latest
+ e2e-test:
+ needs: [ ]
+ runs-on: ARM64
steps:
- run: git config --global core.autocrlf false # Mainly for Windows
- uses: actions/checkout@v4
- - name: Use Node.js 16
- uses: actions/setup-node@v4
- with:
- node-version: 16
- - run: npm ci
- - run: npm run build
- - run: npm run cy:test
-
- frontend-unit-tests:
- needs: [ check-linters ]
- runs-on: ubuntu-latest
- steps:
- - run: git config --global core.autocrlf false # Mainly for Windows
- - uses: actions/checkout@v4
-
- - name: Use Node.js 16
+ - name: Use Node.js 20
uses: actions/setup-node@v4
with:
- node-version: 16
- - run: npm ci
+ node-version: 20
+ - run: npm install
+ - run: npx playwright install
- run: npm run build
- - run: npm run cy:run:unit
+ - run: npm run test-e2e
diff --git a/.github/workflows/close-incorrect-issue.yml b/.github/workflows/close-incorrect-issue.yml
index e26cf5e5ee..3ef5ba3788 100644
--- a/.github/workflows/close-incorrect-issue.yml
+++ b/.github/workflows/close-incorrect-issue.yml
@@ -11,7 +11,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
- node-version: [16]
+ node-version: [18]
steps:
- uses: actions/checkout@v4
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
new file mode 100644
index 0000000000..0e3b72c4b7
--- /dev/null
+++ b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,43 @@
+name: "CodeQL"
+
+on:
+ push:
+ branches: [ "master", "1.23.X"]
+ pull_request:
+ branches: [ "master", "1.23.X"]
+ schedule:
+ - cron: '16 22 * * 0'
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ timeout-minutes: 360
+
+ permissions:
+ actions: read
+ contents: read
+ security-events: write
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: [ 'go', 'javascript-typescript' ]
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v2
+ with:
+ languages: ${{ matrix.language }}
+
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v2
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v2
+ with:
+ category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/conflict_labeler.yml b/.github/workflows/conflict_labeler.yml
new file mode 100644
index 0000000000..fdcc9c5516
--- /dev/null
+++ b/.github/workflows/conflict_labeler.yml
@@ -0,0 +1,25 @@
+name: Merge Conflict Labeler
+
+on:
+ push:
+ branches:
+ - master
+ pull_request_target:
+ branches:
+ - master
+ types: [synchronize]
+
+jobs:
+ label:
+ name: Labeling
+ runs-on: ubuntu-latest
+ if: ${{ github.repository == 'louislam/uptime-kuma' }}
+ permissions:
+ contents: read
+ pull-requests: write
+ steps:
+ - name: Apply label
+ uses: eps1lon/actions-label-merge-conflict@v3
+ with:
+ dirtyLabel: 'needs:resolve-merge-conflict'
+ repoToken: '${{ secrets.GITHUB_TOKEN }}'
diff --git a/.github/workflows/prevent-file-change.yml b/.github/workflows/prevent-file-change.yml
new file mode 100644
index 0000000000..0af3a6cbf4
--- /dev/null
+++ b/.github/workflows/prevent-file-change.yml
@@ -0,0 +1,17 @@
+name: prevent-file-change
+
+on:
+ pull_request:
+
+jobs:
+ check-file-changes:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Prevent file change
+ uses: xalvarez/prevent-file-change-action@v1
+ with:
+ githubToken: ${{ secrets.GITHUB_TOKEN }}
+ # Regex, /src/lang/*.json is not allowed to be changed, except for /src/lang/en.json
+ pattern: '^(?!src/lang/en\.json$)src/lang/.*\.json$'
+ trustedAuthors: UptimeKumaBot
+
diff --git a/.github/workflows/stale-bot.yml b/.github/workflows/stale-bot.yml
index 8238be0acc..60eca64030 100644
--- a/.github/workflows/stale-bot.yml
+++ b/.github/workflows/stale-bot.yml
@@ -1,4 +1,4 @@
-name: 'Automatically close stale issues and PRs'
+name: 'Automatically close stale issues'
on:
workflow_dispatch:
schedule:
@@ -9,14 +9,34 @@ jobs:
stale:
runs-on: ubuntu-latest
steps:
- - uses: actions/stale@v8
+ - uses: actions/stale@v9
with:
- stale-issue-message: 'We are clearing up our old issues and your ticket has been open for 3 months with no activity. Remove stale label or comment or this will be closed in 2 days.'
- close-issue-message: 'This issue was closed because it has been stalled for 2 days with no activity.'
- days-before-stale: 90
- days-before-close: 2
- days-before-pr-stale: 999999999
- days-before-pr-close: 1
+ stale-issue-message: |-
+ We are clearing up our old `help`-issues and your issue has been open for 60 days with no activity.
+ If no comment is made and the stale label is not removed, this issue will be closed in 7 days.
+ days-before-stale: 60
+ days-before-close: 7
+ days-before-pr-stale: -1
+ days-before-pr-close: -1
exempt-issue-labels: 'News,Medium,High,discussion,bug,doc,feature-request'
exempt-issue-assignees: 'louislam'
operations-per-run: 200
+ - uses: actions/stale@v9
+ with:
+ stale-issue-message: |-
+ This issue was marked as `cannot-reproduce` by a maintainer.
+ If an issue is non-reproducible, we cannot fix it, as we do not know what the underlying issue is.
+ If you have any ideas how we can reproduce this issue, we would love to hear them.
+
+ We don't have a good way to deal with truely unreproducible issues and are going to close this issue in a month.
+ If think there might be other differences in our environment or in how we tried to reproduce this, we would appreciate any ideas.
+ close-issue-message: |-
+ This issue will be closed as no way to reproduce it has been found.
+ If you/somebody finds a way how to (semi-reliably) reproduce this, we can reopen this issue. ^^
+ days-before-stale: 180
+ days-before-close: 30
+ days-before-pr-stale: -1
+ days-before-pr-close: -1
+ any-of-issue-labels: 'cannot-reproduce'
+ operations-per-run: 200
+
diff --git a/.github/workflows/json-yaml-validate.yml b/.github/workflows/validate.yml
similarity index 58%
rename from .github/workflows/json-yaml-validate.yml
rename to .github/workflows/validate.yml
index b6437ec496..7e631ccd44 100644
--- a/.github/workflows/json-yaml-validate.yml
+++ b/.github/workflows/validate.yml
@@ -1,4 +1,4 @@
-name: json-yaml-validate
+name: validate
on:
push:
branches:
@@ -25,3 +25,19 @@ jobs:
with:
comment: "true" # enable comment mode
exclude_file: ".github/config/exclude.txt" # gitignore style file for exclusions
+
+ # General validations
+ validate:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Use Node.js 20
+ uses: actions/setup-node@v4
+ with:
+ node-version: 20
+
+ - name: Validate language JSON files
+ run: node ./extra/check-lang-json.js
+
+ - name: Validate knex migrations filename
+ run: node ./extra/check-knex-filenames.mjs
diff --git a/.gitignore b/.gitignore
index 009b15f104..b11a793542 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,6 +7,7 @@ dist-ssr
/data
!/data/.gitkeep
+/data*
.vscode
/private
@@ -14,9 +15,6 @@ dist-ssr
/tmp
.env
-cypress/videos
-cypress/screenshots
-
/extra/healthcheck.exe
/extra/healthcheck
/extra/healthcheck-armv7
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d94eb71db8..2e10be48ca 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,92 +1,216 @@
# Project Info
-First of all, I want to thank everyone who made pull requests for Uptime Kuma. I never thought the GitHub Community would be so nice! Because of this, I also never thought that other people would actually read and edit my code. It is not very well structured or commented, sorry about that.
+First of all, I want to thank everyone who has submitted issues or shared pull requests for Uptime Kuma.
+I never thought the GitHub community would be so nice!
+Because of this, I also never thought that other people would actually read and edit my code.
+Parts of the code are not very well-structured or commented, sorry about that.
-The project was created with vite.js (vue3). Then I created a subdirectory called "server" for the server part. Both frontend and backend share the same package.json.
+The project was created with `vite.js` and is written in `vue3`.
+Our backend lives in the `server`-directory and mostly communicates via websockets.
+Both frontend and backend share the same `package.json`.
-The frontend code builds into "dist" directory. The server (express.js) exposes the "dist" directory as the root of the endpoint. This is how production is working.
-
-## Key Technical Skills
-
-- Node.js (You should know about promise, async/await and arrow function etc.)
-- Socket.io
-- SCSS
-- Vue.js
-- Bootstrap
-- SQLite
+For production, the frontend is built into the `dist`-directory and the server (`express.js`) exposes the `dist` directory as the root of the endpoint.
+For development, we run vite in development mode on another port.
## Directories
-- config (dev config files)
-- data (App data)
-- db (Base database and migration scripts)
-- dist (Frontend build)
-- docker (Dockerfiles)
-- extra (Extra useful scripts)
-- public (Frontend resources for dev only)
-- server (Server source code)
-- src (Frontend source code)
-- test (unit test)
+- `config` (dev config files)
+- `data` (App data)
+- `db` (Base database and migration scripts)
+- `dist` (Frontend build)
+- `docker` (Dockerfiles)
+- `extra` (Extra useful scripts)
+- `public` (Frontend resources for dev only)
+- `server` (Server source code)
+- `src` (Frontend source code)
+- `test` (unit test)
## Can I create a pull request for Uptime Kuma?
-Yes or no, it depends on what you will try to do. Since I don't want to waste your time, be sure to **create an empty draft pull request or open an issue, so we can have a discussion first**. Especially for a large pull request or you don't know if it will be merged or not.
-
-Here are some references:
-
-### ✅ Usually accepted:
-- Bug fix
-- Security fix
-- Adding notification providers
-- Adding new language files (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md))
-- Adding new language keys: `$t("...")`
+Yes or no, it depends on what you will try to do.
+Both yours and our maintainers' time is precious, and we don't want to waste either.
+
+If you have any questions about any process/.. is not clear, you are likely not alone => please ask them ^^
+
+Different guidelines exist for different types of pull requests (PRs):
+- security fixes
+
+
+ Submitting security fixes is something that may put the community at risk.
+ Please read through our [security policy](SECURITY.md) and submit vulnerabilities via an [advisory](https://github.com/louislam/uptime-kuma/security/advisories/new) + [issue](https://github.com/louislam/uptime-kuma/issues/new?assignees=&labels=help&template=security.md) instead.
+ We encourage you to submit how to fix a vulnerability if you know how to, this is not required.
+ Following the security policy allows us to properly test, fix bugs.
+ This review allows us to notice, if there are any changes necessary to unrelated parts like the documentation.
+ [**PLEASE SEE OUR SECURITY POLICY.**](SECURITY.md)
+
+
+
+- small, non-breaking bug fixes
+
+
+ If you come across a bug and think you can solve, we appreciate your work.
+ Please make sure that you follow these rules:
+ - keep the PR as small as possible, fix only one thing at a time => keeping it reviewable
+ - test that your code does what you claim it does.
+
+ Because maintainer time is precious, junior maintainers may merge uncontroversial PRs in this area.
+
+
+- translations / internationalisation (i18n)
+
+
+ We use weblate to localise this project into many languages.
+ If you are unhappy with a translation this is the best start.
+ On how to translate using weblate, please see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).
+
+ There are two cases in which a change cannot be done in weblate and requires a PR:
+ - A text may not be currently localisable. In this case, **adding a new language key** via `$t("languageKey")` might be nessesary
+ - language keys need to be **added to `en.json`** to be visible in weblate. If this has not happened, a PR is appreciated.
+ - **Adding a new language** requires a new file see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md)
+
+ Because maintainer time is precious, junior maintainers may merge uncontroversial PRs in this area.
+
+
+- new notification providers
+
+
+ To set up a new notification provider these files need to be modified/created:
+ - `server/notification-providers/PROVIDER_NAME.js` is where the heart of the notification provider lives.
+ - Both `monitorJSON` and `heartbeatJSON` can be `null` for some events.
+ If both are `null`, this is a general testing message, but if just `heartbeatJSON` is `null` this is a certificate expiry.
+ - Please wrap the axios call into a
+ ```js
+ try {
+ let result = await axios.post(...);
+ if (result.status === ...) ...
+ } catch (error) {
+ this.throwGeneralAxiosError(error);
+ }
+ ```
+ - `server/notification.js` is where the backend of the notification provider needs to be registered.
+ *If you have an idea how we can skip this step, we would love to hear about it ^^*
+ - `src/components/NotificationDialog.vue` you need to decide if the provider is a regional or a global one and add it with a name to the respective list
+ - `src/components/notifications/PROVIDER_NAME.vue` is where the frontend of each provider lives.
+ Please make sure that you have:
+ - used `HiddenInput` for secret credentials
+ - included all the necessary helptexts/placeholder/.. to make sure the notification provider is simple to setup for new users.
+ - include all translations (`{{ $t("Translation key") }}`, [`i18n-t keypath="Translation key">`](https://vue-i18n.intlify.dev/guide/advanced/component.html)) in `src/lang/en.json` to enable our translators to translate this
+ - `src/components/notifications/index.js` is where the frontend of the provider needs to be registered.
+ *If you have an idea how we can skip this step, we would love to hear about it ^^*
+
+ Offering notifications is close to the core of what we are as an uptime monitor.
+ Therefore, making sure that they work is also really important.
+ Because testing notification providers is quite time intensive, we mostly offload this onto the person contributing a notification provider.
+
+ To make sure you have tested the notification provider, please include screenshots of the following events in the pull-request description:
+ - `UP`/`DOWN`
+ - Certificate Expiry via https://expired.badssl.com/
+ - Testing (the test button on the notification provider setup page)
+
+ Using the following way to format this is encouraged:
+ ```md
+ | Event | Before | After |
+ ------------------
+ | `UP` | paste-image-here | paste-image-here |
+ | `DOWN` | paste-image-here | paste-image-here |
+ | Certificate-expiry | paste-image-here | paste-image-here |
+ | Testing | paste-image-here | paste-image-here |
+ ```
+
+ Because maintainer time is precious, junior maintainers may merge uncontroversial PRs in this area.
+
+
+- new monitoring types
+
+
+ To set up a new notification provider these files need to be modified/created:
+ - `server/monitor-types/MONITORING_TYPE.js` is the core of each monitor.
+ the `async check(...)`-function should:
+ - throw an error for each fault that is detected with an actionable error message
+ - in the happy-path, you should set `heartbeat.msg` to a successful message and set `heartbeat.status = UP`
+ - `server/uptime-kuma-server.js` is where the monitoring backend needs to be registered.
+ *If you have an idea how we can skip this step, we would love to hear about it ^^*
+ - `src/pages/EditMonitor.vue` is the shared frontend users interact with.
+ Please make sure that you have:
+ - used `HiddenInput` for secret credentials
+ - included all the necessary helptexts/placeholder/.. to make sure the notification provider is simple to setup for new users.
+ - include all translations (`{{ $t("Translation key") }}`, [`i18n-t keypath="Translation key">`](https://vue-i18n.intlify.dev/guide/advanced/component.html)) in `src/lang/en.json` to enable our translators to translate this
+ -
+
+
+ Because maintainer time is precious, junior maintainers may merge uncontroversial PRs in this area.
+
+
+- new features/ major changes / breaking bugfixes
+
+
+ be sure to **create an empty draft pull request or open an issue, so we can have a discussion first**.
+ This is especially important for a large pull request or when you don't know if it will be merged or not.
+
+ Because of the large impact of this work, only senior maintainers may merge PRs in this area.
+
+
+
+The following rules are essential for making your PR mergable:
+- Merging multiple issues by a huge PR is more difficult to review and causes conflicts with other PRs. Please
+ - (if possible) **create one PR for one issue** or
+ - (if not possible) **explain which issues a PR addresses and why this PR should not be broken apart**
+- Make sure your **PR passes our continuous integration**.
+ PRs will not be merged unless all CI-Checks are green.
+- **Breaking changes** (unless for a good reason and discussed beforehand) will not get merged / not get merged quickly.
+ Such changes require a major version release.
+- **Test your code** before submitting a PR.
+ Buggy PRs will not be merged.
+- Make sure the **UI/UX is close to Uptime Kuma**.
+- **Think about the maintainability**:
+ Don't add functionality that is completely **out of scope**.
+ Keep in mind that we need to be able to maintain the functionality.
+- Don't modify or delete existing logic without a valid reason.
+- Don't convert existing code into other programming languages for no reason.
+
+I ([@louislam](https://github.com/louislam)) have the final say.
+If your pull request does not meet my expectations, I will reject it, no matter how much time you spent on it.
+Therefore, it is essential to have a discussion beforehand.
-### ⚠️ Discussion required:
-- Large pull requests
-- New features
-
-### ❌ Won't be merged:
-- A dedicated PR for translating existing languages (see [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md))
-- Do not pass the auto-test
-- Any breaking changes
-- Duplicated pull requests
-- Buggy
-- UI/UX is not close to Uptime Kuma
-- Modifications or deletions of existing logic without a valid reason.
-- Adding functions that is completely out of scope
-- Converting existing code into other programming languages
-- Unnecessarily large code changes that are hard to review and cause conflicts with other PRs.
-
-The above cases may not cover all possible situations.
+I will assign your pull request to a [milestone](https://github.com/louislam/uptime-kuma/milestones), if I plan to review and merge it.
-I (@louislam) have the final say. If your pull request does not meet my expectations, I will reject it, no matter how much time you spend on it. Therefore, it is essential to have a discussion beforehand.
+Please don't rush or ask for an ETA.
+We have to understand the pull request, make sure it has no breaking changes and stick to the vision of this project, especially for large pull requests.
-I will assign your pull request to a [milestone](https://github.com/louislam/uptime-kuma/milestones), if I plan to review and merge it.
-Also, please don't rush or ask for an ETA, because I have to understand the pull request, make sure it is no breaking changes and stick to my vision of this project, especially for large pull requests.
+## I'd like to work on an issue. How do I do that?
+We have found that assigning people to issues is management-overhead that we don't need.
+A short comment that you want to try your hand at this issue is appreciated to save other devs time.
+If you come across any problem during development, feel free to leave a comment with what you are stuck on.
### Recommended Pull Request Guideline
-Before deep into coding, discussion first is preferred. Creating an empty pull request for discussion would be recommended.
+Before diving deep into coding, having a discussion first by creating an empty pull request for discussion is preferred.
+The rationale behind this is that we can align the direction and scope of the feature to eliminate any conflicts with existing and planned work, and can help by pointing out any potential pitfalls.
1. Fork the project
-1. Clone your fork repo to local
-1. Create a new branch
-1. Create an empty commit
- `git commit -m "[empty commit] pull request for " --allow-empty`
-1. Push to your fork repo
-1. Create a pull request: https://github.com/louislam/uptime-kuma/compare
-1. Write a proper description
-1. Click "Change to draft"
-1. Discussion
+2. Clone your fork repo to local
+3. Create a new branch
+4. Create an empty commit: `git commit -m "" --allow-empty`
+5. Push to your fork repo
+6. Prepare a pull request: https://github.com/louislam/uptime-kuma/compare
+7. Write a proper description. You can mention @louislam in it, so @louislam will get the notification.
+8. Create your pull request as a Draft
+9. Wait for the discussion
## Project Styles
-I personally do not like something that requires so many configurations before you can finally start the app. I hope Uptime Kuma installation will be as easy as like installing a mobile app.
+I personally do not like something that requires a lot of configuration before you can finally start the app.
+The goal is to make the Uptime Kuma installation as easy as installing a mobile app.
-- Easy to install for non-Docker users, no native build dependency is needed (for x86_64/armv7/arm64), no extra config, and no extra effort required to get it running
-- Single container for Docker users, no very complex docker-compose file. Just map the volume and expose the port, then good to go
+- Easy to install for non-Docker users
+ - no native build dependency is needed (for `x86_64`/`armv7`/`arm64`)
+ - no extra configuration and
+ - no extra effort required to get it running
+- Single container for Docker users
+ - no complex docker-compose file
+ - mapping the volume and exposing the port should be the only requirements
- Settings should be configurable in the frontend. Environment variables are discouraged, unless it is related to startup such as `DATA_DIR`
- Easy to use
- The web UI styling should be consistent and nice
@@ -106,12 +230,18 @@ I personally do not like something that requires so many configurations before y
## Tools
-- [`Node.js`](https://nodejs.org/) >= 14
-- [`npm`](https://www.npmjs.com/) >= 8.5
+- [`Node.js`](https://nodejs.org/) >= 18
+- [`npm`](https://www.npmjs.com/) >= 9.3
- [`git`](https://git-scm.com/)
- IDE that supports [`ESLint`](https://eslint.org/) and EditorConfig (I am using [`IntelliJ IDEA`](https://www.jetbrains.com/idea/))
- A SQLite GUI tool (f.ex. [`SQLite Expert Personal`](https://www.sqliteexpert.com/download.html) or [`DBeaver Community`](https://dbeaver.io/download/))
+## Git Branches
+
+- `master`: 2.X.X development. If you want to add a new feature, your pull request should base on this.
+- `1.23.X`: 1.23.X development. If you want to fix a bug for v1 and v2, your pull request should base on this.
+- All other branches are unused, outdated or for dev.
+
## Install Dependencies for Development
```bash
@@ -130,8 +260,9 @@ Port `3000` and port `3001` will be used.
npm run dev
```
-But sometimes, you would like to restart the server, but not the frontend, you can run these commands in two terminals:
-```
+But sometimes you may want to restart the server without restarting the frontend. In that case, you can run these commands in two terminals:
+
+```bash
npm run start-frontend-dev
npm run start-server-dev
```
@@ -140,32 +271,31 @@ npm run start-server-dev
It binds to `0.0.0.0:3001` by default.
+The backend is an `express.js` server with `socket.io` integrated.
+It uses `socket.io` to communicate with clients, and most server logic is encapsulated in the `socket.io` handlers.
+`express.js` is also used to serve:
-It is mainly a socket.io app + express.js.
-
-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 the status page
+- as an entry point for redirecting to a status page or the dashboard
+- the frontend built files (`index.html`, `*.js`, `*.css`, etc.)
+- internal APIs of the status page
+### Structure in `/server/`
-### Structure in /server/
-
-- jobs/ (Jobs that are running in another process)
-- model/ (Object model, auto-mapping to the database table name)
-- modules/ (Modified 3rd-party modules)
-- monitor_types (Monitor Types)
-- notification-providers/ (individual notification logic)
-- routers/ (Express Routers)
-- socket-handler (Socket.io Handlers)
-- server.js (Server entry point)
-- uptime-kuma-server.js (UptimeKumaServer class, main logic should be here, but some still in `server.js`)
+- `jobs/` (Jobs that are running in another process)
+- `model/` (Object model, auto-mapping to the database table name)
+- `modules/` (Modified 3rd-party modules)
+- `monitor_types/` (Monitor Types)
+- `notification-providers/` (individual notification logic)
+- `routers/` (Express Routers)
+- `socket-handler/` (Socket.io Handlers)
+- `server.js` (Server entry point)
+- `uptime-kuma-server.js` (UptimeKumaServer class, main logic should be here, but some still in `server.js`)
## Frontend Dev Server
-It binds to `0.0.0.0:3000` by default. The frontend dev server is used for development only.
+It binds to `0.0.0.0:3000` by default. The frontend dev server is used for development only.
-For production, it is not used. It will be compiled to `dist` directory instead.
+For production, it is not used. It will be compiled to `dist` directory instead.
You can use Vue.js devtools Chrome extension for debugging.
@@ -187,8 +317,7 @@ The data and socket logic are in `src/mixins/socket.js`.
## Database Migration
-1. Create `patch-{name}.sql` in `./db/`
-2. Add your patch filename in the `patchList` list in `./server/database.js`
+See: https://github.com/louislam/uptime-kuma/tree/master/db/knex_migrations
## Unit Test
@@ -199,14 +328,15 @@ npm test
## Dependencies
-Both frontend and backend share the same package.json. However, the frontend dependencies are eventually not used in the production environment, because it is usually also baked into dist files. So:
+Both frontend and backend share the same `package.json`.
+However, the frontend dependencies are eventually not used in the production environment, because it is usually also baked into `dist` files. So:
- Frontend dependencies = "devDependencies"
- - Examples: vue, chart.js
+ - Examples: `vue`, `chart.js`
- Backend dependencies = "dependencies"
- - Examples: socket.io, sqlite3
+ - Examples: `socket.io`, `sqlite3`
- Development dependencies = "devDependencies"
- - Examples: eslint, sass
+ - Examples: `eslint`, `sass`
### Update Dependencies
@@ -218,9 +348,9 @@ If for security / bug / other reasons, a library must be updated, breaking chang
## Translations
-Please add **all** the strings which are translatable to `src/lang/en.json` (If translation keys are omitted, they can not be translated).
+Please add **all** the strings which are translatable to `src/lang/en.json` (if translation keys are omitted, they can not be translated.)
-**Don't include any other languages in your initial Pull-Request** (even if this is your mother tongue), to avoid merge-conflicts between weblate and `master`.
+**Don't include any other languages in your initial pull request** (even if this is your mother tongue), to avoid merge-conflicts between weblate and `master`.
The translations can then (after merging a PR into `master`) be translated by awesome people donating their language skills.
If you want to help by translating Uptime Kuma into your language, please visit the [instructions on how to translate using weblate](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).
@@ -232,55 +362,151 @@ My mother language is not English and my grammar is not that great.
## Wiki
-Since there is no way to make a pull request to wiki's repo, I have set up another repo to do that.
+Since there is no way to make a pull request to the wiki, I have set up another repo to do that.
https://github.com/louislam/uptime-kuma-wiki
-## Maintainer
+## Docker
-Check the latest issues and pull requests:
-https://github.com/louislam/uptime-kuma/issues?q=sort%3Aupdated-desc
+### Arch
-### Release Procedures
+- amd64
+- arm64
+- armv7
-1. Draft a release note
-2. Make sure the repo is cleared
-3. If the healthcheck is updated, remember to re-compile it: `npm run build-docker-builder-go`
-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. Deploy to the demo server: `npm run deploy-demo-server`
+### Docker Tags
-Checking:
+#### v2
-- Check all tags is fine on https://hub.docker.com/r/louislam/uptime-kuma/tags
-- Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 / armv7)
-- Try clean installation with Node.js
+- `2`, `latest-2`: v2 with full features such as Chromium and bundled MariaDB
+- `2.x.x`
+- `2-slim`: v2 with basic features
+- `2.x.x-slim`
+- `beta2`: Latest beta build
+- `2.x.x-beta.x`
+- `nightly2`: Dev build
+- `base2`: Basic Debian setup without Uptime Kuma source code (Full features)
+- `base2-slim`: Basic Debian setup without Uptime Kuma source code
+- `pr-test2`: For testing pull request without setting up a local environment
-### Release Beta Procedures
+#### v1
-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
+- `1`, `latest`, `1-debian`, `debian`: Latest version of v1
+- `1.x.x`, `1.x.x-debian`
+- `1.x.x-beta.x`: Beta build
+- `beta`: Latest beta build
+- `nightly`: Dev build
+- `base-debian`: Basic Debian setup without Uptime Kuma source code
+- `pr-test`: For testing pull request without setting up a local environment
+- `base-alpine`: (Deprecated) Basic Alpine setup without Uptime Kuma source code
+- `1-alpine`, `alpine`: (Deprecated)
+- `1.x.x-alpine`: (Deprecated)
-### Release Wiki
-
-#### Setup Repo
-
-```bash
-git clone https://github.com/louislam/uptime-kuma-wiki.git
-cd uptime-kuma-wiki
-git remote add production https://github.com/louislam/uptime-kuma.wiki.git
-```
+## Maintainer
-#### Push to Production Wiki
+Check the latest issues and pull requests:
+https://github.com/louislam/uptime-kuma/issues?q=sort%3Aupdated-desc
-```bash
-git pull
-git push production master
-```
+### What is a maintainer and what are their roles?
+
+This project has multiple maintainers who specialise in different areas.
+Currently, there are 3 maintainers:
+
+| Person | Role | Main Area |
+|-------------------|-------------------|------------------|
+| `@louislam` | senior maintainer | major features |
+| `@chakflying` | junior maintainer | fixing bugs |
+| `@commanderstorm` | junior maintainer | issue-management |
+
+### Procedures
+
+We have a few procedures we follow. These are documented here:
+- Set up a Docker Builder
+
+
+ - amd64, armv7 using local.
+ - arm64 using remote arm64 cpu, as the emulator is too slow and can no longer pass the `npm ci` command.
+ 1. Add the public key to the remote server.
+ 2. Add the remote context. The remote machine must be arm64 and installed Docker CE.
+ ```
+ docker context create oracle-arm64-jp --docker "host=ssh://root@100.107.174.88"
+ ```
+ 3. Create a new builder.
+ ```
+ docker buildx create --name kuma-builder --platform linux/amd64,linux/arm/v7
+ docker buildx use kuma-builder
+ docker buildx inspect --bootstrap
+ ```
+ 4. Append the remote context to the builder.
+ ```
+ docker buildx create --append --name kuma-builder --platform linux/arm64 oracle-arm64-jp
+ ```
+ 5. Verify the builder and check if the builder is using `kuma-builder`.
+ ```
+ docker buildx inspect kuma-builder
+ docker buildx ls
+ ```
+
+
+- Release
+
+
+ 1. Draft a release note
+ 2. Make sure the repo is cleared
+ 3. If the healthcheck is updated, remember to re-compile it: `npm run build-docker-builder-go`
+ 4. `npm run release-final` with env vars: `VERSION` and `GITHUB_TOKEN`
+ 5. Wait until the `Press any key to continue`
+ 6. `git push`
+ 7. Publish the release note as `1.X.X`
+ 8. Press any key to continue
+ 9. Deploy to the demo server: `npm run deploy-demo-server`
+
+ These Items need to be checked:
+
+ - [ ] Check all tags is fine on https://hub.docker.com/r/louislam/uptime-kuma/tags
+ - [ ] Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 / armv7)
+ - [ ] Try clean installation with Node.js
+
+
+
+- Release Beta
+
+
+ 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**
+
+ ```bash
+ git clone https://github.com/louislam/uptime-kuma-wiki.git
+ cd uptime-kuma-wiki
+ git remote add production https://github.com/louislam/uptime-kuma.wiki.git
+ ```
+
+ **Push to Production Wiki**
+
+ ```bash
+ git pull
+ git push production master
+ ```
+
+
+
+- Change the base of a pull request such as master to 1.23.X
+
+
@@ -17,23 +17,23 @@ Uptime Kuma is an easy-to-use self-hosted monitoring tool.
Try it!
-- Tokyo Demo Server: https://demo.uptime.kuma.pet (Sponsored by [Uptime Kuma Sponsors](https://github.com/louislam/uptime-kuma#%EF%B8%8F-sponsors))
+Demo Server (Location: Frankfurt - Germany): https://demo.kuma.pet/start-demo
-It is a temporary live demo, all data will be deleted after 10 minutes. Use the one that is closer to you, but I suggest that you should install and try it out for the best demo experience.
+It is a temporary live demo, all data will be deleted after 10 minutes. Sponsored by [Uptime Kuma Sponsors](https://github.com/louislam/uptime-kuma#%EF%B8%8F-sponsors).
## ⭐ Features
-* Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Ping / DNS Record / Push / Steam Game Server / Docker Containers
-* Fancy, Reactive, Fast UI/UX
-* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [90+ notification services, click here for the full list](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/lang)
-* Multiple status pages
-* Map status pages to specific domains
-* Ping chart
-* Certificate info
-* Proxy support
-* 2FA support
+- Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Ping / DNS Record / Push / Steam Game Server / Docker Containers
+- Fancy, Reactive, Fast UI/UX
+- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [90+ notification services, click here for the full list](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/lang)
+- Multiple status pages
+- Map status pages to specific domains
+- Ping chart
+- Certificate info
+- Proxy support
+- 2FA support
## 🔧 How to Install
@@ -43,26 +43,32 @@ It is a temporary live demo, all data will be deleted after 10 minutes. Use the
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
```
-⚠️ Please use a **local volume** only. Other types such as NFS are not supported.
+Uptime Kuma is now running on