KevinMidboe/mktxp-no-cli
1
0
Fork 0
mirror of https://github.com/KevinMidboe/mktxp-no-cli.git synced 2025-12-29 05:11:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Arseniy Kuznetsov
2022-10-20 09:04:29 +01:00
committed by GitHub
parent cfa1aa3b36
commit 24c6ec7586
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -42,7 +42,7 @@ There are multiple ways to install this project, from a standalone app to a [ful
## Getting started ## Getting started
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. To get started with MKTXP, you need to edit its main configuration file. This essentially involves adding your Mikrotik devices ip addresses & authentication info, optionally modifying various settings to specific needs.
The default configuration file comes with a sample configuration, making it easy to copy / edit parameters as needed: The default configuration file comes with a sample configuration, making it easy to copy / edit parameters as needed:
``` ```
@@ -90,14 +90,14 @@ Obviously, you can do the same via just open the config file directly:
``` ```
#### Docker image #### Docker image
For Docker instances, the easiest is to use a configered mktxp.conf file from a local installation. \ For Docker instances, one way is to use a configered mktxp.conf file from a local installation. \
You can also create a standalone one in a dedicated folder: You can also create a standalone one in a dedicated folder:
``` ```
mkdir mktxp mkdir mktxp
cd mktxp cd mktxp
nano mktxp.conf # copy & edit sample entry(ies) from above nano mktxp.conf # copy & edit sample entry(ies) from above
``` ```
Now you mount this folder and run your docker instance with: Now you can mount this folder and run your docker instance with:
``` ```
❯ docker run -v ./mktxp:/home/mktxp/mktxp/ -it --rm ghcr.io/akpw/mktxp:latest ❯ docker run -v ./mktxp:/home/mktxp/mktxp/ -it --rm ghcr.io/akpw/mktxp:latest
``` ```