Repository navigation
Releases
Releases · gureetk/wglink
wglink v0.4.0
Install with apt or dnf: .deb and .rpm packages come with each release,
and wglink has a website.
Added
.deband.rpmpackages on each release, for amd64, arm64 and armv7.
They install shell completions for bash, zsh and fish, and recommend
openssh-clientandwireguard-tools. CI installs them on Debian and
Fedora before a release can ship them.- Release archives include the shell completions too.
- A website, published from
site/with GitHub Pages: a home page and a
quick start, in light and dark themes that follow the system unless you
pick one.
wglink v0.3.0
Build networks from the dashboard: add nodes and connect them there, then
plan and apply.
Added
- The dashboard adds nodes and connects them.
nopens a form for a new
node, andcone that joins checked nodes in a new or existing network,
then shows its plan to apply. Both make the same changes as
wglink node addandwglink connect.
Fixed
wglink connectandwglink net joinno longer reset the pinned
address of a node that is already a member.
wglink v0.2.0
Reach more machines and shape networks more ways: Proxmox VMs, phones, hubs,
routed subnets and IPv6, with key rotation, preshared keys, safer changes
over SSH and a terminal dashboard.
Added
- Proxmox VMs as nodes, through the QEMU guest agent:
wglink node add vm200 --qm 200 --via pve1. The VM needsqemu-guest-agentand no SSH. - Manual nodes for devices wglink can't reach, such as phones:
wglink node add phone --manualadds one.wglink export lab phoneprints its config and makes its key pair on
the first run.plansays when a device's config is out of date, andstatusjudges
its links from the other end.
- Safe changes over SSH:
- Before changing an SSH node,
applyarms a systemd timer there that
restores the previous config, then cancels it over a new SSH connection. - If the change cut off the route wglink uses, the node undoes the change
by itself after a minute. --no-revertturns this off, andplanwarns about SSH nodes without
systemd.
- Before changing an SSH node,
wglink discover HOSTlists a Proxmox host's containers and VMs with their
addresses.--addadds the running ones as nodes.wglink state rebuildrecovers a lost or stalewglink.state.jsonfrom
the configs on the nodes. It keeps the old file as.bak.- Hub-and-spoke networks:
--hub NODEonconnect,net createandnet set.- Spokes connect only to the hub and send the whole network through it.
- The hub turns on forwarding for its WireGuard interface alone.
statusshows the hub's links.
- Routed subnets:
wglink routes NETWORK NODE SUBNET...lets the other members reach a
member's LAN through it, through the hub in hub networks.- Auto subnets avoid routed ones.
planstops you when a member is on a routed subnet itself, and warns
when the routing member doesn't forward.
wglink rotate NETWORK [NODE...]replaces members' keys:- New keys are made on the members and loaded live on them and their
peers. - The probe now compares the key file with the keys in the config and in
the running interface.planloads a new key that hasn't been picked up,
for example after an interrupted rotation.
- New keys are made on the members and loaded live on them and their
- Preshared keys, with
--pskonconnect,net createandnet set:applymakes a key for each pair of peers and stores it on both before
either config uses it.- Nodes report keys by their hashes, so
planfinds pairs that don't
match and keys that aren't loaded yet. rotatereplaces a member's preshared keys too, andexportgives a
phone new ones.
- IPv6 inside the tunnels, with
--ipv6onconnect,net createand
net set:- A random unique local /64 by default, or a fixed subnet.
- Each member's IPv6 address has the same host number as its IPv4 one.
- Hubs forward IPv6 for their interface alone on Linux 6.17 and later;
planwarns when an older hub forwards no IPv6. - Routed subnets can be IPv6 too.
wglink ui, a terminal dashboard: every network with the health of its
links, checked again every few seconds, with plan and apply for the
selected network a key away.
Fixed
- A config edited by hand without a final newline no longer breaks
plan
andstatusfor its node. - Turning a network's keepalive off now takes effect on a live update, not
only after the interface restarts.wg syncconfkeeps settings a config
leaves out, so wglink sets them to zero.
wglink v0.1.0
The first release: describe machines and networks, preview, apply, and check
that tunnels pass traffic.
Added
wglink.yamlinventory of nodes and networks. Edit it by hand, or with
init,node,net,connectandip, which keep comments and layout.- Four ways to reach a node:
- SSH, using the system OpenSSH client with connections reused across commands.
- Local execution.
- Any exec prefix, such as
docker exec -i. - Proxmox containers, through
pct execon their host.
- Automatic subnets, ports and addresses that stay the same across runs.
Any of them can be pinned: a host part (.10), a full address, a subnet or
a port. Picks avoid addresses, routes and UDP ports already in use on each
node. planandapply:- Private keys are made on the nodes that use them and never leave them.
- Configs are written for wg-quick, and systemd is used where present.
- Peer changes load live with
wg syncconf. - Edits made on a node are detected.
- Configs wglink didn't write are left alone unless
--adoptis given.
status:- Health of each link from handshakes and pings through the tunnel, with
traffic counters and drift. --jsonoutput and--exit-codefor scripts.--localchecks a node by itself, without an inventory.
- Health of each link from handshakes and pings through the tunnel, with
- Tests:
- Node scripts are tested under dash, bash and busybox sh.
- End-to-end tests run against real WireGuard in network namespaces, over
exec, SSH and systemd.