diff --git a/README.md b/README.md index 62d4037..9559081 100644 --- a/README.md +++ b/README.md @@ -1 +1,115 @@ # xoxys.wireguard + +[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.wireguard/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.wireguard) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.wireguard/src/branch/main/LICENSE) + +Setup wireguard VPN. + +## Table of content + +- [Requirements](#requirements) +- [Default Variables](#default-variables) + - [wireguard_address](#wireguard_address) + - [wireguard_interface](#wireguard_interface) + - [wireguard_peers](#wireguard_peers) + - [wireguard_peers_unmanaged](#wireguard_peers_unmanaged) + - [wireguard_port](#wireguard_port) + - [wireguard_postdown](#wireguard_postdown) + - [wireguard_postup](#wireguard_postup) + - [wireguard_predown](#wireguard_predown) + - [wireguard_preup](#wireguard_preup) +- [Dependencies](#dependencies) +- [License](#license) +- [Author](#author) + +--- + +## Requirements + +- Minimum Ansible version: `2.10` + +## Default Variables + +### wireguard_address + +#### Default value + +```YAML +wireguard_address: 10.0.0.1/24 +``` + +### wireguard_interface + +#### Default value + +```YAML +wireguard_interface: wg0 +``` + +### wireguard_peers + +#### Default value + +```YAML +wireguard_peers: [] +``` + +### wireguard_peers_unmanaged + +#### Default value + +```YAML +wireguard_peers_unmanaged: [] +``` + +### wireguard_port + +#### Default value + +```YAML +wireguard_port: '51820' +``` + +### wireguard_postdown + +#### Default value + +```YAML +wireguard_postdown: [] +``` + +### wireguard_postup + +#### Default value + +```YAML +wireguard_postup: [] +``` + +### wireguard_predown + +#### Default value + +```YAML +wireguard_predown: [] +``` + +### wireguard_preup + +#### Default value + +```YAML +wireguard_preup: [] +``` + +## Dependencies + +None. + +## License + +MIT + +## Author + +[Robert Kaussow](https://gitea.rknet.org/xoxys)