</span></code></pre></div><h2id=parameters>Parameters<aclass=headerlinkhref=#parameterstitle="Permanent link">¶</a></h2><p>Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)<aclass=headerlinkhref=#ports-ptitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>943</code></td><td>Admin GUI port.</td></tr><tr><tdstyle="text-align: center;"><code>9443</code></td><td>TCP port.</td></tr><tr><tdstyle="text-align: center;"><code>1194/udp</code></td><td>UDP port.</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)<aclass=headerlinkhref=#environment-variables-etitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Env</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>TZ=Europe/London</code></td><td>Specify a timezone to use EG Europe/London.</td></tr><tr><tdstyle="text-align: center;"><code>INTERFACE=eth0</code></td><td>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 <code>ifconfig</code></td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)<aclass=headerlinkhref=#volume-mappings-vtitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Volume</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>/config</code></td><td>Where openvpn-as should store configuration files.</td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)<aclass=headerlinkhref=#environment-variables-from-files-docker-secretstitle="Permanent link">¶</a></h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-2-1><aid=__codelineno-2-1name=__codelineno-2-1href=#__codelineno-2-1></a>-e<spanclass=w></span><spanclass=nv>FILE__PASSWORD</span><spanclass=o>=</span>/run/secrets/mysecretpassword
</span></code></pre></div><p>Will set the environment variable <code>PASSWORD</code> based on the contents of the <code>/run/secrets/mysecretpassword</code> file.</p><h2id=umask-for-running-applications>Umask for running applications<aclass=headerlinkhref=#umask-for-running-applicationstitle="Permanent link">¶</a></h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=user-group-identifiers>User / Group Identifiers<aclass=headerlinkhref=#user-group-identifierstitle="Permanent link">¶</a></h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-3-1><aid=__codelineno-3-1name=__codelineno-3-1href=#__codelineno-3-1></a><spanclass=w></span>$<spanclass=w></span>id<spanclass=w></span>username
</span></code></pre></div><h2id=docker-mods>Docker Mods<aclass=headerlinkhref=#docker-modstitle="Permanent link">¶</a></h2><p><ahref="https://mods.linuxserver.io/?mod=openvpn-as"title="view available mods for this container."><imgalt="Docker Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=openvpn-as&query=%24.mods%5B%27openvpn-as%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a><ahref="https://mods.linuxserver.io/?mod=universal"title="view available universal mods."><imgalt="Docker Universal Mods"src="https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml"></a></p><p>We publish various <ahref=https://github.com/linuxserver/docker-mods>Docker Mods</a> to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.</p><h2id=support-info>Support Info<aclass=headerlinkhref=#support-infotitle="Permanent link">¶</a></h2><ul><li>Shell access whilst the container is running:</li><li><code>docker exec -it openvpn-as /bin/bash</code></li><li>To monitor the logs of the container in realtime:</li><li><code>docker logs -f openvpn-as</code></li><li>Container version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' openvpn-as</code></li><li>Image version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvpn-as</code></li></ul><h2id=versions>Versions<aclass=headerlinkhref=#versionstitle="Permanent link">¶</a></h2><ul><li><strong>15.06.20:</strong> - Deprecate.</li><li><strong>15.06.20:</strong> - Add fixes for 2.9.0.</li><li><strong>04.11.20:</strong> - <code>xenial</code> tag is deprecated and there will be no further releases for that tag.</li><li><strong>22.06.20:</strong> - Added Support for persistent Customization Folders.</li><li><strong>26.03.20:</strong> - Switch to using the openvpn-as repo for packages.</li><li><strong>29.08.19:</strong> - Update Application Setup instructions in readme to fix 2.7.5 login issue for existing users.</li><li><strong>27.08.19:</strong> - Add new clients package to install and upgrade process.</li><li><strong>22.08.19:</strong> - Prevent auto-start of openvpn after first time install, before configuration is completed.</li><li><strong>25.07.19:</strong> - Create a xenial branch/tag and rebase master/latest to bionic.</li><li><strong>07.04.19:</strong> - Fix first time config.</li><li><strong>03.04.19:</strong> - 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.</li><li><strong>14.03.19:</strong> - Update deb package URL.</li><li><strong>21.02.19:</strong> - Rebase to xenial due to incompatibility issues on some older host OSes.</li><li><strong>12.02.19:</strong> - Rename github repo to match the docker hub repo and container name.</li><li><strong>07.02.19:</strong> - Add pipeline logic and multi arch.</li><li><strong>31.01.19:</strong> - Add port mappings to docker create sample in readme.</li><li><strong>26.01.19:</strong> - Removed <code>privileged</code> and <code>host</code> networking requirements, added <code>cap-add=NET_ADMIN</code> requirement instead. <code>INTERFACE</code> no longer needs to be defined as in bridge mode, it will use the container's eth0 interface by default.</li><li><strong>19.12.18:</strong> - Bump to version 2.6.1.</li><li><strong>10.07.18:</strong> - Bump to version 2.5.2.</li><li><strong>23.03.18:</strong> - Bump to version 2.5.</li><li><strong>14.12.17:</strong> - Consolidate l
