From 7f87412c74a039be9861d18d859b2b83a0d6dfda Mon Sep 17 00:00:00 2001 From: Arseniy Kuznetsov Date: Wed, 19 Oct 2022 16:10:53 +0100 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93dd1a7..15678a1 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,25 @@ ![License](https://img.shields.io/badge/prometheus-exporter-blueviolet) ## Description -MKTXP-Monitor is an out-of-the-box dockerized monitoring stack for [MKTXP Exporter](https://github.com/akpw/mktxp). This is mostly a complimentary project to get people up & running with mktxp, though it does add some extra capabilitis such as Mikrotik router log monitoring, etc. +MKTXP-Monitor is an out-of-the-box dockerized monitoring stack for [MKTXP Exporter](https://github.com/akpw/mktxp). This is mostly to get people up & running with [mktxp](https://github.com/akpw/mktxp) and have your Mikrotik routers monitored with least amount of configuration, though this project also adds some extra capabilitis such an [Loki](https://grafana.com/docs/loki/latest/?tech=target&pg=oss-loki&plcmt=quick-links&cta=A)-based Mikrotik log processing, etc. #### 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 +``` + + - From that directory, run docker-compose: +``` +cd mktxp-monitor-main +docker-compose -f ./docker-compose-mktxp.yml up -d +``` + +- Give the containers some time to start up, and point your Web browser to Grafana at http://localhost:3000/