4.4 KiB
title, sidebar_position, hide_title
| title | sidebar_position | hide_title |
|---|---|---|
| Welcome | 1 | true |
:::danger
🚧 cunīcu is currently still in an Alpha state and not usable yet
:::
cunīcu is a user-space daemon managing WireGuard® interfaces to establish peer-to-peer connections in harsh network environments.
It relies on the awesome pion/ice package for the interactive connectivity establishment as well as bundles the Go user-space implementation of WireGuard in a single binary for environments in which WireGuard kernel support has not landed yet.
Getting started
To use cunīcu follow these steps on each host:
- Install cunīcu
- Configure your WireGuard interfaces using
wg,wg-quickor NetworkManager - Start the cunīcu daemon by running:
sudo cunicu daemon
Make sure that in step 2. you have created WireGuard keys and exchanged them by hand between the hosts. cunīcu does not (yet) discover available peers. You are responsible to add the peers to the WireGuard interface by yourself.
After the cunīcu daemons have been started, they will attempt to discover valid endpoint addresses using the ICE protocol (e.g. contacting STUN servers).
These ICE candidates are then exchanged via the signaling server and cunīcu will update the endpoint addresses of the WireGuard peers accordingly.
Once this has been done, the cunīcu logs should show a line state=connected.
Documentation
Documentation of cunīcu can be found in the docs/ directory.
Authors
- Steffen Vogel (@stv0g, Institute for Automation of Complex Power Systems, RWTH Aachen University)
Join us
Please feel free to join our Slack channel #cunicu in the Gophers workspace and say 👋.
Name
The project name cunīcu [kʊˈniːkʊ] is derived from the latin noun cunīculus which means rabbit, a rabbit burrow or underground tunnel. We have choosen it as a name for this project as cunīcu builds tunnels between otherwise hard to reach network locations. It has been changed from the former name wice in order to broaden the scope of the project and avoid any potential trademark violations.
License
cunīcu is licensed under the Apache 2.0 license.
Copyright 2022 Institute for Automation of Complex Power Systems, RWTH Aachen University
Funding acknowledgement
<img alt="European Flag" style={{height: '4em', marginRight: '10px'}} src="/img/flag_of_europe.svg" align="left" />
The development of cunīcu has been supported by the ERIGrid 2.0 project of the H2020 Programme under Grant Agreement No. 870620
Trademark
WireGuard and the WireGuard logo are registered trademarks of Jason A. Donenfeld.