docs/content/getting-started.md
This page explains how to get started with wg-easy. The guide uses Docker Compose as a reference. In our examples, we mount the named volume etc_wireguard to /etc/wireguard inside the container.
Before you can get started with deploying your own VPN, there are some requirements to be met:
There are a few requirements for a suitable host system:
/// note | About the Container Runtime
On the host, you need to have a suitable container runtime (like Docker or Podman) installed. We assume Docker Compose is installed. We have aligned file names and configuration conventions with the latest Docker Compose specification. If you're using podman, make sure to read the related documentation. ///
To understand which tags you should use, read this section carefully. Our CI will automatically build, test and push new images to the following container registry:
ghcr.io/wg-easy/wg-easy)codeberg.org/wg-easy/wg-easy) (IPv6 support)All workflows are using the tagging convention listed below. It is subsequently applied to all images.
| tag | Type | Example | Description |
|---|---|---|---|
15 | latest minor for that major tag | ghcr.io/wg-easy/wg-easy:15 | latest features for specific major versions, no breaking changes, recommended |
15.0 | latest patch for that minor tag | ghcr.io/wg-easy/wg-easy:15.0 | latest patches for specific minor version |
15.0.0 | specific tag | ghcr.io/wg-easy/wg-easy:15.0.0 | specific release, no updates |
edge | push to master | ghcr.io/wg-easy/wg-easy:edge | mostly unstable, gets frequent package and code updates |
development | pull requests | ghcr.io/wg-easy/wg-easy:development | used for development, testing code from PRs |
latest | latest tag | ghcr.io/wg-easy/wg-easy:latest or ghcr.io/wg-easy/wg-easy | points to the v14 release, should be avoided |
When publishing a tag we follow the Semantic Versioning specification. Pin to the latest major version to avoid breaking changes (e.g. 15), avoid using the latest tag.
/// danger | Use the Correct Commands For Stopping and Starting wg-easy
Use sudo docker compose up / down, not sudo docker compose start / stop. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state.
///
That's it! It really is that easy.