Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Completed draft of Administrator guide #132

Closed
wants to merge 43 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
86f5f68
Changing client2 to connector and revising the affected spec
jdormansteele Jan 11, 2025
8e2b53d
NAT diagrams ready for review
jdormansteele Jan 13, 2025
f1c7b8c
Misc. drafting
jdormansteele Jan 21, 2025
1626468
Misc. new files
jdormansteele Jan 21, 2025
eb2cba0
Accidental flattening of Components chapter reverted
jdormansteele Jan 21, 2025
774bf53
Drafting
jdormansteele Jan 23, 2025
2f3a6d9
NAT topic ready for review
jdormansteele Jan 23, 2025
9e3c9a9
Fixing image paths
jdormansteele Jan 23, 2025
03eae0d
Spellchecked
jdormansteele Jan 23, 2025
014b456
Consolidating files in Operations chapter
jdormansteele Jan 25, 2025
8ca869d
Fixing errors in the includes
jdormansteele Jan 26, 2025
a12e991
Merge branch 'main' of ssh://github.com/katzenpost/website into alt-site
jdormansteele Jan 26, 2025
b76d21c
Un-commenting the ops content
jdormansteele Jan 27, 2025
ec39ec3
Editing per review
jdormansteele Jan 31, 2025
20eea6e
Adding a test environment for CLI DocBook/XSLT processing
jdormansteele Jan 31, 2025
341ffa3
Merge branch 'alt-site' of ssh://github.com/katzenpost/website into a…
jdormansteele Jan 31, 2025
ab14bb2
Edits per review
jdormansteele Jan 31, 2025
b75865f
Merge branch 'alt-site' of ssh://github.com/katzenpost/website into a…
jdormansteele Jan 31, 2025
d76ed4c
Edits per review
jdormansteele Feb 1, 2025
c04ab48
Revisions per review
jdormansteele Feb 4, 2025
89601ff
Cleaning out incomplete or superseded topics prior to publication
jdormansteele Feb 4, 2025
3af1e94
Merge branch 'alt-site' of ssh://github.com/katzenpost/website into a…
jdormansteele Feb 4, 2025
bb71932
Removing suggestion of NAT piercing
jdormansteele Feb 4, 2025
359dd18
Updating pre-published version
jdormansteele Feb 4, 2025
5f62e14
Merge branch 'alt-site' into alt-site-ops
jdormansteele Feb 4, 2025
88e308d
Adding quickstart
jdormansteele Feb 5, 2025
66be92e
Drafting and breaking up monolithic ops file
jdormansteele Feb 8, 2025
c833783
ng
jdormansteele Feb 22, 2025
6c8fb54
NAT revisions and new diagram
jdormansteele Feb 25, 2025
3e72460
Added NAT section
jdormansteele Feb 25, 2025
27a4429
Revision per review
jdormansteele Feb 25, 2025
a7450c4
Reviewing
jdormansteele Feb 28, 2025
8f709fd
Updated NAT diagrams
jdormansteele Mar 1, 2025
3426867
Revisions per review to NAT topic, ready for final review.
jdormansteele Mar 1, 2025
dbfdc56
Minor revisions
jdormansteele Mar 1, 2025
b0ece64
Updating built files
jdormansteele Mar 1, 2025
7578870
Harmonizing branches
jdormansteele Mar 2, 2025
3cd7912
Reconciling branches
jdormansteele Mar 2, 2025
f0b2e74
Reconciling branches
jdormansteele Mar 2, 2025
dc85fbb
Merge branch 'alt-site' of ssh://github.com/katzenpost/website into a…
jdormansteele Mar 2, 2025
5299014
Quickstart and install drafted, final guide structure applied
jdormansteele Mar 3, 2025
d6d62c6
Restored book and built the big PD
jdormansteele Mar 3, 2025
50935d9
All files updated, ready for review
jdormansteele Mar 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ type: "base"

| | Title | Description | Link(s) |
|------|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| 📖 | **[Admin Guide](/docs/admin_guide)** | Detailed guide for deploying and managing Katzenpost servers, including setting up a local Docker-based mixnet. | [HTML](/docs/admin_guide) / [PDF](/admin_guide/admin_guide.pdf) |
| 📖 | **[Admin Guide](/docs/admin_guide)** | Detailed guide for deploying and managing Katzenpost servers, including setting up a local Docker-based mixnet. | [HTML](/docs/admin_guide) / [PDF](/docs/admin_guide/pdf/admin_guide.pdf) |
| 📖 | **[Design specifications](/docs/specs)** | Documentation of the mixnet design. | [HTML](/docs/specs) |
| 🔒 | **[Threat Model](/docs/threat_model)** | An evolving document defining Katzenpost's security assumptions, attack scenarios, and mitigation strategies. | [HTML](/docs/threat_model) / [PDF](/research/Threat_Model_Doc.pdf) |
| 📚 | **[Literature Review](/research/Literature_overview__website_version.pdf)** | A curated review of academic literature, explaining the theoretical foundations behind Katzenpost's design decisions. | [PDF](/research/Literature_overview__website_version.pdf) |
Expand Down
169 changes: 101 additions & 68 deletions content/en/docs/admin_guide/components.html

Large diffs are not rendered by default.

