From 0eab85aebbe6ca0c81384d1c5ad848d16b2bcd3f Mon Sep 17 00:00:00 2001 From: Evan Pratten Date: Thu, 3 Aug 2023 23:18:12 -0400 Subject: [PATCH] Working on the book --- book.toml | 4 +++- docs/book/SUMMARY.md | 9 ++++++++- docs/book/binaries/protomask-clat.md | 1 + docs/book/binaries/protomask.md | 1 + docs/book/chapter_1.md | 1 - docs/book/introduction.md | 11 +++++++++++ docs/book/libraries.md | 11 +++++++++++ 7 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 docs/book/binaries/protomask-clat.md create mode 100644 docs/book/binaries/protomask.md delete mode 100644 docs/book/chapter_1.md create mode 100644 docs/book/introduction.md create mode 100644 docs/book/libraries.md diff --git a/book.toml b/book.toml index 9c648e5..7e3db90 100644 --- a/book.toml +++ b/book.toml @@ -13,4 +13,6 @@ build-dir = "target/book" create-missing = true [output.html] -mathjax-support = true \ No newline at end of file +mathjax-support = true +git-repository-url = "https://github.com/ewpratten/protomask" +site-url = "/book/" \ No newline at end of file diff --git a/docs/book/SUMMARY.md b/docs/book/SUMMARY.md index 7390c82..80f7df5 100644 --- a/docs/book/SUMMARY.md +++ b/docs/book/SUMMARY.md @@ -1,3 +1,10 @@ # Summary -- [Chapter 1](./chapter_1.md) +- [Introduction](./introduction.md) +- [Libraries](./libraries.md) + +# User Guides + +- [Using `protomask`](./binaries/protomask.md) +- [Using `protomask-clat`](./binaries/protomask-clat.md) + diff --git a/docs/book/binaries/protomask-clat.md b/docs/book/binaries/protomask-clat.md new file mode 100644 index 0000000..85a0123 --- /dev/null +++ b/docs/book/binaries/protomask-clat.md @@ -0,0 +1 @@ +# `protomask-clat` User Guide diff --git a/docs/book/binaries/protomask.md b/docs/book/binaries/protomask.md new file mode 100644 index 0000000..34749b4 --- /dev/null +++ b/docs/book/binaries/protomask.md @@ -0,0 +1 @@ +# `protomask` User Guide diff --git a/docs/book/chapter_1.md b/docs/book/chapter_1.md deleted file mode 100644 index b743fda..0000000 --- a/docs/book/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/docs/book/introduction.md b/docs/book/introduction.md new file mode 100644 index 0000000..c6820ff --- /dev/null +++ b/docs/book/introduction.md @@ -0,0 +1,11 @@ +# Introduction + +Protomask is a user space [NAT64](https://en.wikipedia.org/wiki/NAT64) implementation geared towards networks that need fast and reliable inter-protocol packet translation. Behind the scenes, protomask uses the [Universal TUN/TAP Device Driver](https://docs.kernel.org/networking/tuntap.html) to translate incoming packets from IPv4 to IPv6 and vice-versa. + +For an overview of the project, see the [website](https://protomask.ewpratten.com) or [GitHub repository](https://github.com/ewpratten/protomask). + +## Table of Contents + +- [Protomask library suite documentation](./libraries.html) +- [Using `protomask`](./binaries/protomask.html) +- [Using `protomask-clat`](./binaries/protomask-clat.html) diff --git a/docs/book/libraries.md b/docs/book/libraries.md new file mode 100644 index 0000000..fa697ca --- /dev/null +++ b/docs/book/libraries.md @@ -0,0 +1,11 @@ +# Libraries + +The protomask library suite is a collection of libraries that were originally developed for use in the protomask tool suite, but are also quite useful outside of the scope of this project. + +These libraries are thoroughly documented in their respective docs.rs crate pages: + +- [`easy-tun`: A minimal TUN interface library](https://docs.rs/easy-tun) +- [`fast-nat`: A library designed for highly efficient mapping and lookup of IP address pairs](https://docs.rs/fast-nat) +- [`interproto`: A library for translating packets between protocols](https://docs.rs/interproto) +- [`rfc6052`: A Rust implementation of RFC6052](https://docs.rs/rfc6052) +- [`rtnl`: A high-level wrapper around `rtnetlink`](https://docs.rs/rtnl) \ No newline at end of file