Skip to content
This repository was archived by the owner on Jun 15, 2021. It is now read-only.

Commit 1db8df0

Browse files
aptalcathelamer
authored andcommitted
clarify INTERFACE variable
1 parent db51c6e commit 1db8df0

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ docker create \
5959
-e PUID=1001 \
6060
-e PGID=1001 \
6161
-e TZ=Europe/London \
62-
-e INTERFACE=<interface name> `#optional` \
62+
-e INTERFACE=eth0 `#optional` \
6363
-p 943:943 \
6464
-p 9443:9443 \
6565
-p 1194:1194/udp \
@@ -86,7 +86,7 @@ services:
8686
- PUID=1001
8787
- PGID=1001
8888
- TZ=Europe/London
89-
- INTERFACE=<interface name> #optional
89+
- INTERFACE=eth0 #optional
9090
volumes:
9191
- <path to data>:/config
9292
ports:
@@ -109,7 +109,7 @@ Container images are configured using parameters passed at runtime (such as thos
109109
| `-e PUID=1001` | for UserID - see below for explanation |
110110
| `-e PGID=1001` | for GroupID - see below for explanation |
111111
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
112-
| `-e INTERFACE=<interface name>` | Only needed if run in host networking (default is eth0). |
112+
| `-e INTERFACE=eth0` | With bridge networking, leave it as eth0 (or don't include at all), if host or macvlan, set it to your host's network interface. |
113113
| `-v /config` | Where openvpn-as should store configuration files. |
114114

115115
## User / Group Identifiers

readme-vars.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ cap_add_param_vars:
3838
# optional container parameters
3939
opt_param_usage_include_env: true
4040
opt_param_env_vars:
41-
- { env_var: "INTERFACE", env_value: "<interface name>", desc: "Only needed if run in host networking (default is eth0)." }
41+
- { env_var: "INTERFACE", env_value: "eth0", desc: "With bridge networking, leave it as eth0 (or don't include at all), if host or macvlan, set it to your host's network interface." }
4242
opt_param_usage_include_vols: false
4343
opt_param_usage_include_ports: false
4444
opt_param_device_map: false

0 commit comments

Comments
 (0)