+ English + +
+ แแแแแ + +
+ Japanese + +
|
+
+
+ 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 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/CONTRIBUTING_ja.md b/docs/CONTRIBUTING_ja.md similarity index 85% rename from CONTRIBUTING_ja.md rename to docs/CONTRIBUTING_ja.md index 82a5133..80461f7 100644 --- a/CONTRIBUTING_ja.md +++ b/docs/CONTRIBUTING_ja.md @@ -1,3 +1,37 @@ +## ๐ 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**ใธใฎ่ฒข็ฎใซใ่ๅณใใๆใกใใใ ใใใใใใจใใใใใพใ โ ใชใขใซใฟใคใ ใใซในใฟใใฏ็ฃ่ฆใฎใใใฎ็ฉถๆฅตใฎใชใผใใณใฝใผในใใฉใใใใฉใผใ ใงใใใใฐใฎๅ ฑๅใๆฉ่ฝใฎๆๆกใใใญใฅใกใณใใฎๆนๅใใพใใฏใณใผใใฎๆๅบใชใฉใใฉใฎใใใชๅฝขใงใฎใ่ฒข็ฎใงใๆญ่ฟใใใใพใ๏ผ 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/README_ja.md b/docs/README_ja.md similarity index 89% rename from README_ja.md rename to docs/README_ja.md index 8009ec1..f2c6938 100644 --- a/README_ja.md +++ b/docs/README_ja.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. +
+  # ๐ CheckCleใจใฏ๏ผ 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) + +แแปแแแแแแ แแแแพแแแแถแแแแแแแแแแแแถแแแแถแแแถแแแแแแขแแแ! ๐