[go: up one dir, main page]

MirageOS

Library operating system that constructs unikernels

Declared in: projects/MirageOS/default.nix

Demo

Implement missing demo

Options

programs.miragevpn Implement missing module
services.dnsvizor Implement missing module
services.dnsvizor.enable

Whether to enable dnsvizor.

Type:
boolean
Default:
false
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.mainInterface

The main network interface of the host.

Type:
string
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.memory

Memory limit of the unikernel in MB.

Type:
positive integer, meaning >0
Default:
512
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.openFirewall

Whether to enable opening ports in the firewall for dnsvizor.

Type:
boolean
Default:
false
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.package

The dnsvizor (hvt target) package to use. We assume dnsvizor.hvt exists at the root dir of the package.

Type:
package
Default:
pkgs.dnsvizor.hvt
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.packetForwardingIsSecure

Whether efforts have been taken to make sure packet forwarding is secure.

Type:
boolean
Default:
config.networking.firewall.enable && config.networking.firewall.filterForward
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings

Configuration for the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
open submodule of attribute set of (null or boolean or string or list of string)
Default:
{ }
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.ca-seed

The seed (base64 encoded) used to generate the private key for the certificate. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

::: {.warning} This secret will be copied into the nix store in clear text. :::

Type:
null or string
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.dns-block

Domains to block. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
list of string
Default:
[ ]
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.dns-blocklist-url

Web addresses to fetch DNS block lists from. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
list of string
Default:
[ ]
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.dns-upstream

Upstream DNS resolver. By default, it runs as a recursive DNS resolver. If this is specified, it runs as a stub DNS resolver instead. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
null or string
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.help

Show help instead of running the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
boolean
Default:
false
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.hostname

The hostname (SNI for the certificate, entry in DNS) of the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
null or string
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.https-port

The HTTPS port. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
443
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.ipv4

IPv4 network address and prefix length for the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
string
Default:
"10.0.0.2/24"
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.ipv4-gateway

IPv4 gateway of the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
string
Default:
"10.0.0.1"
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.ipv4-only

Only use IPv4 for the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
null or one of "true", "false"
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.ipv6

IPv6 network address and prefix length for the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
null or string
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.ipv6-gateway

IPv6 gateway of the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
null or string
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.ipv6-only

Only use IPv6 for the unikernel. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
null or one of "true", "false"
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.no-hosts

Don't read the synthesized /etc/hosts which contains only {option}services.dnsvizor.hostname. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
boolean
Default:
false
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.no-tls

Disable TLS: web interface and DNS-over-TLS/DNS-over-HTTPS. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
boolean
Default:
config.services.dnsvizor.settings.ca-seed == null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.opportunistic-tls-authoritative

Use opportunistic TLS from recursive resolver to authoriative (RFC 9539). See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
boolean
Default:
false
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.password

Password used for authentication. See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

::: {.tip} The space character needs to be escaped with \\. :::

::: {.warning} This secret will be copied into the nix store in clear text. :::

Type:
null or string
Default:
null
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.dnsvizor.settings.qname-minimisation

Use qname minimisation (RFC 9156). See upstream online documentation for more information. Setting {option}services.dnsvizor.settings.help shows the help message locally at runtime.

Type:
boolean
Default:
false
Declared in:
projects/DNSvizor/services/dnsvizor/module.nix
services.miragevpn Implement missing module
services.mollymawk Implement missing module

Examples

Metadata

This project is funded by NLnet through these subgrants:

Core
Mollymawk
Entrust
DNSvizor
Review
MirageVPN

Related links: