Bernhard.Linz/openvpn-install
1
0
Fork 0
mirror of https://github.com/angristan/openvpn-install.git synced 2025-12-17 17:27:03 +01:00
Code Issues Projects Releases Wiki Activity

docs: document CLIENT_FILEPATH variable and file permissions

Browse Source 
- Add CLIENT_FILEPATH to headless install variable list
- Add commented example in headless user addition section
- Document automatic file ownership when client matches system user
This commit is contained in:
Stanislas Lange
2025-12-13 20:31:17 +01:00
parent 245ed2c22b
commit c846240436
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -99,6 +99,9 @@ If you want to customise your installation, you can export them or specify them
- `MULTI_CLIENT=n` - `MULTI_CLIENT=n`
- `CLIENT_CERT_DURATION_DAYS=3650` - `CLIENT_CERT_DURATION_DAYS=3650`
- `SERVER_CERT_DURATION_DAYS=3650` - `SERVER_CERT_DURATION_DAYS=3650`
- `CLIENT_FILEPATH=/custom/path/client.ovpn` (optional, overrides default output path)
The `.ovpn` file is saved to `CLIENT_FILEPATH` if defined, otherwise: the client's home directory if it exists (`/home/$CLIENT`), otherwise `SUDO_USER`'s home, otherwise `/root`.
If the server is behind NAT, you can specify its endpoint with the `ENDPOINT` variable. If the endpoint is the public IP address which it is behind, you can use `ENDPOINT=$(curl -4 ifconfig.co)` (the script will default to this). The endpoint can be an IPv4 or a domain. If the server is behind NAT, you can specify its endpoint with the `ENDPOINT` variable. If the endpoint is the public IP address which it is behind, you can use `ENDPOINT=$(curl -4 ifconfig.co)` (the script will default to this). The endpoint can be an IPv4 or a domain.
@@ -119,9 +122,12 @@ The following Bash script adds a new user `foo` to an existing OpenVPN configura
export MENU_OPTION="1" export MENU_OPTION="1"
export CLIENT="foo" export CLIENT="foo"
export PASS="1" export PASS="1"
# export CLIENT_FILEPATH="/etc/openvpn/clients/foo.ovpn"
./openvpn-install.sh ./openvpn-install.sh
``` ```
**Note:** When a client name matches a system user (e.g., `foo` and `/home/foo` exists), the script automatically sets proper ownership and permissions on the `.ovpn` file.
## Features ## Features
- Installs and configures a ready-to-use OpenVPN server - Installs and configures a ready-to-use OpenVPN server