https://github.com/robertdebock/ansible-role-openvpn
Install and configure openvpn server or client on your system.
https://github.com/robertdebock/ansible-role-openvpn
ansible molecule networking openvpn playbook tox
Last synced: about 1 month ago
JSON representation
Install and configure openvpn server or client on your system.
- Host: GitHub
- URL: https://github.com/robertdebock/ansible-role-openvpn
- Owner: robertdebock
- License: apache-2.0
- Created: 2019-02-15T07:06:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T16:15:09.000Z (3 months ago)
- Last Synced: 2025-04-30T21:25:49.187Z (about 1 month ago)
- Topics: ansible, molecule, networking, openvpn, playbook, tox
- Language: Jinja
- Homepage: https://robertdebock.nl/
- Size: 248 KB
- Stars: 49
- Watchers: 3
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# [Ansible role openvpn](#openvpn)
Install and configure openvpn server or client on your system.
|GitHub|GitLab|Downloads|Version|
|------|------|---------|-------|
|[](https://github.com/robertdebock/ansible-role-openvpn/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-openvpn)|[](https://galaxy.ansible.com/robertdebock/openvpn)|[](https://github.com/robertdebock/ansible-role-openvpn/releases/)|
## [Example Playbook](#example-playbook)
This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-openvpn/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.
```yaml
---
- name: Converge
hosts: all
become: true
gather_facts: true
tasks:
- name: Create openvpn server
ansible.builtin.include_role:
name: robertdebock.openvpn
vars:
openvpn_role: "server"
- name: Copy certificates and keys from the server to the client
ansible.builtin.copy:
src: /etc/openvpn/easy-rsa/pki/{{ item }}
dest: /etc/openvpn/client/{{ item | basename }}
mode: "0640"
remote_src: true
loop:
- ca.crt
- issued/client.crt
- private/client.key
- ta.key
- name: Create openvpn client
ansible.builtin.include_role:
name: robertdebock.openvpn
vars:
openvpn_role: "client"
openvpn_client_server: "127.0.0.1"
```
The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-openvpn/blob/master/molecule/default/prepare.yml):
```yaml
---
- name: Prepare
hosts: all
become: true
gather_facts: false
roles:
- role: robertdebock.bootstrap
- role: robertdebock.epel
```
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
## [Role Variables](#role-variables)
The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-openvpn/blob/master/defaults/main.yml):
```yaml
---
# defaults file for openvpn
# You can setup both a client and a server using this role.
# Use `server` or `client` for `openvpn_role`.
openvpn_role: server
# If you are configuring a client, setup these variables:
# openvpn_role: client
# openvpn_client_server: vpn.example.com
```
## [Requirements](#requirements)
- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-openvpn/blob/master/requirements.txt).
## [State of used roles](#state-of-used-roles)
The following roles are used to prepare a system. You can prepare your system in another way.
| Requirement | GitHub | GitLab |
|-------------|--------|--------|
|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|
|[robertdebock.epel](https://galaxy.ansible.com/robertdebock/epel)|[](https://github.com/robertdebock/ansible-role-epel/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-epel)|
## [Context](#context)
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
Here is an overview of related roles:
## [Compatibility](#compatibility)
This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):
|container|tags|
|---------|----|
|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|
|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|
|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|focal|
The minimum version of Ansible required is 2.12, tests have been done to:
- The previous version.
- The current version.
- The development version.
If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-openvpn/issues).
## [License](#license)
[Apache-2.0](https://github.com/robertdebock/ansible-role-openvpn/blob/master/LICENSE).
## [Author Information](#author-information)
[robertdebock](https://robertdebock.nl/)
Please consider [sponsoring me](https://github.com/sponsors/robertdebock).