<a id="reference"></a>

# Reference

Technical specifications and architectural details for the WireGuard gateway charm, covering the configuration options and actions that operators use to control it, the relation interfaces that connect it to peer gateways and observability tooling, and the internal design that routes encrypted traffic between sites.

## Configuration and operations

Operators drive the charm through its configuration options and actions, and the architecture reference explains how those settings translate into the running WireGuard, BIRD, and Keepalived processes that carry traffic.

* [Configurations](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/configurations/index.html.md#reference-configurations)
* [Actions](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/actions/index.html.md#reference-actions)
* [Charm architecture](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/charm-architecture/index.html.md#reference-charm-architecture)

## Connectivity and monitoring

A gateway becomes useful only once it is peered with other gateways and connected to a monitoring stack. Relation endpoints establish those links, and the charm exposes OSPF and routing metrics once traffic begins to flow.

* [Integrations](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/integrations/index.html.md#reference-integrations)
* [Metrics](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/metrics/index.html.md#reference-metrics)
