forked from linuxserver-archive/docker-openvpn-as
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme-vars.yml
105 lines (94 loc) · 6.87 KB
/
readme-vars.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
---
# project information
project_name: openvpn-as
project_url: "https://openvpn.net/index.php/access-server/overview.html"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/openvpn-as-banner.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a full featured secure network tunneling VPN software solution that integrates OpenVPN server capabilities, enterprise management capabilities, simplified OpenVPN Connect UI, and OpenVPN Client software packages that accommodate Windows, MAC, Linux, Android, and iOS environments. OpenVPN Access Server supports a wide range of configurations, including secure and granular remote access to internal network and/ or private cloud network resources and applications with fine-grained access control."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_blurb_optional_extras_enabled: false
project_deprecation_status: true
project_deprecation_message: |
We recommend our wireguard image instead for vpn:
https://github.com/linuxserver/docker-wireguard
# supported architectures
available_architectures:
- { arch: "{{ arch_x86_64 }}", tag: "latest"}
# development version
development_versions: true
development_versions_items:
- { tag: "latest", desc: "DEPRECATED, no longer updated - Stable releases based on ubuntu bionic" }
- { tag: "xenial", desc: "DEPRECATED, no longer updated - Stable releases based on ubuntu xenial" }
# container parameters
common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_net: false
param_usage_include_env: true
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
param_usage_include_vols: true
param_volumes:
- { vol_path: "/config", vol_host_path: "<path to data>", desc: "Where openvpn-as should store configuration files." }
param_usage_include_ports: true
param_ports:
- { external_port: "943", internal_port: "943", port_desc: "Admin GUI port." }
- { external_port: "9443", internal_port: "9443", port_desc: "TCP port." }
- { external_port: "1194", internal_port: "1194/udp", port_desc: "UDP port." }
param_device_map: false
cap_add_param: true
cap_add_param_vars:
- { cap_add_var: "NET_ADMIN" }
# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
- { 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, found by running `ifconfig`" }
opt_param_usage_include_vols: false
opt_param_usage_include_ports: false
opt_param_device_map: false
opt_cap_add_param: false
optional_block_1: false
# application setup block
app_setup_block_enabled: true
app_setup_block: |
The admin interface is available at `https://DOCKER-HOST-IP:943/admin` (assuming bridge mode) with a default user/password of admin/password
During first login, make sure that the "Authentication" in the webui is set to "Local" instead of "PAM". Then set up the user accounts with their passwords (user accounts created under PAM do not survive container update or recreation).
The "admin" account is a system (PAM) account and after container update or recreation, its password reverts back to the default. It is highly recommended to block this user's access for security reasons:
1) Create another user and set as an admin,
2) Log in as the new user,
3) Delete the "admin" user in the gui,
4) Modify the `as.conf` file under config/etc and replace the line `boot_pam_users.0=admin` with ~~`#boot_pam_users.0=admin`~~ `boot_pam_users.0=kjhvkhv` (this only has to be done once and will survive container recreation)
* IMPORTANT NOTE: Commenting out the first pam user in as.conf creates issues in 2.7.5. To make it work while still blocking pam user access, uncomment that line and change admin to a random nonexistent user as described above.
To ensure your devices can connect to your VPN properly, goto Configuration -> Network Settings -> and change the "Hostname or IP Address" section to either your domain name or public ip address.
# changelog
changelogs:
- { date: "15.06.20:", desc: "Deprecate." }
- { date: "15.06.20:", desc: "Add fixes for 2.9.0." }
- { date: "04.11.20:", desc: "`xenial` tag is deprecated and there will be no further releases for that tag." }
- { date: "22.06.20:", desc: "Added Support for persistent Customization Folders." }
- { date: "26.03.20:", desc: "Switch to using the openvpn-as repo for packages." }
- { date: "29.08.19:", desc: "Update Application Setup instructions in readme to fix 2.7.5 login issue for existing users." }
- { date: "27.08.19:", desc: "Add new clients package to install and upgrade process." }
- { date: "22.08.19:", desc: "Prevent auto-start of openvpn after first time install, before configuration is completed." }
- { date: "25.07.19:", desc: "Create a xenial branch/tag and rebase master/latest to bionic." }
- { date: "07.04.19:", desc: "Fix first time config." }
- { date: "03.04.19:", desc: "Big rewrite of the install and update logic of openvpn-as to fix breaking changes (should fix updating from 2.6.1 to 2.7.3), added mysql-client for cluster support." }
- { date: "14.03.19:", desc: "Update deb package URL." }
- { date: "21.02.19:", desc: "Rebase to xenial due to incompatibility issues on some older host OSes." }
- { date: "12.02.19:", desc: "Rename github repo to match the docker hub repo and container name." }
- { date: "07.02.19:", desc: "Add pipeline logic and multi arch." }
- { date: "31.01.19:", desc: "Add port mappings to docker create sample in readme." }
- { date: "26.01.19:", desc: "Removed `privileged` and `host` networking requirements, added `cap-add=NET_ADMIN` requirement instead. `INTERFACE` no longer needs to be defined as in bridge mode, it will use the container's eth0 interface by default." }
- { date: "19.12.18:", desc: "Bump to version 2.6.1." }
- { date: "10.07.18:", desc: "Bump to version 2.5.2." }
- { date: "23.03.18:", desc: "Bump to version 2.5." }
- { date: "14.12.17:", desc: "Consolidate layers and fix continuation lines." }
- { date: "25.10.17:", desc: "Bump to version 2.1.12." }
- { date: "18.08.17:", desc: "Switch default authentication method to local, update readme on how to deactivate the admin user." }
- { date: "31.07.17:", desc: "Fix updates of existing openvpn-as installs." }
- { date: "07.07.17:", desc: "Bump to version 2.1.9." }
- { date: "31.10.16:", desc: "Bump to version 2.1.4." }
- { date: "14.10.16:", desc: "Add version layer information." }
- { date: "13.09.16:", desc: "Rebuild due to push error to hub on last build." }
- { date: "10.09.16:", desc: "Add layer badges to README." }
- { date: "28.08.16:", desc: "Add badges to README." }
- { date: "01.08.16:", desc: "Rebase to xenial." }
- { date: "18.09.15:", desc: "Initial Release." }