Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
elct9620 authored and tjjh89017 committed Sep 23, 2024
1 parent d1efb9c commit e9e8c36
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ Put the configuration below paths:
wg = "wg03"
refresh_interval = "10m"

[interfaces.wg02]
name = "wg02" # No config available, placeholder to load config

[stun]
address = "stun.l.google.com:19302"

Expand All @@ -56,6 +59,17 @@ zone_name = "<Your Domain>"

> The environment variables is higher priority than the configuration file.
### Environment Variables

| Name | Description |
|--------------------|--------------------------------------------|
| `WG` | Wireguard interface name |
| `CF_API_KEY` | Cloudflare API Key |
| `CF_API_EMAIL` | Cloudflare API Email |
| `CF_ZONE_NAME` | Cloudflare Zone Name |
| `CF_API_TOKEN` | Cloudflare API Token |
| `REFRESH_INTERVAL` | Refresh interval for Cloudflare TXT record |

## Extra Usage
You could use OSPF on Wireguard interface to create full mesh site-to-site VPN with dynamic routing.<br />
Never be bothered to setup static route.<br />
Expand Down
1 change: 1 addition & 0 deletions internal/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ var envs = map[string][]string{
"cloudflare.api_email": {"CF_API_EMAIL", "CLOUDFLARE_API_EMAIL"},
"cloudflare.api_token": {"CF_API_TOKEN", "CLOUDFLARE_API_TOKEN"},
"cloudflare.zone_name": {"CF_ZONE_NAME", "CLOUDFLARE_ZONE_NAME"},
"refresh_interval": {"REFRESH_INTERVAL"},
}

type Config struct {
Expand Down

0 comments on commit e9e8c36

Please sign in to comment.