50 lines
2.5 KiB
Markdown
50 lines
2.5 KiB
Markdown
# protomask
|
|
[](https://github.com/ewpratten/protomask/releases/latest)
|
|
[](https://github.com/ewpratten/protomask/actions/workflows/build.yml)
|
|
[](https://github.com/ewpratten/protomask/actions/workflows/audit.yml)
|
|
|
|
**A user space [NAT64](https://en.wikipedia.org/wiki/NAT64) implementation.**
|
|
|
|
This repository contains:
|
|
|
|
- `protomask`: The main NAT64 daemon
|
|
- [](https://crates.io/crates/protomask)
|
|
- `protomask-clat`: A Customer-side transLATor (CLAT) implementation
|
|
- [](https://crates.io/crates/protomask)
|
|
- `easy-tun`: A minimal TUN interface library
|
|
- [](https://crates.io/crates/easy-tun) [](https://docs.rs/easy-tun)
|
|
- `fast-nat`: A library designed for highly efficient mapping and lookup of IP address pairs
|
|
- [](https://crates.io/crates/fast-nat) [](https://docs.rs/fast-nat)
|
|
- `interproto`: A library for translating packets between protocols
|
|
- [](https://crates.io/crates/interproto) [](https://docs.rs/interproto)
|
|
- `rfc6052`: A Rust implementation of RFC6052
|
|
- [](https://crates.io/crates/rfc6052) [](https://docs.rs/rfc6052)
|
|
- `rtnl`: A high-level wrapper around `rtnetlink`
|
|
- [](https://crates.io/crates/rtnl) [](https://docs.rs/rtnl)
|
|
|
|
For user-oriented documentation, see the [protomask website](https://protomask.ewpratten.com).
|
|
|
|
## Installation
|
|
|
|
Protomask can be installed using various methods:
|
|
|
|
### Debian
|
|
|
|
Head over to the [releases](https://github.com/ewpratten/protomask/releases) page and download the latest release for your architecture.
|
|
|
|
Then, install with:
|
|
|
|
```sh
|
|
apt install /path/to/protomask_<version>_<arch>.deb
|
|
|
|
# You can also edit the config file in /etc/protomask.toml
|
|
# And once ready, start protomask with
|
|
systemctl start protomask
|
|
```
|
|
|
|
### Using Cargo
|
|
|
|
```bash
|
|
cargo install protomask
|
|
```
|