You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 15, 2021. It is now read-only.
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
9
4
10
-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
11
-
*[forum.linuxserver.io][forumurl]
12
-
*[IRC][ircurl] on freenode at `#linuxserver.io`
13
-
*[Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
5
+
* regular and timely application updates
6
+
* easy user mappings (PGID, PUID)
7
+
* custom base image with s6 overlay
8
+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
9
+
* regular security updates
14
10
15
-
# linuxserver/openvpn-as
16
-
[](https://microbadger.com/images/linuxserver/openvpn-as"Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/openvpn-as"Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-openvpn-as/)
11
+
Find us at:
12
+
*[Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
13
+
*[IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
14
+
*[Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
15
+
*[Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
17
16
18
-
OpenVPN Access Server 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. [Openvpn-as](https://openvpn.net/index.php/access-server/overview.html)
17
+
# PSA: Changes are happening
18
+
19
+
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
20
+
21
+
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
[](https://microbadger.com/images/linuxserver/openvpn-as"Get your own version badge on microbadger.com")
26
+
[](https://microbadger.com/images/linuxserver/openvpn-as"Get your own version badge on microbadger.com")
[Openvpn-as](https://openvpn.net/index.php/access-server/overview.html) 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.
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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
39
+
40
+
Simply pulling `linuxserver/openvpn-as` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Here are some example snippets to help you get started creating a container.
52
+
53
+
### docker
54
+
24
55
```
25
56
docker create \
26
-
--name=openvpn-as \
27
-
--cap-add=NET_ADMIN \
28
-
-v <path to data>:/config \
29
-
-e PGID=<gid> -e PUID=<uid> \
30
-
-p 943:943 \
31
-
-p 9443:9443 \
32
-
-p 1194:1194/udp \
33
-
-e TZ=<timezone> \
34
-
linuxserver/openvpn-as
57
+
--name=openvpn-as \
58
+
--cap-add=NET_ADMIN \
59
+
-e PUID=1001 \
60
+
-e PGID=1001 \
61
+
-e TZ=Europe/London \
62
+
-e INTERFACE=<interface name> `#optional` \
63
+
-p 943:943 \
64
+
-p 9443:9443 \
65
+
-p 1194:1194/udp \
66
+
-v <path to data>:/config \
67
+
--restart unless-stopped \
68
+
linuxserver/openvpn-as
35
69
```
36
70
37
-
## Parameters
38
71
39
-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
40
-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
41
-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
42
-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
72
+
### docker-compose
73
+
74
+
Compatible with docker-compose v2 schemas.
75
+
76
+
```
77
+
---
78
+
version: "2"
79
+
services:
80
+
openvpn-as:
81
+
image: linuxserver/openvpn-as
82
+
container_name: openvpn-as
83
+
cap_add:
84
+
- NET_ADMIN
85
+
environment:
86
+
- PUID=1001
87
+
- PGID=1001
88
+
- TZ=Europe/London
89
+
- INTERFACE=<interface name> #optional
90
+
volumes:
91
+
- <path to data>:/config
92
+
ports:
93
+
- 943:943
94
+
- 9443:9443
95
+
- 1194:1194/udp
96
+
mem_limit: 4096m
97
+
restart: unless-stopped
98
+
```
43
99
100
+
## Parameters
44
101
45
-
*`-v /config` - where openvpn-as should store configuration files
46
-
*`-e PGID` for GroupID - see below for explanation
47
-
*`-e PUID` for UserID - see below for explanation
48
-
*`-p 943` admin gui port
49
-
*`-p 9443` tcp port
50
-
*`-p 1194/udp` udp port
51
-
*`-e TZ` for Timezone setting
52
-
*`--cap-add=NET_ADMIN` IMPORTANT, will not operate without this parameter.
53
-
*`-e INTERFACE`*OPTIONAL* - only needed if run in host networking (default is eth0).
102
+
Container 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.
54
103
55
-
It is based on ubuntu xenial with S6 overlay, for shell access whilst the container is running do `docker exec -it openvpn-as /bin/bash`.
104
+
| Parameter | Function |
105
+
| :----: | --- |
106
+
|`-p 943`| Admin GUI port. |
107
+
|`-p 9443`| TCP port. |
108
+
|`-p 1194/udp`| UDP port. |
109
+
|`-e PUID=1001`| for UserID - see below for explanation |
110
+
|`-e PGID=1001`| for GroupID - see below for explanation |
111
+
|`-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). |
113
+
|`-v /config`| Where openvpn-as should store configuration files. |
56
114
115
+
## User / Group Identifiers
57
116
58
-
### User / Group Identifiers
117
+
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`.
59
118
60
-
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
119
+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
61
120
62
-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
121
+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
The admin interface is available at `https://<ip>:943/admin` with a default user/password of admin/password
73
133
@@ -79,36 +139,53 @@ The "admin" account is a system (PAM) account and after container update or recr
79
139
3) Delete the "admin" user in the gui,
80
140
4) Modify the `as.conf` file under config/etc and replace the line `boot_pam_users.0=admin` with `#boot_pam_users.0=admin` (this only has to be done once and will survive container recreation)
81
141
82
-
## Info
83
-
84
-
* To monitor the logs of the container in realtime `docker logs -f openvpn-as`.
85
142
86
143
87
-
* container version number
88
-
89
-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' openvpn-as`
144
+
## Support Info
90
145
146
+
* Shell access whilst the container is running: `docker exec -it openvpn-as /bin/bash`
147
+
* To monitor the logs of the container in realtime: `docker logs -f openvpn-as`
148
+
* container version number
149
+
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' openvpn-as`
91
150
* image version number
92
-
93
-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/openvpn-as`
151
+
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/openvpn-as`
152
+
153
+
## Updating Info
154
+
155
+
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
156
+
157
+
Below are the instructions for updating containers:
158
+
159
+
### Via Docker Run/Create
160
+
* Update the image: `docker pull linuxserver/openvpn-as`
161
+
* Stop the running container: `docker stop openvpn-as`
162
+
* Delete the container: `docker rm openvpn-as`
163
+
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
164
+
* Start the new container: `docker start openvpn-as`
165
+
* You can also remove the old dangling images: `docker image prune`
166
+
167
+
### Via Docker Compose
168
+
* Update the image: `docker-compose pull linuxserver/openvpn-as`
169
+
* Let compose update containers as necessary: `docker-compose up -d`
170
+
* You can also remove the old dangling images: `docker image prune`
94
171
95
172
## Versions
96
173
97
-
+**07.02.19:**Rebase to bionic, add pipeline logic.
98
-
+**31.01.19:** Add port mappings to docker create sample in readme.
99
-
+**26.01.19:** 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.
100
-
+**19.12.18:** Bump to version 2.6.1.
101
-
+**10.07.18:** Bump to version 2.5.2.
102
-
+**23.03.18:** Bump to version 2.5.
103
-
+**14.12.17:** Consolidate layers and fix continuation lines.
104
-
+**25.10.17:** Bump to version 2.1.12.
105
-
+**18.08.17:** Switch default authentication method to local, update readme on how to deactivate the admin user
106
-
+**31.07.17:** Fix updates of existing openvpn-as installs.
107
-
+**07.07.17:** Bump to version 2.1.9.
108
-
+**31.10.16:** Bump to version 2.1.4.
109
-
+**14.10.16:** Add version layer information.
110
-
+**13.09.16:** Rebuild due to push error to hub on last build.
111
-
+**10.09.16:** Add layer badges to README.
112
-
+**28.08.16:** Add badges to README.
113
-
+**01.08.16:** Rebase to xenial.
114
-
+**18.09.15:** Initial Release.
174
+
***07.02.19:**- Add pipeline logic and multi arch.
175
+
***31.01.19:** - Add port mappings to docker create sample in readme.
176
+
***26.01.19:** - 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.
177
+
***19.12.18:** - Bump to version 2.6.1.
178
+
***10.07.18:** - Bump to version 2.5.2.
179
+
***23.03.18:** - Bump to version 2.5.
180
+
***14.12.17:** - Consolidate layers and fix continuation lines.
181
+
***25.10.17:** - Bump to version 2.1.12.
182
+
***18.08.17:**- Switch default authentication method to local, update readme on how to deactivate the admin user.
183
+
***31.07.17:** - Fix updates of existing openvpn-as installs.
184
+
***07.07.17:** - Bump to version 2.1.9.
185
+
***31.10.16:** - Bump to version 2.1.4.
186
+
***14.10.16:** - Add version layer information.
187
+
***13.09.16:** - Rebuild due to push error to hub on last build.
0 commit comments