Yggdrasil - Revision history

Everypizza: Add install instructions

2025-02-23T18:44:01Z

Add install instructions

← Older revision		Revision as of 18:44, 23 February 2025
Line 2:		Line 2:

	This article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-services-networking-yggdrasil NixOS manual].		This article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-services-networking-yggdrasil NixOS manual].

			== Enabling ==

			Install and enable Yggdrasil by adding <code><nowiki>services.yggdrasil.enable = true;</nowiki></code> to your NixOS configuration.

	== Virtual-hosts ==		== Virtual-hosts ==

Klinger: Category:Networking

2024-12-28T20:18:41Z

Category:Networking

← Older revision		Revision as of 20:18, 28 December 2024
Line 1:		Line 1:
	~~<q>~~[https://yggdrasil-network.github.io/ Yggdrasil] is an overlay network implementation of a new routing scheme for mesh networks. It is designed to be a future-proof decentralised alternative to the structured routing protocols commonly used today on the Internet and other networks.~~</q>~~		[https://yggdrasil-network.github.io/ Yggdrasil] is an overlay network implementation of a new routing scheme for mesh networks. It is designed to be a future-proof decentralised alternative to the structured routing protocols commonly used today on the Internet and other networks.

	This article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-services-networking-yggdrasil NixOS manual].		This article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-services-networking-yggdrasil NixOS manual].
Line 119:		Line 119:
	}		}
	</syntaxhighlight>		</syntaxhighlight>


			[[Category:Networking]]

Klinger: fix

2024-05-16T15:42:55Z

fix

← Older revision		Revision as of 15:42, 16 May 2024
Line 1:		Line 1:
	<q>[https://yggdrasil-network.github.io/ Yggdrasil] is an overlay network implementation of a new routing scheme for mesh networks. It is designed to be a future-proof decentralised alternative to the structured routing protocols commonly used today on the Internet and other networks.</q>		<q>[https://yggdrasil-network.github.io/ Yggdrasil] is an overlay network implementation of a new routing scheme for mesh networks. It is designed to be a future-proof decentralised alternative to the structured routing protocols commonly used today on the Internet and other networks.</q>

	~~It is documented~~ in the [https://nixos.org/manual/nixos/stable/#module-services-networking-yggdrasil NixOS manual].		This article extends the documentation in the [https://nixos.org/manual/nixos/stable/#module-services-networking-yggdrasil NixOS manual].

	== Virtual-hosts ==		== Virtual-hosts ==

Klinger: link to manual added

2024-05-16T15:42:22Z

link to manual added

← Older revision		Revision as of 15:42, 16 May 2024
Line 1:		Line 1:
	<q>[https://yggdrasil-network.github.io/ Yggdrasil] is an overlay network implementation of a new routing scheme for mesh networks. It is designed to be a future-proof decentralised alternative to the structured routing protocols commonly used today on the Internet and other networks.</q>		<q>[https://yggdrasil-network.github.io/ Yggdrasil] is an overlay network implementation of a new routing scheme for mesh networks. It is designed to be a future-proof decentralised alternative to the structured routing protocols commonly used today on the Internet and other networks.</q>

			It is documented in the [https://nixos.org/manual/nixos/stable/#module-services-networking-yggdrasil NixOS manual].

	== Virtual-hosts ==		== Virtual-hosts ==

imported>Ehmry: New Yggdrasil page with prefixed address generation example.

2022-09-29T15:28:36Z

New Yggdrasil page with prefixed address generation example.

New page

<q>[https://yggdrasil-network.github.io/ Yggdrasil] is an overlay network implementation of a new routing scheme for mesh networks. It is designed to be a future-proof decentralised alternative to the structured routing protocols commonly used today on the Internet and other networks.</q>

== Virtual-hosts ==

Each Yggdrasil address comes with a 64 bit address prefix for routing additional addresses behind it. The following example shows how to generate unique addresses for local HTTP services.

<syntaxhighlight lang="nix">
{ config, lib, ... }:

let
# Generate a deterministic IPv6 address for a 64 bit prefix
# and seed string. Prefix must not contain trailing ':'.
toIpv6Address = prefix64: seed:
with builtins;
let
digest = builtins.hashString "sha256" seed;
hextets = map (i: substring (4 * i) 4 digest) [ 0 1 2 3 ];
in concatStringsSep ":" ([ prefix64 ] ++ hextets);

# Get this prefix by running `yggdrasilctl getself`.
yggPrefix = "300:ffff:ffff:ffff";

toIpv6Address' = toIpv6Address yggPrefix;
in {

options.vhosts = lib.mkOption {
description =
"Attrset of HTTP virtual-hosts to create Yggdrasil addresses for.";
type = with lib.types;
attrsOf (submodule ({ name, ... }: {
options = {
address = lib.mkOption {
description = "Local listening address of service.";
default = "127.0.0.1";
type = str;
};
port = lib.mkOption {
description = "Local listening port of service.";
type = port;
};
yggdrasil = lib.mkOption {
description = "Yggdrasil address to create for this virtual-host";
type = str;
default = toIpv6Address' name;
};
};
}));
};

config = {

# Add generated addresses eth0
networking.interfaces.eth0 = lib.attrsets.mapAttrsToList (name:
{ yggdrasil, ... }: {
address = yggdrasil;
prefixLength = 64;
}) config.vhosts;

# Configure Squid to proxy generated addresses to the local services.
services.squid = {
enable = true;
extraConfig = ''
acl yggdrasil src 200::/8
http_port 80 accel
http_access allow yggdrasil

'' + (toString (lib.attrsets.mapAttrsToList (name:
{ address, port, yggdrasil }: ''

acl ${name}-address dst ${yggdrasil}
acl ${name}-domain dstdomain ${name}.${config.fqdn}
cache_peer ${address} parent ${toString port} 0 no-query originserver name=${name}-peer
cache_peer_access ${name}-peer allow ${name}-address
cache_peer_access ${name}-peer allow ${name}-domain
cache_peer_access ${name}-peer deny all
http_access allow ${name}-address
http_access allow ${name}-domain
'') config.vhosts));
};

# Add DNS records for the generated addresses.
# This assumes this server is configure as the nameserver for ${config.fqdn}.
services.unbound = {
enable = true;
settings = {
server = {
local-zone = [ ''"${config.fqdn}" static'' ];
local-data = map (s: ''"${s}"'') (lib.attrsets.mapAttrsToList
(name: { yggdrasil, ... }: "${name}.${config.fqdn} IN AAAA ${yggdrasil}")
config.vhosts);
};

};
};

};
}
</syntaxhighlight>

An example of such a virtual-host:
<syntaxhighlight lang="nix">
{ config, ... }:

{
services.hydra = {
enable = true;
hydraURL = "http://hydra.${config.networking.fqdn}";
listenHost = "127.0.0.1";
notificationSender = "hydra@${config.networking.domain}";
useSubstitutes = true;
};

vhosts.hydra = with config.services.hydra; {
address = listenHost;
inherit port;
};
}
</syntaxhighlight>