{"repo":"pirate/wireguard-docs","free":true,"listed":false,"github":"https://github.com/pirate/wireguard-docs","clone":"git clone https://github.com/pirate/wireguard-docs.git","description":"📖 Unofficial WireGuard Documentation: Setup, Usage, Configuration, and full example setups for VPNs supporting both servers & roaming clients.","language":"Shell","stars":5044,"topics":["wireguard","vpn","tuntap","internet","networking","tunnel","security","udp","nat","vpn-solution"],"license":"MIT","category":"networking-infra","readme_excerpt":"Some Unofficial WireGuard Documentation API reference guide for WireGuard including Setup, Configuration, and Usage, with examples. All credit goes to the WireGuard project, zx2c4 and the open source contributors for the original software, this is my solo unofficial attempt at providing more comprehensive documentation, API references, and examples. Source for these docs, example code, and issue tracker: wireguard-docs &nbsp; &nbsp; Nicer HTML page version: docs.sweeting.me --- WireGuard is an open-source VPN solution written in C by Jason Donenfeld and others, aiming to fix many of the problems that have plagued other modern server-to-server VPN offerings like IPSec/IKEv2, OpenVPN, or L2TP. It shares some similarities with other modern VPN offerings like Tinc and MeshBird, namely good cipher suites and minimal config. As of 2020-01 it's been merged into the 5.6 version of the Linux kernel, meaning it will ship with most Linux systems out-of-the-box. Official Links - Homepage - Install - QuickStart - Manpages: wg(8) , wg-quick(8) - Main Git repo - GitHub Mirror - Mailing List WireGuard Goals - strong, modern security by default - minimal config and key management - fast, both low-latency and high-bandwidth - simple internals and small protocol surface area - simple CLI and seamless integration with system networking It's also fast as hell . I routinely get sub 0.5ms pings and 900mbps+ on good connections. (See this WireGuard topology write-up) --- Table of Contents See wiregu","default_branch":null,"files":null,"tree":[],"storefront":"/r/pirate","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pirate/wireguard-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}