Documentation

Everything written about Ze, organised by what you are trying to do. If you are new, start at the top and work down. If you already know Ze, jump straight to the reference.

Start here

Learning-oriented pages that take you from nothing to a working setup.

• Quickstart: two BGP peers talking in under five minutes.
• Install Ze: the daemon on an existing Linux box, or a bootable appliance.
• Configuration: the one YANG model that describes everything Ze does.
• CLI commands: the SSH CLI, with diff, commit, and history.

How-to guides

Task-oriented pages for when you have a specific job to get done and already know your way around.

• Migrating from ExaBGP: convert an ExaBGP config and run existing process scripts.
• Firewall and policy routing.
• OSPF, IS-IS, and static routes.
• PPPoE and L2TP access concentration.
• Flow export, monitoring, and MRT analysis.
• AS112, TACACS+, and the audit trail.
• VPP dataplane, benchmarking, and production diagnostics.

The command reference lists every CLI command in one place.

Reference

Information-oriented pages you look things up in. Accurate, complete, and generated from the running system where possible, not written by hand.

• Features: every capability, colour-coded by category and marked by status.
• CLI reference: all 350 commands, generated from the live binary.
• Configuration reference: the whole config as one searchable tree, from live YANG.
• Dependencies: every direct Go package and why it is there.

Understand the design

Explanation-oriented pages for when you want to know why Ze is built the way it is, not just how to use it.

• Architecture: how the engine, config model, plugins, and operator surfaces fit together.
• Compare: how Ze stacks up against BIRD, FRR, GoBGP, and others, including where it is still behind.
• Performance: measured BGP benchmarks, with the method, not marketing numbers.
• Labs: interop proof you can run yourself against real FRR, BIRD, strongSwan, and more.

Keep up and get involved

• Roadmap: the path to the first release.
• Changes: what shipped, week by week.
• Blog: the longer story behind each week's work.
• FAQ: the questions people ask before they commit time to Ze.
• Contribute: how the project takes code, bug reports, and interop results.