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

Updating documentation with docker informations

Browse Source
This commit is contained in:
Grégoire Compagnon
2022-10-06 13:20:58 +02:00
parent 9e7a75947c
commit 20ea26a1de
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -33,13 +33,16 @@ For effortless visualization of the RouterOS metrics exported to Prometheus, MKT
## Install: ## Install:
- from [PyPI](https://pypi.org/project/mktxp/): `❯ pip install mktxp` - from [PyPI](https://pypi.org/project/mktxp/): `❯ pip install mktxp`
- latest from source repository: `❯ pip install git+https://github.com/akpw/mktxp` - 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`
## Getting started ## Getting started
After installing MKTXP, you need to edit its main configuration file. The easiest way to do it is via running: After installing MKTXP, you need to edit its main configuration file. Theeasiest way to do it is via running:
```
❯ mktxp edit
(for Docker, just replace `mktxp` with `docker run -v mktxp:/home/mktxp/mktxp/ -it --rm ghcr.io/akpw/mktxp:latest`)
```bash
❯ mktxp edit
``` ```
This opens the config file in your default system editor. \ This opens the config file in your default system editor. \