<!-- vale Canonical.007-Headings-sentence-case = NO -->

# WireGuard gateway operator

<!-- vale Canonical.007-Headings-sentence-case = YES -->

A [Juju](https://juju.is/) [charm](https://documentation.ubuntu.com/juju/3.6/reference/charm/) deploying a highly available, high-performance site-to-site VPN based on WireGuard.

Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For the Charmed WireGuard gateway, this includes:

* Automatic WireGuard key exchange and interface management
* Automatic route management and fault tolerance using OSPF on BIRD
* Virtual redundant routing using VRRP on Keepalived

This charm will make operating highly available, high-performance site-to-site VPN simple and straightforward for DevOps or SRE teams through Juju’s clean interface.

## In this documentation

|                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Get started**   | [Deploy and peer two gateways](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/tutorial/index.html.md#tutorial-index)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| **Operations**    | [Enable VRRP](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/enable-vrrp/index.html.md#how-to-enable-vrrp) | [Tune performance on multi-core CPUs](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/performance-tuning/index.html.md#how-to-performance-tuning) | [Set up a site-to-site VPN](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/setup-site-to-site-vpn/index.html.md#how-to-setup-site-to-site-vpn) | [Back up and restore](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/back-up-restore/index.html.md#how-to-back-up-restore) | [Actions](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/actions/index.html.md#reference-actions) | [Configurations](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/configurations/index.html.md#reference-configurations) | [Upgrade](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/upgrade/index.html.md#how-to-upgrade) |
| **Observability** | [Integrate with COS](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/integrate-with-cos/index.html.md#how-to-integrate-with-cos) | [Metrics](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/metrics/index.html.md#reference-metrics)                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **Design**        | [Charm architecture](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/charm-architecture/index.html.md#reference-charm-architecture) | [WireGuard router peering](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/integrations/index.html.md#reference-integrations)                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **Security**      | [Overview](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/explanation/security/index.html.md#explanation-security)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

## How this documentation is organized

This documentation uses the
[Diátaxis documentation structure](https://diataxis.fr/).

* The [Tutorial](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/tutorial/index.html.md#tutorial-index) takes you step-by-step through deploying and peering two WireGuard gateway charms.
* The [How-to guides](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/index.html.md#how-to) cover practical tasks for integrating, maintaining, and upgrading your WireGuard gateway deployment.
* [Reference](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/reference/index.html.md#reference) provides technical details on the charm’s actions, configurations, integrations, metrics, and architecture.
* [Explanation](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/explanation/index.html.md#explanation) includes context and discussion of key topics, such as security.

## Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach
to the documentation as the code. As such, we welcome community contributions, suggestions, and
constructive feedback on our documentation.
See [How to contribute](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/contribute/index.html.md#how-to-contribute) for more information.

If there’s a particular area of documentation that you’d like to see that’s missing, please
[file a bug](https://github.com/canonical/wireguard-gateway-operator/issues).

## Project and community

The WireGuard gateway operator is a member of the Ubuntu family.
It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

- [Code of conduct](https://ubuntu.com/community/code-of-conduct)
- [Get support](https://discourse.charmhub.io/)
- [Contribute](https://canonical.com/juju/docs/wireguard-gateway-charm/latest/how-to/contribute/index.html.md#how-to-contribute)
- [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)

Thinking about using the WireGuard gateway operator for your next project?
[Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!
