The documentation moves from READMEs into a site in docs/: getting started, a user guide, operations, a reference, and development pages, written in the style of network vendors' documentation (docs/STYLE.md). bin/bgp/README.md and docs/RFCs.md are folded into it. - A theme of its own in the International Typographic Style, in blues, with self-hosted Inter and JetBrains Mono, search over Zola's index, dark mode, and no resources loaded from other hosts. - Example configurations in docs/examples/, shown on the pages and checked with `bgp --check` in CI. - A test that fails when a field of config.proto is missing from the configuration reference. - A CI job that builds the site; Zola fails on broken links and anchors. - A hardened systemd unit, tried under systemd with kernel routes on. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
18 lines
644 B
Markdown
18 lines
644 B
Markdown
# bgp
|
|
|
|
The daemon: the BGP speaker, the RTR client, the kernel route installer and
|
|
the status page, in one binary.
|
|
|
|
```
|
|
cargo run -p bgp -- --check docs/examples/quick-start.textpb
|
|
cargo run -p bgp -- docs/examples/quick-start.textpb
|
|
```
|
|
|
|
How to configure, run and operate it is in the documentation, which is
|
|
built from `docs/` (`zola --root docs serve`):
|
|
|
|
- [Quick start](../../docs/content/docs/getting-started/quick-start.md)
|
|
- [Configuration reference](../../docs/content/docs/reference/configuration.md)
|
|
- [Deployment](../../docs/content/docs/operations/deployment.md) and
|
|
[monitoring](../../docs/content/docs/operations/monitoring.md)
|