[
{
"path": ".dockerignore",
"content": "/.idea\n/node_modules\n/data*\n/out\n/test\n/kubernetes\n/.do\n**/.dockerignore\n/private\n**/.git\n**/.gitignore\n**/docker-compose*\n**/[Dd]ockerfile*\nLICENSE\nREADME.md\n.editorconfig\n.vscode\n.eslint*\n.stylelint*\n/.github\nyarn.lock\napp.json\nCODE_OF_CONDUCT.md\nCONTRIBUTING.md\nCNAME\ninstall.sh\nSECURITY.md\ntsconfig.json\n.env\n/tmp\n/ecosystem.config.js\n/extra/healthcheck.exe\n/extra/healthcheck\n/extra/exe-builder\n/extra/uptime-kuma-push\n\n# Comment the following line if you want to rebuild the healthcheck binary\n/extra/healthcheck-armv7\n\n\n### .gitignore content (commented rules are duplicated)\n\n#node_modules\n.DS_Store\n#dist\ndist-ssr\n*.local\n#.idea\n\n#/data\n#!/data/.gitkeep\n#.vscode\n\n### End of .gitignore content\n"
},
{
"path": ".editorconfig",
"content": "root = true\n\n[*]\nindent_style = space\nindent_size = 4\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.md]\ntrim_trailing_whitespace = false\n\n[*.yaml]\nindent_size = 2\n\n[*.yml]\nindent_size = 2\n\n[*.vue]\ntrim_trailing_whitespace = false\n\n[*.go]\nindent_style = tab\n"
},
{
"path": ".eslintrc.js",
"content": "module.exports = {\n ignorePatterns: [\"test/*.js\", \"server/modules/*\", \"src/util.js\"],\n root: true,\n env: {\n browser: true,\n commonjs: true,\n es2020: true,\n node: true,\n },\n extends: [\n \"eslint:recommended\",\n \"plugin:vue/vue3-recommended\",\n \"plugin:vue-scoped-css/vue3-recommended\",\n \"plugin:jsdoc/recommended-error\",\n \"prettier\", // Disables ESLint formatting rules that conflict with Prettier\n ],\n parser: \"vue-eslint-parser\",\n parserOptions: {\n parser: \"@typescript-eslint/parser\",\n sourceType: \"module\",\n requireConfigFile: false,\n },\n plugins: [\"jsdoc\", \"@typescript-eslint\"],\n rules: {\n yoda: \"error\",\n eqeqeq: [\"warn\", \"smart\"],\n camelcase: [\n \"warn\",\n {\n properties: \"never\",\n ignoreImports: true,\n },\n ],\n \"no-unused-vars\": [\n \"warn\",\n {\n args: \"none\",\n },\n ],\n \"vue/max-attributes-per-line\": \"off\",\n \"vue/singleline-html-element-content-newline\": \"off\",\n \"vue/html-self-closing\": \"off\",\n \"vue/require-component-is\": \"off\", // not allow is=\"style\" https://github.com/vuejs/eslint-plugin-vue/issues/462#issuecomment-430234675\n \"vue/attribute-hyphenation\": \"off\", // This change noNL to \"no-n-l\" unexpectedly\n \"vue/multi-word-component-names\": \"off\",\n \"vue-scoped-css/no-unused-selector\": \"warn\",\n curly: \"error\",\n \"no-var\": \"error\",\n \"no-throw-literal\": \"error\",\n \"no-constant-condition\": [\n \"error\",\n {\n checkLoops: false,\n },\n ],\n //\"no-console\": \"warn\",\n \"no-extra-boolean-cast\": \"off\",\n \"no-unneeded-ternary\": \"error\",\n //\"prefer-template\": \"error\",\n \"no-empty\": [\n \"error\",\n {\n allowEmptyCatch: true,\n },\n ],\n \"no-control-regex\": \"off\",\n \"one-var\": [\"error\", \"never\"],\n \"max-statements-per-line\": [\"error\", { max: 1 }],\n \"jsdoc/check-tag-names\": [\n \"error\",\n {\n definedTags: [\"link\"],\n },\n ],\n \"jsdoc/no-undefined-types\": \"off\",\n \"jsdoc/no-defaults\": [\"error\", { noOptionalParamNames: true }],\n \"jsdoc/require-throws\": \"warn\",\n \"jsdoc/require-jsdoc\": [\n \"error\",\n {\n require: {\n FunctionDeclaration: true,\n MethodDefinition: true,\n },\n },\n ],\n \"jsdoc/no-blank-block-descriptions\": \"error\",\n \"jsdoc/require-returns-description\": \"warn\",\n \"jsdoc/require-returns-check\": [\"error\", { reportMissingReturnForUndefinedTypes: false }],\n \"jsdoc/require-returns\": [\n \"warn\",\n {\n forceRequireReturn: true,\n forceReturnsWithAsync: true,\n },\n ],\n \"jsdoc/require-param-type\": \"warn\",\n \"jsdoc/require-param-description\": \"warn\",\n },\n overrides: [\n // Override for TypeScript\n {\n files: [\"**/*.ts\"],\n extends: [\"plugin:@typescript-eslint/recommended\"],\n rules: {\n \"jsdoc/require-returns-type\": \"off\",\n \"jsdoc/require-param-type\": \"off\",\n \"@typescript-eslint/no-explicit-any\": \"off\",\n \"prefer-const\": \"off\",\n },\n },\n ],\n};\n"
},
{
"path": ".github/FUNDING.yml",
"content": "# These are supported funding model platforms\n\ngithub: louislam # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]\n#patreon: # Replace with a single Patreon username\nopen_collective: uptime-kuma # Replace with a single Open Collective username\n#ko_fi: # Replace with a single Ko-fi username\n#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel\n#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry\n#liberapay: # Replace with a single Liberapay username\n#issuehunt: # Replace with a single IssueHunt username\n#otechie: # Replace with a single Otechie username\n#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']\n"
},
{
"path": ".github/ISSUE_TEMPLATE/ask_for_help.yml",
"content": "---\nname: ❓ Ask for help\ndescription: |\n Submit any question related to Uptime Kuma\n#title: \"[Help]\"\nlabels: [\"help\"]\nbody:\n - type: markdown\n attributes:\n value: |\n 🚫 **We kindly ask you to refrain from pinging maintainers unless absolutely necessary. Pings are reserved for critical/urgent issues that require immediate attention.**\n\n - type: checkboxes\n id: no-duplicate-question\n attributes:\n label: ⚠️ Please verify that your question has not already been reported\n description: |\n To avoid duplicate reports, please search for any existing issues before submitting a new one.\n You can find the list of existing issues **[HERE](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc%20)**.\n options:\n - label: |\n I have searched the [existing issues](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc%20) and found no similar reports.\n required: true\n\n - type: checkboxes\n id: security-policy\n attributes:\n label: 🛡️ Security Policy\n description: |\n Please review and acknowledge the Security Policy before reporting any security-related issues or bugs.\n You can find the full Security Policy **[HERE](https://github.com/louislam/uptime-kuma/security/policy)**.\n options:\n - label: |\n I have read and agree to Uptime Kuma's [Security Policy](https://github.com/louislam/uptime-kuma/security/policy).\n required: true\n\n - type: textarea\n id: steps-to-reproduce\n validations:\n required: true\n attributes:\n label: 📝 Describe your problem\n description: |\n Please walk us through it step by step.\n Include all important details and add screenshots where appropriate.\n placeholder: |\n Describe what are you asking for ...\n\n - type: textarea\n id: error-msg\n attributes:\n label: 📝 Error Message(s) or Log\n description: |\n Please copy and paste any relevant log output.\n This will be automatically formatted into code, so no need for backticks.\n render: bash session\n validations:\n required: false\n\n - type: input\n id: uptime-kuma-version\n attributes:\n label: 🐻 Uptime-Kuma Version\n description: |\n What version of Uptime-Kuma are you running?\n Please do not provide Docker tags like `latest` or `1`.\n placeholder: |\n e.g., 1.23.16 or 2.0.0-beta.2\n validations:\n required: true\n\n - type: input\n id: operating-system\n attributes:\n label: 💻 Operating System and Arch\n description: |\n Which OS is your server/device running on? (For Replit, please do not report this bug)\n placeholder: |\n e.g., Ubuntu Server 24.04.2 LTS (GNU/Linux 6.8.0-55-generic x86_64)\n validations:\n required: true\n\n - type: input\n id: browser-vendor\n attributes:\n label: 🌐 Browser\n description: |\n Which browser are you running on? (For Replit, please do not report this bug)\n placeholder: |\n e.g., Google Chrome 134.0.6998.183 (Official Build) (64-bit)\n validations:\n required: true\n\n - type: textarea\n id: deployment-info\n attributes:\n label: 🖥️ Deployment Environment\n description: |\n Provide details about the deployment environment, including runtime components, databases, and storage configurations. This will\n help assess the infrastructure and identify any potential compatibility requirements.\n\n **Remove any fields that do not apply to your setup.**\n value: |\n - **Runtime Environment**:\n - Docker: Version `X.X.X` (Build `Y.Y.Y`)\n - Docker Compose: Version `X.X.X`\n - Portainer (BE/CE): Version `X.X.X` (LTS: Yes/No)\n - MariaDB: Version `X.X.X` (LTS: Yes/No)\n - Node.js: Version `X.X.X` (LTS: Yes/No)\n - Kubernetes (K3S/K8S): Version `X.X.X` (LTS: Yes/No, via `[method/tool]`)\n - **Database**:\n - SQLite: Embedded\n - MariaDB: Embedded/External\n - **Database Storage**:\n - **Filesystem**:\n - Linux: ext4/XFS/Btrfs/ZFS/F2FS\n - macOS: APFS/ HFS+\n - Windows: NTFS/ReFS\n - **Storage Medium**: HDD/eMMC/SSD/NVMe\n - **Uptime Kuma Setup**:\n - Number of monitors: `X`\n validations:\n required: true\n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.yml",
"content": "---\nname: 🐛 Bug Report\ndescription: |\n Submit a bug report to help us improve\n#title: \"[Bug]\"\nlabels: [\"bug\"]\nbody:\n - type: markdown\n attributes:\n value: |\n 🚫 **We kindly ask you to refrain from pinging maintainers unless absolutely necessary. Pings are reserved for critical/urgent issues that require immediate attention.**\n\n - type: textarea\n id: related-issues\n validations:\n required: true\n attributes:\n label: 📑 I have found these related issues/pull requests\n description: |\n Please search for related **[ISSUES](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc)**\n and **[PULL REQUESTS](https://github.com/louislam/uptime-kuma/pulls?q=is%3Apr+sort%3Acreated-desc+)**.\n Explain the differences between them or clarify if you were unable to find any related issues/pull requests.\n placeholder: |\n Example: This relates to issue #1, which also affects the ... system. It should not be merged because ...\n\n - type: checkboxes\n id: security-policy\n attributes:\n label: 🛡️ Security Policy\n description: |\n Please review and acknowledge the Security Policy before reporting any security-related issues or bugs. You can find the full Security Policy **[HERE](https://github.com/louislam/uptime-kuma/security/policy)**.\n options:\n - label: |\n I have read and agree to Uptime Kuma's [Security Policy](https://github.com/louislam/uptime-kuma/security/policy).\n required: true\n\n - type: textarea\n id: description\n validations:\n required: false\n attributes:\n label: 📝 Description\n description: |\n You could also upload screenshots\n\n - type: textarea\n id: steps-to-reproduce\n validations:\n required: true\n attributes:\n label: 👟 Reproduction steps\n description: |\n How do you trigger this bug? Please walk us through it step by step. Include all important details and add screenshots where appropriate\n placeholder: |\n ...\n\n - type: textarea\n id: expected-behavior\n validations:\n required: true\n attributes:\n label: 👀 Expected behavior\n description: |\n What did you think would happen?\n placeholder: |\n ...\n\n - type: textarea\n id: actual-behavior\n validations:\n required: true\n attributes:\n label: 😓 Actual Behavior\n description: |\n What actually happen?\n placeholder: |\n ...\n\n - type: input\n id: uptime-kuma-version\n attributes:\n label: 🐻 Uptime-Kuma Version\n description: |\n What version of Uptime-Kuma are you running? Please do not provide Docker tags like `latest` or `1`.\n placeholder: |\n e.g., 1.23.16 or 2.0.0-beta.2\n validations:\n required: true\n\n - type: input\n id: operating-system\n attributes:\n label: 💻 Operating System and Arch\n description: |\n Which OS is your server/device running on? (For Replit, please do not\n report this bug)\n placeholder: |\n e.g., Ubuntu Server 24.04.2 LTS (GNU/Linux 6.8.0-55-generic x86_64)\n validations:\n required: true\n\n - type: input\n id: browser-vendor\n attributes:\n label: 🌐 Browser\n description: |\n Which browser are you running on?\n placeholder: |\n e.g., Google Chrome 134.0.6998.183 (Official Build) (64-bit)\n validations:\n required: true\n\n - type: textarea\n id: deployment-info\n attributes:\n label: 🖥️ Deployment Environment\n description: |\n Provide details about the deployment environment, including runtime components, databases, and storage configurations. This will\n help assess the infrastructure and identify any potential compatibility requirements.\n\n **Remove any fields that do not apply to your setup.**\n value: |\n - **Runtime Environment**:\n - Docker: Version `X.X.X` (Build `Y.Y.Y`)\n - Docker Compose: Version `X.X.X`\n - Portainer (BE/CE): Version `X.X.X` (LTS: Yes/No)\n - MariaDB: Version `X.X.X` (LTS: Yes/No)\n - Node.js: Version `X.X.X` (LTS: Yes/No)\n - Kubernetes (K3S/K8S): Version `X.X.X` (LTS: Yes/No, via `[method/tool]`)\n - **Database**:\n - SQLite: Embedded\n - MariaDB: Embedded/External\n - **Database Storage**:\n - **Filesystem**:\n - Linux: ext4/XFS/Btrfs/ZFS/F2FS\n - macOS: APFS/ HFS+\n - Windows: NTFS/ReFS\n - **Storage Medium**: HDD/eMMC/SSD/NVMe\n - **Uptime Kuma Setup**:\n - Number of monitors: `X`\n validations:\n required: true\n\n - type: textarea\n id: logs\n attributes:\n label: 📝 Relevant log output\n description: |\n Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.\n render: bash session\n validations:\n required: false\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"content": "---\nblank_issues_enabled: false\n"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.yml",
"content": "---\nname: 🚀 Feature Request\ndescription: |\n Submit a proposal for a new feature\n# title: \"[Feature]\"\nlabels: [\"feature-request\"]\nbody:\n - type: markdown\n attributes:\n value: |\n ### 🚫 Please Avoid Unnecessary Pinging of Maintainers\n\n We kindly ask you to refrain from pinging maintainers unless absolutely necessary.\n Pings are for critical/urgent pull requests that require immediate attention.\n - type: textarea\n id: related-issues\n validations:\n required: true\n attributes:\n label: 📑 I have found these related issues/pull requests\n description: |\n Please search for related **[ISSUES](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc)**\n and **[PULL REQUESTS](https://github.com/louislam/uptime-kuma/pulls?q=is%3Apr+sort%3Acreated-desc+)**.\n Explain the differences between them or clarify if you were unable to find any related issues/pull requests.\n placeholder: |\n Example: This relates to issue #1, which also affects the ... system. It should not be merged because ...\n\n - type: textarea\n id: feature-description\n validations:\n required: true\n attributes:\n label: 🔖 Feature description\n description: |\n A clear and concise description of what the feature request is.\n placeholder: |\n You should add ...\n\n - type: textarea\n id: solution\n validations:\n required: true\n attributes:\n label: ✔️ Solution\n description: |\n A clear and concise description of what you want to happen.\n placeholder: |\n In my use-case, ...\n\n - type: textarea\n id: alternatives\n validations:\n required: false\n attributes:\n label: ❓ Alternatives\n description: |\n A clear and concise description of any alternative solutions or features you've considered.\n placeholder: |\n I have considered ...\n\n - type: textarea\n id: additional-context\n validations:\n required: false\n attributes:\n label: 📝 Additional Context\n description: |\n Add any other context or screenshots about the feature request here.\n placeholder: |\n ...\n"
},
{
"path": ".github/ISSUE_TEMPLATE/security_issue.yml",
"content": "---\nname: 🛡️ Security Issue\ndescription: |\n Notify Louis Lam about a security concern. Please do NOT include any sensitive details in this issue.\n# title: \"Security Issue\"\nlabels: [\"security\"]\nassignees: [louislam]\nbody:\n - type: markdown\n attributes:\n value: |\n ## ❗ IMPORTANT: DO NOT SHARE VULNERABILITY DETAILS HERE\n\n ## Please do not open issues for upstream dependency scan results.\n\n Automated security tools often report false-positive issues that are not exploitable in the context of Uptime Kuma.\n Reviewing these without concrete impact does not scale for us.\n\n If you can demonstrate that an upstream issue is actually exploitable in Uptime Kuma (e.g. with a PoC or reproducible steps), we’re happy to take a look.\n\n ### ⚠️ Report a Security Vulnerability\n\n **If you have discovered a security vulnerability, please report it securely using the GitHub Security Advisory.**\n\n **Note**: This issue is only for notifying the maintainers of the repository, as the GitHub Security Advisory does not automatically send notifications.\n\n - **Confidentiality**: The information you provide in the GitHub Security Advisory will initially remain confidential. However, once the vulnerability is addressed, the advisory will be publicly disclosed on GitHub.\n - **Access and Visibility**: Until the advisory is published, it will only be visible to the maintainers of the repository and invited collaborators.\n - **Credit**: You will be automatically credited as a contributor for identifying and reporting the vulnerability. Your contribution will be reflected in the MITRE Credit System.\n - **Important Reminder**: **Do not include any sensitive or detailed vulnerability information in this issue.** This issue is only for sharing the advisory URL to notify the maintainers of the repository, not for discussing the vulnerability itself.\n\n **Thank you for helping us keep Uptime Kuma secure!**\n\n ## **Step 1: Submit a GitHub Security Advisory**\n\n Right-click the link below and select `Open link in new tab` to access the page.\n This will keep the security issue open, allowing you to easily return and paste the Advisory URL here later.\n\n ➡️ [Create a New Security Advisory](https://github.com/louislam/uptime-kuma/security/advisories/new)\n\n ## **Step 2: Share the Advisory URL**\n\n Once you've created your advisory, please share the URL below.\n This will notify Louis Lam and enable them to take the appropriate action.\n\n - type: textarea\n id: github-advisory-url\n validations:\n required: true\n attributes:\n label: GitHub Advisory URL for @louislam\n placeholder: |\n Please paste the GitHub Advisory URL here. Only the URL is required.\n Example: https://github.com/louislam/uptime-kuma/security/advisories/GHSA-8h5r-7t6l-q3kz\n"
},
{
"path": ".github/PULL_REQUEST_TEMPLATE.md",
"content": "\n\n# Summary\n\nIn this pull request, the following changes are made:\n\n- Foobar was changed to FooFoo, because ...\n\n\n\n- Relates to #issue-number \n- Resolves #issue-number \n\n\nPlease follow this checklist to avoid unnecessary back and forth (click to expand)\n\n- [ ] ⚠️ If there are Breaking change (a fix or feature that alters existing functionality in a way that could cause issues) I have called them out\n- [ ] 🧠 I have disclosed any use of LLMs/AI in this contribution and reviewed all generated content.\n I understand that I am responsible for and able to explain every line of code I submit.\n- [ ] 🔍 Any UI changes adhere to visual style of this project.\n- [ ] 🛠️ I have self-reviewed and self-tested my code to ensure it works as expected.\n- [ ] 📝 I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods).\n- [ ] 🤖 I added or updated automated tests where appropriate.\n- [ ] 📄 Documentation updates are included (if applicable).\n- [ ] 🧰 Dependency updates are listed and explained.\n- [ ] ⚠️ CI passes and is green.\n\n\n\n## Screenshots for Visual Changes\n\n\n\n- **UI Modifications**: Highlight any changes made to the user interface.\n- **Before & After**: Include screenshots or comparisons (if applicable).\n\n| Event | Before | After |\n| ------------------ | --------------------- | -------------------- |\n| `UP` |  |  |\n| `DOWN` |  |  |\n| Certificate-expiry |  |  |\n| Testing |  |  |\n"
},
{
"path": ".github/REVIEW_GUIDELINES.md",
"content": "# Uptime Kuma Review Guidelines\n\n> [!NOTE]\n> These review guidelines are a work in progress, and are frequently\n> updated and improved, so please check back frequently for the latest version.\n\n## Preparing for a PR Review\n\n### Read the PR description carefully\n\nMake sure you understand what the PR is trying to solve or implement. This could\nbe a bug fix, a new feature, or a refactor.\n\n### Check the linked issues\n\nIf the PR has a linked issue, read it to better understand the context and the\nreason for the change.\n\n### Check the test coverage\n\nMake sure relevant tests have been added or modified. If the PR adds new\nfunctionality, there should be tests covering the change.\n\n## General Review\n\n### Code formatting and style\n\nCheck if the code adheres to the style guidelines of the project. Make sure\nthere are no unused imports, variables, `console.log` for debugging in the PR.\n\n- [Project Style](../CONTRIBUTING.md#project-styles)\n- [Coding Style](../CONTRIBUTING.md#coding-styles)\n\n### Readability and maintainability\n\nIs the code easy to understand for other developers? Make sure complex parts are\nexplained with comments about **_why_** something is done, and use clear names\nto show **_how_**. Are variables and functions well-named, and is there a\nconsistent naming style? Also, check if the code is maintainable:\n\n- Is it unnecessarily complex? Could it be simplified?\n- Does it follow the **[Single Responsibility Principle (SRP)]**?\n\n[Single Responsibility Principle (SRP)]: https://www.geeksforgeeks.org/single-responsibility-in-solid-design-principle/\n\n### Documentation\n\nIs the PR well documented? Check if the descriptions of functions, parameters,\nand return values are present. Are there any changes needed to the README or\nother documentation, for example, if new features or configurations are\nintroduced?\n\n## Functional Review\n\n### Testing\n\nEnsure that the new code is properly tested. This includes unit tests,\nintegration tests, and if necessary, end-to-end tests.\n\n### Test results\n\nDid all tests pass in the CI pipeline (e.g., GitHub Actions, Travis, CircleCI)?\n\n### Testing in different environments\n\nIf the changes depend on certain environments or configurations, verify that the\ncode has been tested in various environments (e.g., local development, staging,\nproduction).\n\n- [How to test Pull Requests](https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests)\n\n### Edge cases and regressions\n\n- Are there test cases for possible edge cases?\n- Could this change introduce regressions in other parts of the system?\n\n## Security\n\n### Security issues\n\nCheck for potential security problems, such as SQL injection, XSS attacks, or\nunsafe API calls. Are there passwords, tokens, or other sensitive data left in\nthe code by mistake?\n\n### Authentication and authorization\n\nIs access to sensitive data or functionality properly secured? Check that the\ncorrect authorization and authentication mechanisms are in place.\n\n### Security Best Practices\n\n- Ensure that the code is free from common vulnerabilities like **SQL\n injection**, **XSS attacks**, and **insecure API calls**.\n- Check for proper encryption of sensitive data, and ensure that **passwords**\n or **API tokens** are not hardcoded in the code.\n\n## Performance\n\n### Performance impact\n\nCheck if the changes negatively impact performance. This can include factors\nlike load times, memory usage, or other performance aspects.\n\n### Use of external libraries\n\n- Have the right libraries been chosen?\n- Are there unnecessary dependencies that might reduce performance or increase\n code complexity?\n- Are these dependencies actively maintained and free of known vulnerabilities?\n\n### Performance Best Practices\n\n- **Measure performance** using tools like Lighthouse or profiling libraries.\n- **Avoid unnecessary dependencies** that may bloat the codebase.\n- Ensure that the **code does not degrade the user experience** (e.g., by\n increasing load times or memory consumption).\n\n## Compliance and Integration\n\n### Alignment with the project\n\nAre the changes consistent with the project goals and requirements? Ensure the\nPR aligns with the architecture and design principles of the project.\n\n### Integration\n\nIf the PR depends on other PRs or changes, verify that they integrate well with\nthe rest of the project. Ensure the code does not cause conflicts with other\nactive PRs.\n\n### Backward compatibility\n\nDoes the change break compatibility with older versions of the software or\ndependencies? If so, is there a migration plan in place?\n\n## Logging and Error Handling\n\n### Proper error handling\n\n- Are errors properly caught and handled instead of being silently ignored?\n- Are exceptions used appropriately?\n\n### Logging\n\n- Is sufficient logging included for debugging and monitoring?\n- Is there excessive logging that could affect performance?\n\n## Accessibility (for UI-related changes)\n\nIf the PR affects the user interface, ensure that it meets accessibility\nstandards:\n\n- Can users navigate using only the keyboard?\n- Are screen readers supported?\n- Is there proper color contrast for readability?\n- Are there **WCAG** (Web Content Accessibility Guidelines) compliance issues?\n- Use tools like **Axe** or **Lighthouse** to evaluate accessibility.\n\n## Providing Feedback\n\n### Constructive feedback\n\nProvide clear, constructive feedback on what is good and what can be improved.\nIf improvements are needed, be specific about what should change.\n\n### Clarity and collaboration\n\nEnsure your feedback is friendly and open, so the team member who submitted the\nPR feels supported and motivated to make improvements.\n\nFor Maintainers only (click to expand)\n
\n\n## Go/No-Go Decision\n\n### Go\n\nIf the code has no issues and meets the project requirements, approve it (and\npossibly merge it).\n\n### No-Go\n\nIf there are significant issues, such as missing tests, security\nvulnerabilities, or performance problems, request the necessary changes before\nthe PR can be approved. Some examples of **significant issues** include:\n\n- Missing tests for new functionality.\n- Identified **security vulnerabilities**.\n- Code changes that break **backward compatibility** without a proper migration\n plan.\n- Code that causes **major performance regressions** (e.g., high CPU/memory\n usage).\n\n## After the Review\n\n### Reordering and merging\n\nOnce the necessary changes have been made and the PR is approved, the code can\nbe merged into the main branch (e.g., `main` or `master`).\n\n### Testing after merging\n\nEnsure that the build passes after merging the PR, and re-test the functionality\nin the production environment if necessary.\n\n## Follow-up\n\n### Communication with team members\n\nIf the PR has long-term technical or functional implications, communicate the\nchanges to the team.\n\n### Monitoring\n\nContinue monitoring the production environment for any unexpected issues that\nmay arise after the code has been merged.\n\n
\n\n\n---\n\nThis process ensures that PRs are systematically and thoroughly reviewed,\nimproving overall code quality.\n"
},
{
"path": ".github/config/exclude.txt",
"content": "# This is a .gitignore style file for 'GrantBirki/json-yaml-validate' Action workflow\n"
},
{
"path": ".github/copilot-instructions.md",
"content": "# Copilot Instructions for Uptime Kuma\n\n## Copilot's Goals/Tasks\n\n- Check spelling\n- Do not show \"Pull Request Overview\"\n- You do not have to reply if there are no issues\n\n## Repository Overview\n\n**Uptime Kuma** is a self-hosted monitoring tool for HTTP(s), TCP, DNS, Docker, etc. Built with Vue 3 (frontend) and Node.js/Express (backend), using Socket.IO for real-time communication.\n\n- **Languages**: JavaScript, Vue 3, TypeScript (limited), HTML, CSS/SCSS\n- **Backend**: Node.js >= 20.4, Express.js, Socket.IO, SQLite\n- **Frontend**: Vue 3, Vite, Bootstrap 5, Chart.js\n- **Package Manager**: npm with `legacy-peer-deps=true` (.npmrc)\n\n## Build & Validation Commands\n\n### Prerequisites\n\n- Node.js >= 20.4.0, npm >= 9.3, Git\n\n### Essential Command Sequence\n\n1. **Install Dependencies**:\n\n ```bash\n npm ci # Use npm ci NOT npm install (~60-90 seconds)\n ```\n\n2. **Linting** (required before committing):\n\n ```bash\n npm run lint # Both linters (~15-30 seconds)\n npm run lint:prod # For production (zero warnings)\n ```\n\n3. **Build Frontend**:\n\n ```bash\n npm run build # Takes ~90-120 seconds, builds to dist/\n ```\n\n4. **Run Tests**:\n ```bash\n npm run test-backend # Backend tests (~50-60 seconds)\n npm test # All tests\n ```\n\n### Development Workflow\n\n```bash\nnpm run dev # Starts frontend (port 3000) and backend (port 3001)\n```\n\n## Project Architecture\n\n### Directory Structure\n\n```\n/\n├── server/ Backend source code\n│ ├── model/ Database models (auto-mapped to tables)\n│ ├── monitor-types/ Monitor type implementations\n│ ├── notification-providers/ Notification integrations\n│ ├── routers/ Express routers\n│ ├── socket-handlers/ Socket.IO event handlers\n│ ├── server.js Server entry point\n│ └── uptime-kuma-server.js Main server logic\n├── src/ Frontend source code (Vue 3 SPA)\n│ ├── components/ Vue components\n│ ├── pages/ Page components\n│ ├── lang/ i18n translations\n│ ├── router.js Vue Router configuration\n│ └── main.js Frontend entry point\n├── db/ Database related\n│ ├── knex_migrations/ Knex migration files\n│ └── kuma.db SQLite database (gitignored)\n├── test/ Test files\n│ ├── backend-test/ Backend unit tests\n│ └── e2e/ Playwright E2E tests\n├── config/ Build configuration\n│ ├── vite.config.js Vite build config\n│ └── playwright.config.js Playwright test config\n├── dist/ Frontend build output (gitignored)\n├── data/ App data directory (gitignored)\n├── public/ Static frontend assets (dev only)\n├── docker/ Docker build files\n└── extra/ Utility scripts\n```\n\n### Key Configuration Files\n\n- **package.json**: Scripts, dependencies, Node.js version requirement\n- **.eslintrc.js**: ESLint rules (4 spaces, double quotes, unix line endings, JSDoc required)\n- **.stylelintrc**: Stylelint rules (4 spaces indentation)\n- **.editorconfig**: Editor settings (4 spaces, LF, UTF-8)\n- **tsconfig-backend.json**: TypeScript config for backend (only src/util.ts)\n- **.npmrc**: `legacy-peer-deps=true` (required for dependency resolution)\n- **.gitignore**: Excludes node_modules, dist, data, tmp, private\n\n### Code Style (strictly enforced by linters)\n\n- 4 spaces indentation, double quotes, Unix line endings (LF), semicolons required\n- **Naming**: JavaScript/TypeScript (camelCase), SQLite (snake_case), CSS/SCSS (kebab-case)\n- JSDoc required for all functions/methods\n\n## CI/CD Workflows\n\n**auto-test.yml** (runs on PR/push to master/1.23.X):\n\n- Linting, building, backend tests on multiple OS/Node versions (15 min timeout)\n- E2E Playwright tests\n\n**validate.yml**: Validates JSON/YAML files, language files, knex migrations\n\n**PR Requirements**: All linters pass, tests pass, code follows style guidelines\n\n## Common Issues\n\n1. **npm install vs npm ci**: Always use `npm ci` for reproducible builds\n2. **TypeScript errors**: `npm run tsc` shows 1400+ errors - ignore them, they don't affect builds\n3. **Stylelint warnings**: Deprecation warnings are expected, ignore them\n4. **Test failures**: Always run `npm run build` before running tests\n5. **Port conflicts**: Dev server uses ports 3000 and 3001\n6. **First run**: Server shows \"db-config.json not found\" - this is expected, starts setup wizard\n\n## Translations\n\n- Managed via Weblate. Add keys to `src/lang/en.json` only\n- Don't include other languages in PRs\n- Use `$t(\"key\")` in Vue templates\n\n## Database\n\n- Primary: SQLite (also supports MariaDB/MySQL)\n- Migrations in `db/knex_migrations/` using Knex.js\n- Filename format validated by CI: `node ./extra/check-knex-filenames.mjs`\n\n## Testing\n\n- **Backend**: Node.js test runner, fast unit tests\n- **E2E**: Playwright (requires `npx playwright install` first time)\n- Test data in `data/playwright-test`\n\n## Adding New Features\n\n### New Notification Provider\n\nFiles to modify:\n\n1. `server/notification-providers/PROVIDER_NAME.js` (backend logic)\n2. `server/notification.js` (register provider)\n3. `src/components/notifications/PROVIDER_NAME.vue` (frontend UI)\n4. `src/components/notifications/index.js` (register frontend)\n5. `src/components/NotificationDialog.vue` (add to list)\n6. `src/lang/en.json` (add translation keys)\n\n### New Monitor Type\n\nFiles to modify:\n\n1. `server/monitor-types/MONITORING_TYPE.js` (backend logic)\n2. `server/uptime-kuma-server.js` (register monitor type)\n3. `src/pages/EditMonitor.vue` (frontend UI)\n4. `src/lang/en.json` (add translation keys)\n\n## Important Notes\n\n1. **Trust these instructions** - based on testing. Search only if incomplete/incorrect\n2. **Dependencies**: 5 known vulnerabilities (3 moderate, 2 high) - acknowledged, don't fix without discussion\n3. **Git Branches**: `master` (v2 development), `1.23.X` (v1 maintenance)\n4. **Node Version**: >= 20.4.0 required\n5. **Socket.IO**: Most backend logic in `server/socket-handlers/`, not REST\n6. **Never commit**: `data/`, `dist/`, `tmp/`, `private/`, `node_modules/`\n"
},
{
"path": ".github/dependabot.yml",
"content": "# Dependabot configuration for Uptime Kuma\n# See: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file\n\nversion: 2\nupdates:\n # Enable version updates for GitHub Actions\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n day: \"monday\"\n # Group all GitHub Actions updates into a single PR\n groups:\n github-actions:\n patterns:\n - \"*\"\n open-pull-requests-limit: 5\n commit-message:\n prefix: \"chore\"\n include: \"scope\"\n cooldown:\n default-days: 7\n"
},
{
"path": ".github/workflows/auto-test.yml",
"content": "name: Auto Test\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}-server\n cancel-in-progress: true\n\non:\n push:\n branches: [master, 1.23.X, 3.0.0]\n pull_request:\npermissions: {}\n\njobs:\n auto-test:\n runs-on: ${{ matrix.os }}\n permissions:\n contents: read\n\n strategy:\n fail-fast: false\n matrix:\n os: [macos-latest, ubuntu-22.04, windows-latest, ubuntu-22.04-arm]\n # See supported Node.js release schedule at https://nodejs.org/en/about/releases/\n node: [20, 24]\n # Also test non-LTS, but only on Ubuntu.\n include:\n - os: ubuntu-22.04\n node: 25\n\n steps:\n - run: git config --global core.autocrlf false # Mainly for Windows\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Cache/Restore node_modules\n uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1\n id: node-modules-cache\n with:\n path: node_modules\n key: node-modules-${{ runner.os }}-node${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}\n\n - name: Use Node.js ${{ matrix.node }}\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: ${{ matrix.node }}\n - run: npm clean-install --no-fund\n\n - name: Rebuild native modules for ARM64\n if: matrix.os == 'ubuntu-22.04-arm'\n run: npm rebuild @louislam/sqlite3\n\n - run: npm run build\n - run: npm run test-backend\n env:\n HEADLESS_TEST: 1\n JUST_FOR_TEST: ${{ secrets.JUST_FOR_TEST }}\n\n # 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\n armv7-simple-test:\n runs-on: ubuntu-latest\n permissions:\n contents: read\n strategy:\n fail-fast: false\n matrix:\n node: [20, 22]\n # See supported Node.js release schedule at https://nodejs.org/en/about/releases/\n\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0\n with:\n platforms: linux/arm/v7\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1\n\n - name: Test on ARMv7 using Docker with QEMU\n run: |\n docker run --rm --platform linux/arm/v7 \\\n -v $PWD:/workspace \\\n -w /workspace \\\n arm32v7/node:${{ matrix.node }} \\\n npm clean-install --no-fund --production\n\n check-linters:\n runs-on: ubuntu-latest\n permissions:\n contents: read\n\n steps:\n - run: git config --global core.autocrlf false # Mainly for Windows\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Cache/Restore node_modules\n uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1\n id: node-modules-cache\n with:\n path: node_modules\n key: node-modules-${{ runner.os }}-node${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}\n\n - name: Use Node.js 20\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 20\n - run: npm clean-install --no-fund\n - run: npm run lint:prod\n\n e2e-test:\n runs-on: ubuntu-22.04-arm\n permissions:\n contents: read\n env:\n PLAYWRIGHT_VERSION: ~1.39.0\n steps:\n - run: git config --global core.autocrlf false # Mainly for Windows\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Cache/Restore node_modules\n uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1\n id: node-modules-cache\n with:\n path: node_modules\n key: node-modules-${{ runner.os }}-node${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}\n\n - name: Setup Node.js\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 22\n - run: npm clean-install --no-fund\n\n - name: Rebuild native modules for ARM64\n run: npm rebuild @louislam/sqlite3\n\n - name: Install Playwright ${{ env.PLAYWRIGHT_VERSION }}\n run: npx playwright@${{ env.PLAYWRIGHT_VERSION }} install\n\n - run: npm run build\n - run: npm run test-e2e\n"
},
{
"path": ".github/workflows/autofix.yml",
"content": "name: autofix.ci\n\non:\n push:\n branches: [\"master\", \"1.23.X\"]\n pull_request:\npermissions: {}\n\njobs:\n autofix:\n runs-on: ubuntu-latest\n permissions:\n contents: read\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Cache/Restore node_modules\n uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1\n id: node-modules-cache\n with:\n path: node_modules\n key: node-modules-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}\n\n - name: Setup Node.js\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 20\n\n - name: Install dependencies\n run: npm ci\n\n - name: Auto-fix JavaScript/Vue linting issues\n run: npm run lint-fix:js\n continue-on-error: true\n\n - name: Auto-fix CSS/SCSS linting issues\n run: npm run lint-fix:style\n continue-on-error: true\n\n - name: Auto-format code with Prettier\n run: npm run fmt\n continue-on-error: true\n\n - name: Compile TypeScript\n run: npm run tsc\n continue-on-error: true\n\n - uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27\n"
},
{
"path": ".github/workflows/build-docker-base.yml",
"content": "name: Build Docker Base Images\n\non:\n workflow_dispatch: # Allow manual trigger\n\npermissions: {}\n\njobs:\n build-docker-base:\n runs-on: ubuntu-latest\n timeout-minutes: 120\n permissions:\n contents: read\n packages: write\n\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1\n\n - name: Login to Docker Hub\n uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n - name: Login to GitHub Container Registry\n uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0\n with:\n registry: ghcr.io\n username: ${{ secrets.GHCR_USERNAME }}\n password: ${{ secrets.GHCR_TOKEN }}\n\n - name: Use Node.js 20\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 20\n\n - name: Build and push base2-slim image\n run: npm run build-docker-base-slim\n\n - name: Build and push base2 image\n run: npm run build-docker-base\n"
},
{
"path": ".github/workflows/build-docker-push.yml",
"content": "name: Build Docker Push Image\n\non:\n schedule:\n # Runs at 2:00 AM UTC on the 1st of every month\n - cron: \"0 2 1 * *\"\n workflow_dispatch: # Allow manual trigger\n\npermissions: {}\n\njobs:\n build-docker-push:\n # Only run on the original repository, not on forks\n if: github.repository == 'louislam/uptime-kuma'\n runs-on: ubuntu-latest\n timeout-minutes: 120\n permissions:\n contents: read\n\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1\n\n - name: Login to Docker Hub\n uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n - name: Use Node.js 20\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 20\n\n - name: Set up Go\n uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v5.5.0\n\n - name: Install cross-env\n run: npm install -g cross-env\n\n - name: Build and push Docker image\n working-directory: extra/uptime-kuma-push\n run: npm run build-docker\n"
},
{
"path": ".github/workflows/close-incorrect-issue.yml",
"content": "name: Close Incorrect Issue\n\non:\n issues:\n types: [opened]\npermissions: {}\n\njobs:\n close-incorrect-issue:\n runs-on: ${{ matrix.os }}\n permissions:\n issues: write\n\n strategy:\n matrix:\n os: [ubuntu-latest]\n node-version: [20]\n\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Use Node.js ${{ matrix.node-version }}\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: ${{ matrix.node-version }}\n - run: npm ci\n - name: Close incorrect issue\n run: node extra/close-incorrect-issue.js ${{ secrets.GITHUB_TOKEN }} ${{ github.event.issue.number }} \"$ISSUE_USER_LOGIN\"\n env:\n ISSUE_USER_LOGIN: ${{ github.event.issue.user.login }}\n"
},
{
"path": ".github/workflows/codeql-analysis.yml",
"content": "name: \"CodeQL\"\n\non:\n push:\n branches: [\"master\", \"1.23.X\"]\n pull_request:\n branches: [\"master\", \"1.23.X\"]\n schedule:\n - cron: \"16 22 * * 0\"\n\njobs:\n analyze:\n # Only run scheduled analysis on the original repository, not on forks\n if: github.event_name != 'schedule' || github.repository == 'louislam/uptime-kuma'\n name: Analyze\n runs-on: ubuntu-latest\n timeout-minutes: 360\n\n permissions:\n actions: read\n contents: read\n security-events: write\n\n strategy:\n fail-fast: false\n matrix:\n language: [\"go\", \"javascript-typescript\"]\n\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9\n with:\n languages: ${{ matrix.language }}\n\n - name: Autobuild\n uses: github/codeql-action/autobuild@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # v4.31.9\n with:\n category: \"/language:${{matrix.language}}\"\n zizmor:\n # Only run scheduled analysis on the original repository, not on forks\n if: github.event_name != 'schedule' || github.repository == 'louislam/uptime-kuma'\n runs-on: ubuntu-latest\n permissions:\n security-events: write\n contents: read\n actions: read\n steps:\n - name: Checkout repository\n uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n - name: Run zizmor\n uses: zizmorcore/zizmor-action@e639db99335bc9038abc0e066dfcd72e23d26fb4 # v0.3.0\n"
},
{
"path": ".github/workflows/conflict-labeler.yml",
"content": "name: Merge Conflict Labeler\n\n# pull_request_target is safe here because:\n# 1. Only uses a pinned trusted action (by SHA)\n# 2. Has minimal permissions (contents: read, pull-requests: write)\n# 3. Doesn't checkout or execute any untrusted code from PRs\n# 4. Only adds/removes labels based on merge conflict status\non: # zizmor: ignore[dangerous-triggers]\n push:\n branches:\n - master\n pull_request_target:\n branches:\n - master\n types: [synchronize]\n\njobs:\n label:\n name: Labeling\n runs-on: ubuntu-latest\n if: ${{ github.repository == 'louislam/uptime-kuma' }}\n permissions:\n contents: read\n pull-requests: write\n steps:\n - name: Apply label\n uses: eps1lon/actions-label-merge-conflict@1df065ebe6e3310545d4f4c4e862e43bdca146f0 # v3.0.3\n with:\n dirtyLabel: \"needs:resolve-merge-conflict\"\n repoToken: \"${{ secrets.GITHUB_TOKEN }}\"\n"
},
{
"path": ".github/workflows/mark-as-draft-on-requesting-changes.yml",
"content": "name: Mark PR as draft when changes are requested\n\n# pull_request_target is safe here because:\n# 1. Does not use any external actions; only uses the GitHub CLI via run commands\n# 2. Has minimal permissions\n# 3. Doesn't checkout or execute any untrusted code from PRs\n# 4. Only adds/removes labels or changes the draft status\non: # zizmor: ignore[dangerous-triggers]\n pull_request_target:\n types:\n - review_submitted\n - labeled\n - ready_for_review\n\npermissions: {}\n\njobs:\n mark-draft:\n runs-on: ubuntu-latest\n permissions:\n pull-requests: write\n if: |\n (\n github.event.action == 'review_submitted' &&\n github.event.review.state == 'changes_requested'\n ) || (\n github.event.action == 'labeled' &&\n github.event.label.name == 'pr:please address review comments'\n )\n steps:\n - name: Add label on requested changes\n if: github.event.review.state == 'changes_requested'\n env:\n GH_TOKEN: ${{ github.token }}\n run: |\n gh issue edit \"${{ github.event.pull_request.number }}\" \\\n --repo \"${{ github.repository }}\" \\\n --add-label \"pr:please address review comments\"\n\n - name: Mark PR as draft\n env:\n GH_TOKEN: ${{ github.token }}\n run: |\n gh pr ready \"${{ github.event.pull_request.number }}\" \\\n --repo \"${{ github.repository }}\" \\\n --undo || true\n # || true to ignore the case where the pr is already a draft\n\n ready-for-review:\n runs-on: ubuntu-latest\n permissions:\n pull-requests: write\n if: github.event.action == 'ready_for_review'\n steps:\n - name: Update labels for review\n env:\n GH_TOKEN: ${{ github.token }}\n run: |\n gh issue edit \"${{ github.event.pull_request.number }}\" \\\n --repo \"${{ github.repository }}\" \\\n --remove-label \"pr:please address review comments\" || true\n\n gh issue edit \"${{ github.event.pull_request.number }}\" \\\n --repo \"${{ github.repository }}\" \\\n --add-label \"pr:needs review\"\n"
},
{
"path": ".github/workflows/new-contributor-pr.yml",
"content": "name: New contributor message\n\non:\n # Safety\n # This workflow uses pull_request_target so it can run with write permissions on first-time contributor PRs.\n # It is safe because it does not check out or execute any code from the pull request and\n # only uses the pinned, trusted plbstl/first-contribution action\n pull_request_target: # zizmor: ignore[dangerous-triggers]\n types: [opened, closed]\n branches:\n - master\n\npermissions:\n pull-requests: write\n\njobs:\n build:\n if: github.repository == 'louislam/uptime-kuma'\n name: Hello new contributor\n runs-on: ubuntu-latest\n timeout-minutes: 60\n steps:\n - uses: plbstl/first-contribution@4b2b042fffa26792504a18e49aa9543a87bec077 # v4.1.0\n with:\n pr-reactions: rocket\n pr-opened-msg: >\n Hello and thanks for lending a paw to Uptime Kuma! 🐻👋\n\n As this is your first contribution, please be sure to check out our [Pull Request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma).\n\n In particular:\n - Mark your PR as Draft while you’re still making changes\n - Mark it as Ready for review once it’s fully ready\n\n If you have any design or process questions, feel free to ask them right here in this pull request - unclear documentation is a bug too.\n pr-merged-msg: >\n @{fc-author} congrats on your first contribution to Uptime Kuma! 🐻\n\n We hope you enjoy contributing to our project and look forward to seeing more of your work in the future!\n If you want to see your contribution in action, please see our [nightly builds here](https://hub.docker.com/layers/louislam/uptime-kuma/nightly2).\n"
},
{
"path": ".github/workflows/npm-update.yml",
"content": "name: NPM Update\n\non:\n workflow_dispatch:\n schedule:\n - cron: \"0 0 * * *\" # Run daily at midnight UTC\n\npermissions:\n contents: write\n pull-requests: write\n\njobs:\n npm-update:\n # Only run on the original repository, not on forks\n if: github.repository == 'louislam/uptime-kuma'\n runs-on: ubuntu-latest\n permissions:\n contents: write\n pull-requests: write\n\n steps:\n - name: Checkout master branch\n uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with:\n ref: master\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Setup Node.js\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 20\n\n - name: Generate lockfile from scratch\n run: |\n rm -f package-lock.json\n npm install --package-lock-only\n\n - name: Check if there are changes\n id: check_changes\n run: |\n if git diff --quiet package-lock.json; then\n echo \"has_changes=false\" >> $GITHUB_OUTPUT\n else\n echo \"has_changes=true\" >> $GITHUB_OUTPUT\n fi\n\n - name: Configure git\n if: steps.check_changes.outputs.has_changes == 'true'\n run: |\n git config --global user.name \"github-actions[bot]\"\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n\n - name: Commit changes\n if: steps.check_changes.outputs.has_changes == 'true'\n run: |\n git add package-lock.json\n git commit -m \"chore: Update dependencies\"\n\n - name: Force push to npm-update branch\n if: steps.check_changes.outputs.has_changes == 'true'\n run: |\n git push -f origin HEAD:npm-update\n\n - name: Check if PR exists\n if: steps.check_changes.outputs.has_changes == 'true'\n id: check_pr\n env:\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: |\n PR_EXISTS=$(gh pr list --base master --head npm-update --json number --jq 'length')\n if [ \"$PR_EXISTS\" -eq \"0\" ]; then\n echo \"pr_exists=false\" >> $GITHUB_OUTPUT\n else\n echo \"pr_exists=true\" >> $GITHUB_OUTPUT\n fi\n\n - name: Create Pull Request\n if: steps.check_changes.outputs.has_changes == 'true' && steps.check_pr.outputs.pr_exists == 'false'\n env:\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: |\n gh pr create \\\n --base master \\\n --head npm-update \\\n --title \"chore: Update dependencies\" \\\n --body \"\"\n"
},
{
"path": ".github/workflows/pr-description-check.yml",
"content": "name: \"PR description template check\"\n\non: # zizmor: ignore[dangerous-triggers]\n pull_request_target:\n types: [opened, reopened]\n\npermissions:\n pull-requests: write\n issues: write\n contents: read\n\njobs:\n check-pr-description:\n name: Check PR description and close if missing template phrase\n runs-on: ubuntu-latest\n permissions:\n pull-requests: write\n issues: write\n steps:\n - name: Check PR description\n uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0\n with:\n script: |\n const pr = context.payload.pull_request;\n const body = (pr && pr.body) ? pr.body : \"\";\n const requiredPhrase = \"avoid unnecessary back and forth\";\n\n const exclude = [\"UptimeKumaBot\", \"Copilot\", \"copilot-swe-agent\"];\n const excludeLower = exclude.map((e) => e.toLowerCase());\n const author = pr?.user?.login || \"\";\n\n // If author is in exclude list, skip\n if (author && excludeLower.includes(author.toLowerCase())) {\n core.info(`PR #${pr.number} opened by excluded user '${author}', skipping template check.`);\n return;\n }\n\n if (!body || !body.toLowerCase().includes(requiredPhrase.toLowerCase())) {\n const owner = context.repo.owner;\n const repo = context.repo.repo;\n const number = pr.number;\n\n const commentBody = `Hello! This pull request does not follow the repository's PR template and is being closed automatically.`;\n\n // Post comment\n await github.rest.issues.createComment({ owner, repo, issue_number: number, body: commentBody });\n\n // Close\n await github.rest.pulls.update({ owner, repo, pull_number: number, state: \"closed\" });\n\n core.info(`Closed PR #${number} because required phrase was not present.`);\n } else {\n core.info(\"PR description contains required phrase; no action taken.\");\n }\n"
},
{
"path": ".github/workflows/pr-title.yml",
"content": "name: \"PR Metadata\"\n# if someone opens a PR, edits it, or reopens it we want to validate the title\n# This is separate from the rest of the CI as the title may change without code changes\n\non:\n # SECURITY: pull_request_target is used here to allow validation of PRs from forks.\n # This is safe because:\n # 1. No code from the PR is checked out\n # 2. Permissions are restricted to pull-requests: read\n # 3. Only a trusted third-party action is used to validate the PR title\n # 4. No user-controlled code is executed\n pull_request_target: # zizmor: ignore[dangerous-triggers]\n types:\n - opened\n - edited\n - reopened\n - synchronize\n\npermissions:\n pull-requests: read\n\njobs:\n pr-title:\n name: Validate PR title follows https://conventionalcommits.org\n runs-on: ubuntu-latest\n permissions:\n pull-requests: read\n steps:\n - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n"
},
{
"path": ".github/workflows/prevent-file-change.yml",
"content": "name: prevent-file-change\n\non:\n pull_request:\npermissions: {}\n\njobs:\n check-file-changes:\n runs-on: ubuntu-latest\n permissions:\n pull-requests: read\n steps:\n - name: Prevent file change\n uses: xalvarez/prevent-file-change-action@004d9f17c2e4a7afa037cda5f38dc55a5e9c9c06 # v1.9.1\n with:\n githubToken: ${{ secrets.GITHUB_TOKEN }}\n # Regex, /src/lang/*.json is not allowed to be changed, except for /src/lang/en.json\n pattern: '^(?!src/lang/en\\.json$)src/lang/.*\\.json$'\n trustedAuthors: UptimeKumaBot\n"
},
{
"path": ".github/workflows/release-beta.yml",
"content": "name: Beta Release\n\non:\n workflow_dispatch:\n inputs:\n version:\n description: \"Beta version number (e.g., 2.1.0-beta.2)\"\n required: true\n type: string\n previous_version:\n description: \"Previous version tag for changelog (e.g., 2.1.0-beta.1)\"\n required: true\n type: string\n dry_run:\n description: \"Dry Run (The docker image will not be pushed to registries. PR will still be created.)\"\n required: false\n type: boolean\n default: false\n\npermissions:\n contents: write\n pull-requests: write\n\njobs:\n beta-release:\n runs-on: ubuntu-latest\n timeout-minutes: 120\n\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with:\n ref: master\n persist-credentials: true\n fetch-depth: 0 # Fetch all history for changelog generation\n\n - name: Set up Node.js\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 24\n\n - name: Create release branch\n env:\n VERSION: ${{ inputs.version }}\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: |\n git config user.name \"github-actions[bot]\"\n git config user.email \"github-actions[bot]@users.noreply.github.com\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@github.com/${{ github.repository }}.git\"\n # Delete remote branch if it exists\n git push origin --delete \"release-${VERSION}\" || true\n # Delete local branch if it exists\n git branch -D \"release-${VERSION}\" || true\n # For testing purpose\n # git checkout beta-workflow\n git checkout -b \"release-${VERSION}\"\n\n - name: Install dependencies\n run: npm clean-install --no-fund\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0\n\n - name: Login to Docker Hub\n uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n - name: Login to GitHub Container Registry\n uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0\n with:\n registry: ghcr.io\n username: ${{ secrets.GHCR_USERNAME }}\n password: ${{ secrets.GHCR_TOKEN }}\n\n - name: Run release-beta\n env:\n RELEASE_BETA_VERSION: ${{ inputs.version }}\n RELEASE_PREVIOUS_VERSION: ${{ inputs.previous_version }}\n DRY_RUN: ${{ inputs.dry_run }}\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n GITHUB_RUN_ID: ${{ github.run_id }}\n run: npm run release-beta\n\n - name: Upload dist.tar.gz as artifact\n uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3\n with:\n name: dist-${{ inputs.version }}\n path: ./tmp/dist.tar.gz\n retention-days: 90\n"
},
{
"path": ".github/workflows/release-final.yml",
"content": "name: Final Release\n\non:\n workflow_dispatch:\n inputs:\n version:\n description: \"Release version number (e.g., 2.1.0)\"\n required: true\n type: string\n previous_version:\n description: \"Previous version tag for changelog (e.g., 2.1.0-beta.3)\"\n required: true\n type: string\n dry_run:\n description: \"Dry Run (The docker image will not be pushed to registries. PR will still be created.)\"\n required: false\n type: boolean\n default: false\n\npermissions:\n contents: write\n pull-requests: write\n\njobs:\n release:\n runs-on: ubuntu-latest\n timeout-minutes: 120\n\n steps:\n - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2\n with:\n ref: master\n persist-credentials: true\n fetch-depth: 0 # Fetch all history for changelog generation\n\n - name: Set up Node.js\n uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0\n with:\n node-version: 24\n\n - name: Create release branch\n env:\n VERSION: ${{ inputs.version }}\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: |\n git config user.name \"github-actions[bot]\"\n git config user.email \"github-actions[bot]@users.noreply.github.com\"\n git remote set-url origin \"https://x-access-token:${GITHUB_TOKEN}@github.com/${{ github.repository }}.git\"\n # Delete remote branch if it exists\n git push origin --delete \"release-${VERSION}\" || true\n # Delete local branch if it exists\n git branch -D \"release-${VERSION}\" || true\n # For testing purpose\n # git checkout beta-workflow\n git checkout -b \"release-${VERSION}\"\n\n - name: Install dependencies\n run: npm clean-install --no-fund\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0\n\n - name: Login to Docker Hub\n uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n - name: Login to GitHub Container Registry\n uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # v3.7.0\n with:\n registry: ghcr.io\n username: ${{ secrets.GHCR_USERNAME }}\n password: ${{ secrets.GHCR_TOKEN }}\n\n - name: Run release-final\n env:\n RELEASE_VERSION: ${{ inputs.version }}\n RELEASE_PREVIOUS_VERSION: ${{ inputs.previous_version }}\n DRY_RUN: ${{ inputs.dry_run }}\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n GITHUB_RUN_ID: ${{ github.run_id }}\n run: npm run release-final\n\n - name: Upload dist.tar.gz as artifact\n uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0\n with:\n name: dist-${{ inputs.version }}\n path: ./tmp/dist.tar.gz\n retention-days: 90\n"
},
{
"path": ".github/workflows/release-nightly.yml",
"content": "name: Nightly Release\n\non:\n schedule:\n # Runs at 2:00 AM UTC every day\n - cron: \"0 2 * * *\"\n workflow_dispatch: # Allow manual trigger\n\npermissions: {}\n\njobs:\n release-nightly:\n # Only run on the original repository, not on forks\n if: github.repository == 'louislam/uptime-kuma'\n runs-on: ubuntu-latest\n timeout-minutes: 120\n permissions:\n contents: read\n packages: write\n\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: Set up QEMU\n uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0\n\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1\n\n - name: Login to Docker Hub\n uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_TOKEN }}\n\n - name: Login to GitHub Container Registry\n uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0\n with:\n registry: ghcr.io\n username: ${{ secrets.GHCR_USERNAME }}\n password: ${{ secrets.GHCR_TOKEN }}\n\n - name: Use Node.js 20\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 20\n\n - name: Cache/Restore node_modules\n uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5.0.1\n id: node-modules-cache\n with:\n path: node_modules\n key: node-modules-${{ runner.os }}-node20-${{ hashFiles('**/package-lock.json') }}\n\n - name: Install dependencies\n run: npm clean-install --no-fund\n\n - name: Run release-nightly\n run: npm run release-nightly\n"
},
{
"path": ".github/workflows/stale-bot.yml",
"content": "name: \"Automatically close stale issues\"\non:\n workflow_dispatch:\n schedule:\n - cron: \"0 */6 * * *\"\n#Run every 6 hours\npermissions: {}\n\njobs:\n stale:\n # Only run on the original repository, not on forks\n if: github.repository == 'louislam/uptime-kuma'\n runs-on: ubuntu-latest\n permissions:\n actions: write\n issues: write\n steps:\n - uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1\n with:\n stale-issue-message: |-\n We are clearing up our old `help`-issues and your issue has been open for 60 days with no activity.\n If no comment is made and the stale label is not removed, this issue will be closed in 7 days.\n days-before-stale: 60\n days-before-close: 7\n days-before-pr-stale: -1\n days-before-pr-close: -1\n exempt-issue-labels: \"News,discussion,bug,doc,feature-request\"\n exempt-issue-assignees: \"louislam\"\n operations-per-run: 200\n - uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1\n with:\n stale-issue-message: |-\n This issue was marked as `cannot-reproduce` by a maintainer.\n If an issue is non-reproducible, we cannot fix it, as we do not know what the underlying issue is.\n If you have any ideas how we can reproduce this issue, we would love to hear them.\n\n We don't have a good way to deal with truely unreproducible issues and are going to close this issue in a month.\n If think there might be other differences in our environment or in how we tried to reproduce this, we would appreciate any ideas.\n close-issue-message: |-\n This issue will be closed as no way to reproduce it has been found.\n If you/somebody finds a way how to (semi-reliably) reproduce this, we can reopen this issue. ^^\n days-before-stale: 180\n days-before-close: 30\n days-before-pr-stale: -1\n days-before-pr-close: -1\n any-of-issue-labels: \"cannot-reproduce\"\n operations-per-run: 200\n"
},
{
"path": ".github/workflows/validate.yml",
"content": "name: validate\non:\n push:\n branches:\n - master\n pull_request:\n branches:\n - master\n - 1.23.X\n workflow_dispatch:\npermissions: {}\n\njobs:\n json-yaml-validate:\n runs-on: ubuntu-latest\n permissions:\n contents: read\n pull-requests: write # enable write permissions for pull request comments\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n\n - name: json-yaml-validate\n id: json-yaml-validate\n uses: GrantBirki/json-yaml-validate@9bbaa8474e3af4e91f25eda8ac194fdc30564d96 # v4.0.0\n with:\n comment: \"true\" # enable comment mode\n exclude_file: \".github/config/exclude.txt\" # gitignore style file for exclusions\n\n # General validations\n validate:\n runs-on: ubuntu-latest\n permissions:\n contents: read\n steps:\n - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1\n with: { persist-credentials: false }\n - name: Use Node.js 25\n uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0\n with:\n node-version: 25\n\n - name: Validate language JSON files\n run: node ./extra/check-lang-json.js\n\n - name: Validate knex migrations filename\n run: node ./extra/check-knex-filenames.mjs\n\n - name: Validate package.json\n run: node ./extra/check-package-json.mjs\n"
},
{
"path": ".gitignore",
"content": "node_modules\n.DS_Store\ndist\ndist-ssr\n*.local\n.idea\n\n/data\n!/data/.gitkeep\n/data*\n.vscode\n\n/private\n/out\n/tmp\n.env\n\n/extra/healthcheck.exe\n/extra/healthcheck\n/extra/healthcheck-armv7\n\nextra/exe-builder/bin\nextra/exe-builder/obj\n\n.vs\n.vscode\n"
},
{
"path": ".npmrc",
"content": "legacy-peer-deps=true\n"
},
{
"path": ".prettierignore",
"content": "# language files\nsrc/lang/*.json\n"
},
{
"path": ".prettierrc.js",
"content": "/**\n * Prettier Configuration for Uptime Kuma\n *\n * Usage:\n * npm run fmt - Format all files (auto-runs in CI via autofix workflow)\n * npm run fmt -- --check - Check formatting without making changes\n *\n * TIP: This formatter is automatically run in CI, so no need to worry about it\n */\nmodule.exports = {\n // Core formatting options - matching original ESLint rules\n semi: true,\n singleQuote: false,\n trailingComma: \"es5\",\n printWidth: 120,\n tabWidth: 4,\n useTabs: false,\n endOfLine: \"lf\",\n arrowParens: \"always\",\n bracketSpacing: true,\n bracketSameLine: false,\n\n // Vue-specific settings\n vueIndentScriptAndStyle: false,\n singleAttributePerLine: false,\n htmlWhitespaceSensitivity: \"ignore\", // More forgiving with whitespace in HTML\n\n // Override settings for specific file types\n overrides: [\n {\n files: \"*.vue\",\n options: {\n parser: \"vue\",\n },\n },\n {\n files: [\"*.json\"],\n options: {\n tabWidth: 4,\n trailingComma: \"none\",\n },\n },\n {\n files: [\"*.yml\", \"*.yaml\"],\n options: {\n tabWidth: 2,\n trailingComma: \"none\",\n },\n },\n {\n files: [\"src/icon.js\"],\n options: {\n trailingComma: \"all\",\n },\n },\n {\n files: [\"*.md\"],\n options: {\n printWidth: 100,\n proseWrap: \"preserve\",\n tabWidth: 2,\n },\n },\n ],\n};\n"
},
{
"path": ".stylelintrc",
"content": "{\n \"extends\": [\n \"stylelint-config-standard\",\n \"stylelint-config-prettier\"\n ],\n \"customSyntax\": \"postcss-html\",\n \"rules\": {\n \"no-descending-specificity\": null,\n \"declaration-empty-line-before\": null,\n \"alpha-value-notation\": \"number\",\n \"color-function-notation\": \"legacy\",\n \"shorthand-property-no-redundant-values\": null,\n \"color-hex-length\": null,\n \"declaration-block-no-redundant-longhand-properties\": null,\n \"at-rule-no-unknown\": null\n }\n}\n"
},
{
"path": "CNAME",
"content": "git.kuma.pet\n"
},
{
"path": "CODE_OF_CONDUCT.md",
"content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, caste, color, religion, or sexual\nidentity and orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n- Demonstrating empathy and kindness toward other people\n- Being respectful of differing opinions, viewpoints, and experiences\n- Giving and gracefully accepting constructive feedback\n- Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n- Focusing on what is best not just for us as individuals, but for the overall\n community\n\nExamples of unacceptable behavior include:\n\n- The use of sexualized language or imagery, and sexual attention or advances of\n any kind\n- Trolling, insulting or derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or email address,\n without their explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official email address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at\n. All complaints will be reviewed and investigated promptly and\nfairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series of\nactions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or permanent\nban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within the\ncommunity.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.1, available at\n[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder][Mozilla CoC].\n\nFor answers to common questions about this code of conduct, see the FAQ at\n[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at\n[https://www.contributor-covenant.org/translations][translations].\n\n[homepage]: https://www.contributor-covenant.org\n[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html\n[Mozilla CoC]: https://github.com/mozilla/diversity\n[FAQ]: https://www.contributor-covenant.org/faq\n[translations]: https://www.contributor-covenant.org/translations\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Project Info\n\nFirst of all, I want to thank everyone who has submitted issues or shared pull\nrequests for Uptime Kuma. I never thought the GitHub community would be so nice!\nBecause of this, I also never thought that other people would actually read and\nedit my code. Parts of the code are not very well-structured or commented, sorry\nabout that.\n\nBefore you start, please read our [Code of Conduct](CODE_OF_CONDUCT.md) to understand our community standards.\n\nThe project was created with `vite` and is written in `vue3`. Our backend\nlives in the `server`-directory and mostly communicates via websockets.\nBoth frontend and backend share the same `package.json`.\n\nFor production, the frontend is built into the `dist`-directory and the server\n(`express.js`) exposes the `dist` directory as the root of the endpoint. For\ndevelopment, we run vite in development mode on another port.\n\n## Directories\n\n- `config` (dev config files)\n- `data` (App data)\n- `db` (Base database and migration scripts)\n- `dist` (Frontend build)\n- `docker` (Dockerfiles)\n- `extra` (Extra useful scripts)\n- `public` (Frontend resources for dev only)\n- `server` (Server source code)\n- `src` (Frontend source code)\n- `test` (unit test)\n\n## Can I Create a Pull Request for Uptime Kuma?\n\nWhether or not you can create a pull request depends on the nature of your\ncontribution. We value both your time and our maintainers' time, so we want to\nmake sure it's spent efficiently.\n\nIf you're unsure about any process or step, you're probably not the only one\nwith that question—please feel free to ask. We're happy to help!\n\nDifferent types of pull requests (PRs) may have different guidelines, so be sure\nto review the appropriate one for your contribution.\n\n- Security Fixes (click to expand)\n
\n\n Submitting security fixes is something that may put the community at risk.\n Please read through our [security policy](SECURITY.md) and submit\n vulnerabilities via an [advisory] + [issue] instead. We encourage you to\n submit how to fix a vulnerability if you know how to, this is not required.\n Following the security policy allows us to properly test, fix bugs. This\n review allows us to notice, if there are any changes necessary to unrelated\n parts like the documentation.\n [**PLEASE SEE OUR SECURITY POLICY.**](SECURITY.md)\n\n [advisory]: https://github.com/louislam/uptime-kuma/security/advisories/new\n [issue]: https://github.com/louislam/uptime-kuma/issues/new?template=security_issue.yml\n\n
\n \n\n- Small, Non-Breaking Bug Fixes (click to expand)\n
\n\n If you come across a bug and think you can solve, we appreciate your work.\n Please make sure that you follow these rules:\n - keep the PR as small as possible, fix only one thing at a time => keeping it\n reviewable\n - test that your code does what you claim it does.\n\n Because maintainer time is precious, junior maintainers may merge\n uncontroversial PRs in this area.\n\n
\n \n\n- Translations / Internationalisation (i18n) (click to expand)\n
\n\n Please add **all** strings that are translatable to `src/lang/en.json`. If translation keys are omitted, they cannot be translated. **Do not include any other languages in your initial pull request** (even if it is your mother tongue) to avoid merge conflicts between Weblate and `master`. Once your PR is merged into `master`, the strings can be translated by awesome people donating their language skills.\n\n We use Weblate to localise this project into many languages. If you want to help translate Uptime Kuma into your language, please see [these instructions on how to translate using Weblate](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).\n\n There are some cases where a change cannot be done directly in Weblate and requires a PR:\n - A text may not yet be localisable. In this case, **adding a new language key** via `{{ $t(\"Translation key\") }}` or [``](https://vue-i18n.intlify.dev/guide/advanced/component.html) might be necessary.\n - Language keys need to be **added to `en.json`** to appear in Weblate. If this has not been done, a PR is appreciated.\n - **Adding a new language** requires creating a new file. See [these instructions](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).\n\n Because maintainer time is precious, junior maintainers may merge uncontroversial PRs in this area.\n\n
\n \n\n- New Notification Providers (click to expand)\n
\n\n To set up a new notification provider these files need to be modified/created:\n - `server/notification-providers/PROVIDER_NAME.js` is where the heart of the\n notification provider lives.\n\n - Both `monitorJSON` and `heartbeatJSON` can be `null` for some events. If\n\n both are `null`, this is a general testing message, but if just\n `heartbeatJSON` is `null` this is a certificate expiry.\n\n - Please wrap the axios call into a\n\n ```js\n try {\n let result = await axios.post(...);\n if (result.status === ...) ...\n } catch (error) {\n this.throwGeneralAxiosError(error);\n }\n ```\n\n - `server/notification.js` is where the backend of the notification provider\n needs to be registered. _If you have an idea how we can skip this step, we\n would love to hear about it ^^_\n\n - `src/components/NotificationDialog.vue` you need to decide if the provider\n is a regional or a global one and add it with a name to the respective list\n\n - `src/components/notifications/PROVIDER_NAME.vue` is where the frontend of\n each provider lives. Please make sure that you have:\n\n - used `HiddenInput` for secret credentials\n - included all the necessary helptexts/placeholder/.. to make sure the\n\n notification provider is simple to setup for new users. - include all\n translations (`{{ $t(\"Translation key\") }}`,\n [`i18n-t keypath=\"Translation key\">`](https://vue-i18n.intlify.dev/guide/advanced/component.html))\n in `src/lang/en.json` to enable our translators to translate this\n - `src/components/notifications/index.js` is where the frontend of the\n provider needs to be registered. _If you have an idea how we can skip this\n step, we would love to hear about it ^^_\n\n Offering notifications is close to the core of what we are as an uptime\n monitor. Therefore, making sure that they work is also really important.\n Because testing notification providers is quite time intensive, we mostly\n offload this onto the person contributing a notification provider.\n\n To make sure you have tested the notification provider, please include\n screenshots of the following events in the pull-request description:\n - `UP`/`DOWN`\n - Certificate Expiry via \n - Domain Expiry via and a larger time set\n - Testing (the test button on the notification provider setup page)\n\n \n\n Using the following way to format this is encouraged:\n\n ```md\n | Event | Before | After |\n | ------------------ | --------------------- | -------------------- |\n | `UP` |  |  |\n | `DOWN` |  |  |\n | Certificate-expiry |  |  |\n | Domain-expiry |  |  |\n | Testing |  |  |\n ```\n\n Because maintainer time is precious, junior maintainers may merge\n uncontroversial PRs in this area.\n\n
\n \n\n- New Monitoring Types (click to expand)\n
\n\n To set up a new notification provider these files need to be modified/created:\n - `server/monitor-types/MONITORING_TYPE.js` is the core of each monitor.\n The `async check(...)`-function should:\n - in the happy-path: set `heartbeat.msg` to a successful message and set `heartbeat.status = UP`\n - in the unhappy-path: throw an `Error` for each fault that is detected with an actionable error message.\n - NEVER set `heartbeat.status = DOWN` unless you want to explicitly ignore retries.\n\n - `server/uptime-kuma-server.js` is where the monitoring backend needs to be\n registered. _If you have an idea how we can skip this step, we would love to\n hear about it ^^_\n\n - `src/pages/EditMonitor.vue` is the shared frontend users interact with.\n Please make sure that you have: - used `HiddenInput` for secret\n credentials - included all the necessary helptexts/placeholder/.. to make\n sure the notification provider is simple to setup for new users. - include\n all translations (`{{ $t(\"Translation key\") }}`,\n [``](https://vue-i18n.intlify.dev/guide/advanced/component.html))\n in `src/lang/en.json` to enable our translators to translate this\n\n Because maintainer time is precious, junior maintainers may merge\n uncontroversial PRs in this area.\n\n
\n \n\n- New Features / Major Changes / Breaking Bugfixes (click to expand)\n
\n\n be sure to **create an empty draft pull request or open an issue, so we can\n have a discussion first**.\n This is especially important for large pull requests or when you don't know if it will be merged or not.\n When adding new features, please also add tests to ensure your changes work as expected and to prevent future regressions.\n\n Because of the large impact of this work, only senior maintainers may\n merge PRs in this area. \n\n
\n \n\n- As a First-Time Contributor (click to expand)\n
\n\n Contributing is easy and fun. We will guide you through the process:\n 1. **Fork** the [Uptime-Kuma repository](https://github.com/louislam/uptime-kuma/) and **clone** it to your local machine.\n 2. **Create a new branch** for your changes (e.g., `signal-notification-provider`).\n 3. **Make your changes** and **commit** them with a clear message.\n 4. **Push** your changes to your forked repository.\n 5. **Open a pull request** to the `master` branch of the Uptime Kuma repository.\n - For large changes, please open a **draft pull request** first to discuss the changes with the maintainers.\n 6. **Provide a clear and concise description** of the changes you've made and link any related issues.\n 7. **Complete the PR checklist** and make sure all CI checks pass.\n 8. **Request a review** when your pull request is ready.\n\n ## When Can You Change the PR Status to \"Ready for Review\"?\n\n A PR should remain in **draft status** until all tasks are completed.\n Only change the status to **Ready for Review** when:\n - You have implemented all planned changes.\n - Your code is fully tested and ready for review.\n - You have updated or created the necessary tests.\n - You have verified that CI/CD checks pass successfully.\n\n A volunteer maintainer will review your PR as soon as possible.\n You can help us by reviewing other PRs or taking a look at open issues.\n\n## The following rules are essential for making your PR mergeable\n\n- Merging multiple issues by a huge PR is more difficult to review and causes\n conflicts with other PRs. Please\n - (if possible) **create one PR for one issue** or\n - (if not possible) **explain which issues a PR addresses and why this PR\n should not be broken apart**\n\n- Make sure your **PR passes our continuous integration**. PRs will not be\n merged unless all CI-Checks are green.\n- **Breaking changes** (unless for a good reason and discussed beforehand) will\n not get merged / not get merged quickly. Such changes require a major version\n release.\n- **Test your code** before submitting a PR. Buggy PRs will not be merged.\n- Make sure the **UI/UX is close to Uptime Kuma**.\n- **Think about the maintainability**: Don't add functionality that is\n completely **out of scope**. Keep in mind that we need to be able to maintain\n the functionality.\n- Don't modify or delete existing logic without a valid reason.\n- Don't convert existing code into other programming languages for no reason.\n\n### Continuous Integration\n\nAll pull requests must pass our continuous integration checks. These checks include:\n\n- **Linting**: We use ESLint and Stylelint for code quality checks. You can run the linter locally with `npm run lint`.\n- **Formatting**: We use Prettier for code formatting. You can format your code with `npm run fmt` (or CI will do this for you)\n- **Testing**: We use Playwright for end-to-end tests and have a suite of backend tests. You can run the tests locally with `npm test`.\n\nI ([@louislam](https://github.com/louislam)) have the final say.\nIf your pull request does not meet my expectations, I will reject it, no matter how much time\nyou spent on it.\n\nWe will assign your pull request to a [milestone](https://github.com/louislam/uptime-kuma/milestones), if we plan to review and merge it.\n\nPlease don't rush or ask for an ETA.\nWe 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.\n\n## I'd Like to Work on an Issue. How Do I Do That?\n\nWe have found that assigning people to issues is unnecessary management\noverhead. Instead, a short comment stating that you want to work on an issue is\nappreciated, as it saves time for other developers. If you encounter any\nproblems during development, feel free to leave a comment describing what you\nare stuck on. We are here to help.\n\n## Project Style\n\nI personally do not like something that requires a lot of configuration before\nyou can finally start the app. The goal is to make the Uptime Kuma installation\nas easy as installing a mobile app.\n\n- Easy to install for non-Docker users\n - no native build dependency is needed (for `x86_64`/`armv7`/`arm64`)\n - no extra configuration and\n - no extra effort required to get it running\n\n- Single container for Docker users\n - no complex docker-compose file\n - mapping the volume and exposing the port should be the only requirements\n\n- Settings should be configurable in the frontend. Environment variables are\n discouraged, unless it is related to startup such as `DATA_DIR`\n- Easy to use\n- The web UI styling should be consistent and nice\n\n## Coding Styles\n\n- 4 spaces indentation\n- Follow `.editorconfig`\n- Follow ESLint\n- Methods and functions should be documented with JSDoc\n\n## Name Conventions\n\n- Javascript/Typescript: camelCaseType\n- SQLite: snake_case (Underscore)\n- CSS/SCSS: kebab-case (Dash)\n\n## Tools\n\n- [`Node.js`](https://nodejs.org/) >= 20.4.0\n- [`npm`](https://www.npmjs.com/) >= 9.3\n- [`git`](https://git-scm.com/)\n- IDE that supports [`ESLint`](https://eslint.org/) and EditorConfig (I am using\n [`IntelliJ IDEA`](https://www.jetbrains.com/idea/))\n- A SQLite GUI tool (f.ex.\n [`SQLite Expert Personal`](https://www.sqliteexpert.com/download.html) or\n [`DBeaver Community`](https://dbeaver.io/download/))\n\n## Git Branches\n\n- `master`: 2.X.X development. If you want to add a new feature, your pull\n request should base on this.\n- `1.23.X`: 1.23.X development. If you want to fix a bug for v1 and v2, your\n pull request should base on this.\n- All other branches are unused, outdated or for dev.\n\n## Install Dependencies for Development\n\n```bash\nnpm ci\n```\n\n## Dev Server\n\nWe can start the frontend dev server and the backend dev server in one command.\n\nPort `3000` and port `3001` will be used.\n\n```bash\nnpm run dev\n```\n\nBut sometimes you may want to restart the server without restarting the\nfrontend. In that case, you can run these commands in two terminals:\n\n```bash\nnpm run start-frontend-dev\nnpm run start-server-dev\n```\n\n## Backend Server\n\nIt binds to `0.0.0.0:3001` by default.\n\nThe backend is an `express.js` server with `socket.io` integrated. It uses\n`socket.io` to communicate with clients, and most server logic is encapsulated\nin the `socket.io` handlers. `express.js` is also used to serve:\n\n- as an entry point for redirecting to a status page or the dashboard\n- the frontend built files (`index.html`, `*.js`, `*.css`, etc.)\n- internal APIs of the status page\n\n### Structure in `/server/`\n\n- `jobs/` (Jobs that are running in another process)\n- `model/` (Object model, auto-mapping to the database table name)\n- `modules/` (Modified 3rd-party modules)\n- `monitor_types/` (Monitor Types)\n- `notification-providers/` (individual notification logic)\n- `routers/` (Express Routers)\n- `socket-handler/` (Socket.io Handlers)\n- `server.js` (Server entry point)\n- `uptime-kuma-server.js` (UptimeKumaServer class, main logic should be here,\n but some still in `server.js`)\n\n## Frontend Dev Server\n\nIt binds to `0.0.0.0:3000` by default. The frontend dev server is used for\ndevelopment only.\n\nFor production, it is not used. It will be compiled to `dist` directory instead via `npm run build`.\n\nYou can use Vue.js devtools Chrome extension for debugging.\n\n### Frontend Details\n\nUptime Kuma Frontend is a single page application (SPA). Most paths are handled\nby Vue Router.\n\nThe router is in `src/router.js`\n\nMost data in the frontend is stored at the root level, even though the router can navigate to different pages.\n\nThe data and socket logic are in `src/mixins/socket.js`.\n\n## Database Migration\n\nSee: \n\n## Unit Test\n\nTo run unit tests, use the following command:\n\n```bash\nnpm run build\nnpm test\n```\n\n## Dependencies\n\nBoth frontend and backend share the same `package.json`.\nHowever, the frontend dependencies are eventually not used in the production environment, because it\nis usually also baked into `dist` files. So:\n\n- Frontend dependencies = \"devDependencies\"\n - Examples: - `vue`, `chart.js`\n- Backend dependencies = \"dependencies\"\n - Examples: `socket.io`, `sqlite3`\n- Development dependencies = \"devDependencies\"\n - Examples: `eslint`, `sass`\n\n### Update Dependencies\n\nSince previously updating Vite 2.5.10 to 2.6.0 broke the application completely,\nfrom now on, it should update the patch release version only.\n\nPatch release = the third digit ([Semantic Versioning](https://semver.org/))\n\nIf for security / bug / other reasons, a library must be updated, breaking\nchanges need to be checked by the person proposing the change.\n\n## Spelling & Grammar\n\nFeel free to correct the spelling and grammar in the documentation or code.\nEnglish is not the native language of the maintainers.\n\n## Wiki\n\nSince there is no way to make a pull request to the wiki, I have set up another\nrepo to do that.\n\n\n\n## Maintainer\n\n### What is a maintainer and what are their roles?\n\nThis project has multiple maintainers who specialise in different areas.\nCurrently, there are 3 maintainers:\n\n| Person | Role | Main Area |\n| ----------------- | ----------------- | ---------------- |\n| `@louislam` | senior maintainer | major features |\n| `@chakflying` | junior maintainer | fixing bugs |\n| `@commanderstorm` | junior maintainer | issue-management |\n\n### Procedures\n\nWe have a few procedures we follow. These are documented here:\n\n- Set up a Docker Builder (click to expand)\n
\n - amd64, armv7 using local.\n - arm64 using remote arm64 cpu, as the emulator is too slow and can no longer\n pass the `npm ci` command.\n 1. Add the public key to the remote server.\n 2. Add the remote context. The remote machine must be arm64 and installed\n Docker CE.\n\n ```bash\n docker context create oracle-arm64-jp --docker \"host=ssh://root@100.107.174.88\"\n ```\n\n 3. Create a new builder.\n\n ```bash\n docker buildx create --name kuma-builder --platform linux/amd64,linux/arm/v7\n docker buildx use kuma-builder\n docker buildx inspect --bootstrap\n ```\n\n 4. Append the remote context to the builder.\n\n ```bash\n docker buildx create --append --name kuma-builder --platform linux/arm64 oracle-arm64-jp\n ```\n\n 5. Verify the builder and check if the builder is using `kuma-builder`.\n `docker buildx inspect kuma-builder docker buildx ls`\n\n
\n \n\n- Release (click to expand)\n
\n 1. Draft a release note\n 2. Make sure the repo is cleared\n 3. If the healthcheck is updated, remember to re-compile it:\n `npm run build-docker-builder-go`\n 4. `npm run release-final` with env vars: `VERSION` and `GITHUB_TOKEN`\n 5. Wait until the `Press any key to continue`\n 6. `git push`\n 7. Publish the release note as `1.X.X`\n 8. Press any key to continue\n 9. Deploy to the demo server: `npm run deploy-demo-server`\n\n These Items need to be checked:\n - [ ] Check all tags is fine on\n \n - [ ] Try the Docker image with tag 1.X.X (Clean install / amd64 / arm64 /\n armv7)\n - [ ] Try clean installation with Node.js\n\n
\n \n\n- Release Beta (click to expand)\n
\n 1. Draft a release note, check `This is a pre-release`\n 2. Make sure the repo is cleared\n 3. `npm run release-beta` with env vars: `VERSION` and `GITHUB_TOKEN`\n 4. Wait until the `Press any key to continue`\n 5. Publish the release note as `1.X.X-beta.X`\n 6. Press any key to continue\n\n
\n \n\n- Release Wiki (click to expand)\n
\n\n **Setup Repo**\n\n ```bash\n git clone https://github.com/louislam/uptime-kuma-wiki.git\n cd uptime-kuma-wiki\n git remote add production https://github.com/louislam/uptime-kuma.wiki.git\n ```\n\n **Push to Production Wiki**\n\n ```bash\n git pull\n git push production master\n ```\n\n
\n \n\n- Change the base of a pull request such as master to 1.23.X (click to expand)\n
\n\n ```bash\n git rebase --onto \n ```\n\n
\n \n"
},
{
"path": "LICENSE",
"content": "MIT License\n\nCopyright (c) 2021 Louis Lam\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "README.md",
"content": "
\n \n
\n\n# Uptime Kuma\n\nUptime Kuma is an easy-to-use self-hosted monitoring tool.\n\n\n[](https://github.com/sponsors/louislam) \n\n\n\n\n\n## 🥔 Live Demo\n\nTry it!\n\nDemo Server (Location: Frankfurt - Germany): \n\nIt 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).\n\n## ⭐ Features\n\n- Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / HTTP(s) Json Query / Websocket / Ping / DNS Record / Push / Steam Game Server / Docker Containers\n- Fancy, Reactive, Fast UI/UX\n- 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)\n- 20-second intervals\n- [Multi Languages](https://github.com/louislam/uptime-kuma/tree/master/src/lang)\n- Multiple status pages\n- Map status pages to specific domains\n- Ping chart\n- Certificate info\n- Proxy support\n- 2FA support\n\n## 🔧 How to Install\n\n### 🐳 Docker Compose\n\n```bash\nmkdir uptime-kuma\ncd uptime-kuma\ncurl -o compose.yaml https://raw.githubusercontent.com/louislam/uptime-kuma/master/compose.yaml\ndocker compose up -d\n```\n\nUptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).\n\n> [!WARNING]\n> File Systems like **NFS** (Network File System) are **NOT** supported. Please map to a local directory or volume.\n\n### 🐳 Docker Command\n\n```bash\ndocker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:2\n```\n\nUptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).\n\nIf you want to limit exposure to localhost only:\n\n```bash\ndocker run ... -p 127.0.0.1:3001:3001 ...\n```\n\n### 💪🏻 Non-Docker\n\nRequirements:\n\n- Platform\n - ✅ Major Linux distros such as Debian, Ubuntu, Fedora and ArchLinux etc.\n - ✅ Windows 10 (x64), Windows Server 2012 R2 (x64) or higher\n - ❌ FreeBSD / OpenBSD / NetBSD\n - ❌ Replit / Heroku\n- [Node.js](https://nodejs.org/en/download/) >= 20.4\n- [Git](https://git-scm.com/downloads)\n- [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background\n\n```bash\ngit clone https://github.com/louislam/uptime-kuma.git\ncd uptime-kuma\nnpm run setup\n\n# Option 1. Try it\nnode server/server.js\n\n# (Recommended) Option 2. Run in the background using PM2\n# Install PM2 if you don't have it:\nnpm install pm2 -g && pm2 install pm2-logrotate\n\n# Start Server\npm2 start server/server.js --name uptime-kuma\n```\n\nUptime Kuma is now running on all network interfaces (e.g. http://localhost:3001 or http://your-ip:3001).\n\nMore useful PM2 Commands\n\n```bash\n# If you want to see the current console output\npm2 monit\n\n# If you want to add it to startup\npm2 startup && pm2 save\n```\n\n### Advanced Installation\n\nIf you need more options or need to browse via a reverse proxy, please read:\n\n\n\n## 🆙 How to Update\n\nPlease read:\n\n\n\n## 🆕 What's Next?\n\nI will assign requests/issues to the next milestone.\n\n\n\n## ❤️ Sponsors\n\nThank 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)\n\n\n\n## 🖼 More Screenshots\n\nLight Mode:\n\n\n\nStatus Page:\n\n\n\nSettings Page:\n\n\n\nTelegram Notification Sample:\n\n\n\n## Motivation\n\n- I was looking for a self-hosted monitoring tool like \"Uptime Robot\", but it is hard to find a suitable one. One of the closest ones is statping. Unfortunately, it is not stable and no longer maintained.\n- Wanted to build a fancy UI.\n- Learn Vue 3 and vite.js.\n- Show the power of Bootstrap 5.\n- Try to use WebSocket with SPA instead of a REST API.\n- Deploy my first Docker image to Docker Hub.\n\nIf you love this project, please consider giving it a ⭐.\n\n## 🗣️ Discussion / Ask for Help\n\n⚠️ For any general or technical questions, please don't send me an email, as I am unable to provide support in that manner. I will not respond if you ask questions there.\n\nI recommend using Google, GitHub Issues, or Uptime Kuma's subreddit for finding answers to your question. If you cannot find the information you need, feel free to ask:\n\n- [GitHub Issues](https://github.com/louislam/uptime-kuma/issues)\n- [Subreddit (r/UptimeKuma)](https://www.reddit.com/r/UptimeKuma/)\n\nMy Reddit account: [u/louislamlam](https://reddit.com/u/louislamlam)\nYou can mention me if you ask a question on the subreddit.\n\n## Contributions\n\n### Create Pull Requests\n\nPull requests are awesome.\nTo keep reviews fast and effective, please make sure you’ve [read our pull request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma).\n\n### Test Pull Requests\n\nThere are a lot of pull requests right now, but I don't have time to test them all.\n\nIf you want to help, you can check this:\n\n\n### Test Beta Version\n\nCheck out the latest beta release here: \n\n### Bug Reports / Feature Requests\n\nIf 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).\n\n### Translations\n\nIf you want to translate Uptime Kuma into your language, please visit [Weblate Readme](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).\n\n### Spelling & Grammar\n\nFeel free to correct the grammar in the documentation or code.\nMy mother language is not English and my grammar is not that great.\n"
},
{
"path": "SECURITY.md",
"content": "# Security Policy\n\n> [!CAUTION]\n> Unfortunately, AI slop reports keep wasting my time. It will be closed and you will get banned immediately if you try to do that.\n\n## Reporting a Vulnerability\n\n1. Please report security issues to\n .\n2. Please also create an empty security issue to alert me, as GitHub Advisories\n do not send a notification, I probably will miss it without this.\n \n\n- Do not report any upstream dependency issues / scan result by any tools. It will be closed immediately without explanations. Unless you have PoC to prove that the upstream issue affected Uptime Kuma.\n- Do not use the public issue tracker or discuss it in public as it will cause\n more damage.\n- Do not report any SSRF issues.\n\n## Do you accept other 3rd-party bug bounty platforms?\n\nAt this moment, I DO NOT accept other bug bounty platforms, because I am not\nfamiliar with these platforms and someone has tried to send a phishing link to\nme by doing this already. To minimize my own risk, please report through GitHub\nAdvisories only. I will ignore all 3rd-party bug bounty platforms emails.\n\n## Supported Versions\n\n### Uptime Kuma Versions\n\nYou should use or upgrade to the latest version of Uptime Kuma.\nAll versions are upgradable to the latest version.\n\n### Upgradable Docker Tags\n\n| Tag | Supported |\n| --------------- | ------------------------------------------------------------------------------------- |\n| 2 | :white_check_mark: |\n| 2-slim | :white_check_mark: |\n| next | :white_check_mark: |\n| next-slim | :white_check_mark: |\n| 2-rootless | :white_check_mark: |\n| 2-slim-rootless | :white_check_mark: |\n| 1 | [⚠️ Deprecated](https://github.com/louislam/uptime-kuma/wiki/Migration-From-v1-To-v2) |\n| 1-debian | [⚠️ Deprecated](https://github.com/louislam/uptime-kuma/wiki/Migration-From-v1-To-v2) |\n| latest | [⚠️ Deprecated](https://github.com/louislam/uptime-kuma/wiki/Migration-From-v1-To-v2) |\n| debian | [⚠️ Deprecated](https://github.com/louislam/uptime-kuma/wiki/Migration-From-v1-To-v2) |\n| All other tags | ❌ |\n"
},
{
"path": "compose.yaml",
"content": "services:\n uptime-kuma:\n image: louislam/uptime-kuma:2\n restart: unless-stopped\n volumes:\n - ./data:/app/data\n ports:\n # :\n - \"3001:3001\"\n"
},
{
"path": "config/playwright.config.js",
"content": "import { defineConfig, devices } from \"@playwright/test\";\n\nconst port = 30001;\nexport const url = `http://localhost:${port}`;\n\nexport default defineConfig({\n // Look for test files in the \"tests\" directory, relative to this configuration file.\n testDir: \"../test/e2e/specs\",\n outputDir: \"../private/playwright-test-results\",\n fullyParallel: false,\n locale: \"en-US\",\n\n // Fail the build on CI if you accidentally left test.only in the source code.\n forbidOnly: !!process.env.CI,\n\n // Retry on CI only.\n retries: process.env.CI ? 2 : 0,\n\n // Opt out of parallel tests on CI.\n workers: 1,\n\n // Reporter to use\n reporter: [\n [\n \"html\",\n {\n outputFolder: \"../private/playwright-report\",\n open: \"never\",\n },\n ],\n ],\n\n use: {\n // Base URL to use in actions like `await page.goto('/')`.\n baseURL: url,\n\n // Collect trace when retrying the failed test.\n trace: \"on-first-retry\",\n },\n\n // Configure projects for major browsers.\n projects: [\n {\n name: \"run-once setup\",\n testMatch: /setup-process\\.once\\.js/,\n use: { ...devices[\"Desktop Chrome\"] },\n },\n {\n name: \"specs\",\n use: { ...devices[\"Desktop Chrome\"] },\n dependencies: [\"run-once setup\"],\n },\n /*\n {\n name: \"firefox\",\n use: { browserName: \"firefox\" }\n },*/\n ],\n\n // Run your local dev server before starting the tests.\n webServer: {\n command: `node extra/remove-playwright-test-data.js && cross-env NODE_ENV=development node server/server.js --port=${port} --data-dir=./data/playwright-test`,\n url,\n reuseExistingServer: false,\n cwd: \"../\",\n },\n});\n"
},
{
"path": "config/vite.config.js",
"content": "import vue from \"@vitejs/plugin-vue\";\nimport { defineConfig } from \"vite\";\nimport visualizer from \"rollup-plugin-visualizer\";\nimport viteCompression from \"vite-plugin-compression\";\n\nconst postCssScss = require(\"postcss-scss\");\nconst postcssRTLCSS = require(\"postcss-rtlcss\");\n\nconst viteCompressionFilter = /\\.(js|mjs|json|css|html|svg)$/i;\n\n// https://vitejs.dev/config/\nexport default defineConfig({\n server: {\n port: 3000,\n },\n define: {\n FRONTEND_VERSION: JSON.stringify(process.env.npm_package_version),\n \"process.env\": {},\n },\n plugins: [\n vue(),\n visualizer({\n filename: \"tmp/dist-stats.html\",\n }),\n viteCompression({\n algorithm: \"gzip\",\n filter: viteCompressionFilter,\n }),\n viteCompression({\n algorithm: \"brotliCompress\",\n filter: viteCompressionFilter,\n }),\n ],\n css: {\n postcss: {\n parser: postCssScss,\n map: false,\n plugins: [postcssRTLCSS],\n },\n },\n build: {\n commonjsOptions: {\n include: [/.js$/],\n },\n rollupOptions: {\n output: {\n manualChunks(id, { getModuleInfo, getModuleIds }) {},\n },\n },\n },\n});\n"
},
{
"path": "db/knex_init_db.js",
"content": "const { R } = require(\"redbean-node\");\nconst { log } = require(\"../src/util\");\n\n/**\n * ⚠️⚠️⚠️⚠️⚠️⚠️ DO NOT ADD ANYTHING HERE!\n * IF YOU NEED TO ADD FIELDS, ADD IT TO ./db/knex_migrations\n * See ./db/knex_migrations/README.md for more information\n * @returns {Promise}\n */\nasync function createTables() {\n log.info(\"mariadb\", \"Creating basic tables for MariaDB\");\n const knex = R.knex;\n\n // TODO: Should check later if it is really the final patch sql file.\n\n // docker_host\n await knex.schema.createTable(\"docker_host\", (table) => {\n table.increments(\"id\");\n table.integer(\"user_id\").unsigned().notNullable();\n table.string(\"docker_daemon\", 255);\n table.string(\"docker_type\", 255);\n table.string(\"name\", 255);\n });\n\n // group\n await knex.schema.createTable(\"group\", (table) => {\n table.increments(\"id\");\n table.string(\"name\", 255).notNullable();\n table.datetime(\"created_date\").notNullable().defaultTo(knex.fn.now());\n table.boolean(\"public\").notNullable().defaultTo(false);\n table.boolean(\"active\").notNullable().defaultTo(true);\n table.integer(\"weight\").notNullable().defaultTo(1000);\n table.integer(\"status_page_id\").unsigned();\n });\n\n // proxy\n await knex.schema.createTable(\"proxy\", (table) => {\n table.increments(\"id\");\n table.integer(\"user_id\").unsigned().notNullable();\n table.string(\"protocol\", 10).notNullable();\n table.string(\"host\", 255).notNullable();\n table.smallint(\"port\").notNullable(); // TODO: Maybe a issue with MariaDB, need migration to int\n table.boolean(\"auth\").notNullable();\n table.string(\"username\", 255).nullable();\n table.string(\"password\", 255).nullable();\n table.boolean(\"active\").notNullable().defaultTo(true);\n table.boolean(\"default\").notNullable().defaultTo(false);\n table.datetime(\"created_date\").notNullable().defaultTo(knex.fn.now());\n\n table.index(\"user_id\", \"proxy_user_id\");\n });\n\n // user\n await knex.schema.createTable(\"user\", (table) => {\n table.increments(\"id\");\n table.string(\"username\", 255).notNullable().unique().collate(\"utf8_general_ci\");\n table.string(\"password\", 255);\n table.boolean(\"active\").notNullable().defaultTo(true);\n table.string(\"timezone\", 150);\n table.string(\"twofa_secret\", 64);\n table.boolean(\"twofa_status\").notNullable().defaultTo(false);\n table.string(\"twofa_last_token\", 6);\n });\n\n // monitor\n await knex.schema.createTable(\"monitor\", (table) => {\n table.increments(\"id\");\n table.string(\"name\", 150);\n table.boolean(\"active\").notNullable().defaultTo(true);\n table.integer(\"user_id\").unsigned().references(\"id\").inTable(\"user\").onDelete(\"SET NULL\").onUpdate(\"CASCADE\");\n table.integer(\"interval\").notNullable().defaultTo(20);\n table.text(\"url\");\n table.string(\"type\", 20);\n table.integer(\"weight\").defaultTo(2000);\n table.string(\"hostname\", 255);\n table.integer(\"port\");\n table.datetime(\"created_date\").notNullable().defaultTo(knex.fn.now());\n table.string(\"keyword\", 255);\n table.integer(\"maxretries\").notNullable().defaultTo(0);\n table.boolean(\"ignore_tls\").notNullable().defaultTo(false);\n table.boolean(\"upside_down\").notNullable().defaultTo(false);\n table.integer(\"maxredirects\").notNullable().defaultTo(10);\n table.text(\"accepted_statuscodes_json\").notNullable().defaultTo('[\"200-299\"]');\n table.string(\"dns_resolve_type\", 5);\n table.string(\"dns_resolve_server\", 255);\n table.string(\"dns_last_result\", 255);\n table.integer(\"retry_interval\").notNullable().defaultTo(0);\n table.string(\"push_token\", 20).defaultTo(null);\n table.text(\"method\").notNullable().defaultTo(\"GET\");\n table.text(\"body\").defaultTo(null);\n table.text(\"headers\").defaultTo(null);\n table.text(\"basic_auth_user\").defaultTo(null);\n table.text(\"basic_auth_pass\").defaultTo(null);\n table.integer(\"docker_host\").unsigned().references(\"id\").inTable(\"docker_host\");\n table.string(\"docker_container\", 255);\n table.integer(\"proxy_id\").unsigned().references(\"id\").inTable(\"proxy\");\n table.boolean(\"expiry_notification\").defaultTo(true);\n table.text(\"mqtt_topic\");\n table.string(\"mqtt_success_message\", 255);\n table.string(\"mqtt_username\", 255);\n table.string(\"mqtt_password\", 255);\n table.string(\"database_connection_string\", 2000);\n table.text(\"database_query\");\n table.string(\"auth_method\", 250);\n table.text(\"auth_domain\");\n table.text(\"auth_workstation\");\n table.string(\"grpc_url\", 255).defaultTo(null);\n table.text(\"grpc_protobuf\").defaultTo(null);\n table.text(\"grpc_body\").defaultTo(null);\n table.text(\"grpc_metadata\").defaultTo(null);\n table.text(\"grpc_method\").defaultTo(null);\n table.text(\"grpc_service_name\").defaultTo(null);\n table.boolean(\"grpc_enable_tls\").notNullable().defaultTo(false);\n table.string(\"radius_username\", 255);\n table.string(\"radius_password\", 255);\n table.string(\"radius_calling_station_id\", 50);\n table.string(\"radius_called_station_id\", 50);\n table.string(\"radius_secret\", 255);\n table.integer(\"resend_interval\").notNullable().defaultTo(0);\n table.integer(\"packet_size\").notNullable().defaultTo(56);\n table.string(\"game\", 255);\n });\n\n // heartbeat\n await knex.schema.createTable(\"heartbeat\", (table) => {\n table.increments(\"id\");\n table.boolean(\"important\").notNullable().defaultTo(false);\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.smallint(\"status\").notNullable();\n\n table.text(\"msg\");\n table.datetime(\"time\").notNullable();\n table.integer(\"ping\");\n table.integer(\"duration\").notNullable().defaultTo(0);\n table.integer(\"down_count\").notNullable().defaultTo(0);\n\n table.index(\"important\");\n table.index([\"monitor_id\", \"time\"], \"monitor_time_index\");\n table.index(\"monitor_id\");\n table.index([\"monitor_id\", \"important\", \"time\"], \"monitor_important_time_index\");\n });\n\n // incident\n await knex.schema.createTable(\"incident\", (table) => {\n table.increments(\"id\");\n table.string(\"title\", 255).notNullable();\n table.text(\"content\", 255).notNullable();\n table.string(\"style\", 30).notNullable().defaultTo(\"warning\");\n table.datetime(\"created_date\").notNullable().defaultTo(knex.fn.now());\n table.datetime(\"last_updated_date\");\n table.boolean(\"pin\").notNullable().defaultTo(true);\n table.boolean(\"active\").notNullable().defaultTo(true);\n table.integer(\"status_page_id\").unsigned();\n });\n\n // maintenance\n await knex.schema.createTable(\"maintenance\", (table) => {\n table.increments(\"id\");\n table.string(\"title\", 150).notNullable();\n table.text(\"description\").notNullable();\n table.integer(\"user_id\").unsigned().references(\"id\").inTable(\"user\").onDelete(\"SET NULL\").onUpdate(\"CASCADE\");\n table.boolean(\"active\").notNullable().defaultTo(true);\n table.string(\"strategy\", 50).notNullable().defaultTo(\"single\");\n table.datetime(\"start_date\");\n table.datetime(\"end_date\");\n table.time(\"start_time\");\n table.time(\"end_time\");\n table.string(\"weekdays\", 250).defaultTo(\"[]\");\n table.text(\"days_of_month\").defaultTo(\"[]\");\n table.integer(\"interval_day\");\n\n table.index(\"active\");\n table.index([\"strategy\", \"active\"], \"manual_active\");\n table.index(\"user_id\", \"maintenance_user_id\");\n });\n\n // status_page\n await knex.schema.createTable(\"status_page\", (table) => {\n table.increments(\"id\");\n table.string(\"slug\", 255).notNullable().unique().collate(\"utf8_general_ci\");\n table.string(\"title\", 255).notNullable();\n table.text(\"description\");\n table.string(\"icon\", 255).notNullable();\n table.string(\"theme\", 30).notNullable();\n table.boolean(\"published\").notNullable().defaultTo(true);\n table.boolean(\"search_engine_index\").notNullable().defaultTo(true);\n table.boolean(\"show_tags\").notNullable().defaultTo(false);\n table.string(\"password\");\n table.datetime(\"created_date\").notNullable().defaultTo(knex.fn.now());\n table.datetime(\"modified_date\").notNullable().defaultTo(knex.fn.now());\n table.text(\"footer_text\");\n table.text(\"custom_css\");\n table.boolean(\"show_powered_by\").notNullable().defaultTo(true);\n table.string(\"google_analytics_tag_id\");\n });\n\n // maintenance_status_page\n await knex.schema.createTable(\"maintenance_status_page\", (table) => {\n table.increments(\"id\");\n\n table\n .integer(\"status_page_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"status_page\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n\n table\n .integer(\"maintenance_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"maintenance\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n });\n\n // maintenance_timeslot\n await knex.schema.createTable(\"maintenance_timeslot\", (table) => {\n table.increments(\"id\");\n table\n .integer(\"maintenance_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"maintenance\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.datetime(\"start_date\").notNullable();\n table.datetime(\"end_date\");\n table.boolean(\"generated_next\").defaultTo(false);\n\n table.index(\"maintenance_id\");\n table.index([\"maintenance_id\", \"start_date\", \"end_date\"], \"active_timeslot_index\");\n table.index(\"generated_next\", \"generated_next_index\");\n });\n\n // monitor_group\n await knex.schema.createTable(\"monitor_group\", (table) => {\n table.increments(\"id\");\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table\n .integer(\"group_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"group\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.integer(\"weight\").notNullable().defaultTo(1000);\n table.boolean(\"send_url\").notNullable().defaultTo(false);\n\n table.index([\"monitor_id\", \"group_id\"], \"fk\");\n });\n // monitor_maintenance\n await knex.schema.createTable(\"monitor_maintenance\", (table) => {\n table.increments(\"id\");\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table\n .integer(\"maintenance_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"maintenance\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n\n table.index(\"maintenance_id\", \"maintenance_id_index2\");\n table.index(\"monitor_id\", \"monitor_id_index\");\n });\n\n // notification\n await knex.schema.createTable(\"notification\", (table) => {\n table.increments(\"id\");\n table.string(\"name\", 255);\n table.boolean(\"active\").notNullable().defaultTo(true);\n table.integer(\"user_id\").unsigned();\n table.boolean(\"is_default\").notNullable().defaultTo(false);\n table.text(\"config\", \"longtext\");\n });\n\n // monitor_notification\n await knex.schema.createTable(\"monitor_notification\", (table) => {\n table.increments(\"id\").unsigned(); // TODO: no auto increment????\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table\n .integer(\"notification_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"notification\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n\n table.index([\"monitor_id\", \"notification_id\"], \"monitor_notification_index\");\n });\n\n // tag\n await knex.schema.createTable(\"tag\", (table) => {\n table.increments(\"id\");\n table.string(\"name\", 255).notNullable();\n table.string(\"color\", 255).notNullable();\n table.datetime(\"created_date\").notNullable().defaultTo(knex.fn.now());\n });\n\n // monitor_tag\n await knex.schema.createTable(\"monitor_tag\", (table) => {\n table.increments(\"id\");\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table\n .integer(\"tag_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"tag\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.text(\"value\");\n });\n\n // monitor_tls_info\n await knex.schema.createTable(\"monitor_tls_info\", (table) => {\n table.increments(\"id\");\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.text(\"info_json\");\n });\n\n // notification_sent_history\n await knex.schema.createTable(\"notification_sent_history\", (table) => {\n table.increments(\"id\");\n table.string(\"type\", 50).notNullable();\n table.integer(\"monitor_id\").unsigned().notNullable();\n table.integer(\"days\").notNullable();\n table.unique([\"type\", \"monitor_id\", \"days\"]);\n table.index([\"type\", \"monitor_id\", \"days\"], \"good_index\");\n });\n\n // setting\n await knex.schema.createTable(\"setting\", (table) => {\n table.increments(\"id\");\n table.string(\"key\", 200).notNullable().unique().collate(\"utf8_general_ci\");\n table.text(\"value\");\n table.string(\"type\", 20);\n });\n\n // status_page_cname\n await knex.schema.createTable(\"status_page_cname\", (table) => {\n table.increments(\"id\");\n table\n .integer(\"status_page_id\")\n .unsigned()\n .references(\"id\")\n .inTable(\"status_page\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.string(\"domain\").notNullable().unique().collate(\"utf8_general_ci\");\n });\n\n /*********************\n * Converted Patch here\n *********************/\n\n // 2023-06-30-1348-http-body-encoding.js\n // ALTER TABLE monitor ADD http_body_encoding VARCHAR(25);\n // UPDATE monitor SET http_body_encoding = 'json' WHERE (type = 'http' or type = 'keyword') AND http_body_encoding IS NULL;\n await knex.schema.table(\"monitor\", function (table) {\n table.string(\"http_body_encoding\", 25);\n });\n\n await knex(\"monitor\")\n .where(function () {\n this.where(\"type\", \"http\").orWhere(\"type\", \"keyword\");\n })\n .whereNull(\"http_body_encoding\")\n .update({\n http_body_encoding: \"json\",\n });\n\n // 2023-06-30-1354-add-description-monitor.js\n // ALTER TABLE monitor ADD description TEXT default null;\n await knex.schema.table(\"monitor\", function (table) {\n table.text(\"description\").defaultTo(null);\n });\n\n // 2023-06-30-1357-api-key-table.js\n /*\n CREATE TABLE [api_key] (\n [id] INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n [key] VARCHAR(255) NOT NULL,\n [name] VARCHAR(255) NOT NULL,\n [user_id] INTEGER NOT NULL,\n [created_date] DATETIME DEFAULT (DATETIME('now')) NOT NULL,\n [active] BOOLEAN DEFAULT 1 NOT NULL,\n [expires] DATETIME DEFAULT NULL,\n CONSTRAINT FK_user FOREIGN KEY ([user_id]) REFERENCES [user]([id]) ON DELETE CASCADE ON UPDATE CASCADE\n );\n */\n await knex.schema.createTable(\"api_key\", function (table) {\n table.increments(\"id\").primary();\n table.string(\"key\", 255).notNullable();\n table.string(\"name\", 255).notNullable();\n table\n .integer(\"user_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"user\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.dateTime(\"created_date\").defaultTo(knex.fn.now()).notNullable();\n table.boolean(\"active\").defaultTo(1).notNullable();\n table.dateTime(\"expires\").defaultTo(null);\n });\n\n // 2023-06-30-1400-monitor-tls.js\n /*\n ALTER TABLE monitor\n ADD tls_ca TEXT default null;\n\n ALTER TABLE monitor\n ADD tls_cert TEXT default null;\n\n ALTER TABLE monitor\n ADD tls_key TEXT default null;\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.text(\"tls_ca\").defaultTo(null);\n table.text(\"tls_cert\").defaultTo(null);\n table.text(\"tls_key\").defaultTo(null);\n });\n\n // 2023-06-30-1401-maintenance-cron.js\n /*\n -- 999 characters. https://stackoverflow.com/questions/46134830/maximum-length-for-cron-job\n DROP TABLE maintenance_timeslot;\n ALTER TABLE maintenance ADD cron TEXT;\n ALTER TABLE maintenance ADD timezone VARCHAR(255);\n ALTER TABLE maintenance ADD duration INTEGER;\n */\n await knex.schema.dropTableIfExists(\"maintenance_timeslot\").table(\"maintenance\", function (table) {\n table.text(\"cron\");\n table.string(\"timezone\", 255);\n table.integer(\"duration\");\n });\n\n // 2023-06-30-1413-add-parent-monitor.js.\n /*\n ALTER TABLE monitor\n ADD parent INTEGER REFERENCES [monitor] ([id]) ON DELETE SET NULL ON UPDATE CASCADE;\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.integer(\"parent\").unsigned().references(\"id\").inTable(\"monitor\").onDelete(\"SET NULL\").onUpdate(\"CASCADE\");\n });\n\n /*\n patch-add-invert-keyword.sql\n ALTER TABLE monitor\n ADD invert_keyword BOOLEAN default 0 not null;\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.boolean(\"invert_keyword\").defaultTo(0).notNullable();\n });\n\n /*\n patch-added-json-query.sql\n ALTER TABLE monitor\n\t ADD json_path TEXT;\n\n ALTER TABLE monitor\n\t ADD expected_value VARCHAR(255);\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.text(\"json_path\");\n table.string(\"expected_value\", 255);\n });\n\n /*\n patch-added-kafka-producer.sql\n\n ALTER TABLE monitor\n\tADD kafka_producer_topic VARCHAR(255);\n\nALTER TABLE monitor\n\tADD kafka_producer_brokers TEXT;\n\nALTER TABLE monitor\n\tADD kafka_producer_ssl INTEGER;\n\nALTER TABLE monitor\n\tADD kafka_producer_allow_auto_topic_creation VARCHAR(255);\n\nALTER TABLE monitor\n\tADD kafka_producer_sasl_options TEXT;\n\nALTER TABLE monitor\n\tADD kafka_producer_message TEXT;\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.string(\"kafka_producer_topic\", 255);\n table.text(\"kafka_producer_brokers\");\n\n // patch-fix-kafka-producer-booleans.sql\n table.boolean(\"kafka_producer_ssl\").defaultTo(0).notNullable();\n table.boolean(\"kafka_producer_allow_auto_topic_creation\").defaultTo(0).notNullable();\n\n table.text(\"kafka_producer_sasl_options\");\n table.text(\"kafka_producer_message\");\n });\n\n /*\n patch-add-certificate-expiry-status-page.sql\n ALTER TABLE status_page\n ADD show_certificate_expiry BOOLEAN default 0 NOT NULL;\n */\n await knex.schema.table(\"status_page\", function (table) {\n table.boolean(\"show_certificate_expiry\").defaultTo(0).notNullable();\n });\n\n /*\n patch-monitor-oauth-cc.sql\n ALTER TABLE monitor\n ADD oauth_client_id TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_client_secret TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_token_url TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_scopes TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_auth_method TEXT default null;\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.text(\"oauth_client_id\").defaultTo(null);\n table.text(\"oauth_client_secret\").defaultTo(null);\n table.text(\"oauth_token_url\").defaultTo(null);\n table.text(\"oauth_scopes\").defaultTo(null);\n table.text(\"oauth_auth_method\").defaultTo(null);\n });\n\n /*\n patch-add-timeout-monitor.sql\n ALTER TABLE monitor\n ADD timeout DOUBLE default 0 not null;\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.double(\"timeout\").defaultTo(0).notNullable();\n });\n\n /*\n patch-add-gamedig-given-port.sql\n ALTER TABLE monitor\n ADD gamedig_given_port_only BOOLEAN default 1 not null;\n */\n await knex.schema.table(\"monitor\", function (table) {\n table.boolean(\"gamedig_given_port_only\").defaultTo(1).notNullable();\n });\n\n log.info(\"mariadb\", \"Created basic tables for MariaDB\");\n}\n\nmodule.exports = {\n createTables,\n};\n"
},
{
"path": "db/knex_migrations/2023-08-16-0000-create-uptime.js",
"content": "exports.up = function (knex) {\n return knex.schema\n .createTable(\"stat_minutely\", function (table) {\n table.increments(\"id\");\n table.comment(\"This table contains the minutely aggregate statistics for each monitor\");\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.integer(\"timestamp\").notNullable().comment(\"Unix timestamp rounded down to the nearest minute\");\n table.float(\"ping\").notNullable().comment(\"Average ping in milliseconds\");\n table.smallint(\"up\").notNullable();\n table.smallint(\"down\").notNullable();\n\n table.unique([\"monitor_id\", \"timestamp\"]);\n })\n .createTable(\"stat_daily\", function (table) {\n table.increments(\"id\");\n table.comment(\"This table contains the daily aggregate statistics for each monitor\");\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.integer(\"timestamp\").notNullable().comment(\"Unix timestamp rounded down to the nearest day\");\n table.float(\"ping\").notNullable().comment(\"Average ping in milliseconds\");\n table.smallint(\"up\").notNullable();\n table.smallint(\"down\").notNullable();\n\n table.unique([\"monitor_id\", \"timestamp\"]);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.dropTable(\"stat_minutely\").dropTable(\"stat_daily\");\n};\n"
},
{
"path": "db/knex_migrations/2023-08-18-0301-heartbeat.js",
"content": "exports.up = function (knex) {\n // Add new column heartbeat.end_time\n return knex.schema.alterTable(\"heartbeat\", function (table) {\n table.datetime(\"end_time\").nullable().defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n // Rename heartbeat.start_time to heartbeat.time\n return knex.schema.alterTable(\"heartbeat\", function (table) {\n table.dropColumn(\"end_time\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2023-09-29-0000-heartbeat-retires.js",
"content": "exports.up = function (knex) {\n // Add new column heartbeat.retries\n return knex.schema.alterTable(\"heartbeat\", function (table) {\n table.integer(\"retries\").notNullable().defaultTo(0);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"heartbeat\", function (table) {\n table.dropColumn(\"retries\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2023-10-08-0000-mqtt-query.js",
"content": "exports.up = function (knex) {\n // Add new column monitor.mqtt_check_type\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"mqtt_check_type\", 255).notNullable().defaultTo(\"keyword\");\n });\n};\n\nexports.down = function (knex) {\n // Drop column monitor.mqtt_check_type\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"mqtt_check_type\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2023-10-11-1915-push-token-to-32.js",
"content": "exports.up = function (knex) {\n // update monitor.push_token to 32 length\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"push_token\", 32).alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"push_token\", 20).alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2023-10-16-0000-create-remote-browsers.js",
"content": "exports.up = function (knex) {\n return knex.schema\n .createTable(\"remote_browser\", function (table) {\n table.increments(\"id\");\n table.string(\"name\", 255).notNullable();\n table.string(\"url\", 255).notNullable();\n table.integer(\"user_id\").unsigned();\n })\n .alterTable(\"monitor\", function (table) {\n // Add new column monitor.remote_browser\n table\n .integer(\"remote_browser\")\n .nullable()\n .defaultTo(null)\n .unsigned()\n .index()\n .references(\"id\")\n .inTable(\"remote_browser\");\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.dropTable(\"remote_browser\").alterTable(\"monitor\", function (table) {\n table.dropColumn(\"remote_browser\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2023-12-20-0000-alter-status-page.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"status_page\", function (table) {\n table.integer(\"auto_refresh_interval\").defaultTo(300).unsigned();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"status_page\", function (table) {\n table.dropColumn(\"auto_refresh_interval\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2023-12-21-0000-stat-ping-min-max.js",
"content": "exports.up = function (knex) {\n return knex.schema\n .alterTable(\"stat_daily\", function (table) {\n table\n .float(\"ping_min\")\n .notNullable()\n .defaultTo(0)\n .comment(\"Minimum ping during this period in milliseconds\");\n table\n .float(\"ping_max\")\n .notNullable()\n .defaultTo(0)\n .comment(\"Maximum ping during this period in milliseconds\");\n })\n .alterTable(\"stat_minutely\", function (table) {\n table\n .float(\"ping_min\")\n .notNullable()\n .defaultTo(0)\n .comment(\"Minimum ping during this period in milliseconds\");\n table\n .float(\"ping_max\")\n .notNullable()\n .defaultTo(0)\n .comment(\"Maximum ping during this period in milliseconds\");\n });\n};\n\nexports.down = function (knex) {\n return knex.schema\n .alterTable(\"stat_daily\", function (table) {\n table.dropColumn(\"ping_min\");\n table.dropColumn(\"ping_max\");\n })\n .alterTable(\"stat_minutely\", function (table) {\n table.dropColumn(\"ping_min\");\n table.dropColumn(\"ping_max\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2023-12-22-0000-hourly-uptime.js",
"content": "exports.up = function (knex) {\n return knex.schema.createTable(\"stat_hourly\", function (table) {\n table.increments(\"id\");\n table.comment(\"This table contains the hourly aggregate statistics for each monitor\");\n table\n .integer(\"monitor_id\")\n .unsigned()\n .notNullable()\n .references(\"id\")\n .inTable(\"monitor\")\n .onDelete(\"CASCADE\")\n .onUpdate(\"CASCADE\");\n table.integer(\"timestamp\").notNullable().comment(\"Unix timestamp rounded down to the nearest hour\");\n table.float(\"ping\").notNullable().comment(\"Average ping in milliseconds\");\n table.float(\"ping_min\").notNullable().defaultTo(0).comment(\"Minimum ping during this period in milliseconds\");\n table.float(\"ping_max\").notNullable().defaultTo(0).comment(\"Maximum ping during this period in milliseconds\");\n table.smallint(\"up\").notNullable();\n table.smallint(\"down\").notNullable();\n\n table.unique([\"monitor_id\", \"timestamp\"]);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.dropTable(\"stat_hourly\");\n};\n"
},
{
"path": "db/knex_migrations/2024-01-22-0000-stats-extras.js",
"content": "exports.up = function (knex) {\n return knex.schema\n .alterTable(\"stat_daily\", function (table) {\n table.text(\"extras\").defaultTo(null).comment(\"Extra statistics during this time period\");\n })\n .alterTable(\"stat_minutely\", function (table) {\n table.text(\"extras\").defaultTo(null).comment(\"Extra statistics during this time period\");\n })\n .alterTable(\"stat_hourly\", function (table) {\n table.text(\"extras\").defaultTo(null).comment(\"Extra statistics during this time period\");\n });\n};\n\nexports.down = function (knex) {\n return knex.schema\n .alterTable(\"stat_daily\", function (table) {\n table.dropColumn(\"extras\");\n })\n .alterTable(\"stat_minutely\", function (table) {\n table.dropColumn(\"extras\");\n })\n .alterTable(\"stat_hourly\", function (table) {\n table.dropColumn(\"extras\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2024-04-26-0000-snmp-monitor.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"snmp_oid\").defaultTo(null);\n table.enum(\"snmp_version\", [\"1\", \"2c\", \"3\"]).defaultTo(\"2c\");\n table.string(\"json_path_operator\").defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"snmp_oid\");\n table.dropColumn(\"snmp_version\");\n table.dropColumn(\"json_path_operator\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2024-08-24-000-add-cache-bust.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.boolean(\"cache_bust\").notNullable().defaultTo(false);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"cache_bust\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2024-08-24-0000-conditions.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.text(\"conditions\").notNullable().defaultTo(\"[]\");\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"conditions\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2024-10-1315-rabbitmq-monitor.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.text(\"rabbitmq_nodes\");\n table.string(\"rabbitmq_username\");\n table.string(\"rabbitmq_password\");\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"rabbitmq_nodes\");\n table.dropColumn(\"rabbitmq_username\");\n table.dropColumn(\"rabbitmq_password\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2024-10-31-0000-fix-snmp-monitor.js",
"content": "exports.up = function (knex) {\n return knex(\"monitor\").whereNull(\"json_path_operator\").update(\"json_path_operator\", \"==\");\n};\nexports.down = function (knex) {\n // changing the json_path_operator back to null for all \"==\" is not possible anymore\n // we have lost the context which fields have been set explicitely in >= v2.0 and which would need to be reverted\n};\n"
},
{
"path": "db/knex_migrations/2024-11-27-1927-fix-info-json-data-type.js",
"content": "// Update info_json column to LONGTEXT mainly for MariaDB\nexports.up = function (knex) {\n return knex.schema.alterTable(\"monitor_tls_info\", function (table) {\n table.text(\"info_json\", \"longtext\").alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor_tls_info\", function (table) {\n table.text(\"info_json\", \"text\").alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-01-01-0000-add-smtp.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"smtp_security\").defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"smtp_security\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-02-15-2312-add-wstest.js",
"content": "// Add websocket ignore headers and websocket subprotocol\nexports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.boolean(\"ws_ignore_sec_websocket_accept_header\").notNullable().defaultTo(false);\n table.string(\"ws_subprotocol\", 255).notNullable().defaultTo(\"\");\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"ws_ignore_sec_websocket_accept_header\");\n table.dropColumn(\"ws_subprotocol\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-02-17-2142-generalize-analytics.js",
"content": "// Udpate status_page table to generalize analytics fields\nexports.up = function (knex) {\n return knex.schema\n .alterTable(\"status_page\", function (table) {\n table.renameColumn(\"google_analytics_tag_id\", \"analytics_id\");\n table.string(\"analytics_script_url\");\n table.enu(\"analytics_type\", [\"google\", \"umami\", \"plausible\", \"matomo\"]).defaultTo(null);\n })\n .then(() => {\n // After a succesful migration, add google as default for previous pages\n knex(\"status_page\").whereNotNull(\"analytics_id\").update({\n analytics_type: \"google\",\n });\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"status_page\", function (table) {\n table.renameColumn(\"analytics_id\", \"google_analytics_tag_id\");\n table.dropColumn(\"analytics_script_url\");\n table.dropColumn(\"analytics_type\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-03-04-0000-ping-advanced-options.js",
"content": "/* SQL:\nALTER TABLE monitor ADD ping_count INTEGER default 1 not null;\nALTER TABLE monitor ADD ping_numeric BOOLEAN default true not null;\nALTER TABLE monitor ADD ping_per_request_timeout INTEGER default 2 not null;\n*/\nexports.up = function (knex) {\n // Add new columns to table monitor\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.integer(\"ping_count\").defaultTo(1).notNullable();\n table.boolean(\"ping_numeric\").defaultTo(true).notNullable();\n table.integer(\"ping_per_request_timeout\").defaultTo(2).notNullable();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"ping_count\");\n table.dropColumn(\"ping_numeric\");\n table.dropColumn(\"ping_per_request_timeout\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-03-25-0127-fix-5721.js",
"content": "// Fix #5721: Change proxy port column type to integer to support larger port numbers\nexports.up = function (knex) {\n return knex.schema.alterTable(\"proxy\", function (table) {\n table.integer(\"port\").alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"proxy\", function (table) {\n table.smallint(\"port\").alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-05-09-0000-add-custom-url.js",
"content": "// Add column custom_url to monitor_group table\nexports.up = function (knex) {\n return knex.schema.alterTable(\"monitor_group\", function (table) {\n table.text(\"custom_url\", \"text\");\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor_group\", function (table) {\n table.dropColumn(\"custom_url\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-06-03-0000-add-ip-family.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.boolean(\"ip_family\").defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"ip_family\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-06-11-0000-add-manual-monitor.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"manual_status\").defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"manual_status\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-06-13-0000-maintenance-add-last-start.js",
"content": "// Add column last_start_date to maintenance table\nexports.up = async function (knex) {\n await knex.schema.alterTable(\"maintenance\", function (table) {\n table.datetime(\"last_start_date\");\n });\n\n // Perform migration for recurring-interval strategy\n const recurringMaintenances = await knex(\"maintenance\")\n .where({\n strategy: \"recurring-interval\",\n cron: \"* * * * *\",\n })\n .select(\"id\", \"start_time\");\n\n // eslint-disable-next-line camelcase\n const maintenanceUpdates = recurringMaintenances.map(async ({ start_time, id }) => {\n // eslint-disable-next-line camelcase\n const [hourStr, minuteStr] = start_time.split(\":\");\n const hour = parseInt(hourStr, 10);\n const minute = parseInt(minuteStr, 10);\n\n const cron = `${minute} ${hour} * * *`;\n\n await knex(\"maintenance\").where({ id }).update({ cron });\n });\n await Promise.all(maintenanceUpdates);\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"maintenance\", function (table) {\n table.dropColumn(\"last_start_date\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-06-15-0001-manual-monitor-fix.js",
"content": "// Fix: Change manual_status column type to smallint\nexports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.smallint(\"manual_status\").alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"manual_status\").alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-06-24-0000-add-audience-to-oauth.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"oauth_audience\").nullable().defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"oauth_audience\").alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-07-17-0000-mqtt-websocket-path.js",
"content": "exports.up = function (knex) {\n // Add new column monitor.mqtt_websocket_path\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"mqtt_websocket_path\", 255).nullable();\n });\n};\n\nexports.down = function (knex) {\n // Drop column monitor.mqtt_websocket_path\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"mqtt_websocket_path\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-09-02-0000-add-domain-expiry.js",
"content": "exports.up = function (knex) {\n return knex.schema\n .alterTable(\"monitor\", function (table) {\n table.boolean(\"domain_expiry_notification\").defaultTo(1);\n })\n .createTable(\"domain_expiry\", (table) => {\n table.increments(\"id\");\n table.datetime(\"last_check\");\n // Use VARCHAR(255) for MySQL/MariaDB compatibility with unique constraint\n // Maximum domain name length is 253 characters (255 octets on the wire)\n table.string(\"domain\", 255).unique().notNullable();\n table.datetime(\"expiry\");\n table.integer(\"last_expiry_notification_sent\").defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema\n .alterTable(\"monitor\", function (table) {\n table.boolean(\"domain_expiry_notification\").alter();\n })\n .dropTable(\"domain_expiry\");\n};\n"
},
{
"path": "db/knex_migrations/2025-10-14-0000-add-ip-family-fix.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n // Fix ip_family, change to varchar instead of boolean\n // possible values are \"ipv4\" and \"ipv6\"\n table.string(\"ip_family\", 4).defaultTo(null).alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n // Rollback to boolean\n table.boolean(\"ip_family\").defaultTo(null).alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-10-15-0000-stat-table-fix.js",
"content": "// Fix for #4315. Logically, setting it to 0 ping may not be correct, but it is better than throwing errors\n\nexports.up = function (knex) {\n return knex.schema\n .alterTable(\"stat_daily\", function (table) {\n table.integer(\"ping\").defaultTo(0).alter();\n })\n .alterTable(\"stat_hourly\", function (table) {\n table.integer(\"ping\").defaultTo(0).alter();\n })\n .alterTable(\"stat_minutely\", function (table) {\n table.integer(\"ping\").defaultTo(0).alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema\n .alterTable(\"stat_daily\", function (table) {\n table.integer(\"ping\").alter();\n })\n .alterTable(\"stat_hourly\", function (table) {\n table.integer(\"ping\").alter();\n })\n .alterTable(\"stat_minutely\", function (table) {\n table.integer(\"ping\").alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-10-15-0001-add-monitor-response-config.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.boolean(\"save_response\").notNullable().defaultTo(false);\n table.boolean(\"save_error_response\").notNullable().defaultTo(true);\n table.integer(\"response_max_length\").notNullable().defaultTo(1024); // Default 1KB\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"save_response\");\n table.dropColumn(\"save_error_response\");\n table.dropColumn(\"response_max_length\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-10-15-0002-add-response-to-heartbeat.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"heartbeat\", function (table) {\n table.text(\"response\").nullable().defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"heartbeat\", function (table) {\n table.dropColumn(\"response\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-10-24-0000-show-only-last-heartbeat.js",
"content": "exports.up = function (knex) {\n // Add new column status_page.show_only_last_heartbeat\n return knex.schema.alterTable(\"status_page\", function (table) {\n table.boolean(\"show_only_last_heartbeat\").notNullable().defaultTo(false);\n });\n};\n\nexports.down = function (knex) {\n // Drop column status_page.show_only_last_heartbeat\n return knex.schema.alterTable(\"status_page\", function (table) {\n table.dropColumn(\"show_only_last_heartbeat\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-12-09-0000-add-system-service-monitor.js",
"content": "/**\n * @param {import(\"knex\").Knex} knex The Knex.js instance for database interaction.\n * @returns {Promise}\n */\nexports.up = async (knex) => {\n await knex.schema.alterTable(\"monitor\", (table) => {\n table.string(\"system_service_name\");\n });\n};\n\n/**\n * @param {import(\"knex\").Knex} knex The Knex.js instance for database interaction.\n * @returns {Promise}\n */\nexports.down = async (knex) => {\n await knex.schema.alterTable(\"monitor\", (table) => {\n table.dropColumn(\"system_service_name\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-12-17-0000-add-globalping-monitor.js",
"content": "exports.up = function (knex) {\n // Add new columns\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"subtype\", 10).nullable();\n table.string(\"location\", 255).nullable();\n table.string(\"protocol\", 20).nullable();\n });\n};\n\nexports.down = function (knex) {\n // Drop columns\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"subtype\");\n table.dropColumn(\"location\");\n table.dropColumn(\"protocol\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2025-12-22-0121-optimize-important-indexes.js",
"content": "exports.up = async function (knex) {\n const isSQLite = knex.client.dialect === \"sqlite3\";\n\n if (isSQLite) {\n // For SQLite: Use partial indexes with WHERE important = 1\n // Drop existing indexes using IF EXISTS\n await knex.raw(\"DROP INDEX IF EXISTS monitor_important_time_index\");\n await knex.raw(\"DROP INDEX IF EXISTS heartbeat_important_index\");\n\n // Create partial indexes with predicate\n await knex.schema.alterTable(\"heartbeat\", function (table) {\n table.index([\"monitor_id\", \"time\"], \"monitor_important_time_index\", {\n predicate: knex.whereRaw(\"important = 1\"),\n });\n table.index([\"important\"], \"heartbeat_important_index\", {\n predicate: knex.whereRaw(\"important = 1\"),\n });\n });\n }\n // For MariaDB/MySQL: No changes (partial indexes not supported)\n};\n\nexports.down = async function (knex) {\n const isSQLite = knex.client.dialect === \"sqlite3\";\n\n if (isSQLite) {\n // Restore original indexes\n await knex.raw(\"DROP INDEX IF EXISTS monitor_important_time_index\");\n await knex.raw(\"DROP INDEX IF EXISTS heartbeat_important_index\");\n\n await knex.schema.alterTable(\"heartbeat\", function (table) {\n table.index([\"monitor_id\", \"important\", \"time\"], \"monitor_important_time_index\");\n table.index([\"important\"]);\n });\n }\n // For MariaDB/MySQL: No changes\n};\n"
},
{
"path": "db/knex_migrations/2025-12-29-0000-remove-line-notify.js",
"content": "exports.up = async function (knex) {\n const notifications = await knex(\"notification\").select(\"id\", \"config\");\n const lineNotifyIDs = [];\n\n for (const { id, config } of notifications) {\n try {\n const parsedConfig = JSON.parse(config || \"{}\");\n const type = typeof parsedConfig.type === \"string\" ? parsedConfig.type.toLowerCase() : \"\";\n\n if (type === \"linenotify\" || type === \"line-notify\") {\n lineNotifyIDs.push(id);\n }\n } catch (error) {\n // Ignore invalid JSON blobs here; they are handled elsewhere in the app.\n }\n }\n\n if (lineNotifyIDs.length === 0) {\n return;\n }\n\n await knex.transaction(async (trx) => {\n await trx(\"monitor_notification\").whereIn(\"notification_id\", lineNotifyIDs).del();\n await trx(\"notification\").whereIn(\"id\", lineNotifyIDs).del();\n });\n};\n\nexports.down = async function () {\n // Removal of LINE Notify configs is not reversible.\n};\n"
},
{
"path": "db/knex_migrations/2025-12-31-2143-add-snmp-v3-username.js",
"content": "exports.up = async function (knex) {\n await knex.schema.alterTable(\"monitor\", (table) => {\n table.string(\"snmp_v3_username\", 255);\n });\n};\n\nexports.down = async function (knex) {\n await knex.schema.alterTable(\"monitor\", (table) => {\n table.dropColumn(\"snmp_v3_username\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-01-02-0551-dns-last-result-to-text.js",
"content": "// Change dns_last_result column from VARCHAR(255) to TEXT to handle longer DNS TXT records\nexports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.text(\"dns_last_result\").alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"dns_last_result\", 255).alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-01-02-0713-gamedig-v4-to-v5.js",
"content": "// Migration to update monitor.game from GameDig v4 to v5 game IDs\n// Reference: https://github.com/gamedig/node-gamedig/blob/master/MIGRATE_IDS.md\n\n// Lookup table mapping v4 game IDs to v5 game IDs\nconst gameDig4to5IdMap = {\n americasarmypg: \"aapg\",\n \"7d2d\": \"sdtd\",\n as: \"actionsource\",\n ageofchivalry: \"aoc\",\n arkse: \"ase\",\n arcasimracing: \"asr08\",\n arma: \"aaa\",\n arma2oa: \"a2oa\",\n armacwa: \"acwa\",\n armar: \"armaresistance\",\n armare: \"armareforger\",\n armagetron: \"armagetronadvanced\",\n bat1944: \"battalion1944\",\n bf1942: \"battlefield1942\",\n bfv: \"battlefieldvietnam\",\n bf2: \"battlefield2\",\n bf2142: \"battlefield2142\",\n bfbc2: \"bbc2\",\n bf3: \"battlefield3\",\n bf4: \"battlefield4\",\n bfh: \"battlefieldhardline\",\n bd: \"basedefense\",\n bs: \"bladesymphony\",\n buildandshoot: \"bas\",\n cod4: \"cod4mw\",\n callofjuarez: \"coj\",\n chivalry: \"cmw\",\n commandos3: \"c3db\",\n cacrenegade: \"cacr\",\n contactjack: \"contractjack\",\n cs15: \"counterstrike15\",\n cs16: \"counterstrike16\",\n cs2: \"counterstrike2\",\n crossracing: \"crce\",\n darkesthour: \"dhe4445\",\n daysofwar: \"dow\",\n deadlydozenpt: \"ddpt\",\n dh2005: \"deerhunter2005\",\n dinodday: \"ddd\",\n dirttrackracing2: \"dtr2\",\n dmc: \"deathmatchclassic\",\n dnl: \"dal\",\n drakan: \"dootf\",\n dys: \"dystopia\",\n em: \"empiresmod\",\n empyrion: \"egs\",\n f12002: \"formulaone2002\",\n flashpointresistance: \"ofr\",\n fivem: \"gta5f\",\n forrest: \"theforrest\",\n graw: \"tcgraw\",\n graw2: \"tcgraw2\",\n giantscitizenkabuto: \"gck\",\n ges: \"goldeneyesource\",\n gore: \"gus\",\n hldm: \"hld\",\n hldms: \"hlds\",\n hlopfor: \"hlof\",\n hl2dm: \"hl2d\",\n hidden: \"thehidden\",\n had2: \"hiddendangerous2\",\n igi2: \"i2cs\",\n il2: \"il2sturmovik\",\n insurgencymic: \"imic\",\n isle: \"theisle\",\n jamesbondnightfire: \"jb007n\",\n jc2mp: \"jc2m\",\n jc3mp: \"jc3m\",\n kingpin: \"kloc\",\n kisspc: \"kpctnc\",\n kspdmp: \"kspd\",\n kzmod: \"kreedzclimbing\",\n left4dead: \"l4d\",\n left4dead2: \"l4d2\",\n m2mp: \"m2m\",\n mohsh: \"mohaas\",\n mohbt: \"mohaab\",\n mohab: \"moha\",\n moh2010: \"moh\",\n mohwf: \"mohw\",\n minecraftbe: \"mbe\",\n mtavc: \"gtavcmta\",\n mtasa: \"gtasamta\",\n ns: \"naturalselection\",\n ns2: \"naturalselection2\",\n nwn: \"neverwinternights\",\n nwn2: \"neverwinternights2\",\n nolf: \"tonolf\",\n nolf2: \"nolf2asihw\",\n pvkii: \"pvak2\",\n ps: \"postscriptum\",\n primalcarnage: \"pce\",\n pc: \"projectcars\",\n pc2: \"projectcars2\",\n prbf2: \"prb2\",\n przomboid: \"projectzomboid\",\n quake1: \"quake\",\n quake3: \"q3a\",\n ragdollkungfu: \"rdkf\",\n r6: \"rainbowsix\",\n r6roguespear: \"rs2rs\",\n r6ravenshield: \"rs3rs\",\n redorchestraost: \"roo4145\",\n redm: \"rdr2r\",\n riseofnations: \"ron\",\n rs2: \"rs2v\",\n samp: \"gtasam\",\n saomp: \"gtasao\",\n savage2: \"s2ats\",\n ss: \"serioussam\",\n ss2: \"serioussam2\",\n ship: \"theship\",\n sinep: \"sinepisodes\",\n sonsoftheforest: \"sotf\",\n swbf: \"swb\",\n swbf2: \"swb2\",\n swjk: \"swjkja\",\n swjk2: \"swjk2jo\",\n takeonhelicopters: \"toh\",\n tf2: \"teamfortress2\",\n terraria: \"terrariatshock\",\n tribes1: \"t1s\",\n ut: \"unrealtournament\",\n ut2003: \"unrealtournament2003\",\n ut2004: \"unrealtournament2004\",\n ut3: \"unrealtournament3\",\n v8supercar: \"v8sc\",\n vcmp: \"vcm\",\n vs: \"vampireslayer\",\n wheeloftime: \"wot\",\n wolfenstein2009: \"wolfenstein\",\n wolfensteinet: \"wet\",\n wurm: \"wurmunlimited\",\n};\n\n/**\n * Migrate game IDs from v4 to v5\n * @param {import(\"knex\").Knex} knex - Knex instance\n * @returns {Promise}\n */\nexports.up = async function (knex) {\n await knex.transaction(async (trx) => {\n // Get all monitors that use the gamedig type\n const monitors = await trx(\"monitor\").select(\"id\", \"game\").where(\"type\", \"gamedig\").whereNotNull(\"game\");\n\n // Update each monitor with the new game ID if it needs migration\n for (const monitor of monitors) {\n const oldGameId = monitor.game;\n const newGameId = gameDig4to5IdMap[oldGameId];\n\n if (newGameId) {\n await trx(\"monitor\").where(\"id\", monitor.id).update({ game: newGameId });\n }\n }\n });\n};\n\n/**\n * Revert game IDs from v5 back to v4\n * @param {import(\"knex\").Knex} knex - Knex instance\n * @returns {Promise}\n */\nexports.down = async function (knex) {\n // Create reverse mapping from the same LUT\n const gameDig5to4IdMap = Object.fromEntries(Object.entries(gameDig4to5IdMap).map(([v4, v5]) => [v5, v4]));\n\n await knex.transaction(async (trx) => {\n // Get all monitors that use the gamedig type\n const monitors = await trx(\"monitor\").select(\"id\", \"game\").where(\"type\", \"gamedig\").whereNotNull(\"game\");\n\n // Revert each monitor back to the old game ID if it was migrated\n for (const monitor of monitors) {\n const newGameId = monitor.game;\n const oldGameId = gameDig5to4IdMap[newGameId];\n\n if (oldGameId) {\n await trx(\"monitor\").where(\"id\", monitor.id).update({ game: oldGameId });\n }\n }\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-01-05-0000-add-rss-title.js",
"content": "exports.up = async function (knex) {\n await knex.schema.alterTable(\"status_page\", function (table) {\n table.string(\"rss_title\", 255);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"status_page\", function (table) {\n table.dropColumn(\"rss_title\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-01-05-0000-add-tls-monitor.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.string(\"expected_tls_alert\", 50).defaultTo(null);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"expected_tls_alert\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-01-06-0000-fix-domain-expiry-column-type.js",
"content": "// Ensure domain column is VARCHAR(255) across all database types.\n// This migration ensures MySQL, SQLite, and MariaDB have consistent column type,\n// even if a user installed 2.1.0-beta.0 or 2.1.0-beta.1 which had TEXT type for this column.\n// Maximum domain name length is 253 characters (255 octets on the wire).\n// Note: The unique constraint is already present from the original migration.\nexports.up = function (knex) {\n return knex.schema.alterTable(\"domain_expiry\", function (table) {\n table.string(\"domain\", 255).notNullable().alter();\n });\n};\n\nexports.down = function (knex) {\n // No rollback needed - keeping VARCHAR(255) is the correct state\n};\n"
},
{
"path": "db/knex_migrations/2026-01-10-0000-convert-float-precision.js",
"content": "exports.up = function (knex) {\n return knex.schema\n .alterTable(\"heartbeat\", function (table) {\n table.bigInteger(\"ping\").alter();\n })\n .alterTable(\"stat_minutely\", function (table) {\n table.float(\"ping\", 20, 2).notNullable().alter();\n table.float(\"ping_min\", 20, 2).notNullable().defaultTo(0).alter();\n table.float(\"ping_max\", 20, 2).notNullable().defaultTo(0).alter();\n })\n .alterTable(\"stat_daily\", function (table) {\n table.float(\"ping\", 20, 2).notNullable().alter();\n table.float(\"ping_min\", 20, 2).notNullable().defaultTo(0).alter();\n table.float(\"ping_max\", 20, 2).notNullable().defaultTo(0).alter();\n })\n .alterTable(\"stat_hourly\", function (table) {\n table.float(\"ping\", 20, 2).notNullable().alter();\n table.float(\"ping_min\", 20, 2).notNullable().defaultTo(0).alter();\n table.float(\"ping_max\", 20, 2).notNullable().defaultTo(0).alter();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema\n .alterTable(\"heartbeat\", function (table) {\n table.integer(\"ping\").alter();\n })\n .alterTable(\"stat_minutely\", function (table) {\n table.float(\"ping\").notNullable().alter();\n table.float(\"ping_min\").notNullable().defaultTo(0).alter();\n table.float(\"ping_max\").notNullable().defaultTo(0).alter();\n })\n .alterTable(\"stat_daily\", function (table) {\n table.float(\"ping\").notNullable().alter();\n table.float(\"ping_min\").notNullable().defaultTo(0).alter();\n table.float(\"ping_max\").notNullable().defaultTo(0).alter();\n })\n .alterTable(\"stat_hourly\", function (table) {\n table.float(\"ping\").notNullable().alter();\n table.float(\"ping_min\").notNullable().defaultTo(0).alter();\n table.float(\"ping_max\").notNullable().defaultTo(0).alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-01-15-0000-add-json-query-retry-only-status-code.js",
"content": "exports.up = function (knex) {\n // Add new column to table monitor for json-query retry behavior\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.boolean(\"retry_only_on_status_code_failure\").defaultTo(false).notNullable();\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"retry_only_on_status_code_failure\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-01-16-0000-add-screenshot-delay.js",
"content": "exports.up = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.integer(\"screenshot_delay\").notNullable().unsigned().defaultTo(0);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.alterTable(\"monitor\", function (table) {\n table.dropColumn(\"screenshot_delay\");\n });\n};\n"
},
{
"path": "db/knex_migrations/2026-02-07-0000-disable-domain-expiry-unsupported-tlds.js",
"content": "const { parse: parseTld } = require(\"tldts\");\n\n/*\n * TODO:\n * This migration file is scary, because the json file is dynamically updated.\n * Problem 1: Migration files should ideally be stateless.\n * Problem 2: This migration only runs once, what happens if rdp-dns.json is updated after this migration has run?\n * Have to investigate later.\n */\nconst rdapDnsData = require(\"../../extra/rdap-dns.json\");\n\nconst TYPES_WITH_DOMAIN_EXPIRY_SUPPORT_VIA_FIELD = {\n http: \"url\",\n keyword: \"url\",\n \"json-query\": \"url\",\n \"real-browser\": \"url\",\n \"websocket-upgrade\": \"url\",\n port: \"hostname\",\n ping: \"hostname\",\n \"grpc-keyword\": \"grpc_url\",\n dns: \"hostname\",\n smtp: \"hostname\",\n snmp: \"hostname\",\n gamedig: \"hostname\",\n steam: \"hostname\",\n mqtt: \"hostname\",\n radius: \"hostname\",\n \"tailscale-ping\": \"hostname\",\n \"sip-options\": \"hostname\",\n};\n\n/**\n * Build set of root TLDs that have RDAP support\n * @returns {Set} Set of supported root TLDs\n */\nfunction getSupportedTlds() {\n const supported = new Set();\n const services = rdapDnsData[\"services\"] ?? [];\n for (const [tlds] of services) {\n for (const tld of tlds) {\n supported.add(tld);\n }\n }\n return supported;\n}\n\n/**\n * Check if a target URL/hostname has RDAP support\n * @param {string} target URL or hostname\n * @param {Set} supportedTlds Set of supported root TLDs\n * @returns {boolean} Whether the target's TLD has RDAP support\n */\nfunction hasRdapSupport(target, supportedTlds) {\n if (!target || typeof target !== \"string\") {\n return false;\n }\n const tld = parseTld(target);\n if (!tld.publicSuffix || !tld.isIcann) {\n return false;\n }\n const rootTld = tld.publicSuffix.split(\".\").pop();\n return supportedTlds.has(rootTld);\n}\n\nexports.up = async function (knex) {\n const supportedTlds = getSupportedTlds();\n\n const monitors = await knex(\"monitor\")\n .where(\"domain_expiry_notification\", 1)\n .select(\"id\", \"type\", \"url\", \"hostname\", \"grpc_url\");\n\n const idsToDisable = [];\n for (const monitor of monitors) {\n const targetField = TYPES_WITH_DOMAIN_EXPIRY_SUPPORT_VIA_FIELD[monitor.type];\n if (!targetField || !hasRdapSupport(monitor[targetField], supportedTlds)) {\n idsToDisable.push(monitor.id);\n }\n }\n\n if (idsToDisable.length > 0) {\n await knex(\"monitor\").whereIn(\"id\", idsToDisable).update(\"domain_expiry_notification\", 0);\n }\n\n await knex.schema.alterTable(\"monitor\", function (table) {\n table.boolean(\"domain_expiry_notification\").defaultTo(0).alter();\n });\n};\n\nexports.down = async function (knex) {\n await knex.schema.alterTable(\"monitor\", function (table) {\n table.boolean(\"domain_expiry_notification\").defaultTo(1).alter();\n });\n};\n"
},
{
"path": "db/knex_migrations/README.md",
"content": "# Info\n\nhttps://knexjs.org/guide/migrations.html#knexfile-in-other-languages\n\n## Basic rules\n\n- All tables must have a primary key named `id`\n- Filename format: `YYYY-MM-DD-HHMM-patch-name.js`\n- Avoid native SQL syntax, use knex methods, because Uptime Kuma supports SQLite and MariaDB.\n\n## Template\n\n```js\nexports.up = function (knex) {};\n\nexports.down = function (knex) {};\n\n// exports.config = { transaction: false };\n```\n\n## Example\n\nFilename: 2023-06-30-1348-create-user-and-product.js\n\n```js\nexports.up = function (knex) {\n return knex.schema\n .createTable(\"user\", function (table) {\n table.increments(\"id\");\n table.string(\"first_name\", 255).notNullable();\n table.string(\"last_name\", 255).notNullable();\n })\n .createTable(\"product\", function (table) {\n table.increments(\"id\");\n table.decimal(\"price\").notNullable();\n table.string(\"name\", 1000).notNullable();\n })\n .then(() => {\n knex(\"products\").insert([\n { price: 10, name: \"Apple\" },\n { price: 20, name: \"Orange\" },\n ]);\n });\n};\n\nexports.down = function (knex) {\n return knex.schema.dropTable(\"product\").dropTable(\"user\");\n};\n```\n\nhttps://knexjs.org/guide/migrations.html#transactions-in-migrations\n"
},
{
"path": "db/old_migrations/README.md",
"content": "# Don't create a new migration file here\n\nPlease go to ./db/knex_migrations/README.md\n"
},
{
"path": "db/old_migrations/patch-2fa-invalidate-used-token.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE user\n ADD twofa_last_token VARCHAR(6);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-2fa.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE user\n ADD twofa_secret VARCHAR(64);\n\nALTER TABLE user\n ADD twofa_status BOOLEAN default 0 NOT NULL;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-certificate-expiry-status-page.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE status_page\n ADD show_certificate_expiry BOOLEAN default 0 NOT NULL;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-clickable-status-page-link.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor_group\n ADD send_url BOOLEAN DEFAULT 0 NOT NULL;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-description-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD description TEXT default null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-docker-columns.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nCREATE TABLE docker_host (\n\tid INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n\tuser_id INT NOT NULL,\n\tdocker_daemon VARCHAR(255),\n\tdocker_type VARCHAR(255),\n\tname VARCHAR(255)\n);\n\nALTER TABLE monitor\n\tADD docker_host INTEGER REFERENCES docker_host(id);\n\nALTER TABLE monitor\n\tADD docker_container VARCHAR(255);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-gamedig-given-port.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD gamedig_given_port_only BOOLEAN default 1 not null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-gamedig-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\n ALTER TABLE monitor\n ADD game VARCHAR(255);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-google-analytics-status-page-tag.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE status_page\n ADD google_analytics_tag_id VARCHAR;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-invert-keyword.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD invert_keyword BOOLEAN default 0 not null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-other-auth.sql",
"content": "BEGIN TRANSACTION;\n\n ALTER TABLE monitor\n ADD auth_method VARCHAR(250);\n\n ALTER TABLE monitor\n ADD auth_domain TEXT;\n ALTER TABLE monitor\n\n ADD auth_workstation TEXT;\n\nCOMMIT;\n\nBEGIN TRANSACTION;\n UPDATE monitor\n SET auth_method = 'basic'\n WHERE basic_auth_user is not null;\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-parent-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD parent INTEGER REFERENCES [monitor] ([id]) ON DELETE SET NULL ON UPDATE CASCADE;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-radius-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD radius_username VARCHAR(255);\n\nALTER TABLE monitor\n ADD radius_password VARCHAR(255);\n\nALTER TABLE monitor\n ADD radius_calling_station_id VARCHAR(50);\n\nALTER TABLE monitor\n ADD radius_called_station_id VARCHAR(50);\n\nALTER TABLE monitor\n ADD radius_secret VARCHAR(255);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-add-retry-interval-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD retry_interval INTEGER default 0 not null;\n\nCOMMIT;"
},
{
"path": "db/old_migrations/patch-add-sqlserver-monitor.sql",
"content": "BEGIN TRANSACTION;\n\n ALTER TABLE monitor\n ADD database_connection_string VARCHAR(2000);\n\n ALTER TABLE monitor\n ADD database_query TEXT;\n\n\n COMMIT\n"
},
{
"path": "db/old_migrations/patch-add-timeout-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD timeout DOUBLE default 0 not null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-added-json-query.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n\tADD json_path TEXT;\n\nALTER TABLE monitor\n\tADD expected_value VARCHAR(255);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-added-kafka-producer.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n\tADD kafka_producer_topic VARCHAR(255);\n\nALTER TABLE monitor\n\tADD kafka_producer_brokers TEXT;\n\nALTER TABLE monitor\n\tADD kafka_producer_ssl INTEGER;\n\nALTER TABLE monitor\n\tADD kafka_producer_allow_auto_topic_creation VARCHAR(255);\n\nALTER TABLE monitor\n\tADD kafka_producer_sasl_options TEXT;\n\nALTER TABLE monitor\n\tADD kafka_producer_message TEXT;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-added-mqtt-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n\tADD mqtt_topic TEXT;\n\nALTER TABLE monitor\n\tADD mqtt_success_message VARCHAR(255);\n\nALTER TABLE monitor\n\tADD mqtt_username VARCHAR(255);\n\nALTER TABLE monitor\n\tADD mqtt_password VARCHAR(255);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-api-key-table.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nCREATE TABLE [api_key] (\n [id] INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n [key] VARCHAR(255) NOT NULL,\n [name] VARCHAR(255) NOT NULL,\n [user_id] INTEGER NOT NULL,\n [created_date] DATETIME DEFAULT (DATETIME('now')) NOT NULL,\n [active] BOOLEAN DEFAULT 1 NOT NULL,\n [expires] DATETIME DEFAULT NULL,\n CONSTRAINT FK_user FOREIGN KEY ([user_id]) REFERENCES [user]([id]) ON DELETE CASCADE ON UPDATE CASCADE\n);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-fix-kafka-producer-booleans.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\n-- Rename COLUMNs to another one (suffixed by `_old`)\nALTER TABLE monitor\n RENAME COLUMN kafka_producer_ssl TO kafka_producer_ssl_old;\n\nALTER TABLE monitor\n RENAME COLUMN kafka_producer_allow_auto_topic_creation TO kafka_producer_allow_auto_topic_creation_old;\n\n-- Add correct COLUMNs\nALTER TABLE monitor\n ADD COLUMN kafka_producer_ssl BOOLEAN default 0 NOT NULL;\n\nALTER TABLE monitor\n ADD COLUMN kafka_producer_allow_auto_topic_creation BOOLEAN default 0 NOT NULL;\n\n-- These SQL is still not fully safe. See https://github.com/louislam/uptime-kuma/issues/4039.\n\n-- Set bring old values from `_old` COLUMNs to correct ones\n-- UPDATE monitor SET kafka_producer_allow_auto_topic_creation = monitor.kafka_producer_allow_auto_topic_creation_old\n-- WHERE monitor.kafka_producer_allow_auto_topic_creation_old IS NOT NULL;\n\n-- UPDATE monitor SET kafka_producer_ssl = monitor.kafka_producer_ssl_old\n-- WHERE monitor.kafka_producer_ssl_old IS NOT NULL;\n\n-- Remove old COLUMNs\nALTER TABLE monitor\n DROP COLUMN kafka_producer_allow_auto_topic_creation_old;\n\nALTER TABLE monitor\n DROP COLUMN kafka_producer_ssl_old;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-group-table.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\ncreate table `group`\n(\n id INTEGER not null\n constraint group_pk\n primary key autoincrement,\n name VARCHAR(255) not null,\n created_date DATETIME default (DATETIME('now')) not null,\n public BOOLEAN default 0 not null,\n active BOOLEAN default 1 not null,\n weight BOOLEAN NOT NULL DEFAULT 1000\n);\n\nCREATE TABLE [monitor_group]\n(\n [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n [monitor_id] INTEGER NOT NULL REFERENCES [monitor] ([id]) ON DELETE CASCADE ON UPDATE CASCADE,\n [group_id] INTEGER NOT NULL REFERENCES [group] ([id]) ON DELETE CASCADE ON UPDATE CASCADE,\n weight BOOLEAN NOT NULL DEFAULT 1000\n);\n\nCREATE INDEX [fk]\n ON [monitor_group] (\n [monitor_id],\n [group_id]);\n\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-grpc-monitor.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD grpc_url VARCHAR(255) default null;\n\nALTER TABLE monitor\n ADD grpc_protobuf TEXT default null;\n\nALTER TABLE monitor\n ADD grpc_body TEXT default null;\n\nALTER TABLE monitor\n ADD grpc_metadata TEXT default null;\n\nALTER TABLE monitor\n ADD grpc_method VARCHAR(255) default null;\n\nALTER TABLE monitor\n ADD grpc_service_name VARCHAR(255) default null;\n\nALTER TABLE monitor\n ADD grpc_enable_tls BOOLEAN default 0 not null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-http-body-encoding.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor ADD http_body_encoding VARCHAR(25);\n\nCOMMIT;\n\nBEGIN TRANSACTION;\n\nUPDATE monitor SET http_body_encoding = 'json' WHERE (type = 'http' or type = 'keyword') AND http_body_encoding IS NULL;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-http-monitor-method-body-and-headers.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD method TEXT default 'GET' not null;\n\nALTER TABLE monitor\n ADD body TEXT default null;\n\nALTER TABLE monitor\n ADD headers TEXT default null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-improve-performance.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\n-- For sendHeartbeatList\nCREATE INDEX monitor_time_index ON heartbeat (monitor_id, time);\n\n-- For sendImportantHeartbeatList\nCREATE INDEX monitor_important_time_index ON heartbeat (monitor_id, important,time);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-incident-table.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\ncreate table incident\n(\n id INTEGER not null\n constraint incident_pk\n primary key autoincrement,\n title VARCHAR(255) not null,\n content TEXT not null,\n style VARCHAR(30) default 'warning' not null,\n created_date DATETIME default (DATETIME('now')) not null,\n last_updated_date DATETIME,\n pin BOOLEAN default 1 not null,\n active BOOLEAN default 1 not null\n);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-maintenance-cron.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nDROP TABLE maintenance_timeslot;\n\n-- 999 characters. https://stackoverflow.com/questions/46134830/maximum-length-for-cron-job\nALTER TABLE maintenance ADD cron TEXT;\nALTER TABLE maintenance ADD timezone VARCHAR(255);\nALTER TABLE maintenance ADD duration INTEGER;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-maintenance-table2.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\n-- Just for someone who tested maintenance before (patch-maintenance-table.sql)\nDROP TABLE IF EXISTS maintenance_status_page;\nDROP TABLE IF EXISTS monitor_maintenance;\nDROP TABLE IF EXISTS maintenance;\nDROP TABLE IF EXISTS maintenance_timeslot;\n\n-- maintenance\nCREATE TABLE [maintenance] (\n [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n [title] VARCHAR(150) NOT NULL,\n [description] TEXT NOT NULL,\n [user_id] INTEGER REFERENCES [user]([id]) ON DELETE SET NULL ON UPDATE CASCADE,\n [active] BOOLEAN NOT NULL DEFAULT 1,\n [strategy] VARCHAR(50) NOT NULL DEFAULT 'single',\n [start_date] DATETIME,\n [end_date] DATETIME,\n [start_time] TIME,\n [end_time] TIME,\n [weekdays] VARCHAR2(250) DEFAULT '[]',\n [days_of_month] TEXT DEFAULT '[]',\n [interval_day] INTEGER\n);\n\nCREATE INDEX [manual_active] ON [maintenance] (\n [strategy],\n [active]\n);\n\nCREATE INDEX [active] ON [maintenance] ([active]);\n\nCREATE INDEX [maintenance_user_id] ON [maintenance] ([user_id]);\n\n-- maintenance_status_page\nCREATE TABLE maintenance_status_page (\n id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n status_page_id INTEGER NOT NULL,\n maintenance_id INTEGER NOT NULL,\n CONSTRAINT FK_maintenance FOREIGN KEY (maintenance_id) REFERENCES maintenance (id) ON DELETE CASCADE ON UPDATE CASCADE,\n CONSTRAINT FK_status_page FOREIGN KEY (status_page_id) REFERENCES status_page (id) ON DELETE CASCADE ON UPDATE CASCADE\n);\n\nCREATE INDEX [status_page_id_index]\n ON [maintenance_status_page]([status_page_id]);\n\nCREATE INDEX [maintenance_id_index]\n ON [maintenance_status_page]([maintenance_id]);\n\n-- maintenance_timeslot\nCREATE TABLE [maintenance_timeslot] (\n [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n [maintenance_id] INTEGER NOT NULL CONSTRAINT [FK_maintenance] REFERENCES [maintenance]([id]) ON DELETE CASCADE ON UPDATE CASCADE,\n [start_date] DATETIME NOT NULL,\n [end_date] DATETIME,\n [generated_next] BOOLEAN DEFAULT 0\n);\n\nCREATE INDEX [maintenance_id] ON [maintenance_timeslot] ([maintenance_id] DESC);\n\nCREATE INDEX [active_timeslot_index] ON [maintenance_timeslot] (\n [maintenance_id] DESC,\n [start_date] DESC,\n [end_date] DESC\n);\n\nCREATE INDEX [generated_next_index] ON [maintenance_timeslot] ([generated_next]);\n\n-- monitor_maintenance\nCREATE TABLE monitor_maintenance (\n id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n monitor_id INTEGER NOT NULL,\n maintenance_id INTEGER NOT NULL,\n CONSTRAINT FK_maintenance FOREIGN KEY (maintenance_id) REFERENCES maintenance (id) ON DELETE CASCADE ON UPDATE CASCADE,\n CONSTRAINT FK_monitor FOREIGN KEY (monitor_id) REFERENCES monitor (id) ON DELETE CASCADE ON UPDATE CASCADE\n);\n\nCREATE INDEX [maintenance_id_index2] ON [monitor_maintenance]([maintenance_id]);\n\nCREATE INDEX [monitor_id_index] ON [monitor_maintenance]([monitor_id]);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-monitor-add-resend-interval.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD resend_interval INTEGER default 0 not null;\n\nALTER TABLE heartbeat\n ADD down_count INTEGER default 0 not null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-monitor-basic-auth.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD basic_auth_user TEXT default null;\n\nALTER TABLE monitor\n ADD basic_auth_pass TEXT default null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-monitor-expiry-notification.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD expiry_notification BOOLEAN default 1;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-monitor-oauth-cc.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD oauth_client_id TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_client_secret TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_token_url TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_scopes TEXT default null;\n\nALTER TABLE monitor\n ADD oauth_auth_method TEXT default null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-monitor-push_token.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD push_token VARCHAR(20) DEFAULT NULL;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-monitor-tls-info-add-fk.sql",
"content": "BEGIN TRANSACTION;\n\nPRAGMA writable_schema = TRUE;\n\nUPDATE\n\tSQLITE_MASTER\nSET\n\tsql = replace(sql,\n\t'monitor_id INTEGER NOT NULL',\n\t'monitor_id INTEGER NOT NULL REFERENCES [monitor] ([id]) ON DELETE CASCADE ON UPDATE CASCADE'\n)\nWHERE\n\tname = 'monitor_tls_info'\n\tAND type = 'table';\n\nPRAGMA writable_schema = RESET;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-monitor-tls.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD tls_ca TEXT default null;\n\nALTER TABLE monitor\n ADD tls_cert TEXT default null;\n\nALTER TABLE monitor\n ADD tls_key TEXT default null;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-notification-config.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\n-- SQLite: Change the data type of the column \"config\" from VARCHAR to TEXT\nALTER TABLE notification RENAME COLUMN config TO config_old;\nALTER TABLE notification ADD COLUMN config TEXT;\nUPDATE notification SET config = config_old;\nALTER TABLE notification DROP COLUMN config_old;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-notification_sent_history.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nCREATE TABLE [notification_sent_history] (\n [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n [type] VARCHAR(50) NOT NULL,\n [monitor_id] INTEGER NOT NULL,\n [days] INTEGER NOT NULL,\n UNIQUE([type], [monitor_id], [days])\n);\n\nCREATE INDEX [good_index] ON [notification_sent_history] (\n [type],\n [monitor_id],\n [days]\n);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-ping-packet-size.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD packet_size INTEGER DEFAULT 56 NOT NULL;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-proxy.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nCREATE TABLE proxy (\n id INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n user_id INT NOT NULL,\n protocol VARCHAR(10) NOT NULL,\n host VARCHAR(255) NOT NULL,\n port SMALLINT NOT NULL,\n auth BOOLEAN NOT NULL,\n username VARCHAR(255) NULL,\n password VARCHAR(255) NULL,\n active BOOLEAN NOT NULL DEFAULT 1,\n 'default' BOOLEAN NOT NULL DEFAULT 0,\n created_date DATETIME DEFAULT (DATETIME('now')) NOT NULL\n);\n\nALTER TABLE monitor ADD COLUMN proxy_id INTEGER REFERENCES proxy(id);\n\nCREATE INDEX proxy_id ON monitor (proxy_id);\nCREATE INDEX proxy_user_id ON proxy (user_id);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-setting-value-type.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\n-- Generated by Intellij IDEA\ncreate table setting_dg_tmp\n(\n id INTEGER\n primary key autoincrement,\n key VARCHAR(200) not null\n unique,\n value TEXT,\n type VARCHAR(20)\n);\n\ninsert into setting_dg_tmp(id, key, value, type) select id, key, value, type from setting;\n\ndrop table setting;\n\nalter table setting_dg_tmp rename to setting;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-status-page-footer-css.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE status_page\n ADD footer_text TEXT;\nALTER TABLE status_page\n ADD custom_css TEXT;\nALTER TABLE status_page\n ADD show_powered_by BOOLEAN NOT NULL DEFAULT 1;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-status-page.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nCREATE TABLE [status_page](\n [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n [slug] VARCHAR(255) NOT NULL UNIQUE,\n [title] VARCHAR(255) NOT NULL,\n [description] TEXT,\n [icon] VARCHAR(255) NOT NULL,\n [theme] VARCHAR(30) NOT NULL,\n [published] BOOLEAN NOT NULL DEFAULT 1,\n [search_engine_index] BOOLEAN NOT NULL DEFAULT 1,\n [show_tags] BOOLEAN NOT NULL DEFAULT 0,\n [password] VARCHAR,\n [created_date] DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,\n [modified_date] DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP\n);\n\nCREATE UNIQUE INDEX [slug] ON [status_page]([slug]);\n\n\nCREATE TABLE [status_page_cname](\n [id] INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,\n [status_page_id] INTEGER NOT NULL REFERENCES [status_page]([id]) ON DELETE CASCADE ON UPDATE CASCADE,\n [domain] VARCHAR NOT NULL UNIQUE\n);\n\nALTER TABLE incident ADD status_page_id INTEGER;\nALTER TABLE [group] ADD status_page_id INTEGER;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch-timeout.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nUPDATE monitor SET timeout = (interval * 0.8)\nWHERE timeout IS NULL OR timeout <= 0;\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch1.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\n-- Change Monitor.created_date from \"TIMESTAMP\" to \"DATETIME\"\n-- SQL Generated by Intellij Idea\nPRAGMA foreign_keys=off;\n\nBEGIN TRANSACTION;\n\ncreate table monitor_dg_tmp\n(\n id INTEGER not null\n primary key autoincrement,\n name VARCHAR(150),\n active BOOLEAN default 1 not null,\n user_id INTEGER\n references user\n on update cascade on delete set null,\n interval INTEGER default 20 not null,\n url TEXT,\n type VARCHAR(20),\n weight INTEGER default 2000,\n hostname VARCHAR(255),\n port INTEGER,\n created_date DATETIME,\n keyword VARCHAR(255)\n);\n\ninsert into monitor_dg_tmp(id, name, active, user_id, interval, url, type, weight, hostname, port, created_date, keyword) select id, name, active, user_id, interval, url, type, weight, hostname, port, created_date, keyword from monitor;\n\ndrop table monitor;\n\nalter table monitor_dg_tmp rename to monitor;\n\ncreate index user_id on monitor (user_id);\n\nCOMMIT;\n\nPRAGMA foreign_keys=on;\n"
},
{
"path": "db/old_migrations/patch10.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nCREATE TABLE tag (\n\tid INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n\tname VARCHAR(255) NOT NULL,\n color VARCHAR(255) NOT NULL,\n\tcreated_date DATETIME DEFAULT (DATETIME('now')) NOT NULL\n);\n\nCREATE TABLE monitor_tag (\n\tid INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n\tmonitor_id INTEGER NOT NULL,\n\ttag_id INTEGER NOT NULL,\n\tvalue TEXT,\n\tCONSTRAINT FK_tag FOREIGN KEY (tag_id) REFERENCES tag(id) ON DELETE CASCADE ON UPDATE CASCADE,\n\tCONSTRAINT FK_monitor FOREIGN KEY (monitor_id) REFERENCES monitor(id) ON DELETE CASCADE ON UPDATE CASCADE\n);\n\nCREATE INDEX monitor_tag_monitor_id_index ON monitor_tag (monitor_id);\nCREATE INDEX monitor_tag_tag_id_index ON monitor_tag (tag_id);\n"
},
{
"path": "db/old_migrations/patch2.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nCREATE TABLE monitor_tls_info (\n\tid INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,\n\tmonitor_id INTEGER NOT NULL,\n\tinfo_json TEXT\n);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch3.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\n-- Add maxretries column to monitor\nPRAGMA foreign_keys=off;\n\nBEGIN TRANSACTION;\n\ncreate table monitor_dg_tmp\n(\n id INTEGER not null\n primary key autoincrement,\n name VARCHAR(150),\n active BOOLEAN default 1 not null,\n user_id INTEGER\n references user\n on update cascade on delete set null,\n interval INTEGER default 20 not null,\n url TEXT,\n type VARCHAR(20),\n weight INTEGER default 2000,\n hostname VARCHAR(255),\n port INTEGER,\n created_date DATETIME,\n keyword VARCHAR(255),\n maxretries INTEGER NOT NULL DEFAULT 0\n);\n\ninsert into monitor_dg_tmp(id, name, active, user_id, interval, url, type, weight, hostname, port, created_date, keyword) select id, name, active, user_id, interval, url, type, weight, hostname, port, created_date, keyword from monitor;\n\ndrop table monitor;\n\nalter table monitor_dg_tmp rename to monitor;\n\ncreate index user_id on monitor (user_id);\n\nCOMMIT;\n\nPRAGMA foreign_keys=on;\n"
},
{
"path": "db/old_migrations/patch4.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\n-- OK.... serious wrong, missing maxretries column\n-- Developers should patch it manually if you have missing the maxretries column\nPRAGMA foreign_keys=off;\n\nBEGIN TRANSACTION;\n\ncreate table monitor_dg_tmp\n(\n id INTEGER not null\n primary key autoincrement,\n name VARCHAR(150),\n active BOOLEAN default 1 not null,\n user_id INTEGER\n references user\n on update cascade on delete set null,\n interval INTEGER default 20 not null,\n url TEXT,\n type VARCHAR(20),\n weight INTEGER default 2000,\n hostname VARCHAR(255),\n port INTEGER,\n created_date DATETIME,\n keyword VARCHAR(255),\n maxretries INTEGER NOT NULL DEFAULT 0,\n ignore_tls BOOLEAN default 0 not null,\n upside_down BOOLEAN default 0 not null\n);\n\ninsert into monitor_dg_tmp(id, name, active, user_id, interval, url, type, weight, hostname, port, created_date, keyword, maxretries) select id, name, active, user_id, interval, url, type, weight, hostname, port, created_date, keyword, maxretries from monitor;\n\ndrop table monitor;\n\nalter table monitor_dg_tmp rename to monitor;\n\ncreate index user_id on monitor (user_id);\n\nCOMMIT;\n\nPRAGMA foreign_keys=on;\n"
},
{
"path": "db/old_migrations/patch5.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nPRAGMA foreign_keys = off;\n\nBEGIN TRANSACTION;\n\ncreate table monitor_dg_tmp (\n\tid INTEGER not null primary key autoincrement,\n\tname VARCHAR(150),\n\tactive BOOLEAN default 1 not null,\n\tuser_id INTEGER references user on update cascade on delete\n\tset\n\t\tnull,\n\t\tinterval INTEGER default 20 not null,\n\t\turl TEXT,\n\t\ttype VARCHAR(20),\n\t\tweight INTEGER default 2000,\n\t\thostname VARCHAR(255),\n\t\tport INTEGER,\n\t\tcreated_date DATETIME default (DATETIME('now')) not null,\n\t\tkeyword VARCHAR(255),\n\t\tmaxretries INTEGER NOT NULL DEFAULT 0,\n\t\tignore_tls BOOLEAN default 0 not null,\n\t\tupside_down BOOLEAN default 0 not null\n);\n\ninsert into\n\tmonitor_dg_tmp(\n\t\tid,\n\t\tname,\n\t\tactive,\n\t\tuser_id,\n\t\tinterval,\n\t\turl,\n\t\ttype,\n\t\tweight,\n\t\thostname,\n\t\tport,\n\t\tkeyword,\n\t\tmaxretries,\n\t\tignore_tls,\n\t\tupside_down\n\t)\nselect\n\tid,\n\tname,\n\tactive,\n\tuser_id,\n\tinterval,\n\turl,\n\ttype,\n\tweight,\n\thostname,\n\tport,\n\tkeyword,\n\tmaxretries,\n\tignore_tls,\n\tupside_down\nfrom\n\tmonitor;\n\ndrop table monitor;\n\nalter table\n\tmonitor_dg_tmp rename to monitor;\n\ncreate index user_id on monitor (user_id);\n\nCOMMIT;\n\nPRAGMA foreign_keys = on;\n"
},
{
"path": "db/old_migrations/patch6.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nPRAGMA foreign_keys = off;\n\nBEGIN TRANSACTION;\n\ncreate table monitor_dg_tmp (\n\tid INTEGER not null primary key autoincrement,\n\tname VARCHAR(150),\n\tactive BOOLEAN default 1 not null,\n\tuser_id INTEGER references user on update cascade on delete\n\tset\n\t\tnull,\n\t\tinterval INTEGER default 20 not null,\n\t\turl TEXT,\n\t\ttype VARCHAR(20),\n\t\tweight INTEGER default 2000,\n\t\thostname VARCHAR(255),\n\t\tport INTEGER,\n\t\tcreated_date DATETIME default (DATETIME('now')) not null,\n\t\tkeyword VARCHAR(255),\n\t\tmaxretries INTEGER NOT NULL DEFAULT 0,\n\t\tignore_tls BOOLEAN default 0 not null,\n\t\tupside_down BOOLEAN default 0 not null,\n maxredirects INTEGER default 10 not null,\n accepted_statuscodes_json TEXT default '[\"200-299\"]' not null\n);\n\ninsert into\n\tmonitor_dg_tmp(\n\t\tid,\n\t\tname,\n\t\tactive,\n\t\tuser_id,\n\t\tinterval,\n\t\turl,\n\t\ttype,\n\t\tweight,\n\t\thostname,\n\t\tport,\n created_date,\n\t\tkeyword,\n\t\tmaxretries,\n\t\tignore_tls,\n\t\tupside_down\n\t)\nselect\n\tid,\n\tname,\n\tactive,\n\tuser_id,\n\tinterval,\n\turl,\n\ttype,\n\tweight,\n\thostname,\n\tport,\n created_date,\n\tkeyword,\n\tmaxretries,\n\tignore_tls,\n\tupside_down\nfrom\n\tmonitor;\n\ndrop table monitor;\n\nalter table\n\tmonitor_dg_tmp rename to monitor;\n\ncreate index user_id on monitor (user_id);\n\nCOMMIT;\n\nPRAGMA foreign_keys = on;\n"
},
{
"path": "db/old_migrations/patch7.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n\tADD dns_resolve_type VARCHAR(5);\n\nALTER TABLE monitor\n\tADD dns_resolve_server VARCHAR(255);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch8.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE monitor\n ADD dns_last_result VARCHAR(255);\n\nCOMMIT;\n"
},
{
"path": "db/old_migrations/patch9.sql",
"content": "-- You should not modify if this have pushed to Github, unless it does serious wrong with the db.\nBEGIN TRANSACTION;\n\nALTER TABLE notification\n ADD is_default BOOLEAN default 0 NOT NULL;\n\nCOMMIT;\n"
},
{
"path": "db/patch-monitor-tls-info-add-fk.sql",
"content": "BEGIN TRANSACTION;\n\nPRAGMA writable_schema = TRUE;\n\nUPDATE\n\tSQLITE_MASTER\nSET\n\tsql = replace(sql,\n\t'monitor_id INTEGER NOT NULL',\n\t'monitor_id INTEGER NOT NULL REFERENCES [monitor] ([id]) ON DELETE CASCADE ON UPDATE CASCADE'\n)\nWHERE\n\tname = 'monitor_tls_info'\n\tAND type = 'table';\n\nPRAGMA writable_schema = RESET;\n\nCOMMIT;\n"
},
{
"path": "docker/builder-go.dockerfile",
"content": "############################################\n# Build in Golang\n# Run npm run build-healthcheck-armv7 in the host first, another it will be super slow where it is building the armv7 healthcheck\n############################################\nFROM golang:1-buster\nWORKDIR /app\nARG TARGETPLATFORM\nCOPY ./extra/ ./extra/\n\n## Switch to archive.debian.org\nRUN sed -i '/^deb/s/^/#/' /etc/apt/sources.list \\\n && echo \"deb http://archive.debian.org/debian buster main contrib non-free\" | tee -a /etc/apt/sources.list \\\n && echo \"deb http://archive.debian.org/debian-security buster/updates main contrib non-free\" | tee -a /etc/apt/sources.list \\\n && echo \"deb http://archive.debian.org/debian buster-updates main contrib non-free\" | tee -a /etc/apt/sources.list\n\n# Compile healthcheck.go\nRUN apt update && \\\n apt --yes --no-install-recommends install curl && \\\n curl -sL https://deb.nodesource.com/setup_18.x | bash && \\\n apt --yes --no-install-recommends install nodejs && \\\n node ./extra/build-healthcheck.js $TARGETPLATFORM && \\\n apt --yes remove nodejs\n"
},
{
"path": "docker/debian-base.dockerfile",
"content": "# Download Apprise deb package\nFROM node:22-bookworm-slim AS download-apprise\nWORKDIR /app\nCOPY ./extra/download-apprise.mjs ./download-apprise.mjs\nRUN apt update && \\\n apt --yes --no-install-recommends install curl && \\\n npm install cheerio semver && \\\n node ./download-apprise.mjs\n\n# Base Image (Slim)\n# If the image changed, the second stage image should be changed too\nFROM node:22-bookworm-slim AS base2-slim\nARG TARGETPLATFORM\n\n# Specify --no-install-recommends to skip unused dependencies, make the base much smaller!\n# sqlite3 = for debugging\n# iputils-ping = for ping\n# util-linux = for setpriv (Should be dropped in 2.0.0?)\n# dumb-init = avoid zombie processes (#480)\n# curl = for debugging\n# ca-certificates = keep the cert up-to-date\n# sudo = for start service nscd with non-root user\n# nscd = for better DNS caching\nRUN apt update && \\\n apt --yes --no-install-recommends install \\\n sqlite3 \\\n ca-certificates \\\n iputils-ping \\\n util-linux \\\n dumb-init \\\n curl \\\n sudo \\\n nscd && \\\n rm -rf /var/lib/apt/lists/* && \\\n apt --yes autoremove\n\n# apprise = for notifications (Install from the deb package, as the stable one is too old) (workaround for #4867)\n# Switching to testing repo is no longer working, as the testing repo is not bookworm anymore.\n# python3-paho-mqtt (#4859)\n# TODO: no idea how to delete the deb file after installation as it becomes a layer already\nCOPY --from=download-apprise /app/apprise.deb ./apprise.deb\nRUN apt update && \\\n apt --yes --no-install-recommends install ./apprise.deb python3-paho-mqtt && \\\n rm -rf /var/lib/apt/lists/* && \\\n rm -f apprise.deb && \\\n apt --yes autoremove\n\n# Install cloudflared\nRUN curl https://pkg.cloudflare.com/cloudflare-main.gpg --output /usr/share/keyrings/cloudflare-main.gpg && \\\n echo 'deb [signed-by=/usr/share/keyrings/cloudflare-main.gpg] https://pkg.cloudflare.com/cloudflared bookworm main' | tee /etc/apt/sources.list.d/cloudflared.list && \\\n apt update && \\\n apt install --yes --no-install-recommends cloudflared && \\\n cloudflared version && \\\n rm -rf /var/lib/apt/lists/* && \\\n apt --yes autoremove\n\n# For nscd\nCOPY ./docker/etc/nscd.conf /etc/nscd.conf\nCOPY ./docker/etc/sudoers /etc/sudoers\n\n\n# Full Base Image\n# MariaDB, Chromium and fonts\n# Make sure to reuse the slim image here. Uncomment the above line if you want to build it from scratch.\n# FROM base2-slim AS base2\nFROM louislam/uptime-kuma:base2-slim AS base2\nENV UPTIME_KUMA_ENABLE_EMBEDDED_MARIADB=1\nRUN apt update && \\\n apt --yes --no-install-recommends install chromium fonts-indic fonts-noto fonts-noto-cjk mariadb-server && \\\n rm -rf /var/lib/apt/lists/* && \\\n apt --yes autoremove && \\\n chown -R node:node /var/lib/mysql\n"
},
{
"path": "docker/docker-compose-dev.yml",
"content": "version: \"3.8\"\n\nservices:\n uptime-kuma:\n container_name: uptime-kuma-dev\n image: louislam/uptime-kuma:nightly2\n volumes:\n #- ./data:/app/data\n - ../server:/app/server\n - ../db:/app/db\n ports:\n - \"3001:3001\" # :\n - \"3307:3306\"\n"
},
{
"path": "docker/dockerfile",
"content": "ARG BASE_IMAGE=louislam/uptime-kuma:base2\n\n############################################\n# Build in Golang\n# Run npm run build-healthcheck-armv7 in the host first, otherwise it will be super slow where it is building the armv7 healthcheck\n# Check file: builder-go.dockerfile\n############################################\nFROM louislam/uptime-kuma:builder-go AS build_healthcheck\n\n############################################\n# Build in Node.js\n############################################\nFROM louislam/uptime-kuma:base2 AS build\nUSER node\nWORKDIR /app\n\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1\nCOPY --chown=node:node .npmrc .npmrc\nCOPY --chown=node:node package.json package.json\nCOPY --chown=node:node package-lock.json package-lock.json\nRUN npm ci --omit=dev\nCOPY . .\nCOPY --chown=node:node --from=build_healthcheck /app/extra/healthcheck /app/extra/healthcheck\nRUN mkdir ./data\n\n############################################\n# ⭐ Main Image\n############################################\nFROM $BASE_IMAGE AS release\nWORKDIR /app\n\nLABEL org.opencontainers.image.source=\"https://github.com/louislam/uptime-kuma\"\n\nENV UPTIME_KUMA_IS_CONTAINER=1\n\n# Copy app files from build layer\nCOPY --chown=node:node --from=build /app /app\n\nEXPOSE 3001\nHEALTHCHECK --interval=60s --timeout=30s --start-period=180s --retries=5 CMD extra/healthcheck\nENTRYPOINT [\"/usr/bin/dumb-init\", \"--\"]\nCMD [\"node\", \"server/server.js\"]\n\n############################################\n# Rootless Image\n############################################\nFROM release AS rootless\nUSER node\n\n############################################\n# Mark as Nightly\n############################################\nFROM release AS nightly\nRUN npm run mark-as-nightly\n\nFROM nightly AS nightly-rootless\nUSER node\n\n############################################\n# Build an image for testing pr\n############################################\nFROM louislam/uptime-kuma:base2 AS pr-test2\nWORKDIR /app\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1\n\n## Install Git\nRUN apt update \\\n && apt --yes --no-install-recommends install curl \\\n && curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \\\n && chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \\\n && echo \"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main\" | tee /etc/apt/sources.list.d/github-cli.list > /dev/null \\\n && apt update \\\n && apt --yes --no-install-recommends install git\n\n## Empty the directory, because we have to clone the Git repo.\nRUN rm -rf ./* && chown node /app\n\nUSER node\nRUN git config --global user.email \"no-reply@no-reply.com\"\nRUN git config --global user.name \"PR Tester\"\nRUN git clone https://github.com/louislam/uptime-kuma.git .\n\n# Hide the warning when running in detached head state\nRUN git config --global advice.detachedHead false\n\nRUN npm ci\n\nEXPOSE 3000 3001\nHEALTHCHECK --interval=60s --timeout=30s --start-period=180s --retries=5 CMD extra/healthcheck\nCMD [\"npm\", \"run\", \"start-pr-test\"]\n\n############################################\n# Upload the artifact to Github\n############################################\nFROM louislam/uptime-kuma:base2 AS upload-artifact\nWORKDIR /\nRUN apt update && \\\n apt --yes install curl file\n\nCOPY --from=build /app /app\n\nARG VERSION\nARG GITHUB_TOKEN\nARG TARGETARCH\nARG PLATFORM=debian\nARG FILE=$PLATFORM-$TARGETARCH-$VERSION.tar.gz\nARG DIST=dist.tar.gz\n\nRUN chmod +x /app/extra/upload-github-release-asset.sh\n\n# Full Build\n# RUN tar -zcvf $FILE app\n# RUN /app/extra/upload-github-release-asset.sh github_api_token=$GITHUB_TOKEN owner=louislam repo=uptime-kuma tag=$VERSION filename=$FILE\n\n# Dist only\nRUN cd /app && tar -zcvf $DIST dist\nRUN /app/extra/upload-github-release-asset.sh github_api_token=$GITHUB_TOKEN owner=louislam repo=uptime-kuma tag=$VERSION filename=/app/$DIST\n\n"
},
{
"path": "docker/etc/nscd.conf",
"content": "#\n# /etc/nscd.conf\n#\n# An example Name Service Cache config file. This file is needed by nscd.\n#\n# Legal entries are:\n#\n# logfile \n# debug-level \n# threads \n# max-threads \n# server-user \n# server-user is ignored if nscd is started with -S parameters\n# stat-user \n# reload-count unlimited|\n# paranoia \n# restart-interval
![\"Uptime](\"./public/icon.svg\"){kind=icon}
\n![](\"https://img.shields.io/github/stars/louislam/uptime-kuma?style=flat\")
![](\"https://img.shields.io/docker/pulls/louislam/uptime-kuma\")
![](\"https://img.shields.io/docker/v/louislam/uptime-kuma/2?label=docker%20image%20ver.\")
![](\"https://img.shields.io/github/last-commit/louislam/uptime-kuma\")
![](\"https://opencollective.com/uptime-kuma/total/badge.svg?label=Open%20Collective%20Backers&color=brightgreen\"){kind=icon}
\n[](https://github.com/sponsors/louislam) \n![\"Translation](\"https://weblate.kuma.pet/widgets/uptime-kuma/-/svg-badge.svg\"){kind=icon}
\n\n\n![\"Uptime](\"https://user-images.githubusercontent.com/1336778/212262296-e6205815-ad62-488c-83ec-a5b0d0689f7c.jpg\")
\n\n## 🥔 Live Demo\n\nTry it!\n\nDemo Server (Location: Frankfurt - Germany): ![\"Uptime](\"https://uptime.kuma.pet/img/light.jpg\")
\n\nStatus Page:\n\n![\"Uptime](\"https://user-images.githubusercontent.com/1336778/134628766-a3fe0981-0926-4285-ab46-891a21c3e4cb.png\")
\n\nSettings Page:\n\n![\"Uptime](\"https://louislam.net/uptimekuma/2.jpg\")
\n\nTelegram Notification Sample:\n\n![\"Uptime](\"https://louislam.net/uptimekuma/3.jpg\")
\n\n## Motivation\n\n- I was looking for a self-hosted monitoring tool like \"Uptime Robot\", but it is hard to find a suitable one. One of the closest ones is statping. Unfortunately, it is not stable and no longer maintained.\n- Wanted to build a fancy UI.\n- Learn Vue 3 and vite.js.\n- Show the power of Bootstrap 5.\n- Try to use WebSocket with SPA instead of a REST API.\n- Deploy my first Docker image to Docker Hub.\n\nIf you love this project, please consider giving it a ⭐.\n\n## 🗣️ Discussion / Ask for Help\n\n⚠️ For any general or technical questions, please don't send me an email, as I am unable to provide support in that manner. I will not respond if you ask questions there.\n\nI recommend using Google, GitHub Issues, or Uptime Kuma's subreddit for finding answers to your question. If you cannot find the information you need, feel free to ask:\n\n- [GitHub Issues](https://github.com/louislam/uptime-kuma/issues)\n- [Subreddit (r/UptimeKuma)](https://www.reddit.com/r/UptimeKuma/)\n\nMy Reddit account: [u/louislamlam](https://reddit.com/u/louislamlam)\nYou can mention me if you ask a question on the subreddit.\n\n## Contributions\n\n### Create Pull Requests\n\nPull requests are awesome.\nTo keep reviews fast and effective, please make sure you’ve [read our pull request guidelines](https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma).\n\n### Test Pull Requests\n\nThere are a lot of pull requests right now, but I don't have time to test them all.\n\nIf you want to help, you can check this:\n