Skip to content

Commit 231ffa2

Browse files
committed
update documentation
1 parent 43db0b0 commit 231ffa2

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,29 @@
44

55
* Scale hosts without restart of whole interface
66

7+
## Interfaces
8+
9+
### Input variables
10+
11+
* count - count of connections
12+
* connections - public ips where applied
13+
* private_ips - ips for wireguard communication
14+
* interface - wireguard interface name (default: wg0)
15+
* port - wireguard port (default: 51820)
16+
* network_cidr - network cidr (default: 10.0.1.0/24)
17+
* keys_dir - local directory where wireguard private keys will be stored (default: .wgkeys)
18+
19+
### Output variables
20+
21+
* public_ips - public ips of instances/servers
22+
* ips - wireguard/vpn ips of instances/servers
23+
* systemd_unit - wireguard systemd unit name (example: wg-quick@wg0.service)
24+
* network_route_systemd_unit - network route systemd unit name (example: wg0-network-route.service)
25+
* interface - wireguard interface name (example: wg0)
26+
* port - wireguard port
27+
* network_cidr - netowrk cidr
28+
29+
730
## Example
831

932
```
@@ -24,7 +47,7 @@ module "provider" {
2447
}
2548
2649
module "wireguard" {
27-
source = ".."
50+
source = "git::https://github.com/suquant/tf_wireguard.git?ref=v1.0.0"
2851
2952
count = "${var.hosts}"
3053
connections = "${module.provider.public_ips}"

0 commit comments

Comments
 (0)