From f511ab5d6daa78ac8e82dacea5c70f3dde9ab91e Mon Sep 17 00:00:00 2001 From: Paul Rock Date: Thu, 23 Aug 2018 18:09:23 +0300 Subject: [PATCH] documentation updated --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 64 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 598bd13..e0aa4bc 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,71 @@ # Mikrotik RouterOS in Docker +This extrasmall image was created for tests purpose only, for example on +this project based unit testing of [routeros-api-php](https://github.com/EvilFreelancer/routeros-api-php) library. + +If you need fully functional "RouterOS in Docker" for production usage +look at [VR Network Lab](https://github.com/plajjan/vrnetlab) project. + ## How to use -Build from `Dockerfile` +### Create your own `Dockerfile` - docker build . --tag ros - docker run -p 2222:22 -p 5900:5900 -ti ros +List of all avainble tags is [here](https://hub.docker.com/r/evilfreelancer/docker-routeros/tags/), +`latest` will be used by default. -Now you can connecto to your RouterOS container via VNC protocol +```dockerfile +FROM evilfreelancer/docker-routeros +ADD ["your-scripts.sh", "/"] +RUN /your-scripts.sh +``` + +### Use image from docker hub + +```bash +docker pull evilfreelancer/docker-routeros +docker run -d -p 22:22 -p 8728:8728 -p 8729:8729 -ti evilfreelancer/docker-routeros +``` + +### Use in docker-compose.yml + +```yml +version: "2" + +services: + + routeros-legacy: + image: evilfreelancer/docker-routeros:6.42 + restart: unless-stopped + ports: + - 12222:22 + - 18728:8728 + - 18729:8729 + + routeros-modern: + image: evilfreelancer/docker-routeros:6.43 + restart: unless-stopped + ports: + - 22222:22 + - 28728:8728 + - 28729:8729 +``` + +### Build from sources + +For this you need download project and build everything from scratch: + +```bash +git clone https://github.com/EvilFreelancer/docker-routeros.git +cd docker-routeros +docker build . --tag ros +docker run -d -p 22222:22 -p 8728:8728 -p 8729:8729 -ti ros +``` + +Now you can connect to your RouterOS container via VNC protocol and via SSH on localhost 2222 port. + +## List of exposed ports + +For access via VNC: 5900 + +Default ports of RouterOS: 21, 22, 23, 80, 443, 8291, 8728, 8729