Files
dat-thang/libcess/docs/cesspool-bootstrap.1
T

28 lines
962 B
Groff
Raw Normal View History

2026-10-19 00:12:36 -04:00
.TH CESSPOOL-BOOTSTRAP 1
.SH NAME
cesspool-bootstrap \- run a Cesspool discovery node
.SH SYNOPSIS
.B cesspool-bootstrap
[ B--bind R IPv4] [ B--port R UDP-PORT] [ B--advertise R HOST:PORT] [ B--state-dir R DIR]
.SH DESCRIPTION
Runs the Cesspool UDP bootstrap and rendezvous service in the foreground.
It helps clients discover peers and does not relay chat or archive payloads.
The persistent Ed25519 node identity is stored in the state directory.
.PP
The listening UDP port must be reachable from clients. Configure firewall and
router forwarding as needed. No public-IP lookup is performed; use
.B --advertise
to print the endpoint that clients should configure.
.SH OPTIONS
.TP
.B --bind IPv4
Local IPv4 address to bind; defaults to 0.0.0.0.
.TP
.B --port UDP-PORT
UDP port to listen on; defaults to 3282.
.TP
.B --advertise HOST:PORT
Document the externally reachable endpoint for client configuration.
.TP
.B --state-dir DIR
Persistent identity directory.