EchoMix

Wed, 05 Mar 2025 16:03:14 -0800

Quickstart guide

Table of Contents

Systemd commands
Server CLI commands
Management interface
Monitoring

This topic provides collects basic commands for installed Katzenpost server components in a single convenient place. All system commands require superuser privileges.

The commands in this topic do not apply to the Katzenpost Docker image, which has its own controls. For more information, see Using the Katzenpost Docker test network.

Wed, 05 Mar 2025 16:03:38 -0800

Installing Katzenpost

Table of Contents

Requirements

Obtain the Katzenpost code
Install the latest Go version

Build server components

Build clients

Install the server components

Create service accounts

Create configuration files

Configure systemd

Generate keys

The section provides an overview of how to download Katzenpost, set up a development environment, build the code, install the Katzenpost binaries, and configure the components.

Wed, 05 Mar 2025 16:03:43 -0800

Using the Katzenpost Docker test network

Table of Contents

Requirements

Preparing to run the container image

Operating the test mixnet

Starting and monitoring the mixnet
Testing the mixnet
Shutting down the mixnet
Uninstalling and cleaning up

Network topology and components

The Docker file tree

Katzenpost provides a ready-to-deploy Docker image for developers who need a non-production test environment for developing and testing client applications and server side plugins. By running this image on a single computer, you avoid the need to build and manage a complex multi-node mix net. The image can also be run using Podman

Wed, 05 Mar 2025 16:03:29 -0800

Components and configuration of the Katzenpost mixnet

Table of Contents

Understanding the Katzenpost components

Directory authorities (dirauths)
Mix nodes
Gateway nodes
Service nodes
Clients

Configuring Katzenpost

Configuring directory authorities
Configuring mix nodes
Configuring gateway nodes
Configuring service nodes

This section of the Katzenpost technical documentation provides an introduction to the software components that make up Katzenpost and guidance on how to configure each component. The intended reader is a system administrator who wants to implement a working, production Katzenpost network.

Wed, 05 Mar 2025 16:03:50 -0800

NAT considerations for Katzenpost servers

Table of Contents

Addresses and BindAddresses
Hosting mix, gateway, and service nodes behind NAT
Hosting a directory authority behind NAT

Any Katzenpost server node can be configured to run behind a properly configured router that supports network address translation (NAT) and similar network topologies that traverse public and private network boundaries. This applies to directory authorities, gateways that allow clients to connect to the network, mix nodes, and service nodes that provide protocols over the mix network such as ping and spool services for storing messages or rendezvous information.

Wed, 05 Mar 2025 16:03:25 -0800

Appendix: Configuration files from the Docker test mixnet

Table of Contents

Directory authority
Mix node
Gateway node
Service node

As an aid to administrators 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 Docker test mixnet. These code listings are meant to be used as a reference alongside the detailed configuration documentation in Components and configuration of the Katzenpost mixnet. You cannot use these listings as a drop-in solution in your own mixnets for reasons explained in the Network topology and components section of the Docker test mixnet documentation.