16 changes: 10 additions & 6 deletions content/en/docs/admin_guide/docker-config-appendix.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
linkTitle: "Appendix: Configuration files from the Docker test mixnet"
description: ""
url: "docs/admin_guide/docker-config-appendix.html"
date: "2025-01-08T12:55:24.703635882-08:00"
date: "2025-03-03T07:34:46.406614058-08:00"
draft: false
slug: ""
layout: ""
type: ""
weight: 70
weight: 25
---
<!DOCTYPE HTML>
<html xmlns:ng="http://docbook.org/docbook-ng">
Expand Down Expand Up @@ -39,10 +39,14 @@ <h1 class="title"><a name="docker-config"></a>Appendix: Configuration files from
</div>
<p>As an aid to adminstrators implementing a Katzenpost mixnet, this appendix provides
lightly edited examples of configuration files for each Katzenpost node type. These
files are drawn from a built instance of the <a class="link" href="#">Docker test
mixnet</a>. These code listings are meant to be used as a reference alongside the
detailed configuration documentation in <a class="link" href="https://katzenpost.network/docs/admin_guide/components.html" target="_top">Components and configuration of the Katzenpost mixnet</a>. You cannot use these
listings as a drop-in solution in your own mixnets for reasons explained in the <a class="link" href="https://katzenpost.network/docs/admin_guide/topology.html" target="_top">Network topology and components</a> section of the Docker test mixnet documentation.</p>
files are
drawn from a built instance of the <a class="link" href="https://katzenpost.network/docs/admin_guide/docker.html" target="_top">Docker test mixnet</a>. These code listings
are meant to be used as a reference alongside the detailed configuration documentation
in <a class="link" href="https://katzenpost.network/docs/admin_guide/components.html" target="_top">Components and configuration of the
Katzenpost mixnet</a>. You cannot use these listings
as a drop-in solution in your own mixnets for reasons explained in the <a class="link" href="https://katzenpost.network/docs/admin_guide/topology.html" target="_top">Network topology and
components</a> section of the Docker test mixnet
documentation.</p>
<div class="section">
<div class="titlepage">
<div>
Expand Down
22 changes: 6 additions & 16 deletions content/en/docs/admin_guide/docker.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
linkTitle: "Docker test network"
description: ""
url: "docs/admin_guide/docker.html"
date: "2025-01-08T12:50:03.505791475-08:00"
date: "2025-03-03T07:34:14.421286991-08:00"
draft: false
slug: ""
layout: ""
type: ""
weight: 20
weight: 15
---
<!DOCTYPE HTML>
<html xmlns:ng="http://docbook.org/docbook-ng">
Expand Down Expand Up @@ -47,7 +47,6 @@ <h1 class="title"><a name="container"></a>Using the Katzenpost Docker test netwo
<dt><span class="section"><a href="#d58e584">The Docker file tree</a></span></dt>
</dl>
</dd>
<dt><span class="section"><a href="#d58e596"></a></span></dt>
</dl>
</div>
<p>Katzenpost provides a ready-to-deploy Docker
Expand Down Expand Up @@ -581,7 +580,7 @@ <h2 class="title" style="clear: both"><a name="topology"></a>Network topology an
gray blocks represent nodes, and the arrows represent information transfer. </p>
<div class="figure"><a name="d58e445"></a><p class="title"><b>Figure&nbsp;1.&nbsp;Test network topology</b></p>
<div class="figure-contents">
<div class="mediaobject"><img src="../../pix/katzenpost-docker.png"></div>
<div class="mediaobject"><img src="pix/katzenpost-docker.png"></div>
</div>
</div><br class="figure-break"><p>On the left, the <span class="bold"><strong>Client</strong></span> transmits a message (shown by
purple arrows) through the <span class="bold"><strong>Gateway node</strong></span>, across three
Expand Down Expand Up @@ -717,17 +716,7 @@ <h3 class="title"><a name="d58e584"></a>The Docker file tree</h3>
as highlighted in the listing. For help in understanding these files and a complete
list of configuration options, follow the links in <span class="guilabel">Table 2: Test mixnet
hosts</span>.</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a name="d58e596"></a></h2>
</div>
</div>
</div>
<pre class="programlisting">katzenpost/docker/voting_mixnet/
<pre class="programlisting">katzenpost/docker/voting_mixnet/
|---<span class="bold"><strong>auth1</strong></span>
|&nbsp;&nbsp; |---<span class="bold"><strong>authority.toml</strong></span>
|&nbsp;&nbsp; |---identity.private.pem
Expand Down Expand Up @@ -816,7 +805,8 @@ <h2 class="title" style="clear: both"><a name="d58e596"></a></h2>
|&nbsp;&nbsp; |---pigeonHole.19.log
|&nbsp;&nbsp; |---proxy.31.log
|---voting_mixnet</pre>
<p>Examples of complete TOML configuration files are provided in <a class="link" href="https://katzenpost.network/docs/admin_guide/docker-config.html" target="_top">Appendix: Configuration files from the Docker test mixnet</a>.</p>
<p>Examples of complete TOML configuration files are provided in <a class="link" href="https://katzenpost.network/docs/admin_guide/docker-config.html" target="_top">Appendix: Configuration files from the Docker test mixnet</a>.</p>
</div>
</div>
</div>
</body>
Expand Down
33 changes: 0 additions & 33 deletions content/en/docs/admin_guide/gensphinx-appendix.html

This file was deleted.

Loading