46 lines
2.4 KiB
Markdown
46 lines
2.4 KiB
Markdown
# `protomask`: Fast & reliable user space NAT64
|
|
[](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)
|
|
|
|
|
|
For user-oriented documentation, see the [protomask website](https://protomask.ewpratten.com).
|
|
|
|
## Table of Contents
|
|
|
|
| Crate | Info |
|
|
| -- | -- |
|
|
| [`protomask`](./src/protomask.rs) | [](https://crates.io/crates/protomask) |
|
|
| [`protomask-clat`](./src/protomask-clat.rs) | [](https://crates.io/crates/protomask) |
|
|
| [`easy-tun`](./libs/easy-tun/) | [](https://crates.io/crates/easy-tun) [](https://docs.rs/easy-tun) |
|
|
| [`fast-nat`](./libs/fast-nat/) | [](https://crates.io/crates/fast-nat) [](https://docs.rs/fast-nat) |
|
|
| [`interproto`](./libs/interproto/) | [](https://crates.io/crates/interproto) [](https://docs.rs/interproto) |
|
|
| [`rfc6052`](./libs/rfc6052/) | [](https://crates.io/crates/rfc6052) [](https://docs.rs/rfc6052) |
|
|
| [`rtnl`](./libs/rtnl/) | [](https://crates.io/crates/rtnl) [](https://docs.rs/rtnl) |
|
|
|
|
|
|
|
|
## 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
|
|
```
|