evan/protomask
1
Fork 0
Code

Add example config

Browse Source
This commit is contained in:
Evan Pratten 2023-07-17 11:28:43 -04:00
parent 9310bd3f14
commit 00c21c2011
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -7,4 +7,20 @@
*Protomask* started as a challenge to create a NAT64 implementation in a weekend. The goal of this implementation is to *keep things simple*. There aren't many knobs to tweak, so if you want to do stateful NAT or source address filtering, put something like `iptables` in front of it.
## Configuration
Protomask uses a [TOML](https://toml.io) configuration file. Here is a functional example:
```toml
[Interface]
# A list of IPv4 prefixes to map traffic to
Pool = ["44.31.119.0/24"]
# The IPv6 prefix to listen for traffic on (should generally be the well-known 64:ff9b::/96 prefix)
Prefix = "64:ff9b::/96"
[Rules]
# A static mapping of IPv4 and IPv6 addresses
# These addresses will be exclusively reserved, and not used in the general pool
MapStatic = [{ v4 = "192.0.2.2", v6 = "2001:db8:1::2" }]
```