diff --git a/charts/stable/wireguard/docs/how-to.md b/charts/stable/wireguard/docs/how-to.md index 32f534d145c..68cbf3213d5 100644 --- a/charts/stable/wireguard/docs/how-to.md +++ b/charts/stable/wireguard/docs/how-to.md @@ -2,37 +2,9 @@ title: How-To --- -## Scale App +## Chart Configuration -TrueNAS Scale users, can configure this app from the easily from the UI. -Store your wireguard config file in a directory, on one of your pools. -Example `/mnt/pool/vpn.conf` (Name can be any name. eg `wg0.conf`, `x-site.conf`, etc) -Example config content: - -```toml -[Interface] -Address = 10.0.0.1/24 -ListenPort = 51820 -PrivateKey = PRIVATE_KEY - -[Peer] -PublicKey = PUBLIC_KEY -AllowedIPs = 0.0.0.0/0 -Endpoint = wg.example:51820 -``` - -UI Configuration is simple as that: - -![wg-configuration](./img/wg-configuration.png) - -Tick `Killswitch` if you want to kill traffic when VPN is down. -Add networks in `Excluded IPv{4,6} Networks` that you want to continue their traffic when VPN is down. - -That's it! - -## Native Helm - -Native helm users can modify `values.yaml` and add their wireguard config directly in there. +Wireguard config can be added directly in your `.Values`. Example: @@ -63,3 +35,20 @@ wg: AllowedIPs = 0.0.0.0/0 Endpoint = wg.example:51820 ``` +
+ +## External config file example +Example `/mnt/pool/vpn.conf` (Name can be any name. eg `wg0.conf`, `x-site.conf`, etc) +Example config content: + +```toml +[Interface] +Address = 10.0.0.1/24 +ListenPort = 51820 +PrivateKey = PRIVATE_KEY + +[Peer] +PublicKey = PUBLIC_KEY +AllowedIPs = 0.0.0.0/0 +Endpoint = wg.example:51820 +``` diff --git a/charts/stable/wireguard/docs/img/wg-configuration.png b/charts/stable/wireguard/docs/img/wg-configuration.png deleted file mode 100644 index dd6840c4c1e..00000000000 Binary files a/charts/stable/wireguard/docs/img/wg-configuration.png and /dev/null differ