Git Product home page Git Product logo

docker-wireguard's Introduction

Docker Wireguard

Appreciate the work of the good folks at linuxserver/docker-wireguard, but I needed more functionality and other existing projects did not meet the criteria.

This project supports Wireguard in a site-to-site configuration.

Usage

I built this to be used with docker-compose.

See the examples in the examples directory.

  • Use the docker-compose.local.yml file to add (shared) general local dependencies/modifications like custom dns servers for the containers.
  • Copy the docker-compose.wg0.yml, wgtest.env and sample.env and customize them to fit your use.
  • Add the relevant docker-compose.*.yml to the COMPOSE_FILE variable in .env

Manually

Use start, stop, or restart to control the container.

Notes:

  • The scripts do routing magic.
  • You need to be root for this.

systemd

Copy and adjust the docker-wireguard.service file to /etc/systemd/system/, adjust the paths in the file, run the command systemctl enable docker-wireguard to enable the service, and then run systemctl start docker-wireguard.

Variables

.env

Variable Usage
UPNP_ENABLED Whether upnpc will be called on bringing the containers up
COMPOSE_FILE Specify which containers are to be brought up

Wireguard

Variable Usage
SERVER_PORT Wireguard port
LOCAL_IPS Wireguard tunnel addresses
LOCAL_SUBNETS Inside subnets
REMOTE_SUBNETS Remote subnets (specify the tunnel subnet here)

Peers

Variable Usage
PEER_X_ADDRESS Peer outside address
PEER_X_RESOLVE Resolve peer through DNS
PEER_X_PUBKEY Public key
PEER_X_PSK Pre-shared key
PEER_X_SUBNETS Peer specific remote subnets
PEER_X_KEEPALIVE Keep alive interval

docker-wireguard's People

Contributors

tyisi avatar

Watchers

 avatar  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.