client-vpn

homelab.client-vpn

Name	Type	Description
debug	boolean	Whether to enable debug mode.
enable	boolean	Whether to enable the client VPN gateway.
groups	attribute set of (submodule)	VPN client access groups, indexed by group name. Each group is a wireguard endpoint.
groups..allowEgress	list of string	List of services this group should be granted access to "gateway" is needed for access to gateway (use e.g. ["gateway" "sabnzbd"] to grant access to sabnzbd only), "cluster" gives full access to the cluster
groups..cidr4	string	IPv4 CIDR of the tunnel
groups..cidr6	string	IPv6 CIDR of the tunnel
groups..gatewayIPv4	string (read-only))	IPv4 of the gateway
groups..gatewayIPv6	string (read-only))	IPv6 of the gateway
groups..gatewayPublicKey	string	Public key of the gateway for inline in ready-made client configurations
groups..peers	attribute set of (submodule)	VPN Peers in this group
groups..peers..config.enable	boolean	Whether to enable the wireguard & setup-secrets configuration corresponding to this peer, at most one configuration per group can be enabled at the same time.
groups..peers..enable	boolean	Whether to enable the peer.
groups..peers..ipv4	null or string	The IPv4 of the peer
groups..peers..ipv6	null or string	The IPv6 of the peer
groups..peers..publicKey	string	Public key of the peer
groups..reservedIPs	list of string	Reserved IPs for the VPN endpoint