diff --git a/README.md b/README.md index a36ef3f..ed17ec9 100644 --- a/README.md +++ b/README.md @@ -4,41 +4,42 @@ ![komari](https://socialify.git.ci/komari-monitor/komari/image?description=1&font=Inter&forks=1&issues=1&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fkomari-monitor%2Fkomari-web%2Fd54ce1288df41ead08aa19f8700186e68028a889%2Fpublic%2Ffavicon.png&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Auto) -Komari 是一款轻量级的自托管服务器监控工具,旨在提供简单、高效的服务器性能监控解决方案。它支持通过 Web 界面查看服务器状态,并通过轻量级 Agent 收集数据。 +[简体中文](./docs/README_zh.md) | [繁體中文](./docs/README_zh-TW.md) | [日本語](./docs/README_ja.md) -[文档](https://komari-document.pages.dev/) | [Telegram 群组](https://t.me/komari_monitor) +Komari is a lightweight, self-hosted server monitoring tool designed to provide a simple and efficient solution for monitoring server performance. It supports viewing server status through a web interface and collects data through a lightweight agent. -## 特性 -- **轻量高效**:低资源占用,适合各种规模的服务器。 -- **自托管**:完全掌控数据隐私,部署简单。 -- **Web 界面**:直观的监控仪表盘,易于使用。 +[Documentation](https://komari-document.pages.dev/) | [Telegram Group](https://t.me/komari_monitor) -## 快速开始 +## Features +- **Lightweight and Efficient**: Low resource consumption, suitable for servers of all sizes. +- **Self-hosted**: Complete control over data privacy, easy to deploy. +- **Web Interface**: Intuitive monitoring dashboard, easy to use. -### 0. 容器云一键部署 +## Quick Start -- 雨云云应用 - CNY 4.5/月 +### 0. One-click Deployment with Cloud Hosting +- Rainyun - CNY 4.5/month [![](https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg)](https://app.rainyun.com/apps/rca/store/6780/NzYxNzAz_) -- Claw Run - USD 1.5/月 +- Claw Run - USD 1.5/month [![](https://raw.githubusercontent.com/ClawCloud/Run-Template/refs/heads/main/Run-on-ClawCloud.svg)](https://template.run.claw.cloud/?openapp=system-fastdeploy%3FtemplateName%3Dkomari) -### 1. 使用一键安装脚本 -适用于使用了 systemd 的发行版(Ubuntu、Debian...)。 +### 1. Use the One-click Install Script +Suitable for distributions using systemd (Ubuntu, Debian...). ```bash curl -fsSL https://raw.githubusercontent.com/komari-monitor/komari/main/install-komari.sh -o install-komari.sh chmod +x install-komari.sh sudo ./install-komari.sh ``` -### 2. Docker 部署 -1. 创建数据目录: +### 2. Docker Deployment +1. Create a data directory: ```bash mkdir -p ./data ``` -2. 运行 Docker 容器: +2. Run the Docker container: ```bash docker run -d \ -p 25774:25774 \ @@ -46,72 +47,73 @@ sudo ./install-komari.sh --name komari \ ghcr.io/komari-monitor/komari:latest ``` -3. 查看默认账号和密码: +3. View the default username and password: ```bash docker logs komari ``` -4. 在浏览器中访问 `http://:25774`。 +4. Access `http://:25774` in your browser. > [!NOTE] -> 你也可以通过环境变量 `ADMIN_USERNAME` 和 `ADMIN_PASSWORD` 自定义初始用户名和密码。 +> You can also customize the initial username and password through the environment variables `ADMIN_USERNAME` and `ADMIN_PASSWORD`. -### 3. 二进制文件部署 -1. 访问 Komari 的 [GitHub Release 页面](https://github.com/komari-monitor/komari/releases) 下载适用于你操作系统的最新二进制文件。 -2. 运行 Komari: +### 3. Binary File Deployment +1. Visit Komari's [GitHub Release page](https://github.com/komari-monitor/komari/releases) to download the latest binary for your operating system. +2. Run Komari: ```bash ./komari server -l 0.0.0.0:25774 ``` -3. 在浏览器中访问 `http://:25774`,默认监听 `25774` 端口。 -4. 默认账号和密码可在启动日志中查看,或通过环境变量 `ADMIN_USERNAME` 和 `ADMIN_PASSWORD` 设置。 +3. Access `http://:25774` in your browser. The default port is `25774`. +4. The default username and password can be found in the startup logs or set via the environment variables `ADMIN_USERNAME` and `ADMIN_PASSWORD`. > [!NOTE] -> 确保二进制文件具有可执行权限(`chmod +x komari`)。数据将保存在运行目录下的 `data` 文件夹中。 +> Ensure the binary has execute permissions (`chmod +x komari`). Data will be saved in the `data` folder in the running directory. -### 手工构建 +### Manual Build -#### 依赖 +#### Dependencies -- Go 1.18+ 和 Node.js 20+(手工构建) +- Go 1.18+ and Node.js 20+ (for manual build) -1. 构建前端静态文件: +1. Build the frontend static files: ```bash git clone https://github.com/komari-monitor/komari-web cd komari-web npm install npm run build ``` -2. 构建后端: +2. Build the backend: ```bash git clone https://github.com/komari-monitor/komari cd komari ``` - 将步骤1中生成的静态文件复制到 `komari` 项目根目录下的 `/public/dist` 文件夹。 + Copy the static files generated in step 1 to the `/public/dist` folder in the root of the `komari` project. ```bash go build -o komari ``` -4. 运行: +4. Run: ```bash ./komari server -l 0.0.0.0:25774 ``` - 默认监听 `25774` 端口,访问 `http://localhost:25774`。 + The default listening port is `25774`. Access `http://localhost:25774`. -## 前端开发指南 -[Komari 主题开发指南 | Komari](https://komari-document.pages.dev/dev/theme.html) +## Frontend Development Guide +[Komari Theme Development Guide | Komari](https://komari-document.pages.dev/dev/theme.html) -[在 Crowdin 上翻译 Komari](https://crowdin.com/project/komari/invite?h=cd051bf172c9a9f7f1360e87ffb521692507706) +[Translate Komari on Crowdin](https://crowdin.com/project/komari/invite?h=cd051bf172c9a9f7f1360e87ffb521692507706) -## 客户端 Agent 开发指南 -[Komari Agent 信息上报与事件处理文档](https://komari-document.pages.dev/dev/agent.html) +## Client Agent Development Guide +[Komari Agent Information Reporting and Event Handling Documentation](https://komari-document.pages.dev/dev/agent.html) -## 贡献 -欢迎提交 Issue 或 Pull Request! +## Contributing +Issues and Pull Requests are welcome! -## 鸣谢 +## Acknowledgements - [DreamCloud - 极高性价比解锁直连亚太高防](https://as211392.com/) - - 感谢我自己能这么闲 - - 提交PR、制作主题的各位开发者 + - Thanks to myself for being so idle + - All the developers who submitted PRs and created themes ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=komari-monitor/komari&type=Date)](https://www.star-history.com/#komari-monitor/komari&Date) + diff --git a/docs/README_ja.md b/docs/README_ja.md new file mode 100644 index 0000000..2b377c7 --- /dev/null +++ b/docs/README_ja.md @@ -0,0 +1,115 @@ + +# Komari +![Badge](https://hitscounter.dev/api/hit?url=https%3A%2F%2Fgithub.com%2Fkomari-monitor%2Fkomari&label=&icon=github&color=%23a370f7&message=&style=flat&tz=UTC) + +![komari](https://socialify.git.ci/komari-monitor/komari/image?description=1&font=Inter&forks=1&issues=1&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fkomari-monitor%2Fkomari-web%2Fd54ce1288df41ead08aa19f8700186e68028a889%2Fpublic%2Ffavicon.png&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Auto) + +Komariは、サーバーのパフォーマンスを監視するためのシンプルで効率的なソリューションを提供することを目的とした、軽量の自己ホスト型サーバー監視ツールです。Webインターフェースを介してサーバーのステータスを表示し、軽量エージェントを介してデータを収集します。 + +[ドキュメント](https://komari-document.pages.dev/) | [Telegramグループ](https://t.me/komari_monitor) + +## 特徴 +- **軽量で効率的**: リソース消費が少なく、あらゆる規模のサーバーに適しています。 +- **自己ホスト型**: データプライバシーを完全に制御でき、展開も簡単です。 +- **Webインターフェース**: 直感的な監視ダッシュボードで、使いやすいです。 + +## クイックスタート + +### 0. クラウドホスティングによるワンクリック展開 +- Rainyun - CNY 4.5/月 + +[![](https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg)](https://app.rainyun.com/apps/rca/store/6780/NzYxNzAz_) + +- Claw Run - USD 1.5/月 + +[![](https://raw.githubusercontent.com/ClawCloud/Run-Template/refs/heads/main/Run-on-ClawCloud.svg)](https://template.run.claw.cloud/?openapp=system-fastdeploy%3FtemplateName%3Dkomari) + +### 1. ワンクリックインストールスクリプトを使用する +systemdを使用するディストリビューション(Ubuntu、Debianなど)に適しています。 +```bash +curl -fsSL https://raw.githubusercontent.com/komari-monitor/komari/main/install-komari.sh -o install-komari.sh +chmod +x install-komari.sh +sudo ./install-komari.sh +``` + +### 2. Docker展開 +1. データディレクトリを作成します: + ```bash + mkdir -p ./data + ``` +2. Dockerコンテナを実行します: + ```bash + docker run -d \ + -p 25774:25774 \ + -v $(pwd)/data:/app/data \ + --name komari \ + ghcr.io/komari-monitor/komari:latest + ``` +3. デフォルトのユーザー名とパスワードを表示します: + ```bash + docker logs komari + ``` +4. ブラウザで `http://:25774` にアクセスします。 + +> [!NOTE] +> 環境変数 `ADMIN_USERNAME` と `ADMIN_PASSWORD` を使用して、初期のユーザー名とパスワードをカスタマイズすることもできます。 + +### 3. バイナリファイル展開 +1. Komariの[GitHubリリース](https://github.com/komari-monitor/komari/releases)ページにアクセスして、お使いのオペレーティングシステム用の最新のバイナリをダウンロードします。 +2. Komariを実行します: + ```bash + ./komari server -l 0.0.0.0:25774 + ``` +3. ブラウザで `http://:25774` にアクセスします。デフォルトのポートは `25774` です。 +4. デフォルトのユーザー名とパスワードは、起動ログで確認するか、環境変数 `ADMIN_USERNAME` と `ADMIN_PASSWORD` を介して設定できます。 + +> [!NOTE] +> バイナリに実行権限があることを確認してください(`chmod +x komari`)。データは実行ディレクトリの `data` フォルダに保存されます。 + + +### 手動ビルド + +#### 依存関係 + +- Go 1.18+ および Node.js 20+(手動ビルド用) + +1. フロントエンドの静的ファイルをビルドします: + ```bash + git clone https://github.com/komari-monitor/komari-web + cd komari-web + npm install + npm run build + ``` +2. バックエンドをビルドします: + ```bash + git clone https://github.com/komari-monitor/komari + cd komari + ``` + ステップ1で生成された静的ファイルを `komari` プロジェクトのルートにある `/public/dist` フォルダにコピーします。 + ```bash + go build -o komari + ``` +4. 実行: + ```bash + ./komari server -l 0.0.0.0:25774 + ``` + デフォルトのリスニングポートは `25774` です。`http://localhost:25774` にアクセスします。 + +## フロントエンド開発ガイド +[Komariテーマ開発ガイド | Komari](https://komari-document.pages.dev/dev/theme.html) + +[CrowdinでKomariを翻訳する](https://crowdin.com/project/komari/invite?h=cd051bf172c9a9f7f1360e87ffb521692507706) + +## クライアントエージェント開発ガイド +[Komariエージェント情報レポートおよびイベント処理ドキュメント](https://komari-document.pages.dev/dev/agent.html) + +## 貢献 +IssueやPull Requestを歓迎します! + +## 謝辞 + - こんなに暇でいられる自分に感謝 + - PRを提出し、テーマを作成してくれたすべての開発者 + +## Star履歴 + +[![Star History Chart](https://api.star-history.com/svg?repos=komari-monitor/komari&type=Date)](https://www.star-history.com/#komari-monitor/komari&Date) diff --git a/docs/README_zh-TW.md b/docs/README_zh-TW.md new file mode 100644 index 0000000..ffaf43b --- /dev/null +++ b/docs/README_zh-TW.md @@ -0,0 +1,118 @@ + +# Komari +![Badge](https://hitscounter.dev/api/hit?url=https%3A%2F%2Fgithub.com%2Fkomari-monitor%2Fkomari&label=&icon=github&color=%23a370f7&message=&style=flat&tz=UTC) + +![komari](https://socialify.git.ci/komari-monitor/komari/image?description=1&font=Inter&forks=1&issues=1&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fkomari-monitor%2Fkomari-web%2Fd54ce1288df41ead08aa19f8700186e68028a889%2Fpublic%2Ffavicon.png&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Auto) + +Komari 是一款輕量級的自託管伺服器監控工具,旨在提供簡單、高效的伺服器性能監控解決方案。它支援透過 Web 介面查看伺服器狀態,並透過輕量級 Agent 收集數據。 + +[文檔](https://komari-document.pages.dev/) | [Telegram 群組](https://t.me/komari_monitor) + +## 特性 +- **輕量高效**:低資源佔用,適合各種規模的伺服器。 +- **自託管**:完全掌控數據隱私,部署簡單。 +- **Web 介面**:直觀的監控儀表盤,易於使用。 + +## 快速開始 + +### 0. 容器雲一鍵部署 + +- 雨雲雲應用 - CNY 4.5/月 + +[![](https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg)](https://app.rainyun.com/apps/rca/store/6780/NzYxNzAz_) + +- Claw Run - USD 1.5/月 + +[![](https://raw.githubusercontent.com/ClawCloud/Run-Template/refs/heads/main/Run-on-ClawCloud.svg)](https://template.run.claw.cloud/?openapp=system-fastdeploy%3FtemplateName%3Dkomari) + +### 1. 使用一鍵安裝腳本 +適用於使用了 systemd 的發行版(Ubuntu、Debian...)。 +```bash +curl -fsSL https://raw.githubusercontent.com/komari-monitor/komari/main/install-komari.sh -o install-komari.sh +chmod +x install-komari.sh +sudo ./install-komari.sh +``` + +### 2. Docker 部署 +1. 建立資料目錄: + ```bash + mkdir -p ./data + ``` +2. 執行 Docker 容器: + ```bash + docker run -d \ + -p 25774:25774 \ + -v $(pwd)/data:/app/data \ + --name komari \ + ghcr.io/komari-monitor/komari:latest + ``` +3. 查看預設帳號和密碼: + ```bash + docker logs komari + ``` +4. 在瀏覽器中存取 `http://:25774`。 + +> [!NOTE] +> 你也可以透過環境變數 `ADMIN_USERNAME` 和 `ADMIN_PASSWORD` 自訂初始使用者名稱和密碼。 + +### 3. 二進位檔案部署 +1. 存取 Komari 的 [GitHub Release 頁面](https://github.com/komari-monitor/komari/releases) 下載適用於你作業系統的最新二進位檔案。 +2. 執行 Komari: + ```bash + ./komari server -l 0.0.0.0:25774 + ``` +3. 在瀏覽器中存取 `http://:25774`,預設監聽 `25774` 連接埠。 +4. 預設帳號和密碼可在啟動日誌中查看,或透過環境變數 `ADMIN_USERNAME` 和 `ADMIN_PASSWORD` 設定。 + +> [!NOTE] +> 確保二進位檔案具有可執行權限(`chmod +x komari`)。資料將保存在執行目錄下的 `data` 資料夾中。 + + +### 手工建置 + +#### 依賴 + +- Go 1.18+ 和 Node.js 20+(手工建置) + +1. 建置前端靜態檔案: + ```bash + git clone https://github.com/komari-monitor/komari-web + cd komari-web + npm install + npm run build + ``` +2. 建置後端: + ```bash + git clone https://github.com/komari-monitor/komari + cd komari + ``` + 將步驟1中產生的靜態檔案複製到 `komari` 專案根目錄下的 `/public/dist` 資料夾。 + ```bash + go build -o komari + ``` +4. 執行: + ```bash + ./komari server -l 0.0.0.0:25774 + ``` + 預設監聽 `25774` 連接埠,存取 `http://localhost:25774`。 + +## 前端開發指南 +[Komari 主題開發指南 | Komari](https://komari-document.pages.dev/dev/theme.html) + +[在 Crowdin 上翻譯 Komari](https://crowdin.com/project/komari/invite?h=cd051bf172c9a9f7f1360e87ffb521692507706) + +## 客戶端 Agent 開發指南 +[Komari Agent 資訊上報與事件處理文檔](https://komari-document.pages.dev/dev/agent.html) + +## 貢獻 +歡迎提交 Issue 或 Pull Request! + +## 鳴謝 + - [DreamCloud - 极高性价比解锁直连亚太高防](https://as211392.com/) + - 感謝我自己能這麼閒 + - 提交PR、製作主題的各位開發者 + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=komari-monitor/komari&type=Date)](https://www.star-history.com/#komari-monitor/komari&Date) + diff --git a/docs/README_zh.md b/docs/README_zh.md new file mode 100644 index 0000000..a36ef3f --- /dev/null +++ b/docs/README_zh.md @@ -0,0 +1,117 @@ + +# Komari +![Badge](https://hitscounter.dev/api/hit?url=https%3A%2F%2Fgithub.com%2Fkomari-monitor%2Fkomari&label=&icon=github&color=%23a370f7&message=&style=flat&tz=UTC) + +![komari](https://socialify.git.ci/komari-monitor/komari/image?description=1&font=Inter&forks=1&issues=1&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fkomari-monitor%2Fkomari-web%2Fd54ce1288df41ead08aa19f8700186e68028a889%2Fpublic%2Ffavicon.png&name=1&owner=1&pattern=Plus&pulls=1&stargazers=1&theme=Auto) + +Komari 是一款轻量级的自托管服务器监控工具,旨在提供简单、高效的服务器性能监控解决方案。它支持通过 Web 界面查看服务器状态,并通过轻量级 Agent 收集数据。 + +[文档](https://komari-document.pages.dev/) | [Telegram 群组](https://t.me/komari_monitor) + +## 特性 +- **轻量高效**:低资源占用,适合各种规模的服务器。 +- **自托管**:完全掌控数据隐私,部署简单。 +- **Web 界面**:直观的监控仪表盘,易于使用。 + +## 快速开始 + +### 0. 容器云一键部署 + +- 雨云云应用 - CNY 4.5/月 + +[![](https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg)](https://app.rainyun.com/apps/rca/store/6780/NzYxNzAz_) + +- Claw Run - USD 1.5/月 + +[![](https://raw.githubusercontent.com/ClawCloud/Run-Template/refs/heads/main/Run-on-ClawCloud.svg)](https://template.run.claw.cloud/?openapp=system-fastdeploy%3FtemplateName%3Dkomari) + +### 1. 使用一键安装脚本 +适用于使用了 systemd 的发行版(Ubuntu、Debian...)。 +```bash +curl -fsSL https://raw.githubusercontent.com/komari-monitor/komari/main/install-komari.sh -o install-komari.sh +chmod +x install-komari.sh +sudo ./install-komari.sh +``` + +### 2. Docker 部署 +1. 创建数据目录: + ```bash + mkdir -p ./data + ``` +2. 运行 Docker 容器: + ```bash + docker run -d \ + -p 25774:25774 \ + -v $(pwd)/data:/app/data \ + --name komari \ + ghcr.io/komari-monitor/komari:latest + ``` +3. 查看默认账号和密码: + ```bash + docker logs komari + ``` +4. 在浏览器中访问 `http://:25774`。 + +> [!NOTE] +> 你也可以通过环境变量 `ADMIN_USERNAME` 和 `ADMIN_PASSWORD` 自定义初始用户名和密码。 + +### 3. 二进制文件部署 +1. 访问 Komari 的 [GitHub Release 页面](https://github.com/komari-monitor/komari/releases) 下载适用于你操作系统的最新二进制文件。 +2. 运行 Komari: + ```bash + ./komari server -l 0.0.0.0:25774 + ``` +3. 在浏览器中访问 `http://:25774`,默认监听 `25774` 端口。 +4. 默认账号和密码可在启动日志中查看,或通过环境变量 `ADMIN_USERNAME` 和 `ADMIN_PASSWORD` 设置。 + +> [!NOTE] +> 确保二进制文件具有可执行权限(`chmod +x komari`)。数据将保存在运行目录下的 `data` 文件夹中。 + + +### 手工构建 + +#### 依赖 + +- Go 1.18+ 和 Node.js 20+(手工构建) + +1. 构建前端静态文件: + ```bash + git clone https://github.com/komari-monitor/komari-web + cd komari-web + npm install + npm run build + ``` +2. 构建后端: + ```bash + git clone https://github.com/komari-monitor/komari + cd komari + ``` + 将步骤1中生成的静态文件复制到 `komari` 项目根目录下的 `/public/dist` 文件夹。 + ```bash + go build -o komari + ``` +4. 运行: + ```bash + ./komari server -l 0.0.0.0:25774 + ``` + 默认监听 `25774` 端口,访问 `http://localhost:25774`。 + +## 前端开发指南 +[Komari 主题开发指南 | Komari](https://komari-document.pages.dev/dev/theme.html) + +[在 Crowdin 上翻译 Komari](https://crowdin.com/project/komari/invite?h=cd051bf172c9a9f7f1360e87ffb521692507706) + +## 客户端 Agent 开发指南 +[Komari Agent 信息上报与事件处理文档](https://komari-document.pages.dev/dev/agent.html) + +## 贡献 +欢迎提交 Issue 或 Pull Request! + +## 鸣谢 + - [DreamCloud - 极高性价比解锁直连亚太高防](https://as211392.com/) + - 感谢我自己能这么闲 + - 提交PR、制作主题的各位开发者 + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=komari-monitor/komari&type=Date)](https://www.star-history.com/#komari-monitor/komari&Date)