![License](https://img.shields.io/badge/License-GNU%20GPL-blue.svg)
![Language](https://img.shields.io/badge/docker-%230db7ed.svg)
![License](https://img.shields.io/badge/mikrotik-routeros-orange)
![License](https://img.shields.io/badge/prometheus-exporter-blueviolet)

## 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-monitor/archive/main.zip
unzip main.zip
cd mktxp-monitor-main
```

- Configure mktxp as described in [MKTXP Getting Started](https://github.com/akpw/mktxp#getting-started):\
  a) edit the main mktxp config file:
  ```
  nano mktxp/mktxp.conf
  ```

  b) [add a dedicated API user](https://github.com/akpw/mktxp#mikrotik-device-config) to your router:
  ```
  /user group add name=mktxp_group policy=api,read
  /user add name=mktxp_user group=mktxp_group password=mktxp_user_password
  ```

 - Run docker-compose, give the containers some time to start up, and then point your Web browser to [Grafana](http://localhost:3000)
```
docker-compose -f ./docker-compose-mktxp.yml up -d
```