Komari

简体中文 | 繁體中文 | 日本語

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.

[!WARNING] Komari is a self-hosted monitoring and control program intended only for systems you own or are authorized to administer. Do not weaponize Komari, deploy it without consent, or use it for unauthorized access, persistence, command execution, or other abusive activity. For context on real-world abuse risks, see Huntress' analysis: Komari C2 agent abuse. Users are solely responsible for how they deploy and operate Komari. The developers do not accept responsibility for unauthorized or abusive use, or for any resulting consequences. On Windows, when remote control is enabled, the client displays a Windows notification at each user login to remind the user that Komari is remote control software.

Documentation | 文档(镜像站 By Geekertao) | Telegram Group

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.

Quick Start

0. One-click Deployment with Cloud Hosting

• Rainyun - CNY 4.5/month

• 1Panel App Store

Available on 1Panel App Store. Install via App Store > Utilities > Komari.

1. Use the One-click Install Script

Suitable for distributions using systemd (Ubuntu, Debian...).

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 Deployment

1. Create a data directory:

   mkdir -p ./data
   

2. Run the Docker container:

   docker run -d \
     -p 25774:25774 \
     -v $(pwd)/data:/app/data \
     --name komari \
     ghcr.io/komari-monitor/komari:latest
   

3. View the default username and password:

   docker logs komari
   

4. Access http://<your_server_ip>:25774 in your browser.

[!NOTE] You can also customize the initial username and password through the environment variables ADMIN_USERNAME and ADMIN_PASSWORD.

3. Binary File Deployment

1. Visit Komari's GitHub Release page to download the latest binary for your operating system.
2. Run Komari:

   ./komari server -l 0.0.0.0:25774
   

3. Access http://<your_server_ip>: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] 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+ and Node.js 20+ (for manual build)

1. Build the frontend static files:

   git clone https://github.com/komari-monitor/komari-web
   cd komari-web
   npm install
   npm run build
   

2. Build the backend:

   git clone https://github.com/komari-monitor/komari
   cd komari
   

   Copy the static files generated in step 1 to the /web/public/defaultTheme/dist folder in the root of the komari project, and copy komari-theme.json + preview.png/perview.png to /web/public/defaultTheme.

   go build -o komari
   

3. Run:

   ./komari server -l 0.0.0.0:25774
   

   The default listening port is 25774. Access http://localhost:25774.

Frontend Development Guide

Komari Theme Development Guide | Komari

Client Agent Development Guide

Komari Agent Information Reporting and Event Handling Documentation

Contributing

Issues and Pull Requests are welcome!

Acknowledgements

破碎工坊云

破碎工坊云 - 专业云计算服务平台，提供高效、稳定、安全的高防服务器与CDN解决方案

DreamCloud

DreamCloud - 极高性价比解锁直连亚太高防

🚀 Sponsored by SharonNetworks

SharonNetworks 为您的业务起飞保驾护航！

亚太数据中心提供顶级的中国优化网络接入 · 低延时&高带宽&提供Tbps级本地清洗高防服务, 为您的业务保驾护航, 为您的客户提供极致体验. 加入社区 Telegram群组 可参与公益募捐或群内抽奖免费使用

The open source software community

All the developers who submitted PRs and created themes

Star History