https://github.com/chernetskyi/boringtun-docker

Dockerized BoringTun, a userspace WireGuard® implementation in Rust
https://github.com/chernetskyi/boringtun-docker

boringtun cloudflare docker wireguard

Last synced: 2 days ago
JSON representation

Dockerized BoringTun, a userspace WireGuard® implementation in Rust

• Host: GitHub
• URL: https://github.com/chernetskyi/boringtun-docker
• Owner: chernetskyi
• License: bsd-3-clause
• Archived: true
• Created: 2021-07-27T15:26:06.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-06-02T17:44:40.000Z (almost 3 years ago)
• Last Synced: 2024-11-12T12:48:44.047Z (6 months ago)
• Topics: boringtun, cloudflare, docker, wireguard
• Language: Shell
• Homepage:
• Size: 120 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - chernetskyi/boringtun-docker - Dockerized BoringTun, a userspace WireGuard® implementation in Rust (docker)

README

        
# BoringTun in Docker

## Supported tags and respective `Dockerfile` links

- [`latest`, `bullseye`](https://github.com/chernetskyi/boringtun-docker/blob/main/Dockerfile.bullseye)

- [`alpine`](https://github.com/chernetskyi/boringtun-docker/blob/main/Dockerfile.alpine)

## What is BoringTun?

**BoringTun** is an implementation of the [WireGuard®](https://www.wireguard.com/) protocol designed for portability and speed.

[https://blog.cloudflare.com/boringtun-userspace-wireguard-rust/](https://blog.cloudflare.com/boringtun-userspace-wireguard-rust/)

![BoringTun Logo](https://github.com/chernetskyi/boringtun-docker/blob/main/boringtun.png)

## How to use this image

### WireGuard configuration file

Provide WireGuard configuration file to `/etc/wireguard/${INTERFACE}.cnf`.

`-v ./wireguard.conf:/etc/wireguard/wg0.conf`

### Privileges

Give extended privileges to this container `--privileged`.

### Environment variables

`INTERFACE`

Set the name of created interface. Respective WireGuard configuration file name is `/etc/wireguard/${INTERFACE}.cnf` Default: `wg0`.

`WG_LOG_LEVEL`

Set the verbosity level of logging messages. One of: `error`, `info`, `debug`, `trace`. Default: `info`.

`WG_LOG_FILE`

Set the logging file destination. Default: `/var/log/boringtun`.

`WG_THREADS`

Set the number of OS threads to use. Default: `4`.

## License

The project is licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause).

---

WireGuard is a registered trademark of Jason A. Donenfeld. BoringTun is not sponsored or endorsed by Jason A. Donenfeld.