qrystal

module
v0.0.0-...-a8acacb Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 25, 2024 License: GPL-3.0

README

Qrystal

Website/Docs / Github.com

Qrystal /kristl/ sets up several WireGuard tunnels between servers. In addition, it provides centralised configuration management. Nodes and tokens can be dynamically added (and removed, in a future version).

Installation

Make sure to open the appropriate ports (defaults listed below):

  • CS: 39252/tcp for Nodes and 39253 for utilities
  • The WireGuard ports for UDP (from the expected peers)
Most Linux distros
$ git clone https://github.com/nyiyui/qrystal
$ cd qrystal
$ mkdir build && cd build
$ make src=.. -f ../Makefile
# make src=.. -f ../Makefile install

Then, enable/start qrystal-runner.service (Node) and/or qrystal-cs.service (CS) (depending on what you want to run).

NixOS

Flakes are recommended. See flake.nix for options.

Installation from Generic Archive

# make pre_install # if Qrystal services are already running
# make src=. install
# systemctl start qrystal-runner # for Node
# systemctl start qrystal-cs # for CS

TODO

  • node: test node backport (in test.nix)
  • confine qrystal-node and qrystal-cs (using systemd's options)
  • configure existing interfaces without disrupting connections (as much as possible)
  • support multiple hosts
    • e.g. specify VPC network IP address first, and then public IP address
    • heuristics for a successful wg connection?
  • test all fails on host cs but after waiting a few hours, host cs works so I'll have to figure that out...
  • if azusa contains configuration for a network that isn't in config.cs.networks, warn about this (possible misconfiguration)
  • SRV records

Directories

Path Synopsis
Package central contains Central configuration for Nodes and CSes.
Package central contains Central configuration for Nodes and CSes.
cmd
cs
Package mio provides a local RPC server to configure WireGuard.
Package mio provides a local RPC server to configure WireGuard.
Package testhost performs a test connection and handshake on the host, and a quick bandwidth and latency test.
Package testhost performs a test connection and handshake on the host, and a quick bandwidth and latency test.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL