diff --git a/.gitignore b/.gitignore index 8a74b8a..efda3c4 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,4 @@ dist-ssr *.sw? application/src/lib/pocketbase.ts Dockerfile +application/src/lib/pocketbase-prod.ts diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca2d9bc..f809209 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,36 @@ +## ð Select Language + +
+
+
+ English + + |
+
+
+
+ ááááá + + |
+
+
+
+ Japanese + + |
+
+ Thank you to all our contributors, users, and supporters for making this project thrive. +
+ ++ ð Stay tuned for more updates, features, and improvements. +
# ð ïž Contributing to CheckCle @@ -61,16 +94,45 @@ npm install && npm run dev #Server Backend cd server -./pocketbase serve --dir pb_data +./pocketbase serve --dir pb_data + +If you're not using localhost, please run with this (./pocketbase serve --http=0.0.0.0:8090 --dir pb_data) +``` + +### 4. Start Service Check Operation + +```bash +#Server Backend +Start Service Operation (Check Service for PING, HTTP, TCP, DNS) + +cd server/service-operation + +go run main.go (you do not need to change the .env while it's the localhost connection) ``` +### 5. Start Distributed Regional Agent +```bash +#### 1. Fork the Repository +Click "Fork" on [GitHub](https://github.com/operacle/Distributed-Regional-Monitoring) to create your own copy. + +#### 2. Clone Your Fork +git clone --branch main https://github.com/operacle/Distributed-Regional-Monitoring.git +cd Distributed-Regional-Monitoring + +#### 3. Install Go Service (make sure you have installed the Go Service) + +Copy .env.example -> .env +Change regional agent configuration in .env file +and Run: go run main.go + +``` --- ## â Pull Request Process 1. Ensure your code follows the existing style and naming conventions. 2. Write clear, concise commit messages. -3. Push your branch and open a Pull Request (PR) on the `main` branch. +3. Push your branch and open a Pull Request (PR) on the `develop` branch. 4. Provide a meaningful PR description (what/why/how). 5. Link related issues if applicable (e.g. `Closes #12`). 6. Make sure all checks pass (e.g., linting, tests). diff --git a/README.md b/README.md index 2d5c9bd..2bdff25 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ +## ð Select Language + +
+
+
+ English + + |
+
+
+
+ ááááá + + |
+
+
+
+ Japanese + + |
+
+ Thank you to all our contributors, users, and supporters for making this project thrive. +
+ ++ ð Stay tuned for more updates, features, and improvements. +
+  # ð What is CheckCle? diff --git a/SECURITY.md b/SECURITY.md index 90d9f98..94303c0 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## ðŠ Project: [checkcle](https://github.com/operacle/checkcle) -**checkcle** is a lightweight, TypeScript-based built for uptime and server monitoring tools. +**checkcle** is a self-hosted uptime and server monitoring tool built with TypeScript and Go. We care about the security and privacy of users running this project in production environments. @@ -47,22 +47,21 @@ We support the latest stable release of `checkcle`. Security patches may also be ## ð Security Practices -This project adheres to the following practices to enhance security: +CheckCle follows these practices to improve overall security: -- ð Regular vulnerability checks using `npm audit` -- âïž Dependency pinning via `package-lock.json` -- â Type-safe code using `TypeScript` -- 𧪠Continuous testing and CI +- ð Regular vulnerability scanning (npm audit for JavaScript dependencies, govulncheck for Go modules) +- âïž Dependency pinning (package-lock.json and Go modules) +- â Type-safe code in TypeScript and memory-safe design in Go +- 𧪠Continuous testing and CI pipelines - ð No data is stored or transmitted unless explicitly configured by the user -- ð§âð» All contributions are reviewed before being merged +- ð§âð» All code contributions are reviewed before merging --- ## â ïž Known Security Limitations -- `checkcle` makes outbound HTTPS requests to check certificate details â avoid running in untrusted or high-risk environments without proper network policies. -- Output may contain certificate metadata (e.g., CN, SANs, expiry dates) â avoid exposing this to public logs unless sanitized. -- The data may be lost upon system restarts or crashes. Always ensure that backup and recovery mechanisms are in place in production environments. +- Outbound HTTPS requests: CheckCle agents perform outbound HTTPS connections to send metric data to the backend server. Avoid deploying in untrusted or high-risk environments without appropriate network policies and monitoring. +- The data may be lost upon system restarts or crashes. Always ensure that backup (pb_data) and recovery mechanisms are in place in production environments. --- diff --git a/application/src/components/dashboard/Header.tsx b/application/src/components/dashboard/Header.tsx index 0e0815d..143789a 100644 --- a/application/src/components/dashboard/Header.tsx +++ b/application/src/components/dashboard/Header.tsx @@ -129,6 +129,9 @@ export const Header = ({No online regional agents found. Services will use default monitoring.
)} - {currentRegionalAgent && currentRegionalAgent !== "" && ( -- Currently assigned to: {getCurrentAgentDisplay()} + + {currentRegionalAgents.length === 0 && regionalMonitoringEnabled && ( +
+ No regional agents selected. Service will use default monitoring.
)} - {(!currentRegionalAgent || currentRegionalAgent === "") && regionalMonitoringEnabled && ( -- Service is unassigned and will use default monitoring. + + {currentRegionalAgents.length > 0 && ( +
+ Service assigned to {currentRegionalAgents.length} regional agent{currentRegionalAgents.length > 1 ? 's' : ''}.
)}
+
+
+ English + + |
+
+
+
+ ááááá + + |
+
+
+
+ Japanese + + |
+
+ Thank you to all our contributors, users, and supporters for making this project thrive. +
+ ++ ð Stay tuned for more updates, features, and improvements. +
+ +# ð ïž CheckCleãžã®è²¢ç® + +**CheckCle**ãžã®è²¢ç®ã«ãèå³ããæã¡ããã ããããããšãããããŸã â ãªã¢ã«ã¿ã€ã ãã«ã¹ã¿ãã¯ç£èŠã®ããã®ç©¶æ¥µã®ãªãŒãã³ãœãŒã¹ãã©ãããã©ãŒã ã§ãããã°ã®å ±åãæ©èœã®ææ¡ãããã¥ã¡ã³ãã®æ¹åããŸãã¯ã³ãŒãã®æåºãªã©ãã©ã®ãããªåœ¢ã§ã®ãè²¢ç®ã§ãæè¿ããããŸãïŒ + +倧å°ãåãããããããçš®é¡ã®è²¢ç®ãæè¿ããŸãããã®ã¬ã€ããå§ããã®ã«åœ¹ç«ã¡ãŸãã + +--- + +## ð ç®æ¬¡ +- [è¡åèŠç¯](#-è¡åèŠç¯) +- [è²¢ç®ã®æ¹æ³](#-è²¢ç®ã®æ¹æ³) +- [éçºç°å¢ã®ã»ããã¢ãã](#-éçºç°å¢ã®ã»ããã¢ãã) +- [ãã«ãªã¯ãšã¹ãã®ããã»ã¹](#-ãã«ãªã¯ãšã¹ãã®ããã»ã¹) +- [ãã°ãšåé¡ã®å ±å](#-ãã°ãšåé¡ã®å ±å) +- [æ©èœãªã¯ãšã¹ã](#-æ©èœãªã¯ãšã¹ã) +- [ã³ãã¥ããã£ãšãµããŒã](#-ã³ãã¥ããã£ãšãµããŒã) +- [ã©ã€ã»ã³ã¹](#-ã©ã€ã»ã³ã¹) + +--- + +## ð è¡åèŠç¯ + +ç§ãã¡ã¯[è¡åèŠç¯](https://opensource.guide/code-of-conduct/)ã«åŸãããªãŒãã³ã§æè¿ããã³ãã¥ããã£ãä¿é²ããŠããŸããåå ããããšã§ããããã®åºæºãå®ãããšã«åæãããã®ãšããŸãã + +--- + +## ð€ è²¢ç®ã®æ¹æ³ + +CheckCleã®æ¹åã«åœ¹ç«ã€æ¹æ³ãããã€ã玹ä»ããŸãïŒ + +- ð **ãã°ã®å ±å** â äžå ·åãèŠã€ããŸãããïŒ[GitHub Issue](https://github.com/operacle/checkcle/issues)ãéããŠãç¥ãããã ããã +- ð **æ©èœã®ææ¡** â ã¢ã€ãã¢ã¯ãããŸããïŒ[Discussion](https://github.com/operacle/checkcle/discussions)ãå§ããããæ©èœãªã¯ãšã¹ãã®issueãéããŠãã ããã +- ð **ãã«ãªã¯ãšã¹ãã®æåº** â ã³ãŒãã®æ¹åããã°ã®ä¿®æ£ãæ©èœã®è¿œå ãããã¥ã¡ã³ãã®æ¹åãè¡ã£ãŠãã ããã +- ð **ããã¥ã¡ã³ãã®æ¹å** â ã¿ã€ãã®ä¿®æ£ã§ã倧å€å©ãããŸãïŒ +- ð **宣äŒã®åå** â ãªããžããªã«âãã€ããŠãSNSã§ã·ã§ã¢ããä»ã®æ¹ã«ãè²¢ç®ãåŒã³ãããŠãã ããïŒ + +--- + +## ð§° éçºç°å¢ã®ã»ããã¢ãã + +ã³ãŒãã«è²¢ç®ããåã«ããããžã§ã¯ããããŒã«ã«ã§èšå®ããŠãã ããïŒ + +### 1. ãªããžããªããã©ãŒã¯ +[GitHub](https://github.com/operacle/checkcle)ã§ãForkããã¯ãªãã¯ããŠãèªåã®ã³ããŒãäœæããŠãã ããã + +### 2. ãã©ãŒã¯ãã¯ããŒã³ +```bash +git clone --branch develop https://github.com/operacle/checkcle.git +cd checkcle +``` + +### 3. äŸåé¢ä¿ã®ã€ã³ã¹ããŒã« +READMEãŸãã¯ãããžã§ã¯ãããã¥ã¡ã³ãã®æç€ºã«åŸã£ãŠãå¿ èŠãªããã±ãŒãžãã€ã³ã¹ããŒã«ããããŒã«ã«éçºãµãŒããŒãå®è¡ããŠãã ããã + +### 4. ããŒã«ã«éçºã®éå§ +```bash +#Webã¢ããªã±ãŒã·ã§ã³ +cd application/ +npm install && npm run dev + +#ãµãŒããŒããã¯ãšã³ã +cd server +./pocketbase serve --dir pb_data +``` + +--- + +## â ãã«ãªã¯ãšã¹ãã®ããã»ã¹ + +1. ã³ãŒããæ¢åã®ã¹ã¿ã€ã«ãšåœåèŠåã«åŸã£ãŠããããšã確èªããŠãã ããã +2. æç¢ºã§ç°¡æœãªã³ãããã¡ãã»ãŒãžãæžããŠãã ããã +3. ãã©ã³ããããã·ã¥ãã`main`ãã©ã³ãã«ãã«ãªã¯ãšã¹ãïŒPRïŒãéããŠãã ããã +4. æå³ã®ããPRã®èª¬æãæäŸããŠãã ããïŒäœã/ãªã/ã©ã®ããã«ïŒã +5. é¢é£ããissueãããå Žåã¯ãªã³ã¯ããŠãã ããïŒäŸïŒ`Closes #12`ïŒã +6. ãã¹ãŠã®ãã§ãã¯ãéãããšã確èªããŠãã ããïŒäŸïŒãªã³ãã£ã³ã°ããã¹ãïŒã + +PRãã¬ãã¥ãŒããå¿ èŠã«å¿ããŠå€æŽããªã¯ãšã¹ãããæºåãã§ã次第ããŒãžããŸãïŒ + +--- + +## ð ãã°ãšåé¡ã®å ±å + +å¯èœãªéãå€ãã®æ å ±ãå«ããŠãã ããïŒ +- æç¢ºã§èª¬æçãªã¿ã€ãã« +- åçŸæé +- æåŸ ãããåäœãšå®éã®åäœ +- ç°å¢æ å ±ïŒOSããã©ãŠã¶ãããã€ã¹ãªã©ïŒ +- 該åœããå Žåã¯ã¹ã¯ãªãŒã³ã·ã§ããããã° + +å ±åã«ã¯[Issue Tracker](https://github.com/operacle/checkcle/issues)ããå©çšãã ããã + +--- + +## ð¡ æ©èœãªã¯ãšã¹ã + +ã¢ã€ãã¢ããèãããã ããïŒ[Discussion](https://github.com/operacle/checkcle/discussions)ãŸãã¯æ©èœãªã¯ãšã¹ãã®issueãéããŠãã ããã[ããŒãããã](https://github.com/operacle/checkcle#development-roadmap)ã«æ¢ã«èšèŒãããŠããªãããšã確èªããŠãã ããã + +--- + +## ð ã³ãã¥ããã£ãšãµããŒã + +ãã«ããå¿ èŠã§ããïŒã€ãªããããã§ããïŒ + +- ð¬ [Discordã«åå ](https://discord.gg/xs9gbubGwX) +- ð£ [GitHub Discussion](https://github.com/operacle/checkcle/discussions)ãéå§ãŸãã¯åå +- ðŠ [XïŒTwitterïŒ](https://x.com/tl)ã§ãã©ã㌠+ +--- + +## ð ã©ã€ã»ã³ã¹ + +è²¢ç®ããããšã§ãããªãã®è²¢ç®ã[MITã©ã€ã»ã³ã¹](LICENSE)ã®äžã§ã©ã€ã»ã³ã¹ãããããšã«åæãããã®ãšããŸãã + +--- + +## ð ããããšãããããŸã + +CheckCleãäžç·ã«æ§ç¯ã§ããããšãå¬ããæããŸã â **ã³ãã¥ããã£ã«ãããã³ãã¥ããã£ã®ããã®**匷åãªç£èŠãã©ãããã©ãŒã ãããªãã®ãµããŒãã¯ç§ãã¡ã«ãšã£ãŠãšãŠã倧åã§ãïŒð \ No newline at end of file diff --git a/docs/CONTRIBUTING_km.md b/docs/CONTRIBUTING_km.md new file mode 100644 index 0000000..78efbbb --- /dev/null +++ b/docs/CONTRIBUTING_km.md @@ -0,0 +1,181 @@ + +## ð Select Language + +
+
+
+ English + + |
+
+
+
+ ááááá + + |
+
+
+
+ Japanese + + |
+
+ Thank you to all our contributors, users, and supporters for making this project thrive. +
+ ++ ð Stay tuned for more updates, features, and improvements. +
+ +# ð ïž Contributing to CheckCle + +Thank you for your interest in contributing to **CheckCle** â the ultimate open-source platform for real-time full-stack monitoring. Whether you're here to report bugs, suggest features, improve documentation, or submit code, your contribution matters! + +We welcome all kinds of contributions, big or small. This guide will help you get started. + +--- + +## ð Table of Contents +- [Code of Conduct](#-code-of-conduct) +- [Ways to Contribute](#-ways-to-contribute) +- [Development Setup](#-development-setup) +- [Pull Request Process](#-pull-request-process) +- [Reporting Bugs & Issues](#-reporting-bugs--issues) +- [Feature Requests](#-feature-requests) +- [Community & Support](#-community--support) +- [License](#-license) + +--- + +## ð Code of Conduct + +We follow a [Code of Conduct](https://opensource.guide/code-of-conduct/) to foster an open and welcoming community. By participating, you agree to uphold these standards. + +--- + +## ð€ Ways to Contribute + +Here are some ways you can help improve CheckCle: + +- ð **Report Bugs** â Found a glitch? Let us know by opening a [GitHub Issue](https://github.com/operacle/checkcle/issues). +- ð **Suggest Features** â Have an idea? Start a [Discussion](https://github.com/operacle/checkcle/discussions) or open a Feature Request issue. +- ð **Submit Pull Requests** â Improve the code, fix bugs, add features, or enhance the docs. +- ð **Improve Documentation** â Even a typo fix helps! +- ð **Spread the Word** â Star â the repo, share it on socials, and invite others to contribute! + +--- + +## ð§° Development Setup + +Before contributing code, set up the project locally: + +### 1. Fork the Repository +Click "Fork" on [GitHub](https://github.com/operacle/checkcle) to create your own copy. + +### 2. Clone Your Fork +```bash +git clone --branch develop https://github.com/operacle/checkcle.git +cd checkcle +``` + +### 3. Install Dependencies +Follow the instructions in the README or project docs to install required packages and run the local development server. + +### 4. Start Local Development +```bash +#Web Application +cd application/ +npm install && npm run dev + +#Server Backend +cd server +./pocketbase serve --dir pb_data + +If you're not using localhost, please run with this (./pocketbase serve --http=0.0.0.0:8090 --dir pb_data) +``` + +### 4. Start Service Check Operation + +```bash +#Server Backend +Start Service Operation (Check Service for PING, HTTP, TCP, DNS) + +cd server/service-operation + +go run main.go (you do not need to change the .env while it's the localhost connection) +``` + +### 5. Start Distributed Regional Agent +```bash +#### 1. Fork the Repository +Click "Fork" on [GitHub](https://github.com/operacle/Distributed-Regional-Monitoring) to create your own copy. + +#### 2. Clone Your Fork +git clone --branch main https://github.com/operacle/Distributed-Regional-Monitoring.git +cd Distributed-Regional-Monitoring + +#### 3. Install Go Service (make sure you have installed the Go Service) + +Copy .env.example -> .env +Change regional agent configuration in .env file +and Run: go run main.go + +``` +--- + +## â Pull Request Process + +1. Ensure your code follows the existing style and naming conventions. +2. Write clear, concise commit messages. +3. Push your branch and open a Pull Request (PR) on the `develop` branch. +4. Provide a meaningful PR description (what/why/how). +5. Link related issues if applicable (e.g. `Closes #12`). +6. Make sure all checks pass (e.g., linting, tests). + +Weâll review your PR, request changes if needed, and merge it once ready! + +--- + +## ð Reporting Bugs & Issues + +Please include as much information as possible: +- A clear, descriptive title +- Steps to reproduce +- Expected vs actual behavior +- Environment info (OS, browser, device, etc.) +- Screenshots or logs if applicable + +Use the [Issue Tracker](https://github.com/operacle/checkcle/issues) to report. + +--- + +## ð¡ Feature Requests + +Weâd love to hear your ideas! Open a [Discussion](https://github.com/operacle/checkcle/discussions) or Feature Request issue. Make sure itâs not already listed in the [Roadmap](https://github.com/operacle/checkcle#development-roadmap). + +--- + +## ð Community & Support + +Need help? Want to connect? + +- ð¬ [Join our Discord](https://discord.gg/xs9gbubGwX) +- ð£ Start or join a [GitHub Discussion](https://github.com/operacle/checkcle/discussions) +- ðŠ Follow us on [X (Twitter)](https://x.com/tl) + +--- + +## ð License + +By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE). + +--- + +## ð Thank You + +Weâre excited to build CheckCle together â a powerful monitoring platform **for the community, by the community**. Your support means the world! ð diff --git a/docs/README_ja.md b/docs/README_ja.md new file mode 100644 index 0000000..f2c6938 --- /dev/null +++ b/docs/README_ja.md @@ -0,0 +1,181 @@ +## ð Select Language + +
+
+
+ English + + |
+
+
+
+ ááááá + + |
+
+
+
+ Japanese + + |
+
+ Thank you to all our contributors, users, and supporters for making this project thrive. +
+ ++ ð Stay tuned for more updates, features, and improvements. +
+ + + +# ð CheckCleãšã¯ïŒ + +CheckCleã¯ããã«ã¹ã¿ãã¯ã·ã¹ãã ãã¢ããªã±ãŒã·ã§ã³ãã€ã³ãã©ã¹ãã©ã¯ãã£ã®ã·ãŒã ã¬ã¹ã§ãªã¢ã«ã¿ã€ã ãªç£èŠãå®çŸãããªãŒãã³ãœãŒã¹ãœãªã¥ãŒã·ã§ã³ã§ããéçºè ãã·ã¹ãã 管çè ãDevOpsããŒã ã«å¯ŸããŠãç°å¢ã®å šã¬ã€ã€ãŒïŒãµãŒããŒãã¢ããªã±ãŒã·ã§ã³ããµãŒãã¹ïŒã«ãããæ·±ãæŽå¯ãšå®çšçãªããŒã¿ãæäŸããŸããCheckCleã«ããããã¯ãããžãŒã¹ã¿ãã¯å šäœã®å¯èŠæ§ãå¶åŸ¡ãæé©ãªããã©ãŒãã³ã¹ã®ç¢ºä¿ãå¯èœã«ãªããŸãã + +## ð¯ ã©ã€ãã㢠+ð **ä»ãã詊ã:** [CheckCle ã©ã€ããã¢](https://demo.checkcle.io) + +## ð äž»èŠæ©èœ + +### ã¢ããã¿ã€ã ãµãŒãã¹ & ã€ã³ãã©ã¹ãã©ã¯ãã£ãµãŒããŒç£èŠ +- HTTPãDNSãPingãããã³ã«ã®ç£èŠ +- TCPããŒã¹ã®APIãµãŒãã¹ïŒFTPãSMTPãHTTPãªã©ïŒã®ç£èŠ +- 詳现ãªã¢ããã¿ã€ã ãã¬ã¹ãã³ã¹æéãããã©ãŒãã³ã¹åé¡ã®è¿œè·¡ +- 忣å°åç£èŠ +- ã€ã³ã·ãã³ãå±¥æŽïŒUP/DOWN/WARNING/PAUSEïŒ +- SSL & ãã¡ã€ã³ç£èŠïŒãã¡ã€ã³ãçºè¡è ãæå¹æéãæ®ãæ¥æ°ãã¹ããŒã¿ã¹ãæçµéç¥æ¥ïŒ +- ã€ã³ãã©ã¹ãã©ã¯ãã£ãµãŒããŒç£èŠïŒLinuxïŒð§ DebianãUbuntuãCentOSãRed Hatãªã©ïŒããã³WindowsïŒããŒã¿çïŒããµããŒããã¯ã³ã©ã€ã³ã»ã€ã³ã¹ããŒã«ã»ãšãŒãžã§ã³ãã»ã¹ã¯ãªããã«ãããµãŒããŒã¡ããªã¯ã¹ïŒCPUãRAMããã£ã¹ã¯äœ¿çšéããããã¯ãŒã¯æŽ»åïŒã®ç£èŠ +- ã¡ã³ããã³ã¹ã¹ã±ãžã¥ãŒã« & ã€ã³ã·ãã³ã管ç +- éçšã¹ããŒã¿ã¹ / ãããªãã¯ã¹ããŒã¿ã¹ããŒãž +- ã¡ãŒã«ãTelegramãDiscordãSlackçµç±ã®éç¥ +- ã¬ããŒã & åæ +- èšå®ããã«ïŒãŠãŒã¶ãŒç®¡çãããŒã¿ä¿æãå€èšèªãããŒãïŒããŒã¯ & ã©ã€ãã¢ãŒãïŒãéç¥ãšãã£ãã«ãã¢ã©ãŒããã³ãã¬ãŒãïŒ + +## #ïžâ£ ã¯ããã« + +### çŸåšãµããŒããããŠããã¢ãŒããã¯ã㣠+* â x86_64 PCãã©ãããããããµãŒããŒïŒamd64ïŒ +* â ææ°ã®Raspberry Pi 3/4/5ïŒ64ãããOSïŒãApple Silicon MacïŒarm64ïŒ + +### 以äžã®ãªãã·ã§ã³ã®ããããã䜿çšããŠCheckCleãã€ã³ã¹ããŒã«ããŸãã + +1. CheckCle ã¯ã³ã¯ãªãã¯ã€ã³ã¹ããŒã« - ã¿ãŒããã«ã«ã³ããŒããŠå®è¡ããã ã +```bash +curl -fsSL https://checkcle.io/install.sh | bash + +``` +2. docker runã§ã€ã³ã¹ããŒã«ã以äžã®æºåæžã¿docker runã³ãã³ããã³ããŒããã ã +```bash +docker run -d \ + --name checkcle \ + --restart unless-stopped \ + -p 8090:8090 \ + -v /opt/pb_data:/mnt/pb_data \ + --ulimit nofile=4096:8192 \ + operacle/checkcle:latest + +``` +3. Docker composeèšå®ã§ã€ã³ã¹ããŒã« +```bash + +version: '3.9' + +services: + checkcle: + image: operacle/checkcle:latest + container_name: checkcle + restart: unless-stopped + ports: + - "8090:8090" # Webã¢ããªã±ãŒã·ã§ã³ + volumes: + - /opt/pb_data:/mnt/pb_data # ãã¹ããã£ã¬ã¯ããªãã³ã³ãããã¹ã«ããã + ulimits: + nofile: + soft: 4096 + hard: 8192 + +``` +3. 管çWebç»é¢ + + ããã©ã«ãURL: http://0.0.0.0:8090 + ãŠãŒã¶ãŒ: admin@example.com + ãã¹ã¯ãŒã: Admin123456 + +4. https://docs.checkcle.io ã®ã¯ã€ãã¯ã¹ã¿ãŒãã¬ã€ãã«åŸã£ãŠãã ãã + +### + + + + + + +## ð éçºããŒãããã + +- â ãã«ã¹ãã§ã㯠& ã¢ããã¿ã€ã ç£èŠïŒHTTPïŒ +- â ã©ã€ãçµ±èšæ å ±ä»ãããã·ã¥ããŒãUI +- â ãã«ããŠãŒã¶ãŒã·ã¹ãã èªèšŒïŒç®¡çè ïŒ +- â éç¥ïŒTelegramïŒ +- â Dockerã³ã³ããå +- â CheckCle ãŠã§ããµã€ã +- â CheckCle ãã¢ãµãŒã㌠+- â SSL & ãã¡ã€ã³ç£èŠ +- â ã¡ã³ããã³ã¹ã¹ã±ãžã¥ãŒã« +- â ã€ã³ã·ãã³ã管ç +- [ ] ã€ã³ãã©ã¹ãã©ã¯ãã£ãµãŒããŒç£èŠ +- â éçšã¹ããŒã¿ã¹ / ãããªãã¯ã¹ããŒã¿ã¹ããŒãž +- â ã¢ããã¿ã€ã ç£èŠïŒHTTPãTCPãPINGãDNSïŒãã«æ©èœ +- â 忣å°åç£èŠãšãŒãžã§ã³ã [ãµããŒãéçš](https://github.com/operacle/Distributed-Regional-Monitoring) +- â ã·ã¹ãã èšå®ããã«ïŒã¡ãŒã«èšå® +- â ãŠãŒã¶ãŒæš©éããŒã« +- [ ] éç¥ïŒEmail/Slack/Discord/SignalïŒ +- â ããŒã¿ä¿æ & èªåå§çž®ïŒããŒã¿ & ããŒã¿ããŒã¹å§çž®ã®ãã«ããªãã·ã§ã³ïŒ +- â å®å šãªããã¥ã¡ã³ãä»ããªãŒãã³ãœãŒã¹ãªãªãŒã¹ + +## ð CheckCleã¯ã³ãã¥ããã£ã®ããïŒ +- **æ ç±ãæã£ãŠéçº**: ã³ãã¥ããã£ã®ããã®ãªãŒãã³ãœãŒã¹æå¥œå®¶ã«ãã£ãŠäœæ +- **ããªãŒ & ãªãŒãã³ãœãŒã¹**: é ããã³ã¹ããªãã§å®å šã«ç¡æã§äœ¿çšå¯èœ +- **åå & ã€ãªãã**: ãªãŒãã³ãœãŒã¹ã«æ ç±ãæã€åå¿ãšåºäŒã + +--- + +## ð€ è²¢ç®ã®æ¹æ³ + +CheckCleã®æ¹åã«ãååããã ããæ¹æ³ãã玹ä»ããŸãïŒ + +- ð **ãã°å ±å** â äžå ·åãçºèŠããŸãããïŒ[GitHub Issue](https://github.com/operacle/checkcle/issues)ãéããŠãç¥ãããã ããã +- ð **æ©èœææ¡** â ã¢ã€ãã¢ã¯ãããŸããïŒ[ãã£ã¹ã«ãã·ã§ã³](https://github.com/operacle/checkcle/discussions)ãéå§ããããæ©èœãªã¯ãšã¹ãã®issueãéããŠãã ããã +- ð **ãã«ãªã¯ãšã¹ãéä¿¡** â ã³ãŒãã®æ¹åããã°ä¿®æ£ãæ©èœè¿œå ãããã¥ã¡ã³ãã®æ¹è¯ãè¡ã£ãŠãã ããã +- ð **ããã¥ã¡ã³ãæ¹å** â ã¿ã€ãä¿®æ£ã§ãå©ãããŸãïŒ +- ð **å£ã³ã宣äŒ** â ãªããžããªã«âãã€ããSNSã§ã·ã§ã¢ããä»ã®äººãè²¢ç®ã«æåŸ ããŠãã ããïŒ + +--- + +## ð ã€ãªãããä¿ã€ +- ãŠã§ããµã€ã: [checkcle.io](https://checkcle.io) +- ããã¥ã¡ã³ã: [docs.checkcle.io](https://docs.checkcle.io) +- GitHubãªããžããª: â [CheckCle](https://github.com/operacle/checkcle.git) +- ã³ãã¥ããã£ãã£ã³ãã«: ãã£ã¹ã«ãã·ã§ã³ãissuesã§åå ããŠãã ããïŒ +- Discord: ã³ãã¥ããã£ã«åå [@discord](https://discord.gg/xs9gbubGwX) +- X: [@tlengoss](https://x.com/tlengoss) + +## ð ã©ã€ã»ã³ã¹ + +CheckCleã¯MITã©ã€ã»ã³ã¹ã®äžã§ãªãªãŒã¹ãããŠããŸãã + +--- +## ð¥ è²¢ç®è + +[](https://github.com/operacle/checkcle/graphs/contributors) + + +## ã¹ã¿ãŒå±¥æŽ + +[](https://www.star-history.com/#operacle/checkcle&Date) + +CheckCleã§æ å ±ãææ¡ãããªã³ã©ã€ã³ãç¶æããŸãããïŒ ð \ No newline at end of file diff --git a/docs/README_km.md b/docs/README_km.md new file mode 100644 index 0000000..f605d66 --- /dev/null +++ b/docs/README_km.md @@ -0,0 +1,182 @@ +## ð Select Language + +
+
+
+ English + + |
+
+
+
+ ááááá + + |
+
+
+
+ Japanese + + |
+
+ Thank you to all our contributors, users, and supporters for making this project thrive. +
+ ++ ð Stay tuned for more updates, features, and improvements. +
+ + + +# ð ááŸáááááááºáá¶á¢áááž? + +ááááá (CheckCle) ááºáá¶áááááááááááááááŸáá áá ááœááááááŸáá¢ááááááŸáááá¶ááááŒáá¶áááážááááááááá¥ááá·ááááá ááááá¶ááááá»ááá»ááá¶áá ááááááá»ááá¶áááááœááá·áá·ááááááááá¶á áááááá·áážáá áá áááá·áááá¶âáá·áá ááááá¶áá áá¶ááááááááááááá¶áá»ážááááá¶ááŸáá áá¶áááááá±ááá¢áááá¢áá·áááááá á¢áááááááááááááááááááá áá·ááááá»á DevOps ááŒááá¶ááááááážááááá áá·ááá·ááááááááá ááááá¶áá áá¶áááááááá áá·ááá¶áá¶ááá¶ááážááá áááááá·ááž á¬áááá¶áááááááááá áá¶ááœá CheckCle á¢áááááŸáááŸááá¶áááá¶á áá·áá¶áâ áá·áá ááá»áá¶áááááááâ áá·ááá¶áá¶áá¶áááŒááá¶áááŒáááááŸááá¶ááá á ááá»áá¶áááááááááááá¶áááŸáá¡áŸáá + +## ð¯ ááááááá¶ááááááááá¶áá +ð **Try it now:** [CheckCle Live Demo](https://demo.checkcle.io) + +## ð áá»ááá¶áá áááá + +### áá·áá·ááááááááááááááááá¶á áá·ááá¶áááááœááá·áá·áááá ááááá¶áá áá¶ááááááááááááá¶ááážááá +- ááááœááá·áá·ááááá·áážáááááá·ááž HTTP, DNS, and Ping protocols +- ááááœááá·áá·ááááá·áážáááááá·ááž TCP-based, API services (e.g., FTP, SMTP, HTTP) +- áá¶ááá¶ááá·ááá·áá¶ááááá¢á·á, response times, and performance issues +- áá¶ááá¶ááá·ááá·áá¶ááááá¢á·ááážáááááá¬áááááááááááááá¶á +- áááááááá·á§ááááááá·á ááá» (UP/DOWN/WARNING/PAUSE) +- áá¶ááá¶áâ SSL & Domain (Domain, Issuer, Expiration Date, Days Left, Status, Last Notified) +- áá¶ááá¶ááá·áááááœááá·áá·áááááá¶ááážááá, Supports Linux (ð§ Debian, Ubuntu, CentOS, Red Hat, etc.) and Windows (Beta). And Servers metrics like CPU, RAM, disk usage, and network activity) with an one-line installation angent script. +- áááá ááá¶ááá·áá¶á áá·ááá¶ááááááááááá§ááááááá·á ááá» +- ááááááááá¶ááá¶áááááá·ááááá·áá¶á +- áá¶áááŒááááá¹ááá¶áááá email, Telegram, Discord, and Slack +- ááá¶ááá¶ááá & áá·áá¶ááááá¢á·á +- áááá¶áááá¶ááááááááááááááááááááááá (User Management, Data Retention, Multi-language, Themes (Dark & Light Mode), Notification and channels and alert templates). + +## #ïžâ£ áá¶áá á¶ááááááŸá + +### ááááŸááá¶áááŸáááá¶ááááááááááŒá áá¶ +* â x86_64 PCs, laptops, servers (amd64) +* â Modern Raspberry Pi 3/4/5 with (64-bit OS), Apple Silicon Macs (arm64) + +### á¢áááá¢á¶á ááá¡áŸá CheckCle áááááááŸáááŸááááááŸáááœááááá»áá áááááááááŸááá¶ááááááá + + +1. CheckCle One-Click Installation - Just copy and run on terminal +```bash +curl -fsSL https://checkcle.io/install.sh | bash + +``` +2. Install with docker run. Just copy ready docker run command below +```bash +docker run -d \ + --name checkcle \ + --restart unless-stopped \ + -p 8090:8090 \ + -v /opt/pb_data:/mnt/pb_data \ + --ulimit nofile=4096:8192 \ + operacle/checkcle:latest + +``` +3. Install with Docker compose Configuration. +```bash + +version: '3.9' + +services: + checkcle: + image: operacle/checkcle:latest + container_name: checkcle + restart: unless-stopped + ports: + - "8090:8090" # Web Application + volumes: + - /opt/pb_data:/mnt/pb_data # Host directory mapped to container path + ulimits: + nofile: + soft: 4096 + hard: 8192 + +``` +3. á áŒááá áá¶áááááá¶ááááááááááá + + Default URL: http://0.0.0.0:8090 + User: admin@example.com + Passwd: Admin123456 + +4. á¯ááá¶áâ áá·áááááááááŸáááá¶ááááááá at https://docs.checkcle.io + +### + + + + + + +## ð áááááááááá»ááá¶áá¢áá·ááááááááááááááááááááááá + +- â Health check & uptime monitoring (HTTP) +- â Dashboard UI with live stats +- â Auth with Multi-users system (admin) +- â Notifications (Telegram) +- â Docker containerization +- â CheckCle Website +- â CheckCle Demo Server +- â SSL & Domain Monitoring +- â Schedule Maintenance +- â Incident Management +- [ ] Infrastructure Server Monitoring +- â Operational Status / Public Status Pages +- â Uptime monitoring (HTTP, TCP, PING, DNS) Full functionality +- â Distributed Regional Monitoring Agent [Support Operation](https://github.com/operacle/Distributed-Regional-Monitoring) +- â System Setting Panel and Mail Settings +- â User Permission Roles +- [ ] Notifications (Email/Slack/Discord/Signal) +- â Data Retention & Automate Strink (Muti Options to Shrink Data & Database ) +- â Open-source release with full documentation + +## ð áááááááááá¶áááá áááá +- **Built with Passion**: Created by an open-source enthusiast for the community +- **Free & Open Source**: Completely free to use with no hidden costs +- **Collaborate & Connect**: Meet like-minded people passionate about Open Source + +--- + +## ð€ áááááááá»ááá¶áá áŒáááœáá¢áá·ááááááááááááááááŒáááŸáááá + +áááááºáá¶áá·áážááœáá áááœááááá¢áááá¢á¶á ááœááááááᢠCheckCle: + +- ð **áá¶ááá¶áááááá á»á** - ááááŸáááá á»áááááž? á¢áá»áááá¶áá±ááááŸááá¹ááááááŸáááááááááááŸá [GitHub Issue](https://github.com/operacle/checkcle/issues). +- ð **áááááááááá** â áá¶ááááá·áááááž?â á¢áá»áááá¶áá±ááááŸááá¹ááááááŸáááááááááááŸá [Discussion](https://github.com/operacle/checkcle/discussions) or open a Feature Request issue. +- ð **áááááŒáááááŸá¢áá·ááááááááŒá** â áááááá¢ááŒá ááœááá»áááá á»á áááááááá»ááá¶á á¬áááááá¢á¯ááá¶áá +- ð **ááááŸá¢ááá¯ááá¶ááááááŸáá¡áŸá** â ááŒáááážáááá¶ááááááá¢ááááá·á áááááœá ááá¢á¶á ááœááá¶á! +- ð **áááááááááá¶á** â áá¶áááááá¶á â repo á ááááááááá¶áá ááŸáááááá áŸáá¢ááááŸáá¢áááááááááááá±ááá áŒáááœáá¢áá·áááááá! + +--- + +## ð ááááá¶áááá¶áááááá +- áááááá¶á: [checkcle.io](https://checkcle.io) +- á¯ááá¶á: [docs.checkcle.io](https://docs.checkcle.io) +- áááá¶áááááá»áááŒá: â [CheckCle](https://github.com/operacle/checkcle.git) +- áááá¶áááááááááá»á: Engage via discussions and issues! +- ááááá¶áááááá: Join our community [@discord](https://discord.gg/xs9gbubGwX) +- X: [@tlengoss](https://x.com/tlengoss) + +## ð License + +CheckCle ááááŒááá¶áá áááááá¶ááááááá¢á¶áááá¶ááááá MIT á + +--- +## ð¥ á¢áááááœáá áááá + +[](https://github.com/operacle/checkcle/graphs/contributors) + + +## áááá¶ááá¶ááááá¶á + +[](https://www.star-history.com/#operacle/checkcle&Date) + +áá»áááááá ááááŸáááá¶áááááááááááá¶áááá¶ááá¶áááááá¢ááá! ð