adnix-rs/docs/index.html

431 lines
23 KiB
HTML

<!DOCTYPE html>
<html lang="en" id="oranda" class="dark">
<head>
<title>adnix</title>
<meta property="og:url" content="https://github.com/msfjarvis/adnix-rs" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Rust binary to generate DNSMasq and Unbound configurations from UNIX host files" />
<meta property="og:description" content="Rust binary to generate DNSMasq and Unbound configurations from UNIX host files" />
<meta property="og:type" content="website" />
<meta property="og:title" content="adnix" />
<meta http-equiv="Permissions-Policy" content="interest-cohort=()" />
<link rel="stylesheet" href="/adnix-rs/oranda-v0.2.0.css" />
</head>
<body>
<div class="container">
<div class="page-body">
<div class="repo_banner">
<a href="https://github.com/msfjarvis/adnix-rs">
<div class="github-icon" aria-hidden="true"></div>
Check out our GitHub!
</a>
</div>
<main>
<header>
<h1 class="title">adnix</h1>
<nav class="nav">
<ul>
<li><a href="/adnix-rs/">Home</a></li>
<li><a href="/adnix-rs/artifacts/">Install</a></li>
</ul>
</nav>
</header>
<div class="artifacts" data-tag="v0.4.6">
<div class="artifact-header target">
<h4>Install v0.4.6</h4>
<div><small class="published-date">Published on Jul 24 2023 at 09:01 UTC</small></div>
<ul class="arches">
<li class="arch hidden" data-arch="aarch64-apple-darwin">
<ul class="tabs">
<li class="install-tab" data-id="0" data-triple="aarch64-apple-darwin">
shell
</li>
<li class="install-tab" data-id="2" data-triple="aarch64-apple-darwin">
tarball
</li>
</ul>
<ul class="contents">
<li data-id="0" data-triple="aarch64-apple-darwin" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">curl</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">proto </span><span style="color:#89ddff;">&#39;</span><span style="color:#c3e88d;">=https</span><span style="color:#89ddff;">&#39; --</span><span style="color:#f78c6c;">tlsv1</span><span style="color:#82aaff;">.2</span><span style="color:#89ddff;"> -</span><span style="color:#f78c6c;">LsSf</span><span style="color:#82aaff;"> https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.sh </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">sh</span></pre>
<button class="button copy-clipboard-button primary" data-copy="curl --proto '=https' --tlsv1.2 -LsSf https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.sh | sh">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/adnix-rs/adnix-installer.sh.txt">Source</a>
</div>
</li>
<li data-id="2" data-triple="aarch64-apple-darwin" class="install-content hidden">
<div class="download-wrapper">
<a href="https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-aarch64-apple-darwin.tar.xz">
<button class="button primary">
<span>Download</span>
<span class="button-subtitle">adnix-aarch64-apple-darwin.tar.xz</span>
</button>
</a>
</div>
</li>
</ul>
</li>
<li class="arch hidden" data-arch="x86_64-apple-darwin">
<ul class="tabs">
<li class="install-tab" data-id="0" data-triple="x86_64-apple-darwin">
shell
</li>
<li class="install-tab" data-id="3" data-triple="x86_64-apple-darwin">
tarball
</li>
</ul>
<ul class="contents">
<li data-id="0" data-triple="x86_64-apple-darwin" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">curl</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">proto </span><span style="color:#89ddff;">&#39;</span><span style="color:#c3e88d;">=https</span><span style="color:#89ddff;">&#39; --</span><span style="color:#f78c6c;">tlsv1</span><span style="color:#82aaff;">.2</span><span style="color:#89ddff;"> -</span><span style="color:#f78c6c;">LsSf</span><span style="color:#82aaff;"> https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.sh </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">sh</span></pre>
<button class="button copy-clipboard-button primary" data-copy="curl --proto '=https' --tlsv1.2 -LsSf https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.sh | sh">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/adnix-rs/adnix-installer.sh.txt">Source</a>
</div>
</li>
<li data-id="3" data-triple="x86_64-apple-darwin" class="install-content hidden">
<div class="download-wrapper">
<a href="https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-x86_64-apple-darwin.tar.xz">
<button class="button primary">
<span>Download</span>
<span class="button-subtitle">adnix-x86_64-apple-darwin.tar.xz</span>
</button>
</a>
</div>
</li>
</ul>
</li>
<li class="arch hidden" data-arch="x86_64-pc-windows-msvc">
<ul class="tabs">
<li class="install-tab" data-id="1" data-triple="x86_64-pc-windows-msvc">
powershell
</li>
<li class="install-tab" data-id="4" data-triple="x86_64-pc-windows-msvc">
zip
</li>
</ul>
<ul class="contents">
<li data-id="1" data-triple="x86_64-pc-windows-msvc" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">irm https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.ps1 </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">iex</span></pre>
<button class="button copy-clipboard-button primary" data-copy="irm https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.ps1 | iex">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/adnix-rs/adnix-installer.ps1.txt">Source</a>
</div>
</li>
<li data-id="4" data-triple="x86_64-pc-windows-msvc" class="install-content hidden">
<div class="download-wrapper">
<a href="https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-x86_64-pc-windows-msvc.zip">
<button class="button primary">
<span>Download</span>
<span class="button-subtitle">adnix-x86_64-pc-windows-msvc.zip</span>
</button>
</a>
</div>
</li>
</ul>
</li>
<li class="arch hidden" data-arch="x86_64-unknown-linux-gnu">
<ul class="tabs">
<li class="install-tab" data-id="0" data-triple="x86_64-unknown-linux-gnu">
shell
</li>
<li class="install-tab" data-id="5" data-triple="x86_64-unknown-linux-gnu">
tarball
</li>
</ul>
<ul class="contents">
<li data-id="0" data-triple="x86_64-unknown-linux-gnu" class="install-content">
<div class="install-code-wrapper">
<pre style="background-color:#263238;">
<span style="color:#82aaff;">curl</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">proto </span><span style="color:#89ddff;">&#39;</span><span style="color:#c3e88d;">=https</span><span style="color:#89ddff;">&#39; --</span><span style="color:#f78c6c;">tlsv1</span><span style="color:#82aaff;">.2</span><span style="color:#89ddff;"> -</span><span style="color:#f78c6c;">LsSf</span><span style="color:#82aaff;"> https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.sh </span><span style="color:#89ddff;">| </span><span style="color:#82aaff;">sh</span></pre>
<button class="button copy-clipboard-button primary" data-copy="curl --proto '=https' --tlsv1.2 -LsSf https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-installer.sh | sh">
<svg stroke='currentColor' fill='currentColor' stroke-width='0' viewBox='0 0 20 20' height='1em' width='1em' xmlns='http://www.w3.org/2000/svg'><path d='M8 2a1 1 0 000 2h2a1 1 0 100-2H8z'></path><path d='M3 5a2 2 0 012-2 3 3 0 003 3h2a3 3 0 003-3 2 2 0 012 2v6h-4.586l1.293-1.293a1 1 0 00-1.414-1.414l-3 3a1 1 0 000 1.414l3 3a1 1 0 001.414-1.414L10.414 13H15v3a2 2 0 01-2 2H5a2 2 0 01-2-2V5zM15 11h2a1 1 0 110 2h-2v-2z'></path></svg>
</button>
<a class="button primary" href="/adnix-rs/adnix-installer.sh.txt">Source</a>
</div>
</li>
<li data-id="5" data-triple="x86_64-unknown-linux-gnu" class="install-content hidden">
<div class="download-wrapper">
<a href="https://github.com/msfjarvis/adnix-rs/releases/download/v0.4.6/adnix-x86_64-unknown-linux-gnu.tar.xz">
<button class="button primary">
<span>Download</span>
<span class="button-subtitle">adnix-x86_64-unknown-linux-gnu.tar.xz</span>
</button>
</a>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="no-autodetect hidden">
<span class="no-autodetect-details">We weren't able to detect your OS.</span>
</div>
<noscript>
<a href="/adnix-rs/artifacts/">View all installation options</a>
</noscript>
<div class="mac-switch hidden">This project doesn't offer Apple Silicon downloads, but you can run Intel macOS binaries via Rosetta 2.</div>
<div class="bottom-options ">
<a href="/adnix-rs/artifacts/" class="backup-download primary">View all installation options</a>
<div class="arch-select hidden">
<select id="install-arch-select">
<option disabled="true" selected="true" value=""></option>
<option value="aarch64-apple-darwin">macOS Apple Silicon</option>
<option value="x86_64-apple-darwin">macOS Intel</option>
<option value="x86_64-pc-windows-msvc">Windows x64</option>
<option value="x86_64-unknown-linux-gnu">Linux x64</option>
</select>
</div>
</div>
</div>
<a href="/adnix-rs/artifacts/" class="button mobile-download primary">View all installation options</a>
<h1>adnix-rs <a href="https://crates.io/crates/adnix" rel="noopener noreferrer"><img src="https://img.shields.io/crates/v/adnix.svg" alt="Version info"></a> <a href="http://unmaintained.tech/" rel="noopener noreferrer"><img src="http://unmaintained.tech/badge.svg" alt="No Maintenance Intended"></a> <a href="https://garnix.io" rel="noopener noreferrer"><img src="https://img.shields.io/static/v1?label=Built%20with&amp;message=Garnix&amp;color=blue&amp;style=flat&amp;logo=nixos&amp;link=https://garnix.io&amp;labelColor=111212" alt="Built with Garnix"></a></h1>
<p>Rust reimplementation of <a href="https://github.com/sniner/adnix" rel="noopener noreferrer">sniner/adnix</a> for educational purposes.</p>
<h2>Installation</h2>
<p>adnix is available on <a href="https://crates.io/crates/adnix" rel="noopener noreferrer">crates.io</a> and you can install it through cargo.</p>
<pre style="background-color:#263238;"><span style="color:#82aaff;">cargo install adnix
</span></pre>
<h2>Usage</h2>
<pre style="background-color:#263238;"><span style="color:#82aaff;">USAGE:
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">adnix </span><span style="font-style:italic;color:#c792ea;">[</span><span style="color:#82aaff;">OPTIONS</span><span style="font-style:italic;color:#c792ea;">]
</span><span style="color:#eeffff;">
</span><span style="color:#82aaff;">FLAGS:
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">-h,</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">help</span><span style="color:#82aaff;"> Prints help information
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">-V,</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">version</span><span style="color:#82aaff;"> Prints version information
</span><span style="color:#eeffff;">
</span><span style="color:#82aaff;">OPTIONS:
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">-f,</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">formatter </span><span style="color:#89ddff;">&lt;</span><span style="color:#82aaff;">STRING</span><span style="color:#89ddff;">&gt;</span><span style="color:#82aaff;"> Formatter </span><span style="font-style:italic;color:#c792ea;">[</span><span style="color:#82aaff;">default: dnsmasq</span><span style="font-style:italic;color:#c792ea;">] [</span><span style="color:#82aaff;">possible values: dnsmasq, dnsmasq</span><span style="color:#89ddff;">-</span><span style="color:#82aaff;">server, unbound</span><span style="font-style:italic;color:#c792ea;">]
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">--address </span><span style="color:#89ddff;">&lt;</span><span style="color:#82aaff;">ADDRESS</span><span style="color:#89ddff;">&gt;</span><span style="color:#82aaff;"> IPv4 address </span><span style="font-style:italic;color:#c792ea;">[</span><span style="color:#82aaff;">default: 127</span><span style="color:#89ddff;">.</span><span style="color:#82aaff;">0</span><span style="color:#89ddff;">.</span><span style="color:#82aaff;">0.1</span><span style="font-style:italic;color:#c792ea;">]
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">--v6address </span><span style="color:#89ddff;">&lt;</span><span style="color:#82aaff;">ADDRESS</span><span style="color:#89ddff;">&gt;</span><span style="color:#82aaff;"> IPv6 address </span><span style="font-style:italic;color:#c792ea;">[</span><span style="color:#82aaff;">default: ::1</span><span style="font-style:italic;color:#c792ea;">]
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">-o,</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">output </span><span style="color:#89ddff;">&lt;</span><span style="color:#82aaff;">OUTPUT</span><span style="color:#89ddff;">&gt;</span><span style="color:#82aaff;"> Output file
</span><span style="color:#eeffff;"> </span><span style="color:#82aaff;">-s,</span><span style="color:#89ddff;"> --</span><span style="color:#f78c6c;">sources_file </span><span style="color:#89ddff;">&lt;</span><span style="color:#82aaff;">STRING</span><span style="color:#89ddff;">&gt;</span><span style="color:#82aaff;"> File to read </span><span style="color:#89ddff;">"</span><span style="color:#c3e88d;">name|source url</span><span style="color:#89ddff;">"</span><span style="color:#82aaff;"> mappings from
</span></pre>
<p>Sample sources file for use with adnix.</p>
<pre style="background-color:#263238;"><span style="color:#eeffff;">Yoyo|http://pgl.yoyo.org/adservers/serverlist.php?hostformat=hosts&amp;showintro=0&amp;mimetype=plaintext
</span><span style="color:#eeffff;">Malware Domain List|http://www.malwaredomainlist.com/hostslist/hosts.txt
</span></pre>
</main>
</div>
<footer>
<a href="https://github.com/msfjarvis/adnix-rs"><div class="github-icon" aria-hidden="true"></div></a>
<span>
adnix, MIT
</span>
</footer>
</div>
<script src="/adnix-rs/artifacts.js"></script>
</body>
</html>