From 332c4edf628e3c9ad2d003699adf9d2478d77591 Mon Sep 17 00:00:00 2001 From: "Jason A. Donenfeld" Date: Wed, 19 Jul 2017 21:16:44 +0200 Subject: [PATCH] wireguard: move documentation into docs/ Now that this isn't a project, we move the last remains into the right place. Signed-off-by: Jason A. Donenfeld --- projects/wireguard/README.md => docs/wireguard.md | 6 ++---- projects/README.md | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) rename projects/wireguard/README.md => docs/wireguard.md (89%) diff --git a/projects/wireguard/README.md b/docs/wireguard.md similarity index 89% rename from projects/wireguard/README.md rename to docs/wireguard.md index 06564a833..5d4fafa11 100644 --- a/projects/wireguard/README.md +++ b/docs/wireguard.md @@ -15,14 +15,12 @@ A full technical paper from NDSS 2017 is available [here](https://www.wireguard. ## Contents ### Kernel Patches -The `kernel/patches-*` sub-directories contain a kernel patch. +The default kernels build WireGuard in as a module. ### Userspace Tools -The userspace tools are available from the `wireguard-tools` package. +The userspace tools are part of `tools/alpine`. ## Quickstart -The quickest way to get started is to use the provided `examples/wireguard.yml` in this directory and use the prebuilt images. - To give WireGuard a spin, the [official quick start](https://www.wireguard.com/quickstart/) is a good way to get going. For containers, WireGuard has a [network namespace integration](https://www.wireguard.com/netns/) that we could use for Moby's containers. diff --git a/projects/README.md b/projects/README.md index 2b29cf65d..a44afc346 100644 --- a/projects/README.md +++ b/projects/README.md @@ -12,7 +12,6 @@ If you want to create a project, please submit a pull request to create a new di ## Current projects - [Kernel Self Protection Project enhancements](kspp/) - [Mirage SDK](miragesdk/) privilege separation for userspace services -- [Wireguard](wireguard/) cryptographic enforced container network separation - [OKernel](okernel/) intra-kernel protection using EPT (HPE) - [eBPF](ebpf/) iovisor eBPF tools - [Swarmd](swarmd) Standalone swarmkit based orchestrator @@ -33,3 +32,4 @@ If you want to create a project, please submit a pull request to create a new di ## Completed projects - `aws/`: AWS support was merged into mainline in #1964. +- `wireguard/`: [WireGuard](https://www.wireguard.com/) is now part of the default LinuxKit kernel and package set.