Skip to content
This repository was archived by the owner on Mar 16, 2024. It is now read-only.

Commit 6150534

Browse files
author
ssg
committed
documented on how to perform VPN authentication
1 parent de244a7 commit 6150534

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,25 @@ ports:
8989
- <host_port>:1080
9090
```
9191

92-
###### `PROXY_USERNAME_SECRET`, `PROXY_PASSWORD_SECRET`, and `VPN_AUTH_SECRET`
92+
##### `PROXY_USERNAME_SECRET`, `PROXY_PASSWORD_SECRET`, and `VPN_AUTH_SECRET`
9393
Compose has support for [Docker secrets](https://docs.docker.com/engine/swarm/secrets/#use-secrets-in-compose).
9494
See the [Compose file](docker-compose.yml) in this repository for example usage of passing proxy credentials as Docker secrets.
9595

96+
### VPN Authentication
97+
To provide the VPN user and password credentials, create a file called `passfile` in the config folder being mounted, right next to the vpn .conf (or .ovpn) file.
98+
99+
In the passfile, enter the username in the first line and password in the second line. For example:
100+
```
101+
gilbert
102+
p@sswd123
103+
```
104+
Now in the vpn configuration file, such as my_vpn.ovpn, create a new line and enter the following:
105+
```
106+
auth-user-pass passfile
107+
```
108+
That should be enough. You can refer to this link for more details: https://help.yeastar.com/en/s-series/topic/openvpn-username-password-authentication.html#openvpn-create-account-password-for-each-client__section_uyg_sps_33b
109+
110+
96111
### Using with other containers
97112
Once you have your `openvpn-client` container up and running, you can tell other containers to use `openvpn-client`'s network stack which gives them the ability to utilize the VPN tunnel.
98113
There are a few ways to accomplish this depending how how your container is created.

0 commit comments

Comments
 (0)