Giter Club home page Giter Club logo

ansible-role-wireguard's Introduction

Ansible role for Wireguard

Description

Ansible role to install and setup a Wireguard VPN server.

Prerequisites

  • An EC2 instance (t3-micro recommended) with public Elastic IP address
  • Ubuntu 18.04 Minimal
  • S3 bucket with credentials for backup & centralize user config key

Required variables

The dictionary list of users to add to the VPN, with username, unique private(local to the VPN node itself) IP address and settings:

s3_bucket     : "nfq-infrastructure-terraform"
s3_key_prefix : "credentials/wireguard" # s3://<bucket-name>/credentials/wireguard
aws_access_key: "{{ lookup('env','AWS_ACCESS_KEY_ID') }}"
aws_secret_key: "{{ lookup('env','AWS_SECRET_ACCESS_KEY') }}"
security_token: "{{ lookup('env','AWS_SESSION_TOKEN') }}"
region        : "ap-southeast-1"
wg_user_list:
  devops:
    username: "devops"
    private_ip: "10.99.0.11"
    default_route: true
    wg_dns_enabled: true
    remove: false
  nam.nguyen:
    username: "nam.nguyen"
    private_ip: "10.99.0.11"
    default_route: true
    wg_dns_enabled: true
    remove: false
  nghia.pham:
    username: "nghia.pham"
    private_ip: "10.99.0.12"
    default_route: true
    wg_dns_enabled: true
    remove: false

Decsription of the required parameters:

  • username: username
  • private_ip: private IP address to be assigned on Wireguard tunnel
  • default_route: yes if user is allowed to use VPN as default route
  • wg_dns_enabled: yes if user is allowed to use server DNS resolver
  • remove: no (yes if user is marked to be deleted)

Defaults

  • Listen port: UDP/51820 (Set with wg_listen_port)
  • Tunnel network: 10.99.0.0/24 (Set with wg_private_ip and change private_ip of each client)
  • Download path for profile is default to ~/Downloads, set in wg_download_path

Optional variables

n/a

Tags

  • sysctl - Add IPv4 forwarding to Sysctl
  • install - Install Wireguard
  • configure - Configure Wireguard
  • users - Add/remove users
  • upload - Push client key into S3 bucket

Usage

To use, either use wg-quick:

brew install wireguard-tools
wg-quick up ~/Downloads/path-to/wg0.conf
# Shutdown:
wg-quick down ~/Downloads/path-to/wg0.conf

Or use the official clients here

Notes

  • DNS push not working automatically on MacOS

ansible-role-wireguard's People

Contributors

kietvo01314 avatar tylern91 avatar

Watchers

Thien Tran avatar Tri Tran avatar hungdq avatar  avatar devops-nfq avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.