Update website deployment system
This commit is contained in:
parent
ffa8864788
commit
3b5a5fd181
16
.github/workflows/docs.yml
vendored
16
.github/workflows/docs.yml
vendored
@ -32,17 +32,17 @@ jobs:
|
|||||||
- name: Build Book
|
- name: Build Book
|
||||||
run: mdbook build
|
run: mdbook build
|
||||||
|
|
||||||
- name: Build Website
|
- name: Build rustdoc
|
||||||
uses: shalzz/zola-deploy-action@v0.17.2
|
uses: actions-rs/cargo@v1
|
||||||
env:
|
with:
|
||||||
BUILD_DIR: ./docs/website
|
command: doc
|
||||||
BUILD_ONLY: true
|
args: --no-deps --workspace --document-private-items
|
||||||
|
|
||||||
- name: Combine Book and Website
|
- name: Combine Book and rustdoc
|
||||||
run: mkdir -p /tmp/combined && cp -rv docs/website/public/* /tmp/combined && cp -rv target/book/ /tmp/combined/book
|
run: mkdir -p /tmp/combined && cp -rv target/book/ /tmp/combined/book && cp -rv target/doc/ /tmp/combined/rustdoc-master
|
||||||
|
|
||||||
- name: Write CNAME file
|
- name: Write CNAME file
|
||||||
run: echo "protomask.ewpratten.com" > /tmp/combined/CNAME
|
run: echo "docs.protomask.ewpratten.com" > /tmp/combined/CNAME
|
||||||
|
|
||||||
- name: Upload artifact
|
- name: Upload artifact
|
||||||
uses: actions/upload-pages-artifact@v2
|
uses: actions/upload-pages-artifact@v2
|
||||||
|
|||||||
@ -1,4 +1,5 @@
|
|||||||
{
|
{
|
||||||
"MD033": false,
|
"MD033": false,
|
||||||
"MD013": false
|
"MD013": false,
|
||||||
|
"MD022": false
|
||||||
}
|
}
|
||||||
9
.vscode/settings.json
vendored
9
.vscode/settings.json
vendored
@ -11,5 +11,14 @@
|
|||||||
"editor.tabSize": 2,
|
"editor.tabSize": 2,
|
||||||
"editor.autoIndent": "advanced",
|
"editor.autoIndent": "advanced",
|
||||||
"diffEditor.ignoreTrimWhitespace": false
|
"diffEditor.ignoreTrimWhitespace": false
|
||||||
|
},
|
||||||
|
"files.associations": {
|
||||||
|
"*.json.liquid": "json",
|
||||||
|
"*.yaml.liquid": "yaml",
|
||||||
|
"*.md.liquid": "markdown",
|
||||||
|
"*.js.liquid": "liquid-javascript",
|
||||||
|
"*.css.liquid": "liquid-css",
|
||||||
|
"*.scss.liquid": "liquid-scss",
|
||||||
|
"docs/website/_redirects": "plaintext"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
1
docs/website/.gitignore
vendored
1
docs/website/.gitignore
vendored
@ -1 +0,0 @@
|
|||||||
/public
|
|
||||||
3
docs/website/_redirects
Normal file
3
docs/website/_redirects
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
/ https://github.com/ewpratten/protomask 302
|
||||||
|
/book https://docs.protomask.ewpratten.com/book
|
||||||
|
/rustdoc https://docs.protomask.ewpratten.com/rustdoc-master
|
||||||
@ -1,8 +0,0 @@
|
|||||||
base_url = "https://protomask.ewpratten.com"
|
|
||||||
compile_sass = true
|
|
||||||
build_search_index = true
|
|
||||||
|
|
||||||
[markdown]
|
|
||||||
highlight_code = true
|
|
||||||
|
|
||||||
[extra]
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
---
|
|
||||||
title: Protomask
|
|
||||||
---
|
|
||||||
|
|
||||||
## What is protomask?
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## The protomask tool suite
|
|
||||||
|
|
||||||
To accomplish the various translation needs of an IPv6-only or dual-stack ISP, the protomask tool suite includes a few tools:
|
|
||||||
|
|
||||||
- **`protomask`**: The main NAT64 daemon
|
|
||||||
- Translates IPv6 packets using *RFC6052 IPv4-Embedded IPv6 Addressing* to native IPv4 traffic
|
|
||||||
- Can handle high volumes of traffic from multiple clients simultaneously
|
|
||||||
- **`protomask-clat`**: A Customer-side transLATor (CLAT) implementation
|
|
||||||
- Intended to be deployed at the customer edge to pass IPv4 traffic over an IPv6-only ISP's network
|
|
||||||
|
|
||||||
Every tool in the protomask suite is easy to deploy and configure, plus supports optionally exposing Prometheus metrics for remote monitoring.
|
|
||||||
|
|
||||||
## The protomask library suite
|
|
||||||
|
|
||||||
The development of protomask necessitated the creation of a few specialized software libraries. Since the technology developed for protomask is useful outside of the scope of this project, these libraries are also available for general use:
|
|
||||||
|
|
||||||
- **`easy-tun`**: A minimal TUN interface library
|
|
||||||
- **`fast-nat`**: A library designed for highly efficient mapping and lookup of IP address pairs
|
|
||||||
- **`interproto`**: The heart of protomask, a library for translating many types of packets between layer 3 protocols
|
|
||||||
- **`rfc6052`**: A Rust implementation of RFC6052
|
|
||||||
- **`rtnl`**: A high-level wrapper around `rtnetlink`
|
|
||||||
|
|
||||||
## Want to learn more?
|
|
||||||
|
|
||||||
Check out the [documentation](/book) for a deeper dive into protomask, or head over to the [GitHub repository](https://github.com/ewpratten/protomask) to see the source code.
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
.container {
|
|
||||||
max-width: 1000px !important;
|
|
||||||
|
|
||||||
h2 {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@media screen and (max-width: 405px) {
|
|
||||||
.navbar-brand{
|
|
||||||
display:none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#hero-title {
|
|
||||||
font-size:5em;
|
|
||||||
|
|
||||||
@media screen and (max-width: 420px) {
|
|
||||||
font-size: 3em;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,45 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8">
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
||||||
<title>{% block title %}{% endblock title %}</title>
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="/main.css">
|
|
||||||
|
|
||||||
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.1/dist/css/bootstrap.min.css" rel="stylesheet"
|
|
||||||
integrity="sha384-4bw+/aepP/YC94hEpVNVgiZdgIC5+VKNBQNGCHeKRQN+PtmoHDEXuppvnDJzQIu9" crossorigin="anonymous">
|
|
||||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/all.min.css"
|
|
||||||
integrity="sha512-z3gLpd7yknf1YoNbCzqRKc4qyor8gaKU1qmn+CShxbuBusANI9QpRohGBreCFkKxLhei6S9CQXFEbbKuqLg0DA=="
|
|
||||||
crossorigin="anonymous" referrerpolicy="no-referrer" />
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<nav class="navbar navbar-expand-lg bg-body-tertiary">
|
|
||||||
<div class="container">
|
|
||||||
<a class="navbar-brand" href="/">Protomask</a>
|
|
||||||
<div class="navbar-nav ml-auto" style="flex-direction: row;">
|
|
||||||
<a class="nav-link active" style="padding:8px" aria-current="page" href="/book"><i class="fa-solid fa-book"></i> Documentation</a>
|
|
||||||
<a class="nav-link active" style="padding:8px" aria-current="page" href="https://github.com/ewpratten/protomask" target="_blank">
|
|
||||||
<i class="fa-brands fa-github"></i>
|
|
||||||
Source Code
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
{% block content %}{% endblock content %}
|
|
||||||
|
|
||||||
<br>
|
|
||||||
<hr>
|
|
||||||
<p style="text-align:center">Protomask is a project by <a href="https://ewpratten.com">Evan Pratten</a></p>
|
|
||||||
|
|
||||||
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.1/dist/js/bootstrap.bundle.min.js"
|
|
||||||
integrity="sha384-HwwvtgBNo3bZJJLYd8oVXjrBZt8cqVSpeBNS5n7C8IVInixGAoxmnlMuBnhbgrkm"
|
|
||||||
crossorigin="anonymous"></script>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</html>
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
{% extends "base.html" %}
|
|
||||||
|
|
||||||
{% block title %}{{section.title}}{% endblock title %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<div style="background-color:lightgray;width:100%;height:20vh;display:flex;justify-content:center;align-items:center;">
|
|
||||||
<div style="text-align:center;">
|
|
||||||
<h1 id="hero-title" style="font-weight:bold;padding:0;margin:0;">Protomask</h1>
|
|
||||||
<span style="font-size: 1.25em;">Fast & reliable user space NAT64</span>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<br>
|
|
||||||
|
|
||||||
<div class="container">
|
|
||||||
{{section.content|safe}}
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{% endblock content %}
|
|
||||||
Loading…
x
Reference in New Issue
Block a user