Skip to content

Commit a94a5fd

Browse files
committed
Update readme
1 parent 9ed606b commit a94a5fd

1 file changed

Lines changed: 59 additions & 2 deletions

File tree

README.md

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,59 @@
1-
# munin-node
2-
Munin node with some basic plugins written in PHP.
1+
<p align="center">
2+
<img src="https://bloatless.org/img/logo.svg" width="60px" height="80px">
3+
</p>
4+
5+
<h1 align="center">Bloatless Munin Node</h1>
6+
7+
<p align="center">Bloatless Munin Node is a simple port of munin-node and some basic plugins to PHP.</p>
8+
9+
## Features
10+
11+
This application provides a basic [munin-node](http://munin-monitoring.org/) supporting the following commands:
12+
13+
* list
14+
* fetch
15+
* config
16+
* version
17+
18+
It includes the following plugins by default:
19+
20+
* Cpu (Cpu usage)
21+
* Df (Disc usage)
22+
* If_ (Network interface traffic)
23+
* Load (Load average)
24+
* Memory (Memory usage)
25+
* Uptime
26+
27+
All plugins are ports from the original munin-node versions to PHP. Additional plugins can be added easily.
28+
29+
## Documentation
30+
31+
### Requirements
32+
33+
* PHP >= 7.2
34+
* Linux operating system
35+
* Read access to system files like `/proc/stat` or `/proc/loadavg`
36+
37+
### Installation
38+
39+
1. Clone/Download this repository to your server.
40+
2. Run `php munin.php` from the munin-node root folder.
41+
42+
### Adjusting configuration
43+
44+
In case you need to adjust the configuration copy the `config/config.default.php` file to
45+
`config/config.php` and adjust it to your requirements. Then kill and restart the munin.php process.
46+
47+
### Additional notes
48+
49+
This application is not meant to be a replacement of the original [munin](http://munin-monitoring.org/). Whenever
50+
possible you should use the original munin software which offers much more plugins and is tested on thousands of
51+
machines.
52+
53+
Nevertheless it is sometimes useful to have a munin-node implemented in PHP. For example when you have
54+
some kind of managed sever where you can not install additional software - but can run PHP scripts. In those
55+
cases it might be a good possibility to fetch some basic statistics from those machines.
56+
57+
## License
58+
59+
The MIT License

0 commit comments

Comments
 (0)