44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
|
|
|
|
|
|
|
|
|
|
## Description
|
|
MKTXP-Stack is a dockerized monitoring stack for [MKTXP Exporter](https://github.com/akpw/mktxp).
|
|
|
|
As an out-of-the-box solution, it let's you quickly get up & running with [MKTXP](https://github.com/akpw/mktxp), [Prometheus](https://prometheus.io/), and [Grafana](https://grafana.com/) and have your Mikrotik RouterOS devices monitored with least amount of configuration.
|
|
|
|
While complementary to [MKTXP](https://github.com/akpw/mktxp), this project also adds some extra capabilitis such an Mikrotik log processing based on [syslog-ng](https://www.syslog-ng.com/) & [Loki](https://grafana.com/docs/loki/latest).
|
|
|
|
|
|
## Requirements:
|
|
[Docker](https://docs.docker.com/get-docker/)\
|
|
[Docker Compose](https://docs.docker.com/compose/install/)
|
|
|
|
|
|
## Install:
|
|
- Download the code from this repository and extract it into a directory:
|
|
```
|
|
wget https://github.com/akpw/mktxp-stack/archive/main.zip
|
|
unzip main.zip
|
|
cd mktxp-stack-main
|
|
```
|
|
|
|
- Configure mktxp as described in [MKTXP Getting Started](https://github.com/akpw/mktxp#getting-started):\
|
|
a) edit the main mktxp config file, adding your Mikrotik device ip address & authentication info to provided sample entry:
|
|
```
|
|
nano mktxp/mktxp.conf
|
|
```
|
|
|
|
b) if needed, [add a dedicated API user](https://github.com/akpw/mktxp#mikrotik-device-config) from the mktxp config to your RouterOS device:
|
|
```
|
|
/user group add name=mktxp_group policy=api,read
|
|
/user add name=mktxp_user group=mktxp_group password=mktxp_user_password
|
|
```
|
|
|
|
- Now run docker-compose, give the containers some time to start up, and point your Web browser to [Grafana](http://localhost:3000)
|
|
```
|
|
docker-compose -f ./docker-compose-mktxp.yml up -d
|
|
```
|
|
|