Docs

Documentation

Pick the path that matches your intent. Start with the card that describes the job you are trying to do, then follow the links inside that path.

Start

Get Ze running

Guides that take you from a blank shell to a working setup.

Quickstart two BGP peers talking in under five minutes Install Ze daemon install or bootable appliance Build on Ubuntu compile, install, create zefs, set up SSH Configuration the YANG model behind Ze config CLI commands diff, commit, history, and operator commands CLI tour interactive, one-shot, pipes, and runtime control Lifecycle and rollback reload, restart, archive, update, and recover

Operate

Do a specific job

Task-oriented guides for protocol setup, access services, migration, and diagnostics.

ExaBGP migration convert an existing config and process scripts SSH and RBAC local users, profiles, and operator access RADIUS operator login authenticate SSH, web, and MCP users safely FlowSpec route reflector reflect FlowSpec routes to iBGP clients FlowSpec protected router turn FlowSpec into nftables protection DDoS mitigation detect floods and respond locally or upstream Anomaly detection baseline source behaviour and respond shadow-first Looking glass publish read-only BGP visibility Firewall and policy routing protect and steer traffic OSPF, IS-IS, and static routes bring routing protocols online MPLS label switching with LDP and RSVP-TE SRv6 segment routing over IPv6 and SID programming Traffic control shape, queue, and prioritise egress traffic PPPoE and L2TP access concentration paths Native IPsec configure IKEv2 initiator and responder tunnels Monitoring and diagnostics flow export, MRT, and production checks Debugging tools trace netlink, capture packets, and inspect state BGP peering groups, families, capabilities, and verification BGP policy import, export, validation, and redistribution BGP resilience refresh, GR, persistence, reflection, and multipath Fleet Management hub, managed clients, cached config, and reconnect

Automate

Use and extend every surface

Management transports, browser and public interfaces, and the plugin SDK.

REST and gRPC authentication, commands, config sessions, and streaming gNMI Capabilities, Get, Set, Subscribe, TLS, and metrics Web interface workbench, editing, commands, and live updates Looking Glass routes, topology, Birdwatcher API, and security MCP tools, resources, authentication, and remote access Plugin development SDK, protocol, YANG, handlers, commands, and testing

Reference

Look up generated facts

Information-oriented pages generated from live data where possible.

Features capabilities by category and maturity RFC status implemented RFCs, partial support, and remaining gaps CLI reference all generated commands in one place Configuration reference the whole config as a searchable tree Dependencies direct Go packages and why they exist

Design

Understand the system

Explanation pages for architecture, comparisons, performance, labs, and deployment shapes.

Architecture engine, config, plugins, and operator surfaces Route selection how Ze picks the best path, step by step Compare Ze against BIRD, FRR, GoBGP, and others Performance measured BGP benchmarks and methodology VPP deployment reference startup.conf, NIC, LCP, and notes Labs and usage examples interop proof and deployment shapes Chaos testing deterministic faults, properties, replay, and shrink IXP route server member policy, validation, and replay checks Transit edge with RPKI dual transit, origin validation, and failover FlowSpec injection authorised, atomic, and reversible route control

Community

Keep up and contribute

Project context for people deciding whether to try Ze or help shape it.

Why Ze what makes Ze different and who it is for Roadmap the path to the first release Changes what shipped, week by week Blog longer notes behind the work FAQ answers before you commit time Contribute code, bug reports, and interop results Developer setup build, test, and debug the Ze source tree RFC implementation guide how a new RFC gets built and proven Documentation testing keep docs honest with tested command output Project history how ExaBGP's programmable model grew into Ze Glossary BGP, policy, configuration, operator, and testing terms Contributor testing choose the right proof layer and run it locally