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>
31 lines
846 B
Protocol Buffer Text Format
31 lines
846 B
Protocol Buffer Text Format
# Quick start: Ferrix and a test peer on one host, over loopback.
|
|
router_id: "192.0.2.1"
|
|
local_asn: 64500
|
|
|
|
# A port above 1023, so that no privileges are required.
|
|
listen_endpoints { address: "127.0.0.1" port: 1790 }
|
|
|
|
peers {
|
|
name: "test-peer"
|
|
endpoint { address: "127.0.0.1" port: 1791 }
|
|
remote_asn: 65001
|
|
import {
|
|
max_prefixes: 1000
|
|
# The test peer advertises documentation prefixes and uses a private
|
|
# AS number. Both are rejected by default.
|
|
accept_bogons: true
|
|
# The test peer connects from 127.0.0.1 and advertises 10.0.0.2 as the
|
|
# next hop.
|
|
accept_third_party_next_hop: true
|
|
}
|
|
}
|
|
|
|
originate { prefix: "198.51.100.0/24" }
|
|
originate {
|
|
prefix: "2001:db8:100::/48"
|
|
communities: "64500:100"
|
|
}
|
|
|
|
# Status page, HTTP API, and metrics. Not authenticated.
|
|
http_endpoint { address: "127.0.0.1" port: 8080 }
|