xsteadfastx/wg-quicker
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity
50 Commits 1 Branch 26 Tags 14 MiB
Go 93.6%
Makefile 4%
Shell 2.4%
dbcf05b98b
Go to file
Marvin Steadfast dbcf05b98b
Some checks reported errors
continuous-integration/drone/push Build is failing
Details
continuous-integration/drone Build was killed
Details
release only on drone promotion
2021-01-22 15:31:52 +01:00
cmd adds show command 2021-01-22 13:46:01 +01:00
third_party adds wireguard-go as submodule 2021-01-22 10:10:06 +01:00
vendor uses cobra for command line interface rewrite 2021-01-21 15:18:17 +01:00
wgquick adds show command 2021-01-22 13:46:01 +01:00
.drone.yml release only on drone promotion 2021-01-22 15:31:52 +01:00
.gitignore getting drone to work 2021-01-21 13:04:58 +01:00
.gitmodules adds wireguard-go as submodule 2021-01-22 10:10:06 +01:00
.goreleaser.yml try to fix submodules 2021-01-22 11:27:22 +01:00
go.mod uses cobra for command line interface rewrite 2021-01-21 15:18:17 +01:00
go.sum uses cobra for command line interface rewrite 2021-01-21 15:18:17 +01:00
LICENSE Initial commit 2019-03-26 13:28:22 +01:00
logo.png docs: readme work 2021-01-21 13:42:24 +01:00
main.go uses wireguard-go submodule + arm 6 and 7 builds 2021-01-22 11:05:17 +01:00
Makefile uses wireguard-go submodule + arm 6 and 7 builds 2021-01-22 11:05:17 +01:00
README.md docs: readme work 2021-01-21 13:42:24 +01:00

README.md

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