KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #deepseek-harness #typescript #ai-agent #codex #developer-tools #claude-code #windows #mcp #python #desktop-app

docker-openvpn

★ 1 Open GitHub ↗

Docker OpenVPN server

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [slocomptech/docker-openvpn](https://github.com/SloCompTech/docker-openvpn)

[![](https://images.microbadger.com/badges/version/slocomptech/openvpn.svg)](https://microbadger.com/images/slocomptech/openvpn "Get your own version badge on microbadger.com") [![](https://images.microbadger.com/badges/image/slocomptech/openvpn.svg)](https://microbadger.com/images/slocomptech/openvpn "Get your own image badge on microbadger.com") [![](https://images.microbadger.com/badges/commit/slocomptech/openvpn.svg)](https://microbadger.com/images/slocomptech/openvpn "Get your own commit badge on microbadger.com") ![](https://img.shields.io/docker/cloud/automated/slocomptech/openvpn.svg) ![](https://img.shields.io/docker/cloud/build/slocomptech/openvpn.svg)

Features:

- OpenVPN running as non-root user (limited permission)
- Containerized (Isolated environment)
- Easy managed (Helper scripts).
- Easy start (Simple first-start guide).
- Easly modified to your needs (see [docs](CONTRIBUTING.md)).
- Easy scripting (python3 installed).

## Usage

Here are some example snippets to help you get started creating a container.

### docker

``` bash
# Normal start command (but you need to setup config first)
docker run \
  --name=ovpn \
  --cap-add NET_ADMIN \
  -e PUID=1000 \
  -e PGID=1000 \
  -p 1194:1194/udp \
  -v </path/o/config>:/config \
  --restart=unless-stopped \
  --network host \
  slocomptech/openvpn:latest

# First config command
docker run \
  --rm -it \
  --cap-add NET_ADMIN \
  -e PUID=1000 \
  -e PGID=1000 \
  -e SKIP_APP=true \
  -v $(pwd)/data:/config
  slocomptech/openvpn:latest bash
```

### docker-compose

``` yml
version: '2.2'
services:
  ovpn:
    image: slocomptech/openvpn
    container_name: ovpn
    hostname: ovpn
    cap_add:
      - NET_ADMIN
    ports:
      - "1194:1194/udp"
    volumes:
      - ./data:/config
    environment:
      - PUID=1000
      - PGID=1000
    restart: on-failure
    # If you want to build from source add build:
    build:
      context: .
    sysctls: # For IPv6
      - net.ipv6.conf.all.disable_ipv6=0
      - net.ipv6.conf.default.forwarding=1
      - net.ipv6.conf.all.forwarding=1
    network_mode: host

```

## Parameters

See also: [EasyRSA](https://github.com/OpenVPN/easy-rsa/blob/master/doc/EasyRSA-Advanced.md)  
See [upstream image](https://github.com/SloCompTech/docker-baseimage)

## 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:

``` bash
id username
# uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```

## Configuration

- OpenVPN configuration is in `/config/openvpn`. Config file is `openvpn.conf` or `<anyfilename>.ovpn`.
- Client template configuration is `openvpn-client.conf`.
- At the top of config file you **MUST** include:

``` conf
  dev tun0 # You MUST set interface with name (with number !!)
  config include.conf # Includes general config
  config include-server.conf # Includes additional server config (only for server)
  config unprivileged.conf # Sets OpenVPN to run unprivileged
  ```

### Server

If you are new to containers please see rather [Detailed first setup guide](docs/SetupGuide.md), because it includes more detailed description.

1. Init configuration directory with initial config files:
  
  ``` bash
  docker run -it --rm --cap-add NET_ADMIN -e SKIP_APP=true -v </path/to/config>:/config slocomptech/openvpn:latest bash
  ```

2. Edit `vars` file. (See [docs](https://github.com/OpenVPN/easy-rsa/blob/master/doc/EasyRSA-Advanced.md))
3. At this point you will have bash shell which runs in container. Now run following commands to setup your PKI:

``` bash
  ovpn pki init [nopass] # Inits PKI
  ```

4. Setup OpenVPN config based on example `basic` with configuration wizard or put your config in `/config/openvpn/openvpn.conf`:

``` bash
  ovpn example basic
  #Out interface [eth0]: <interface connected to the Internet>
  #Protocol udp, tcp, udp6, tcp6 [udp]:
  #VPN network [10.0.0.0]:
  #Port [1194]:
  #Public IP or domain of server: <YOUR PUBLIC IP>
  #DNS1 [8.8.8.8]:
  #DNS2 [8.8.4.4]:
  ```

5. Generate server certificate `ovpn subject add server server [nopass]`.
6. Enable **port forwarding** on your router so OpenVPN server will be accessible from the internet.
7. Add clients

``` bash
  # Generates client certificates (put in client-confs directory)
  ovpn subject add <name> [nopass]
  # Generate .ovpn manually (generated in client-configs)
  ovpn subject gen-ovpn <name>
  ```

8. Exit container with `exit`, then it will destroy itself.
9. Start container using command specified in *Usage* section.

For more infromation see:

- [Detailed first setup guide](docs/SetupGuide.md)  
- [docs](docs) (for detailed command usage)  
- **configuration example directory** (for more info about example)  
- [Contributing](CONTRIBUTING.md) (for explanation how container works, how to write an example config ...)

**Note:** OpenVPN documentation is located at `/usr/share/doc/openvpn`.

### Client

1. Run container to get config structure `docker run -it --rm -v PATH:/config slocomptech/openvpn`.
2. Make sure you **don't** have following options specified in your config file
    - user
    - group
3. Put config file in `/config/openvpn`.

## Troubleshooting

- [OpenVPN troubleshoot guide](https://community.openvpn.net/openvpn/wiki/HOWTO#Troubleshooting)

### Cannot ioctl TUNSETIFF tun0: Operation not permitted (errno=1)

Just manualy remove **tun0**  manually `openvpn --rmtun --dev tun0`.

## Contribute

Feel free to contribute new features to this container, but first see [Contribute Guide](CONTRIBUTING.md).

## TODO

## Licenses

- [This project](LICENSE.md)  
- [OpenVPN](https://openvpn.net/terms/)  
- [Base image](https://github.com/linuxserver/docker-baseimage-alpine)  
- [s6 Layer](https://github.com/just-containers/s6-overlay/blob/master/LICENSE.md)

## Versions

See [CHANGELOG](CHANGELOG.md)

## External documentation

- [EasyRSA](https://github.com/OpenVPN/easy-rsa/blob/master/doc/EasyRSA-Readme.md)
- [EasyRSA vars](https://github.com/OpenVPN/easy-rsa/blob/master/doc/EasyRSA-Advanced.md)
- [EasyRSA password scripting](https://stackoverflow.com/questions/22415601/using-easy-rsa-how-to-automate-client-server-creation-process)
- [OpenVPN](https://community.openvpn.net/openvpn/wiki/Openvpn24ManPage)
- [OpenVPN getting started](https://community.openvpn.net/openvpn/wiki/GettingStartedwithOVPN)
- [OpenVPN how to](https://openvpn.net/community-resources/how-to/)
- [s6](https://skarnet.org/software/s6)

docker-openvpn

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README