7.3 KiB
Executable File
linuxserver/openvpn-as
Openvpn-as 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.
Supported Architectures
Our images support multiple architectures such as x86-64
, arm64
and armhf
. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling linuxserver/openvpn-as
should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture | Tag |
---|---|
x86-64 | latest |
Usage
Here are some example snippets to help you get started creating a container from this image.
docker
docker create \
--name=openvpn-as \
--cap-add=NET_ADMIN \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e INTERFACE=eth0 `#optional` \
-p 943:943 \
-p 9443:9443 \
-p 1194:1194/udp \
-v <path to data>:/config \
--restart unless-stopped \
linuxserver/openvpn-as
docker-compose
Compatible with docker-compose v2 schemas.
---
version: "2"
services:
openvpn-as:
image: linuxserver/openvpn-as
container_name: openvpn-as
cap_add:
- NET_ADMIN
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- INTERFACE=eth0 #optional
volumes:
- <path to data>:/config
ports:
- 943:943
- 9443:9443
- 1194:1194/udp
restart: unless-stopped
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal>
respectively. For example, -p 8080:80
would expose port 80
from inside the container to be accessible from the host's IP on port 8080
outside the container.
Ports (-p
)
Parameter | Function |
---|---|
943 |
Admin GUI port. |
9443 |
TCP port. |
1194/udp |
UDP port. |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Europe/London |
Specify a timezone to use EG Europe/London. |
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, found by running ifconfig |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Where openvpn-as should store configuration files. |
User / Group Identifiers
When using volumes (-v
flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID
and group PGID
.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000
and PGID=1000
, to find yours use id user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Application Setup
The admin interface is available at https://<ip>:943/admin
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:
- Create another user and set as an admin,
- Log in as the new user,
- Delete the "admin" user in the gui,
- Modify the
as.conf
file under config/etc and replace the lineboot_pam_users.0=admin
with#boot_pam_users.0=admin
(this only has to be done once and will survive container recreation)
Support Info
- Shell access whilst the container is running:
docker exec -it openvpn-as /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f openvpn-as
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' openvpn-as
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/openvpn-as
Versions
- 21.02.19: - Rebase to xenial due to incompatibility issues on some older host OSes.
- 12.02.19: - Rename github repo to match the docker hub repo and container name.
- 07.02.19: - Add pipeline logic and multi arch.
- 31.01.19: - Add port mappings to docker create sample in readme.
- 26.01.19: - Removed
privileged
andhost
networking requirements, addedcap-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. - 19.12.18: - Bump to version 2.6.1.
- 10.07.18: - Bump to version 2.5.2.
- 23.03.18: - Bump to version 2.5.
- 14.12.17: - Consolidate layers and fix continuation lines.
- 25.10.17: - Bump to version 2.1.12.
- 18.08.17: - Switch default authentication method to local, update readme on how to deactivate the admin user.
- 31.07.17: - Fix updates of existing openvpn-as installs.
- 07.07.17: - Bump to version 2.1.9.
- 31.10.16: - Bump to version 2.1.4.
- 14.10.16: - Add version layer information.
- 13.09.16: - Rebuild due to push error to hub on last build.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 01.08.16: - Rebase to xenial.
- 18.09.15: - Initial Release.