History

core 9316502432 [meta] boring documentation text stuff		2022-12-15 17:59:56 -05:00
..
src	[meta] boring documentation text stuff	2022-12-15 17:59:56 -05:00
Cargo.toml	most cryptography functions finished	2022-12-12 20:24:48 -05:00
README.md	[meta] boring documentation text stuff	2022-12-15 17:59:56 -05:00

README.md

Quicktap

Quicktap is a (hopefully) standard-compliant Rust implementation of the WireGuard protocol.

It was designed to be a simpler alternative to Cloudflare's boringtun.

Getting Started: Normal People

Warning: Quicktap's CLI (and quicktap as a whole) is in a very unfinished state right now. Use something else for a little bit.

See the sections below for your platform for a guide on how to use Quicktap.

Linux

Dont! Linux has had in-kernel WireGuard support since 5.6 and you probably have it. If you don't, use wireguard-linux-compat. There is no reason to use quicktap on Linux. The kernel module is better and faster.

After you've ignored the previous sentences and want to do it anyway:

First, compile quicktap. You only need to do this once per release.

Download the latest release from https://gitlab.e3t.cc/e3team/elaeis4/-/releases.
Make sure you have Rust installed. Check out https://rustup.rs if you don't.
Run cargo build --release in the project directory.

After compilation, use target/release/quicktap-cli <name-of-your-interface> to create your interface. Then you can configure it as usual with ip and wg commands.

MacOS

Not yet...

NetBSD

Not yet...

Getting Started: Application Developers

It's just a typical Rust library. It's up on crates.io as quicktap for stable releases. We aim to have pretty good documentation, so check out the crate documentation for more info on how to use it.

Getting Started: Quicktap Developers

It's just a typical Rust library. Try to follow our contributor guidelines. Thanks!