adnix-rs/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

37 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2023-10-29 23:10:11 +05:30
# adnix-rs [![Version info](https://img.shields.io/crates/v/adnix.svg)](https://crates.io/crates/adnix) [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/) [![Built with Garnix](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fgarnix.io%2Fapi%2Fbadges%2Fmsfjarvis%2Fadnix-rs%3Fbranch%3Dmain)](https://garnix.io)
Rust reimplementation of [sniner/adnix](https://github.com/sniner/adnix) for educational purposes.
## Installation
adnix is available on [crates.io](https://crates.io/crates/adnix) and you can install it through cargo.
```shell
cargo install adnix
```
## Usage
```shell
USAGE:
adnix [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-f, --formatter <STRING> Formatter [default: dnsmasq] [possible values: dnsmasq, dnsmasq-server, unbound]
--address <ADDRESS> IPv4 address [default: 127.0.0.1]
--v6address <ADDRESS> IPv6 address [default: ::1]
-o, --output <OUTPUT> Output file
-s, --sources_file <STRING> File to read "name|source url" mappings from
```
Sample sources file for use with adnix.
```
Yoyo|http://pgl.yoyo.org/adservers/serverlist.php?hostformat=hosts&showintro=0&mimetype=plaintext
Malware Domain List|http://www.malwaredomainlist.com/hostslist/hosts.txt
```