Guides
Guides
Use these pages to install Ze, configure a network role, operate the system, and diagnose problems. Feature pages explain what Ze can do. Guides explain how to do it.
To test Ze with an AI coding agent, start with Use Ze with an AI agent: ze create agent skill sets up Claude Code or Codex with the guide your installed ze serves.
Start and install
- Quickstart: run two local BGP peers and verify a received route.
- Install Ze: install the daemon or provision an appliance.
- Build and install on Ubuntu: compile, install, initialize the store, and start SSH.
- Docker: build the image, keep state across recreation, and manage it with Compose.
- VM and gokrazy appliance: build and boot a disk image or installer ISO.
- containerlab and netlab: run the supplied topology with the lab image.
- CLI tour: use interactive, one-shot, pipe, and runtime commands.
- Configuration: understand the hierarchical configuration format.
- Lifecycle and rollback: reload, restart, archive, update, and recover.
Routing
- BGP peering: configure peers, groups, families, and capabilities.
- BGP policy: build import, export, validation, and redistribution policy.
- BGP resilience: configure refresh, graceful restart, persistence, reflection, and multipath.
- OSPF, IS-IS, and static routes: bring routing protocols online.
- BFD: configure fast failure detection.
- MPLS and RSVP-TE: configure label switching and traffic engineering.
Services and security
- Firewall and policy routing: protect and steer traffic.
- FlowSpec protected router: translate FlowSpec into local protection.
- DDoS mitigation: detect floods and respond locally or upstream.
- PPPoE, L2TP, and IPsec: configure access and tunnel services.
- Authentication, authorization, RADIUS, and TACACS+: secure operator access.
Interfaces and automation
- Use Ze with an AI agent: set up Claude Code, Codex, OpenCode or Pi with
ze create agent skill. - REST and gRPC: use authenticated management APIs.
- gNMI: use Capabilities, Get, Set, and Subscribe.
- Web interface: edit configuration and run commands in the browser.
- MCP: connect tools, resources, and remote clients.
- Fleet configuration: distribute configuration to managed nodes.
Diagnose and recover
- System readiness: run offline doctor checks and inspect runtime health.
- Production diagnostics: start from symptoms and debug safely.
- Monitoring: configure flow export, MRT, and operational checks.
- Debugging tools: trace netlink, capture packets, and inspect state.
- Logging and audit: inspect operational and security history.
Use site search for a specific protocol, command, or configuration leaf.