github/linuxkit
1
0
Fork 0
mirror of https://github.com/linuxkit/linuxkit.git synced 2025-07-20 09:39:08 +00:00
Code Issues Projects Releases Wiki Activity

wireguard: move documentation into docs/

Browse Source 
Now that this isn't a project, we move the last remains into the right
place.

Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
This commit is contained in:
Jason A. Donenfeld 2017-07-19 21:16:44 +02:00
parent a09a2a4b22
commit 332c4edf62
2 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
projects/wireguard/README.md → docs/wireguard.md
View File

@ -15,14 +15,12 @@ A full technical paper from NDSS 2017 is available [here](https://www.wireguard.
## Contents ## Contents
### Kernel Patches ### Kernel Patches
The `kernel/patches-*` sub-directories contain a kernel patch. The default kernels build WireGuard in as a module.
### Userspace Tools ### Userspace Tools
The userspace tools are available from the `wireguard-tools` package. The userspace tools are part of `tools/alpine`.
## Quickstart ## 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, 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. WireGuard has a [network namespace integration](https://www.wireguard.com/netns/) that we could use for Moby's containers.

2
projects/README.md
View File

@ -12,7 +12,6 @@ If you want to create a project, please submit a pull request to create a new di
## Current projects ## Current projects
- [Kernel Self Protection Project enhancements](kspp/) - [Kernel Self Protection Project enhancements](kspp/)
- [Mirage SDK](miragesdk/) privilege separation for userspace services - [Mirage SDK](miragesdk/) privilege separation for userspace services
- [Wireguard](wireguard/) cryptographic enforced container network separation
- [OKernel](okernel/) intra-kernel protection using EPT (HPE) - [OKernel](okernel/) intra-kernel protection using EPT (HPE)
- [eBPF](ebpf/) iovisor eBPF tools - [eBPF](ebpf/) iovisor eBPF tools
- [Swarmd](swarmd) Standalone swarmkit based orchestrator - [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 ## Completed projects
- `aws/`: AWS support was merged into mainline in #1964. - `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.