KevinMidboe/mktxp-no-cli
1
0
Fork 0
mirror of https://github.com/KevinMidboe/mktxp-no-cli.git synced 2025-10-29 17:50:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Arseniy Kuznetsov
2022-10-20 08:55:21 +01:00
committed by GitHub
parent 90bf16d9bd
commit 9bd49da3b2
1 changed files with 30 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -35,26 +35,15 @@ For effortless visualization of the RouterOS metrics exported to Prometheus, MKT
- latest from source repository: `❯ pip install git+https://github.com/akpw/mktxp`
- from [Docker](https://github.com/akpw/mktxp/pkgs/container/mktxp) : `❯ docker pull ghcr.io/akpw/mktxp:latest`
- from [Docker image](https://github.com/akpw/mktxp/pkgs/container/mktxp) : `❯ docker pull ghcr.io/akpw/mktxp:latest`
- download a full dockerized [mktxp monitoring stack](https://github.com/akpw/mktxp-stack)
## Getting started
After installing MKTXP, you need to edit its main configuration file. You can do it directly from mktxp via running:
```bash
❯ mktxp edit
```
This opens the config file in your default system editor. \
In case you prefer a different editor, just run the ```edit``` command with its optional `-ed` parameter. \
For example, to explicitly open the MKTXP config in nano:
```
❯ mktxp edit -ed nano
```
The configuration file comes with a sample configuration, making it easy to copy / edit parameters as needed:
To get started with MKXP, you need to edit its main configuration file. This essentially involves adding your Mikrotik devices ip addresses & authentication info, optionally modifying various MKTXP settings to specific needs.
The default configuration file comes with a sample configuration, making it easy to copy / edit parameters as needed:
```
[Sample-Router]
enabled = False # turns metrics collection for this RouterOS device on / off
@@ -84,12 +73,36 @@ The configuration file comes with a sample configuration, making it easy to copy
use_comments_over_names = False # when available, forces using comments over the interfaces names
```
#### Local install
If you have a local MKTXP installation, you can edit this file with your default system editor directly from mktxp:
```bash
❯ mktxp edit
```
In case you prefer a different editor, run the ```edit``` command with its optional `-ed` parameter:
```
❯ mktxp edit -ed nano
```
Obviously, you can do the same via just open the config file directly:
```
❯ nano ~/mktxp/mktxp.conf
For Docker instances, just mount your mktxp config files:
```
#### Docker image
For Docker instances, the easiest is to use a configered mktxp.conf file from a local installation. \
You can also create a standalone one in a dedicated folder:
```
mkdir mktxp
cd mktxp
nano mktxp.conf # copy & edit sample entry(ies) from above
```
Now you mount this folder and run your docker instance with:
```
❯ docker run -v ./mktxp:/home/mktxp/mktxp/ -it --rm ghcr.io/akpw/mktxp:latest
```
#### MKTXP stack install
## Mikrotik Device Config
For the purpose of RouterOS device monitoring, it's best to create a dedicated user with minimal required permissions. \