tarampampam/mikrotik-hosts-parser

Application for generating ADBlock script for MikroTik routers, based on Lumen framework

, _(*1)

MikroTik hosts parser

![Coverage][badge_coverage] ![Image size][badge_size_latest] , _(*2)

This application provides HTTP server, that can generate script for RouterOS-based routers for blocking "AD" hosts using 3rd party host-lists (available by HTTP):, _(*3)

## Limit: 5000
## Cache lifetime: 30m0s
## Format: routeros
## Redirect to: 127.0.0.1
## Sources list:
##  - <https://adaway.org/hosts.txt>
##  - <https://www.malwaredomainlist.com/hostslist/hosts.txt>
## Excluded hosts:
##  - broadcasthost
##  - ip6-allhosts
##  - ip6-allnodes
##  - ip6-allrouters
## Cache HIT for <https://adaway.org/hosts.txt> (expires after 25m55s)
## Cache miss for <https://www.malwaredomainlist.com/hostslist/hosts.txt>

/ip dns static
add address=127.0.0.1 comment="ADBlock" disabled=no name="1-1ads.com"
add address=127.0.0.1 comment="ADBlock" disabled=no name="101com.com"
add address=127.0.0.1 comment="ADBlock" disabled=no name="101order.com"
add address=127.0.0.1 comment="ADBlock" disabled=no name="123freeavatars.com"

# ...

Hosts file format (example):, _(*4)

# Any comments
127.0.0.1   1-1ads.com
127.0.0.1   101com.com 101order.com
0.0.0.0     123freeavatars.com

All what you need is:, _(*5)

• Start current application HTTP server
• Make an HTTP request to the script generator endpoint /script/source?sources_urls=... with all required parameters (like records limit, hosts file URLs, exclusion list and others)
• Generated script source execute on your RouterOS-based hardware

More information can be found here., _(*6)

Previous version (PHP) can be found in php-version branch., _(*7)

Installing

Download latest binary file for your os/arch from releases page or use our docker image (ghcr.io). Also you may need in configuration file ./configs/config.yml and ./web directory content for web UI access., _(*8)

Usage

This application supports next sub-commands:, _(*9)

And global flags:, _(*10)

HTTP server starting

serve sub-command allows to use next flags:, _(*11)

Environment variables have higher priority then flag values., _(*12)

Server starting command example:, _(*13)

$ ./mikrotik-hosts-parser serve \
    --config ./configs/config.yml \
    --listen 0.0.0.0 \
    --port 8080 \
    --resources-dir ./web

This command will start HTTP server using configuration from ./configs/config.yml on TCP port 8080 and use directory ./web for serving static files. Configuration file well-documented, so, feel free to change any settings on your choice!, _(*14)

Configuration file allows you to use environment variables with default values (used library)!, _(*15)

After that you can navigate your browser to http://127.0.0.1:8080/ and you will see something like that:, _(*16)

, _(*17)

Special endpoint /script/source?sources_urls=... generates RouterOS-based script using passed http-get parameters (watch examples on index page)., _(*18)

Using docker

, _(*19)

All supported image tags can be found here and here., _(*20)

Just execute in your terminal:, _(*21)

$ docker run --rm -p 8080:8080/tcp tarampampam/mikrotik-hosts-parser:X.X.X

Where X.X.X is image tag (application version)., _(*22)

Demo

I can't guarantee that this links will available forever, but you can use this application by the following links:, _(*23)

• https://stopad.cgood.ru/

Testing

For application testing and building we use built-in golang testing feature and docker-ce + docker-compose as develop environment. So, just write into your terminal after repository cloning:, _(*24)

$ make test

Or build the binary file:, _(*25)

$ make build

Releasing

New versions publishing is very simple - just make required changes in this repository, update changelog file and "publish" new release using repo releases page., _(*26)

Binary files and docker images will be build and published automatically., _(*27)

New release will overwrite the latest docker image tag in both registers., _(*28)

Changes log

![Release date][badge_release_date] , _(*29)

Changes log can be found here., _(*30)

Support

![Issues][badge_issues] , _(*31)

If you will find any package errors, please, make an issue in current repository., _(*32)

License

This is open-sourced software licensed under the MIT License., _(*33)