xsteadfastx/wg-quicker
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity
c694b55e91
wg-quicker/README.md
Marvin Steadfast 976636bbc5
All checks were successful
continuous-integration/drone/push Build is passing
Details
docs: readme work
2021-01-21 13:42:24 +01:00

1.8 KiB
Raw Blame History

logo

wg-quick like library with batteries included

This is a friendly fork of wg-quick-go. It contains everything needed to get a system into a wireguard vpn network. If there is no wireguard kernel modul available, it will spin up the embedded wireguard-go to create a wireguard interface.

Badges

Build Status Go Reference Go Report Card

Installation

Prebuild packages

Get these on release page.

Compile it for yourself

  • git clone https://git.xsfx.dev/xsteadfastx/wg-quicker.git
  • cd wg-quicker
  • make build

Roadmap

  • full wg-quick feature parity
    • PreUp
    • PostUp
    • PreDown
    • PostDown
    • DNS
    • MTU
    • Save --> Use MarshallText interface to save config
  • Sync
  • Up
  • Down
  • MarshallText
  • UnmarshallText
  • Minimal test
  • Embedded wireguard-go
  • Integration tests ((TODO; have some virtual machines/kvm and wreck havoc :) ))

Caveats

  • Endpoints DNS MarshallText is unsupported
  • Pre/Post Up/Down doesn't support escaped %i, that is all %i are expanded to interface name.
  • SaveConfig in config is only a placeholder (( since there's no reading/writing from files )). Use Unmarshall/Marshall Text to save/load config (( you're responsible for IO)).