diff --git a/reference/module-options/erigon/index.html b/reference/module-options/erigon/index.html index b0ca341d..6ea8160b 100644 --- a/reference/module-options/erigon/index.html +++ b/reference/module-options/erigon/index.html @@ -1211,7 +1211,7 @@

services.ethereum.erigon

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.enable

Whether to enable Erigon Ethereum Node…

Type: @@ -1221,7 +1221,7 @@

services.ethereum.erigon.\.enableExample: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.package

Package to use as Erigon node.

Type: @@ -1229,7 +1229,7 @@

services.ethereum.erigon.\.package<

Default: pkgs.erigon

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.addr

HTTP-RPC server listening interface for the Engine API.

Type: @@ -1237,7 +1237,7 @@

services.ethereum.erigon.\.

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.jwtsecret

Path to the token that ensures safe connection between CL and EL.

Type: @@ -1247,7 +1247,7 @@

services.ethereum.erigon.\Example: "/var/run/erigon/jwtsecret"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.port

HTTP-RPC server listening port for the Engine API

Type: @@ -1255,7 +1255,7 @@

services.ethereum.erigon.\.

Default: 8551

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

@@ -1266,7 +1266,7 @@

services.ethereum.erigon.

Example: "30s"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: @@ -1276,7 +1276,7 @@

services.ethereum.erigon.

Example: "30s"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

@@ -1287,7 +1287,7 @@

services.ethereum.erigon

Example: "30m0s"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.authrpc.vhosts

Comma separated list of virtual hostnames from which to accept Engine API requests (server enforced). Accepts ‘*’ wildcard."

@@ -1310,7 +1310,7 @@

services.ethereum.erigon.\]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.chain

Name of the network to join. If null the network is mainnet.

Type: @@ -1318,7 +1318,7 @@

services.ethereum.erigon.\.args.c

Default: "mainnet"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.externalcl

Whether to enable enables external consensus.

Type: @@ -1328,7 +1328,7 @@

services.ethereum.erigon.\.a

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.enable

Enable HTTP-RPC server

Type: @@ -1336,7 +1336,7 @@

services.ethereum.erigon.\.a

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.addr

HTTP-RPC server listening interface.

Type: @@ -1344,7 +1344,7 @@

services.ethereum.erigon.\.arg

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.api

API’s offered over the HTTP-RPC interface.

Type: @@ -1359,7 +1359,7 @@

services.ethereum.erigon.\.args ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.compression

Whether to enable Enable compression over HTTP-RPC…

Type: @@ -1369,7 +1369,7 @@

services.ethereum.erigon.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.corsdomain

List of domains from which to accept cross origin requests.

Type: @@ -1384,7 +1384,7 @@

services.ethereum.erigon.\]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.port

HTTP-RPC server listening port.

Type: @@ -1392,7 +1392,7 @@

services.ethereum.erigon.\.arg

Default: 8545

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

@@ -1403,7 +1403,7 @@

services.ethereum.erigon.\Example: "30s"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: @@ -1413,7 +1413,7 @@

services.ethereum.erigon.\Example: "30s"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

@@ -1424,7 +1424,7 @@

services.ethereum.erigon.\<

Example: "30m0s"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.trace

Whether to enable Trace HTTP requests with INFO level.

Type: @@ -1434,7 +1434,7 @@

services.ethereum.erigon.\.ar

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts ‘*’ wildcard.

@@ -1457,7 +1457,7 @@

services.ethereum.erigon.\.a ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.metrics.enable

Whether to enable Enable metrics collection and reporting…

Type: @@ -1467,7 +1467,7 @@

services.ethereum.erigon.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.metrics.addr

Enable stand-alone metrics HTTP server listening interface.

Type: @@ -1475,7 +1475,7 @@

services.ethereum.erigon.\.

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.metrics.port

Metrics HTTP server listening port

Type: @@ -1483,7 +1483,7 @@

services.ethereum.erigon.\.

Default: 6060

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.port

Network listening port.

Type: @@ -1491,7 +1491,7 @@

services.ethereum.erigon.\.args.po

Default: 30303

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.private.api.addr

Private api network address, for example: 127.0.0.1:9090, empty string means not to start the listener. Do not expose to public network. Serves remote database interface.

Type: @@ -1499,7 +1499,7 @@

services.ethereum.erigon.\Default: "127.0.0.1:9090"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.private.api.ratelimit

Amount of requests server handle simultaneously - requests over this limit will wait. Increase it - if clients see ‘request timeout’ while server load is low - it means your ‘hot data’ is small or have much RAM.

Type: @@ -1507,7 +1507,7 @@

services.ethereum.erigon.

Default: 31872

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.snapshots

Default: use snapshots “true” for BSC, Mainnet and Goerli. use snapshots “false” in all other cases.

Type: @@ -1515,7 +1515,7 @@

services.ethereum.erigon.\.ar

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.torrent.port

Port to listen and serve BitTorrent protocol .

Type: @@ -1523,7 +1523,7 @@

services.ethereum.erigon.\.

Default: 42069

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.ws.enable

Whether to enable Erigon WebSocket API.

Type: @@ -1533,7 +1533,7 @@

services.ethereum.erigon.\.arg

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.args.ws.compression

Whether to enable Enable compression over HTTP-RPC…

Type: @@ -1543,7 +1543,7 @@

services.ethereum.erigon.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.extraArgs

Additional arguments to pass to Erigon.

Type: @@ -1551,7 +1551,7 @@

services.ethereum.erigon.\.extraA

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -1559,7 +1559,7 @@

services.ethereum.erigon.\.ope

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.service.supplementaryGroups

Additional groups for the systemd service e.g. sops-nix group for secret access

Type: @@ -1567,7 +1567,7 @@

services.ethereum.erig

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

services.ethereum.erigon.\.subVolume

Whether to enable Use a subvolume for the state directory if the underlying filesystem supports it e.g. btrfs.

Type: @@ -1577,7 +1577,7 @@

services.ethereum.erigon.\.subVol

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

diff --git a/reference/module-options/geth-bootnode/index.html b/reference/module-options/geth-bootnode/index.html index 9b36d690..d181e48d 100644 --- a/reference/module-options/geth-bootnode/index.html +++ b/reference/module-options/geth-bootnode/index.html @@ -903,7 +903,7 @@

services.ethereum.geth-bootnode

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.enable

Whether to enable Go Ethereum Boot Node.

Type: @@ -913,7 +913,7 @@

services.ethereum.geth-bootnode.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.package

Package to use as Go Ethereum Boot node.

Type: @@ -921,7 +921,7 @@

services.ethereum.geth-bootnode.\<

Default: pkgs.geth

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.addr

Listen address

Type: @@ -929,7 +929,7 @@

services.ethereum.geth-bootnode.\

Default: ":30301"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.genkey

Generate a node key

Type: @@ -937,7 +937,7 @@

services.ethereum.geth-bootnode

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.nat

Port mapping mechanism (any|none|upnp|pmp|pmp:IP|extip:IP)

Type: @@ -945,7 +945,7 @@

services.ethereum.geth-bootnode.\<

Default: "none"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.netrestrict

Restrict network communication to the given IP networks (CIDR masks)

Type: @@ -953,7 +953,7 @@

services.ethereum.geth-boo

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.nodekey

Private key filename

Type: @@ -961,7 +961,7 @@

services.ethereum.geth-bootnod

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.nodekeyhex

Private key as hex (for testing)

Type: @@ -969,7 +969,7 @@

services.ethereum.geth-boot

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.v5

Run a V5 topic discovery bootnode

Type: @@ -977,7 +977,7 @@

services.ethereum.geth-bootnode.\Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.verbosity

log verbosity (0-5)

Type: @@ -985,7 +985,7 @@

services.ethereum.geth-bootn

Default: 3

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.vmodule

Log verbosity pattern

Type: @@ -993,7 +993,7 @@

services.ethereum.geth-bootnod

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.args.writeaddress

Write out the node’s public key and quit

Type: @@ -1001,7 +1001,7 @@

services.ethereum.geth-bo

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.extraArgs

Additional arguments to pass to the Go Ethereum Bootnode.

Type: @@ -1009,7 +1009,7 @@

services.ethereum.geth-bootnode.

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

services.ethereum.geth-bootnode.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -1017,7 +1017,7 @@

services.ethereum.geth-bootno

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

diff --git a/reference/module-options/geth/index.html b/reference/module-options/geth/index.html index 5d5e6e49..40276f22 100644 --- a/reference/module-options/geth/index.html +++ b/reference/module-options/geth/index.html @@ -1533,7 +1533,7 @@

services.ethereum.geth

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.enable

Whether to enable Go Ethereum Node.

Type: @@ -1543,7 +1543,7 @@

services.ethereum.geth.\.enable

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.package

Package to use as Go Ethereum node.

Type: @@ -1551,7 +1551,7 @@

services.ethereum.geth.\.package

Default: pkgs.geth

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.authrpc.addr

Listen address of Go Ethereum Auth RPC API.

Type: @@ -1559,7 +1559,7 @@

services.ethereum.geth.\.args

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.authrpc.jwtsecret

Path to a JWT secret for authenticated RPC endpoint.

Type: @@ -1569,7 +1569,7 @@

services.ethereum.geth.\

Example: "/var/run/geth/jwtsecret"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.authrpc.port

Port number of Go Ethereum Auth RPC API.

Type: @@ -1577,7 +1577,7 @@

services.ethereum.geth.\.args

Default: 8551

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.authrpc.vhosts

List of virtual hostnames from which to accept requests.

Type: @@ -1599,7 +1599,7 @@

services.ethereum.geth.\.ar ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.bootnodes

List of bootnodes to connect to

Type: @@ -1607,7 +1607,7 @@

services.ethereum.geth.\.args.b

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.gcmode

Blockchain garbage collection mode.

Type: @@ -1615,7 +1615,7 @@

services.ethereum.geth.\.args.gcmo

Default: "full"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.http.enable

Whether to enable Go Ethereum HTTP API.

Type: @@ -1625,7 +1625,7 @@

services.ethereum.geth.\.args.

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.http.addr

HTTP-RPC server listening interface

Type: @@ -1633,7 +1633,7 @@

services.ethereum.geth.\.args.ht

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.http.api

API’s offered over the HTTP-RPC interface

Type: @@ -1650,7 +1650,7 @@

services.ethereum.geth.\.args.htt ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.http.corsdomain

List of domains from which to accept cross origin requests

Type: @@ -1665,7 +1665,7 @@

services.ethereum.geth.\.a ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.http.port

Port number of Go Ethereum HTTP API.

Type: @@ -1673,7 +1673,7 @@

services.ethereum.geth.\.args.ht

Default: 8545

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.http.rpcprefix

HTTP path path prefix on which JSON-RPC is served. Use ‘/’ to serve on all paths.

Type: @@ -1683,7 +1683,7 @@

services.ethereum.geth.\.ar

Example: "/"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts ‘*’ wildcard.

@@ -1706,7 +1706,7 @@

services.ethereum.geth.\.args. ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.maxpeers

Maximum peers to connect to.

Type: @@ -1714,7 +1714,7 @@

services.ethereum.geth.\.args.ma

Default: 50

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.metrics.enable

Whether to enable Go Ethereum prometheus metrics.

Type: @@ -1724,7 +1724,7 @@

services.ethereum.geth.\.ar

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.metrics.addr

Listen address of Go Ethereum metrics service.

Type: @@ -1732,7 +1732,7 @@

services.ethereum.geth.\.args

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.metrics.port

Port number of Go Ethereum metrics service.

Type: @@ -1740,7 +1740,7 @@

services.ethereum.geth.\.args

Default: 6060

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.netrestrict

Restrict network communication to the given IP networks (CIDR masks)

Type: @@ -1748,7 +1748,7 @@

services.ethereum.geth.\.args

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: @@ -1756,7 +1756,7 @@

services.ethereum.geth.\.args.net

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.networkid

The network id used for peer to peer communication

Type: @@ -1764,7 +1764,7 @@

services.ethereum.geth.\.args.n

Default: 1

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.nodiscover

Disable discovery

Type: @@ -1772,7 +1772,7 @@

services.ethereum.geth.\.args.

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.port

Port number Go Ethereum will be listening on, both TCP and UDP.

Type: @@ -1780,7 +1780,7 @@

services.ethereum.geth.\.args.portDefault: 30303

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.syncmode

Blockchain sync mode.

Type: @@ -1788,7 +1788,7 @@

services.ethereum.geth.\.args.sy

Default: "snap"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.verbosity

log verbosity (0-5)

Type: @@ -1796,7 +1796,7 @@

services.ethereum.geth.\.args.v

Default: 3

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.ws.enable

Whether to enable Go Ethereum WebSocket API.

Type: @@ -1806,7 +1806,7 @@

services.ethereum.geth.\.args.ws

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.ws.addr

Listen address of Go Ethereum WebSocket API.

Type: @@ -1814,7 +1814,7 @@

services.ethereum.geth.\.args.ws.a

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.ws.api

APIs to enable over WebSocket

Type: @@ -1831,7 +1831,7 @@

services.ethereum.geth.\.args.ws.ap ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.args.ws.port

Port number of Go Ethereum WebSocket API.

Type: @@ -1839,7 +1839,7 @@

services.ethereum.geth.\.args.ws.p

Default: 8546

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.enable

Whether to enable Enable backup.

Type: @@ -1849,7 +1849,7 @@

services.ethereum.geth.\.backup.

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: @@ -1859,7 +1859,7 @@

services.ethereum.geth.\.ba

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: @@ -1867,7 +1867,7 @@

services.ethereum.geth

Default: "/snapshots"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: @@ -1877,7 +1877,7 @@

services.ethereum.geth

Example: "10"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: @@ -1885,7 +1885,7 @@

services.ethereum.geth.\Default: 10

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1894,7 +1894,7 @@

services.ethereum.geth.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1924,7 +1924,7 @@

services.ethereum.geth.\. ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1939,7 +1939,7 @@

services.ethereum.geth.\]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.passwordFile

Read the repository password from a file.

Type: @@ -1947,7 +1947,7 @@

services.ethereum.geth.\Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1978,7 +1978,7 @@

services.ethereum.geth.\}

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1990,7 +1990,7 @@

services.ethereum.geth

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -2012,7 +2012,7 @@

services.ethereum.geth.\< }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.repository

repository to backup to.

Type: @@ -2022,7 +2022,7 @@

services.ethereum.geth.\Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -2030,7 +2030,7 @@

services.ethereum.geth.\

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: @@ -2040,7 +2040,7 @@

services.ethereum.geth.\.backu

Example: "daily"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.extraArgs

Additional arguments to pass to Go Ethereum.

Type: @@ -2048,7 +2048,7 @@

services.ethereum.geth.\.extraArgs<

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -2056,7 +2056,7 @@

services.ethereum.geth.\.openFir

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.enable

Whether to enable Enable restore from snapshot.

Type: @@ -2066,7 +2066,7 @@

services.ethereum.geth.\.restor

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -2075,7 +2075,7 @@

services.ethereum.geth

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -2105,7 +2105,7 @@

services.ethereum.geth.\ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -2120,7 +2120,7 @@

services.ethereum.geth.\< ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.passwordFile

Read the repository password from a file.

Type: @@ -2128,7 +2128,7 @@

services.ethereum.geth.\<

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -2159,7 +2159,7 @@

services.ethereum.geth.\< }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -2171,7 +2171,7 @@

services.ethereum.get

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -2193,7 +2193,7 @@

services.ethereum.geth.\ }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.repository

repository to backup to.

Type: @@ -2203,7 +2203,7 @@

services.ethereum.geth.\Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -2211,13 +2211,13 @@

services.ethereum.geth.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

services.ethereum.geth.\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: @@ -2227,7 +2227,7 @@

services.ethereum.geth.\.resto

Example: "900"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

diff --git a/reference/module-options/lighthouse-beacon/index.html b/reference/module-options/lighthouse-beacon/index.html index bcc38e4e..77c33831 100644 --- a/reference/module-options/lighthouse-beacon/index.html +++ b/reference/module-options/lighthouse-beacon/index.html @@ -1391,7 +1391,7 @@

services.ethereum.lighthouse-beaconDefault: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.enable

Whether to enable Lighthouse Ethereum Beacon Chain Node written in Rust from Sigma Prime.

Type: @@ -1401,7 +1401,7 @@

services.ethereum.lighthouse-be

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.package

Package to use for Lighthouse binary

Type: @@ -1409,7 +1409,7 @@

services.ethereum.lighthouse-b

Default: pkgs.lighthouse

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.checkpoint-sync-url

URL of a synced beacon node to trust in obtaining checkpoint sync data. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --wss-checkpoint flag

@@ -1420,7 +1420,7 @@

services.ether

Example: "https://goerli.checkpoint-sync.ethpandaops.io"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.datadir

Data directory for the databases.

Type: @@ -1428,7 +1428,7 @@

services.ethereum.lighthou

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.disable-deposit-contract-sync

Explicitly disables syncing of deposit logs from the execution node. This overrides any previous option that depends on it. @@ -1438,7 +1438,7 @@

serv

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.disable-quic

Disables the quic transport. The node will rely solely on the TCP transport for libp2p connections.

@@ -1447,7 +1447,7 @@

services.ethereum.lig

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.disable-upnp

Disable the UPnP configuration

Type: @@ -1455,7 +1455,7 @@

services.ethereum.lig

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.discovery-port

The port used by discv5.

Type: @@ -1463,7 +1463,7 @@

services.ethereum.l

Default: 9000

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.execution-endpoint

Listen address for the execution layer.

Type: @@ -1471,7 +1471,7 @@

services.ethere

Default: "http://127.0.0.1:8551"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.execution-jwt

Path to a file containing a hex-encoded string representing a 32 byte secret used for authentication with an execution node via HTTP

@@ -1482,7 +1482,7 @@

services.ethereum.li

Example: "/var/run/prysm/jwtsecret"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.genesis-state-url

URL of a synced beacon node to trust for obtaining genesis state. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --wss-checkpoint flag

@@ -1493,7 +1493,7 @@

services.ethereu

Example: "https://goerli.checkpoint-sync.ethpandaops.io"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.http.enable

Enable the HTTP RPC server

Type: @@ -1501,7 +1501,7 @@

services.ethereum.light

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.http.address

Host on which the RPC server should listen.

Type: @@ -1509,7 +1509,7 @@

services.ethereum.ligh

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.http.port

RPC port exposed by a beacon node.

Type: @@ -1517,7 +1517,7 @@

services.ethereum.lightho

Default: 5052

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.metrics.enable

Enable Prometheus metrics exporter.

Type: @@ -1525,7 +1525,7 @@

services.ethereum.li

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.metrics.address

Host used to listen and respond with metrics for prometheus.

Type: @@ -1533,7 +1533,7 @@

services.ethereum.l

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.metrics.port

Port used to listen and respond with metrics for prometheus.

Type: @@ -1541,7 +1541,7 @@

services.ethereum.ligh

Default: 5054

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.network

The network to connect to. Mainnet is the default ethereum network.

Type: @@ -1549,7 +1549,7 @@

services.ethereum.lighthou

Default: "name"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.quic-port

The port used by libp2p. Will use TCP if disable-quic is set

@@ -1558,7 +1558,7 @@

services.ethereum.lighth

Default: args.discovery-port + 1

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.args.user

User to run the systemd service.

Type: @@ -1566,7 +1566,7 @@

services.ethereum.lighthouse-

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.enable

Whether to enable Enable backup.

Type: @@ -1576,7 +1576,7 @@

services.ethereum.lightho

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: @@ -1586,7 +1586,7 @@

services.ethereum.li

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: @@ -1594,7 +1594,7 @@

services.

Default: "/snapshots"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: @@ -1604,7 +1604,7 @@

services.

Example: "10"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: @@ -1612,7 +1612,7 @@

services.ethere

Default: 10

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1621,7 +1621,7 @@

services.e

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1651,7 +1651,7 @@

services.ethereum. ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1666,7 +1666,7 @@

services.ethe ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.passwordFile

Read the repository password from a file.

Type: @@ -1674,7 +1674,7 @@

services.ethe

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1705,7 +1705,7 @@

services.ethe }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1717,7 +1717,7 @@

services.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1739,7 +1739,7 @@

services.eth }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.repository

repository to backup to.

Type: @@ -1749,7 +1749,7 @@

services.ethere

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1757,7 +1757,7 @@

services.et

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: @@ -1767,7 +1767,7 @@

services.ethereum.light

Example: "daily"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.extraArgs

Additional arguments to pass to Lighthouse Beacon Chain.

Type: @@ -1775,7 +1775,7 @@

services.ethereum.lighthouse

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -1783,7 +1783,7 @@

services.ethereum.lightho

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.enable

Whether to enable Enable restore from snapshot.

Type: @@ -1793,7 +1793,7 @@

services.ethereum.lighth

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1802,7 +1802,7 @@

services.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1832,7 +1832,7 @@

services.ethereum ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1847,7 +1847,7 @@

services.eth ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.passwordFile

Read the repository password from a file.

Type: @@ -1855,7 +1855,7 @@

services.eth

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1886,7 +1886,7 @@

services.eth }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1898,7 +1898,7 @@

services

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1920,7 +1920,7 @@

services.et }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.repository

repository to backup to.

Type: @@ -1930,7 +1930,7 @@

services.ether

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1938,13 +1938,13 @@

services.e

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

services.ethereum.lighthouse-beacon.\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: @@ -1954,7 +1954,7 @@

services.ethereum.light

Example: "900"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

diff --git a/reference/module-options/lighthouse-validator/index.html b/reference/module-options/lighthouse-validator/index.html index d1296ef0..e8fc972d 100644 --- a/reference/module-options/lighthouse-validator/index.html +++ b/reference/module-options/lighthouse-validator/index.html @@ -963,7 +963,7 @@

services.ethereum.lighthouse-valid

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.enable

Whether to enable Lighthouse Ethereum Validator Client written in Rust from Sigma Prime.

Type: @@ -973,7 +973,7 @@

services.ethereum.lighthouse

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.package

Package to use for Lighthouse binary

Type: @@ -981,7 +981,7 @@

services.ethereum.lighthous

Default: pkgs.lighthouse

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.beacon-nodes

List of Lighthouse Beacon node HTTP APIs to connect to.

When null, looks up the http address+port from the lighthouse @@ -993,7 +993,7 @@

services.ethereum.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.datadir

Data directory for the databases.

Type: @@ -1001,7 +1001,7 @@

services.ethereum.light

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.graffiti

String to include in proposed blocks

Type: @@ -1009,7 +1009,7 @@

services.ethereum.ligh

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.http.enable

Whether to enable the HTTP REST API server.

Type: @@ -1019,7 +1019,7 @@

services.ethereum.li

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.http.address

Host on which the REST API server should listen.

Type: @@ -1027,7 +1027,7 @@

services.ethereum.l

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.http.port

REST API port exposed by a beacon node.

Type: @@ -1035,7 +1035,7 @@

services.ethereum.ligh

Default: 5062

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.metrics.enable

Enable Prometheus metrics exporter.

Type: @@ -1043,7 +1043,7 @@

services.ethereum

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.metrics.address

Host used to listen and respond with metrics for prometheus.

Type: @@ -1051,7 +1051,7 @@

services.ethereu

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.metrics.port

Port used to listen and respond with metrics for prometheus.

Type: @@ -1059,7 +1059,7 @@

services.ethereum.l

Default: 5064

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.network

The network to connect to. Mainnet is the default ethereum network.

Type: @@ -1067,7 +1067,7 @@

services.ethereum.light

Default: "name"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.suggested-fee-recipient

Sets ALL validators’ mapping to a suggested eth address to receive gas fees when proposing a block. note @@ -1079,7 +1079,7 @@

service

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.args.user

User to run the systemd service.

Type: @@ -1087,7 +1087,7 @@

services.ethereum.lighthou

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.enable

Whether to enable Enable backup.

Type: @@ -1097,7 +1097,7 @@

services.ethereum.ligh

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: @@ -1107,7 +1107,7 @@

services.ethereum

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: @@ -1115,7 +1115,7 @@

servic

Default: "/snapshots"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: @@ -1125,7 +1125,7 @@

servic

Example: "10"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: @@ -1133,7 +1133,7 @@

services.eth

Default: 10

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1142,7 +1142,7 @@

service

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1172,7 +1172,7 @@

services.ethere ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1187,7 +1187,7 @@

services.e ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.passwordFile

Read the repository password from a file.

Type: @@ -1195,7 +1195,7 @@

services.e

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1226,7 +1226,7 @@

services.e }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1238,7 +1238,7 @@

servic

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1260,7 +1260,7 @@

services. }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.repository

repository to backup to.

Type: @@ -1270,7 +1270,7 @@

services.eth

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1278,7 +1278,7 @@

services

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: @@ -1288,7 +1288,7 @@

services.ethereum.li

Example: "daily"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.extraArgs

Additional arguments to pass to Lighthouse Validator Client.

Type: @@ -1296,7 +1296,7 @@

services.ethereum.lightho

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -1304,7 +1304,7 @@

services.ethereum.ligh

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.enable

Whether to enable Enable restore from snapshot.

Type: @@ -1314,7 +1314,7 @@

services.ethereum.lig

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1323,7 +1323,7 @@

servic

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1353,7 +1353,7 @@

services.ether ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1368,7 +1368,7 @@

services. ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.passwordFile

Read the repository password from a file.

Type: @@ -1376,7 +1376,7 @@

services.

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1407,7 +1407,7 @@

services. }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1419,7 +1419,7 @@

servi

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1441,7 +1441,7 @@

services }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.repository

repository to backup to.

Type: @@ -1451,7 +1451,7 @@

services.et

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1459,13 +1459,13 @@

service

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

services.ethereum.lighthouse-validator.\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: @@ -1475,7 +1475,7 @@

services.ethereum.li

Example: "900"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

diff --git a/reference/module-options/mev-boost/index.html b/reference/module-options/mev-boost/index.html index 2671d7c8..412ec6e2 100644 --- a/reference/module-options/mev-boost/index.html +++ b/reference/module-options/mev-boost/index.html @@ -970,7 +970,7 @@

services.ethereum.mev-boost

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.enable

Whether to enable MEV-Boost from Flashbots.

Type: @@ -980,7 +980,7 @@

services.ethereum.mev-boost.\.ena

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.package

Package to use for mev-boost binary

Type: @@ -988,7 +988,7 @@

services.ethereum.mev-boost.\.pa

Default: pkgs.mev-boost

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.addr

listen-address for mev-boost server (default ‘localhost:18550’)

Type: @@ -996,7 +996,7 @@

services.ethereum.mev-boost.\.a

Default: "localhost:18550"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.json

log in JSON format instead of text

Type: @@ -1004,7 +1004,7 @@

services.ethereum.mev-boost.\.a

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.log-no-version

disables adding the version to every log entry

Type: @@ -1012,7 +1012,7 @@

services.ethereum.mev-boost

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.log-service

add a ‘service=…’ tag to all log messages

Type: @@ -1020,7 +1020,7 @@

services.ethereum.mev-boost.\<

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.loglevel

minimum loglevel

Type: @@ -1028,7 +1028,7 @@

services.ethereum.mev-boost.\Default: "info"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.min-bid

minimum bid to accept from a relay [eth]

Type: @@ -1036,7 +1036,7 @@

services.ethereum.mev-boost.\Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: @@ -1044,7 +1044,7 @@

services.ethereum.mev-boost.\Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.relay-check

check relay status on startup and on the status API call

Type: @@ -1052,7 +1052,7 @@

services.ethereum.mev-boost.\<

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.relay-monitors

relay urls

Type: @@ -1060,13 +1060,13 @@

services.ethereum.mev-boost

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.relays

relay urls

Type: list of string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.request-max-retries

maximum number of retries for a relay get payload request

Type: @@ -1074,7 +1074,7 @@

services.ethereum.mev-

Default: 5

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.request-timeout-getheader

timeout for getHeader requests to the relay [ms]

Type: @@ -1082,7 +1082,7 @@

services.ethereu

Default: 950

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.request-timeout-getpayload

timeout for getPayload requests to the relay [ms]

Type: @@ -1090,7 +1090,7 @@

services.ethere

Default: 4000

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.args.request-timeout-regval

timeout for registerValidator requests [ms]

Type: @@ -1098,7 +1098,7 @@

services.ethereum.m

Default: 3000

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.enable

Whether to enable Enable backup.

Type: @@ -1108,7 +1108,7 @@

services.ethereum.mev-boost.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: @@ -1118,7 +1118,7 @@

services.ethereum.mev-boost.

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: @@ -1126,7 +1126,7 @@

services.ethereum

Default: "/snapshots"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: @@ -1136,7 +1136,7 @@

services.ethereum

Example: "10"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: @@ -1144,7 +1144,7 @@

services.ethereum.mev-b

Default: 10

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1153,7 +1153,7 @@

services.ethereum.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1183,7 +1183,7 @@

services.ethereum.mev-boos ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1198,7 +1198,7 @@

services.ethereum.mev ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.passwordFile

Read the repository password from a file.

Type: @@ -1206,7 +1206,7 @@

services.ethereum.mev

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1237,7 +1237,7 @@

services.ethereum.mev }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1249,7 +1249,7 @@

services.ethereum

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1271,7 +1271,7 @@

services.ethereum.me }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.repository

repository to backup to.

Type: @@ -1281,7 +1281,7 @@

services.ethereum.mev-b

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1289,7 +1289,7 @@

services.ethereum.m

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: @@ -1299,7 +1299,7 @@

services.ethereum.mev-boost.\Example: "daily"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.extraArgs

Additional arguments to pass to MEV-Boost.

Type: @@ -1307,7 +1307,7 @@

services.ethereum.mev-boost.\.

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.enable

Whether to enable Enable restore from snapshot.

Type: @@ -1317,7 +1317,7 @@

services.ethereum.mev-boost.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1326,7 +1326,7 @@

services.ethereum

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1356,7 +1356,7 @@

services.ethereum.mev-boo ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1371,7 +1371,7 @@

services.ethereum.me ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.passwordFile

Read the repository password from a file.

Type: @@ -1379,7 +1379,7 @@

services.ethereum.me

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1410,7 +1410,7 @@

services.ethereum.me }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1422,7 +1422,7 @@

services.ethereu

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1444,7 +1444,7 @@

services.ethereum.m }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.repository

repository to backup to.

Type: @@ -1454,7 +1454,7 @@

services.ethereum.mev-

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1462,13 +1462,13 @@

services.ethereum.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

services.ethereum.mev-boost.\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: @@ -1478,7 +1478,7 @@

services.ethereum.mev-boost.\Example: "900"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

diff --git a/reference/module-options/nethermind/index.html b/reference/module-options/nethermind/index.html index 4e95923b..2b5f8564 100644 --- a/reference/module-options/nethermind/index.html +++ b/reference/module-options/nethermind/index.html @@ -1365,7 +1365,7 @@

services.ethereum.nethermind

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.enable

Whether to enable Nethermind Ethereum Node…

Type: @@ -1375,7 +1375,7 @@

services.ethereum.nethermind.\.e

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.package

Package to use as Nethermind.

Type: @@ -1383,7 +1383,7 @@

services.ethereum.nethermind.\.

Default: pkgs.nethermind

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.baseDbPath

Configures the path of the Nethermind’s database folder.

Type: @@ -1391,7 +1391,7 @@

services.ethereum.nethermind.\

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.config

Determines the configuration file of the network on which Nethermind will be running.

Type: @@ -1401,7 +1401,7 @@

services.ethereum.nethermind.\Example: "mainnet"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.configsDirectory

Changes the source directory of your configuration files.

Type: @@ -1409,7 +1409,7 @@

services.ethereum.nether

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.log

Changes the logging level.

Type: @@ -1417,7 +1417,7 @@

services.ethereum.nethermind.\.

Default: "INFO"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.loggerConfigSource

Changes the path of the NLog.config file.

Type: @@ -1425,7 +1425,7 @@

services.ethereum.neth

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.HealthChecks.Enabled

If ‘true’ then Health Check endpoints is enabled at /health.

Type: @@ -1433,7 +1433,7 @@

services.ether

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.JsonRpc.Enabled

Defines whether the JSON RPC service is enabled on node startup.

Type: @@ -1441,7 +1441,7 @@

services.ethereum.n

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.JsonRpc.EngineHost

Host for JSON RPC calls.

Type: @@ -1449,7 +1449,7 @@

services.ethereu

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.JsonRpc.EnginePort

Port for Execution Engine calls.

Type: @@ -1457,7 +1457,7 @@

services.ethereu

Default: 8551

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.JsonRpc.JwtSecretFile

Path to file with hex encoded secret for jwt authentication.

Type: @@ -1467,7 +1467,7 @@

services.ethe

Example: "/var/run/geth/jwtsecret"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.JsonRpc.Port

Port number for JSON RPC calls.

Type: @@ -1475,7 +1475,7 @@

services.ethereum.neth

Default: 8545

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.JsonRpc.WebSocketsPort

Port number for JSON RPC web sockets calls.

Type: @@ -1483,7 +1483,7 @@

services.eth

Default: 8545

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.Metrics.Enabled

If ‘true’,the node publishes various metrics to Prometheus Pushgateway at given interval.

Type: @@ -1491,7 +1491,7 @@

services.ethereum.n

Default: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.Metrics.ExposePort

If ‘true’ then Health Check endpoints is enabled at /health

Type: @@ -1499,7 +1499,7 @@

services.ethereu

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.Network.DiscoveryPort

UDP port number for incoming discovery connections.

Type: @@ -1507,7 +1507,7 @@

services.ethe

Default: 30303

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.args.modules.Network.P2PPort

TPC/IP port number for incoming P2P connections.

Type: @@ -1515,7 +1515,7 @@

services.ethereum.n

Default: 30303

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.enable

Whether to enable Enable backup.

Type: @@ -1525,7 +1525,7 @@

services.ethereum.nethermind.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: @@ -1535,7 +1535,7 @@

services.ethereum.nethermin

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: @@ -1543,7 +1543,7 @@

services.ethereu

Default: "/snapshots"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: @@ -1553,7 +1553,7 @@

services.ethereu

Example: "10"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: @@ -1561,7 +1561,7 @@

services.ethereum.neth

Default: 10

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1570,7 +1570,7 @@

services.ethereum

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1600,7 +1600,7 @@

services.ethereum.netherm ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1615,7 +1615,7 @@

services.ethereum.ne ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.passwordFile

Read the repository password from a file.

Type: @@ -1623,7 +1623,7 @@

services.ethereum.ne

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1654,7 +1654,7 @@

services.ethereum.ne }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1666,7 +1666,7 @@

services.ethereu

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1688,7 +1688,7 @@

services.ethereum.n }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.repository

repository to backup to.

Type: @@ -1698,7 +1698,7 @@

services.ethereum.neth

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1706,7 +1706,7 @@

services.ethereum.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: @@ -1716,7 +1716,7 @@

services.ethereum.nethermind.\

Example: "daily"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.extraArgs

Additional arguments to pass to Nethermind.

Type: @@ -1724,7 +1724,7 @@

services.ethereum.nethermind.\Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -1732,7 +1732,7 @@

services.ethereum.nethermind.\Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.enable

Whether to enable Enable restore from snapshot.

Type: @@ -1742,7 +1742,7 @@

services.ethereum.nethermind.\<

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1751,7 +1751,7 @@

services.ethereu

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1781,7 +1781,7 @@

services.ethereum.nether ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1796,7 +1796,7 @@

services.ethereum.n ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.passwordFile

Read the repository password from a file.

Type: @@ -1804,7 +1804,7 @@

services.ethereum.n

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1835,7 +1835,7 @@

services.ethereum.n }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1847,7 +1847,7 @@

services.ethere

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1869,7 +1869,7 @@

services.ethereum. }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.repository

repository to backup to.

Type: @@ -1879,7 +1879,7 @@

services.ethereum.net

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1887,13 +1887,13 @@

services.ethereum

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

services.ethereum.nethermind.\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: @@ -1903,7 +1903,7 @@

services.ethereum.nethermind.\

Example: "900"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

diff --git a/reference/module-options/prysm-beacon/index.html b/reference/module-options/prysm-beacon/index.html index 48591dd3..6d0eea0b 100644 --- a/reference/module-options/prysm-beacon/index.html +++ b/reference/module-options/prysm-beacon/index.html @@ -1407,7 +1407,7 @@

services.ethereum.prysm-beacon

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.enable

Whether to enable Ethereum Beacon Chain Node from Prysmatic Labs.

Type: @@ -1417,7 +1417,7 @@

services.ethereum.prysm-beacon.\Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.package

Package to use for Prysm binary

Type: @@ -1425,7 +1425,7 @@

services.ethereum.prysm-beacon.\Default: pkgs.prysm

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.checkpoint-sync-url

URL of a synced beacon node to trust in obtaining checkpoint sync data. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --weak-subjectivity-checkpoint flag

Type: @@ -1435,7 +1435,7 @@

services.ethereum.p

Example: "https://goerli.checkpoint-sync.ethpandaops.io"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.datadir

Data directory for the databases.

Type: @@ -1443,7 +1443,7 @@

services.ethereum.prysm-beacon.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.disable-grpc-gateway

Disable the gRPC gateway for JSON-HTTP requests

Type: @@ -1451,7 +1451,7 @@

services.ethereum.

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.disable-monitoring

Disable monitoring service.

Type: @@ -1459,7 +1459,7 @@

services.ethereum.pr

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.genesis-beacon-api-url

URL of a synced beacon node to trust for obtaining genesis state. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --weak-subjectivity-checkpoint flag

Type: @@ -1469,7 +1469,7 @@

services.ethereu

Example: "https://goerli.checkpoint-sync.ethpandaops.io"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.grpc-gateway-host

The host on which the gateway server runs on.

Type: @@ -1477,7 +1477,7 @@

services.ethereum.pry

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.grpc-gateway-port

The port on which the gateway server runs.

Type: @@ -1485,7 +1485,7 @@

services.ethereum.pry

Default: 3500

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.jwt-secret

Path to a file containing a hex-encoded string representing a 32 byte secret used for authentication with an execution node via HTTP

Type: @@ -1495,7 +1495,7 @@

services.ethereum.prysm-beac

Example: "/var/run/prysm/jwtsecret"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.monitoring-host

Host used to listen and respond with metrics for prometheus.

Type: @@ -1503,7 +1503,7 @@

services.ethereum.prysm

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.monitoring-port

Port used to listen and respond with metrics for prometheus.

Type: @@ -1511,7 +1511,7 @@

services.ethereum.prysm

Default: 8080

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: @@ -1519,7 +1519,7 @@

services.ethereum.prysm-beacon.

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.p2p-tcp-port

The port used by libp2p.

Type: @@ -1527,7 +1527,7 @@

services.ethereum.prysm-be

Default: 13000

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.p2p-udp-port

The port used by discv5.

Type: @@ -1535,7 +1535,7 @@

services.ethereum.prysm-be

Default: 12000

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.pprof

Enable the pprof HTTP server.

Type: @@ -1543,7 +1543,7 @@

services.ethereum.prysm-beacon.\<

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.pprofaddr

pprof HTTP server listening interface.

Type: @@ -1551,7 +1551,7 @@

services.ethereum.prysm-beaco

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.pprofport

pprof HTTP server listening port.

Type: @@ -1559,7 +1559,7 @@

services.ethereum.prysm-beaco

Default: 6060

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.rpc-host

Host on which the RPC server should listen.

Type: @@ -1567,7 +1567,7 @@

services.ethereum.prysm-beacon

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.rpc-port

RPC port exposed by a beacon node.

Type: @@ -1575,7 +1575,7 @@

services.ethereum.prysm-beacon

Default: 4000

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.args.user

User to run the systemd service.

Type: @@ -1583,7 +1583,7 @@

services.ethereum.prysm-beacon.\Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.enable

Whether to enable Enable backup.

Type: @@ -1593,7 +1593,7 @@

services.ethereum.prysm-beacon

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: @@ -1603,7 +1603,7 @@

services.ethereum.prysm-b

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: @@ -1611,7 +1611,7 @@

services.ether

Default: "/snapshots"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: @@ -1621,7 +1621,7 @@

services.ether

Example: "10"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: @@ -1629,7 +1629,7 @@

services.ethereum.pr

Default: 10

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1638,7 +1638,7 @@

services.ethere

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1668,7 +1668,7 @@

services.ethereum.prysm ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1683,7 +1683,7 @@

services.ethereum. ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.passwordFile

Read the repository password from a file.

Type: @@ -1691,7 +1691,7 @@

services.ethereum.

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1722,7 +1722,7 @@

services.ethereum. }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1734,7 +1734,7 @@

services.ether

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1756,7 +1756,7 @@

services.ethereum }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.repository

repository to backup to.

Type: @@ -1766,7 +1766,7 @@

services.ethereum.pr

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1774,7 +1774,7 @@

services.ethereu

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: @@ -1784,7 +1784,7 @@

services.ethereum.prysm-beac

Example: "daily"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.extraArgs

Additional arguments to pass to Prysm Beacon Chain.

Type: @@ -1792,7 +1792,7 @@

services.ethereum.prysm-beacon.\<

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -1800,7 +1800,7 @@

services.ethereum.prysm-beacon

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.enable

Whether to enable Enable restore from snapshot.

Type: @@ -1810,7 +1810,7 @@

services.ethereum.prysm-beaco

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1819,7 +1819,7 @@

services.ether

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1849,7 +1849,7 @@

services.ethereum.prys ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1864,7 +1864,7 @@

services.ethereum ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.passwordFile

Read the repository password from a file.

Type: @@ -1872,7 +1872,7 @@

services.ethereum

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1903,7 +1903,7 @@

services.ethereum }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1915,7 +1915,7 @@

services.ethe

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1937,7 +1937,7 @@

services.ethereu }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.repository

repository to backup to.

Type: @@ -1947,7 +1947,7 @@

services.ethereum.p

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1955,13 +1955,13 @@

services.ethere

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

services.ethereum.prysm-beacon.\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: @@ -1971,7 +1971,7 @@

services.ethereum.prysm-beac

Example: "900"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

diff --git a/reference/module-options/prysm-validator/index.html b/reference/module-options/prysm-validator/index.html index 6c076a8e..f30cf3aa 100644 --- a/reference/module-options/prysm-validator/index.html +++ b/reference/module-options/prysm-validator/index.html @@ -984,7 +984,7 @@

services.ethereum.prysm-validator

Default: { }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.enable

Whether to enable Ethereum Prysm validator client.

Type: @@ -994,7 +994,7 @@

services.ethereum.prysm-validator

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.package

Package to use for Prysm binary

Type: @@ -1002,7 +1002,7 @@

services.ethereum.prysm-validato

Default: pkgs.prysm

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.datadir

Data directory for the databases. Defaults to the default datadir for Prysm Beacon

Type: @@ -1010,7 +1010,7 @@

services.ethereum.prysm-vali

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.disable-monitoring

Disable monitoring service.

Type: @@ -1018,7 +1018,7 @@

services.ethereum

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.graffiti

String to include in proposed blocks

Type: @@ -1026,7 +1026,7 @@

services.ethereum.prysm-val

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.grpc-gateway-host

The host on which the gateway server runs on.

Type: @@ -1034,7 +1034,7 @@

services.ethereum.

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.grpc-gateway-port

The port on which the gateway server runs.

Type: @@ -1042,7 +1042,7 @@

services.ethereum.

Default: 7500

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.monitoring-host

Host used to listen and respond with metrics for prometheus.

Type: @@ -1050,7 +1050,7 @@

services.ethereum.pr

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.monitoring-port

Port used to listen and respond with metrics for prometheus.

Type: @@ -1058,7 +1058,7 @@

services.ethereum.pr

Default: 8081

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: @@ -1066,7 +1066,7 @@

services.ethereum.prysm-vali

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.rpc.enable

Enable the Enables the RPC server for the validator.

Type: @@ -1074,7 +1074,7 @@

services.ethereum.prysm-va

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.rpc.host

Host on which the RPC server should listen.

Type: @@ -1082,7 +1082,7 @@

services.ethereum.prysm-vali

Default: "127.0.0.1"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.rpc.port

RPC port exposed by a validator client.

Type: @@ -1090,7 +1090,7 @@

services.ethereum.prysm-vali

Default: 7000

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.suggested-fee-recipient

Sets ALL validators’ mapping to a suggested eth
address to receive gas fees when proposing a block. note
@@ -1102,7 +1102,7 @@

services.eth

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.user

User to run the systemd service.

Type: @@ -1110,7 +1110,7 @@

services.ethereum.prysm-validat

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.wallet-dir

Path to a wallet directory on-disk for Prysm validator accounts

Type: @@ -1118,7 +1118,7 @@

services.ethereum.prysm-v

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.args.wallet-password-file

Path to a plain-text, .txt file containing your wallet password

Type: @@ -1126,7 +1126,7 @@

services.ethere

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.enable

Whether to enable Enable backup.

Type: @@ -1136,7 +1136,7 @@

services.ethereum.prysm-val

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: @@ -1146,7 +1146,7 @@

services.ethereum.prys

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: @@ -1154,7 +1154,7 @@

services.et

Default: "/snapshots"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: @@ -1164,7 +1164,7 @@

services.et

Example: "10"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: @@ -1172,7 +1172,7 @@

services.ethereum

Default: 10

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1181,7 +1181,7 @@

services.eth

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1211,7 +1211,7 @@

services.ethereum.pr ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1226,7 +1226,7 @@

services.ethere ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.passwordFile

Read the repository password from a file.

Type: @@ -1234,7 +1234,7 @@

services.ethere

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1265,7 +1265,7 @@

services.ethere }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1277,7 +1277,7 @@

services.et

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1299,7 +1299,7 @@

services.ether }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.repository

repository to backup to.

Type: @@ -1309,7 +1309,7 @@

services.ethereum

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1317,7 +1317,7 @@

services.ethe

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: @@ -1327,7 +1327,7 @@

services.ethereum.prysm-v

Example: "daily"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.extraArgs

Additional arguments to pass to Prysm validator.

Type: @@ -1335,7 +1335,7 @@

services.ethereum.prysm-valida

Default: [ ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.openFirewall

Open ports in the firewall for any enabled networking services

Type: @@ -1343,7 +1343,7 @@

services.ethereum.prysm-val

Default: false

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.enable

Whether to enable Enable restore from snapshot.

Type: @@ -1353,7 +1353,7 @@

services.ethereum.prysm-va

Example: true

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

@@ -1362,7 +1362,7 @@

services.et

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for @@ -1392,7 +1392,7 @@

services.ethereum.p ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: @@ -1407,7 +1407,7 @@

services.ether ]

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.passwordFile

Read the repository password from a file.

Type: @@ -1415,7 +1415,7 @@

services.ether

Example: "/etc/nixos/restic-password"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote’s specific options under rclone’s docs at @@ -1446,7 +1446,7 @@

services.ether }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup @@ -1458,7 +1458,7 @@

services.e

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for @@ -1480,7 +1480,7 @@

services.ethe }

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.repository

repository to backup to.

Type: @@ -1490,7 +1490,7 @@

services.ethereu

Example: "sftp:backup@192.168.1.100:/backups/my-bucket"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: @@ -1498,13 +1498,13 @@

services.eth

Default: null

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

services.ethereum.prysm-validator.\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: @@ -1514,7 +1514,7 @@

services.ethereum.prysm-v

Example: "900"

Declared by: - - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

+ - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

diff --git a/search/search_index.json b/search/search_index.json index 565b514d..f0bbb16a 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"About the Project","text":"

Ethereum.nix is a collection of Nix packages and NixOS modules designed to make it easier to operate Ethereum related services and infrastructure.

"},{"location":"#background","title":"Background","text":"

In the beginning Ethereum.nix was a playground for Aldo Borrero to experiment with nix'ifying Ethereum related processes. Since then, it has grown into an ever-increasing number of packages and modules targeted towards streamlining day-to-day operations across a variety of different projects.

"},{"location":"license/","title":"License","text":"

Copyright (c) 2022-2023 Ethereum.nix contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"},{"location":"development/contributing/","title":"Contribution Guidelines","text":"

This file contains instructions that will help you make a contribution.

"},{"location":"development/contributing/#licensing","title":"Licensing","text":"

The Ethereum.nix packages, modules and this user guide are licensed under the MIT license.

"},{"location":"development/contributing/#before-you-contribute","title":"Before you contribute","text":"

Here you can take a look at the existing issues. Feel free to contribute, but make sure you have a GitHub account first :) .

If you're new to open source, please read GitHub's guide on How to Contribute to Open Source. It's a quick read, and it's a great way to introduce yourself to how things work behind the scenes in open-source projects.

Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please state your question clearly in an issue.

"},{"location":"development/contributing/#creating-an-issue","title":"Creating an issue","text":"

If you need to create an issue, make sure to clearly describe it, including:

  • The steps to reproduce it if it's a bug
  • The version of ethereum.nix used
"},{"location":"development/contributing/#making-changes","title":"Making changes","text":"

If you want to introduce changes to the project, please follow these steps:

  • Fork the repository on GitHub
  • Create a branch on your fork. Don't commit directly to main
  • Add the necessary tests for your changes
  • Push your changes to the branch in your repository fork
  • Submit a pull request to the original repository

Make sure you based your commits on logical and atomic units!

"},{"location":"development/contributing/#examples-of-git-history","title":"Examples of git history","text":"

Git history that we want to have:

Git history that we are trying to avoid:

Git history that we want to have
*   e3ed88b (HEAD -> contribution-guide, upstream/main, origin/main, origin/HEAD, main) Merge pull request #470 from zimbatm/fix_lru_cache\n\n|\\\n\n| * 1ab7d9f Use rayon for multithreading command\n\n|/\n\n*   e9c5bb4 Merge pull request #468 from zimbatm/multithread\n\n|\\\n\n| * de2d6cf Add lint property for Formatter struct\n\n| * cd2ed17 Fix impl on Formatter get_command() function\n\n|/\n\n*   028c344 Merge pull request #465 from rayon/0.15.0-release\n\n|\\\n\n| * 7b619d6 0.15.0 release\n\n|/\n\n*   acdf7df Merge pull request #463 from zimbatm/support-multi-part-namespaces\n
Git history that we are trying to avoid:
*   4c8aca8 Merge pull request #120 from zimbatm/add-rayon\n\n|\\\n\n| * fc2b449 use rayon for engine now\n\n| * 2304683 add rayon config\n\n| * 5285bd3 bump base image to F30\n\n* |   4d0fbe2 Merge pull request #114 from rizary/create_method_create_release\n\n|\\ \\\n\n| * | 36a9396 test changed\n\n| * | 22f681d method create release for github created\n\n* | |   2ef4ea1 Merge pull request #119 from rizary/config.rs\n\n|\\ \\ \\\n\n| |/ /\n\n|/| |\n\n| * | 5f1b8f0 unused functions removed\n\n* | |   a93c361 Merge pull request #117 from zimbatm/add-getreleases-to-abstract\n\n|\\ \\ \\\n\n| |/ /\n\n|/| |\n\n| * | 0a97236 add get_releses for Cargo\n\n| * | 55e4c57 add get_releases/get_release into engine.rs\n\n|/ /\n\n* |   badeddd Merge pull request #101 from zimbatm/extreme-cachin\n

Additionally, it's always good to work on improving documentation and adding examples.

Thank you for considering contributing to ethereum.nix.

"},{"location":"getting-started/backup-and-restore/","title":"Backup and restore","text":"

The following service modules support backups:

  • Geth
  • Prysm Beacon
  • Nethermind

Backup and restore functionality is implemented with Restic.

"},{"location":"getting-started/backup-and-restore/#storage-providers","title":"Storage providers","text":"

At the time of writing Restic supports the following storage backends:

  • Local
  • SFTP
  • REST Server
  • Amazon S3
  • Minio Server
  • Wasabi
  • Alibaba Cloud Object Storage System
  • OpenStack Swift
  • Backblaze B3
  • Microsoft Azure Blob Storage
  • Google Cloud Storage
  • Other services vis RClone
"},{"location":"getting-started/backup-and-restore/#configuring-backups","title":"Configuring backups","text":"

Backup options are set inside the backup section of supporting modules.

backup.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nbackup = {\nenable = true;\nschedule = \"0/1:00:00\";\nrestic = {\nrepository = \"s3:http://dione:9000/geth-sepolia\";\npasswordFile = sops.secrets.restic_password.path;\nenvironmentFile = sops.secrets.restic_env.path;\n};\n};\n};\n}\n

By default, backups are scheduled daily. This can be modified through the schedule option which follows the same format as systemd.time.

To access a Restic repository, a password (also called a key) must be specified. This can be done via restic.passwordFile.

And since Restic can be configured with a wide variety of storage providers, an environment file can be provided to accommodate their configuration. When using an Amazon S3 backend for example the environment file might look like this:

aws.env
AWS_DEFAULT_REGION=eu-west-1\nAWS_ACCESS_KEY_ID=my_access_key\nAWS_SECRET_ACCESS_KEY=my_secret_key\n

For a detailed list of options please see here.

"},{"location":"getting-started/backup-and-restore/#systemd-services","title":"Systemd services","text":"

When backups are enabled several new Systemd services and timers will be introduced to facilitate the backup process.

For an instance of Geth named sepolia for example, the following services will be added:

  • geth-sepolia-metadata.service which captures metadata such as chain height and persists it in the state directory.
  • geth-sepolia-metadata.timer which triggers the metadata service every 10 seconds by default. This interval is configurable via metadata.interval.
  • geth-sepolia-backup.service which is responsible for stopping geth-sepolia.service, backing up its state directory, and restarting it.
  • geth-sepolia-backup.timer which triggers the backup service once daily by default. This schedule is configurable via backup.schedule.
"},{"location":"getting-started/backup-and-restore/#restoring-from-backup","title":"Restoring from backup","text":"

Restore options are set inside the restore section of supporting modules and share many of the same config options as backups.

restore.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nrestore = {\nenable = true;\nsnapshot = \"latest\";\nrestic = {\nrepository = \"s3:http://dione:9000/geth-sepolia\";\npasswordFile = sops.secrets.restic_password.path;\nenvironmentFile = sops.secrets.restic_env.path;\n};\n};\n};\n}\n

The one key difference is the snapshot option which details which snapshot to restore from. This can be latest as seen in the example above, or a specific snapshot id as listed by running restic snapshots:

\u276f restic snapshots -c | head\nID        Time                 Host    Tags\n-------------------------------------------------------------------------------------------------------------------\n5e2006e9  2023-03-22 07:00:07  phoebe  height:3139753\n                                       number:0x2fe8a9\n                                       stateRoot:0x1be15cbc48fbd1ddb2fee1332f5fd6eacca60a737b4e87874c82be32810b19a5\n                                       hash:0x04a53f7cc92888de4ea743419855abdfff4ba84454db211846d984609578b265\n                                       name:geth-sepolia\nbdf903fc  2023-03-22 08:00:18  phoebe  height:3140008\n                                       number:0x2fe9a8\n                                       stateRoot:0xac1fd086f4e5afe152afd110f67ce86a5787895ca75c3fffa516229fc10ec9b2\n                                       hash:0x330594bc56d97b30c9794f33c692f32f3e29a6de1acb495cc4e66b0a437dc4c3\n                                       name:geth-sepolia\ne83e3f49  2023-03-22 09:00:17  phoebe  height:3140256\n                                       number:0x2feaa0\n                                       stateRoot:0x0a82d296b70638063187208707681d8976769594e65cd823da7429e215cce2a7\n                                       hash:0x6b39cfca2375b0cfb11e59c9f159e7a19108aa25cfbf4a88de53a9c1e089e233\n                                       name:geth-sepolia\n

Note: restoring from backup will only be attempted if the state directory for the service in question is empty. The presence of any files will cause the restoration attempt to be aborted.

This means it is safe to leave the restore config in place as it only has an effect when initialising a fresh instance.

"},{"location":"getting-started/installation/","title":"Installation","text":"

Below you'll find several examples of how to use ethereum.nix. Choose appropriately depending on if you're using Nix Flakes or not.

With flakes without using overlays (recommended) flake.nix
{\ninputs = {\n    nixpkgs.url = \"github:nixos/nixpkgs/22.11\";\nethereum-nix = {\nurl = \"github:nix-community/ethereum.nix\";\n      inputs.nixpkgs.follows = \"nixpkgs\";\n};\n};\noutputs = inputs @ { self, ethereum-nix, nixpkgs, ... }: let\nsystem = \"x86_64-linux\";\nin {\n    nixosConfigurations.my-system = nixpkgs.lib.nixosSystem {\ninherit system;\npkgs = nixpkgs.legacyPackages.${system};\nmodules = [\n# optional: add nixos modules via the default nixosModule\n        ethereum-nix.nixosModules.${system}.default\n\n({pkgs, system, ...}: {\n          environment.systemPackages = (with ethereum-nix.packages.${system}; [\n            teku\n            lighthouse\n            # ...\n]);\n})\n];\n};\n};\n}\n
With flakes using overlays flake.nix
{\ninputs = {\n    nixpkgs.url = \"github:nixos/nixpkgs/22.11\";\nethereum-nix = {\nurl = \"github:nix-community/ethereum.nix\";\n      inputs.nixpkgs.follows = \"nixpkgs\";\n};\n};\noutputs = inputs @ { self, ethereum-nix, nixpkgs, ... }: let\nsystem = \"x86_64-linux\";\npkgs = import inputs.nixpkgs {\ninherit system;\noverlays = [\n# add packages via the default overlay\n        ethereum-nix.overlays.default\n      ];\n};\nin {\n    nixosConfigurations.my-system = nixpkgs.lib.nixosSystem {\ninherit system pkgs;\nmodules = [\n# optional: add nixos modules via the default nixosModule\n        ethereum-nix.nixosModules.${system}.default\n      ];\n};\n};\n}\n
Without flakes default.nix
{\n  ethereum-nix ? import (fetchTarball \"https://github.com/nix-community/ethereum.nix/archive/main.tar.gz\"),\n  system ? \"x86_64-linux\",\n  pkgs ?\nimport <nixpkgs> # (1) {\ninherit system;\noverlays = [\n# add packages via the default overlay\n        ethereum-nix.overlays.default\n      ];\n},\n}: {\nmy-machine = pkgs.lib.nixosSystem {\ninherit system pkgs;\nmodules = [\n# optional: add nixos modules via the default nixosModule\n      ethereum-nix.nixosModules.${system}.default\n    ];\n};\n}\n
1. You must ensure that your `NIX_PATH` has `nixpkgs` pointing to a version that contains nixos modules e.g. `nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-22.11.tar.gz`"},{"location":"getting-started/restore-from-backup/","title":"Restoring from a backup","text":"

The following service modules support restoring from backups:

  • Geth
  • Prysm Beacon
  • Nethermind

For an overview of how to configure backups please see here

"},{"location":"getting-started/restore-from-backup/#basic-configuration","title":"Basic configuration","text":"

Restore options are set inside the restore section of supporting modules.

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nrestore = {\nenable = true;\nsnapshot = \"3090378\";\nborg = {\nrepo = \"ssh://borg@backup.server/data/borgbackup/ethereum/geth-sepolia\";\nkeyPath = \"/root/ed25519\";\nunencryptedRepoAccess = true;\n};\n};\n};\n}\n
"},{"location":"getting-started/restore-from-backup/#borg-backup","title":"Borg Backup","text":""},{"location":"getting-started/restore-from-backup/#host-key-checking","title":"Host key checking","text":"

Borg Backup uses ssh when connecting to a remote repository and as such requires an ssh private key. This key path can be provided via the keyPath option.

When connecting to a backup host for the first time a restoration may fail if the provided host key has not been added to the remote machine's known host list.

For testing and development purposes this check can be disabled via the strictHostKeyChecking option.

For production setups it is recommended to update the remote server's known host list first before any backups are scheduled.

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nrestore = {\nenable = true;\nsnapshot = \"3090378\";\nborg = {\nrepo = \"ssh://borg@dione/data/borgbackup/ethereum/geth-sepolia\";\nkeyPath = \"/root/ed25519\";\nstrictHostKeyChecking = false;\n};\n};\n};\n}\n
"},{"location":"getting-started/restore-from-backup/#repository-encryption","title":"Repository encryption","text":"

There are several encryption schemes available for securing backup repositories.

**Note: ** The encryption mode can only be configured when creating a new repository - you can neither configure it on a per-archive basis nor change the encryption mode of an existing repository.

For an overview of the encryption schemes available please refer to the borg backup official docs.

Suitable corresponding NixOS options for configuring encryption are available.

"},{"location":"getting-started/running-geth/","title":"Running Geth","text":"

One or more Geth services can be configured with the services.ethereum.geth prefix.

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\nenable = true;\npackage = pkgs.geth;\nopenFirewall = true;\nargs = {\nsyncmode = \"full\";\nnetwork = \"sepolia\";\nhttp = {\nenable = true;\naddr = \"0.0.0.0\";\nvhosts = [\"localhost\" \"phoebe\"];\napi = [\"net\" \"web3\" \"eth\"];\n};\n      authrpc.jwtsecret = sops.secrets.geth_jwt_secret.path;\n};\nextraArgs = [\n\"--bootnodes\"\n\"enode://8ae4559db1b1e160be8cc46018d7db123ed6d03fbbfe481da5ec05f71f0aa4d5f4b02ad059127096aa994568706a0d02933984083b87c5e1e3de2b7692444d37@35.161.233.158:46855,enode://d0b3b290422f35ec3e68356f3a4cdf9c661f71a868110670e31441a5021d7abd0440ae8dfb9360aafdd0198f177863361e3a7a7eb5e1a3e26575bf1ac3ef4ab3@162.19.136.65:48264,enode://d64624bda3cdb65d542c90757a4a661cfe9dddf8328bdb1ea97a8d70fad287c360f0101c492d8fd6ab30d79160a3bf148cacfd68f5d2e47eab0b709516419304@51.195.63.10:30040,enode://c7df835939e027325c6bba926220fae5912a33c83d96b3eef8ef445c98083f3191788581c9a0e8f74cadb0b13229b847f5c1ebd315b22bcf11faf6468020eb48@54.163.51.157:30303,enode://da0609bad3afcab9b93175a41a2d621d07aa7ff6c134a00792d4541f0ce8d30d8f3c51bb37a47573508a0bf18865b04066af2a661edf1d3a3d8d133fc1031aa0@88.151.101.14:45192,enode://7a4534d392c59369eae6befa56ac670476d9edc16597cf53c92bbefa6e741b6b0b9e6822cab12afb09123e03ca1131026fbef145adec429fe2e50182dfb650a5@94.130.18.108:31312,enode://db6fa13b63a885440de581ee3fc8df9c6a590326b39fc5ccba7991707ee0cebac306211f7eca5270a350201a3132511f2338481edd81f3dc819c2a1c60419cf2@65.21.89.157:30303,enode://fcf03e9404cace34c60e4eed374ef9a779471014319b3346352fbc2f992a399af6517486e8e65a4ab55f4645fe55420bbea1cddc13a4af4df63b0f731915c6a6@13.125.238.49:46173,enode://8b973816278fdd56966709e4794c7ccce1f256eaa9165a6b013b991a9bdf3886a8f2d23af50ee723a5614a9fe9d197252b803b4455a87ab2468e128f7b06e0ca@172.104.107.145:30303,enode://5a1fb15f826a213d3ef4adb9be47ab58b2240ea05df0d760a244f04762b0847dcb08276b1284f726c22eea30fce0c601cf121b81bac0c151f1b3b4ad00d1482a@34.159.55.147:51262,enode://560928dd14819f88113586726e452b16bbc694ed4144ddadd6290053e7f3fc66bfad13add6889f7d8f37e0c21ccbb6948eb8899c8b30743f4b45a3081f1efed8@34.138.254.5:29888,enode://69a13b575b8c5278431409e9f7db36e7218667ae286bfb65a72dfec9201b2c5bbbe2797a1babbdf17a7bf7ca68fa3fbe1554612637eb1b2425fa975e1bccb54c@35.223.41.3:30303,enode://66158b31eecff939f220b291d2b448edbfe94f1d4c992d9395b5d476e55e54b5abd11d3ee44daf1e18ee27b910ef99cdf6f19775eb4820ebe4f77d7aa948e3b6@51.195.63.10:55198,enode://bf94acbd51170bf075cacb9f149b21ff46354d659ab434a0d40688f776e1e1556bc62be2dc2867ba513844268c0dc8240099a6b60efe1713fbc25da7fdeb6ff1@3.82.105.139:30303,enode://41329e5ceb51cdddbe6a475db00b682505768b71ff8ee37d2d3500ca1b78918f9fad57d6006dd9f79cd418437dbcf87ec2fd58d60710f925cb17da05a51197cf@65.21.34.60:30303\"\n];\n};\n  services.ethereum.geth.goerli = {\nenable = true;\n...\n};\n}\n

Note: It is recommended to use an attribute name that matches the network that Geth is configured for.

"},{"location":"getting-started/running-geth/#configuration","title":"Configuration","text":"

Many of Geth's process arguments have been mapped to NixOS types and can be provided via the args section of the config. For a detailed list please refer to the NixOS Options reference.

Additional arguments can be provided in a list directly to the Geth process via the extraArgs attribute as shown above.

"},{"location":"getting-started/running-geth/#systemd-service","title":"Systemd service","text":"

For each instance that is configured a corresponding Systemd service is created. The service name follows a convention of geth-${name}.service.

Config Name Service name services.ethereum.geth.sepolia sepolia geth-sepolia.service services.ethereum.geth.goerli goerli geth-goerli.service services.ethereum.geth.mainnet mainnet geth-mainnet.service

The service that is created can then be introspected and managed via the standard Systemd toolset.

Action Command Status systemctl status geth-sepolia.service Stop systemctl stop geth-sepolia.service Start systemctl start geth-sepolia.service Restart systemctl restart geth-sepolia.service Logs journalctl -xefu geth-sepolia.service"},{"location":"getting-started/running-geth/#using-a-geth-fork","title":"Using a Geth fork","text":"

A different version of Geth can be configured via the package option.

To configure Geth Sealer for example:

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\nenable = true;\npackage = pkgs.geth-sealer;\n...\n};\n}\n
"},{"location":"getting-started/running-geth/#opening-ports","title":"Opening ports","text":"

By default, openFirewall is set to false. If set to true, firewall rules are added which will expose the following ports:

Protocol Config Default value TCP, UDP port 30303 TCP authrpc.port 8551 TCP http.port 8545 TCP ws.port 8546 TCP metrics.port 6060

Note: it is important when running multiple instances of Geth on the same machine that you ensure they are configured with different ports.

"},{"location":"getting-started/running-lighthouse-beacon/","title":"Running Lighthouse Beacon","text":"

One or more Lighthouse Beacon services can be configured with the services.ethereum.lighthouse-beacon prefix.

server.nix
{ pkgs, ...}: {\n  services.ethereum.lighthouse-beacon.sepolia = {\nenable = true;\nopenFirewall = true;\nargs = {\nnetwork = \"sepolia\"; # (Optional) defaults to beacon name\nexecution-jwt = secrets.lighthouse_jwt_secret.path;\ncheckpoint-sync-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\ngenesis-state-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\n};\nhttp-address = \"0.0.0.0\";\n};\n  services.ethereum.lighthouse-beacon.goerli = {\nenable = true;\n...\n};\n}\n

Note: It is recommended to use an attribute name that matches the network that Lighthouse Beacon is configured for.

"},{"location":"getting-started/running-lighthouse-beacon/#configuration","title":"Configuration","text":"

Many of Lighthouse Beacon's process arguments have been mapped to NixOS types and can be provided via the args section of the config. For a detailed list please refer to the NixOS Options reference.

Additional arguments can be provided in a list directly to the Lighthouse Beacon process via the extraArgs attribute as shown above.

"},{"location":"getting-started/running-lighthouse-beacon/#systemd-service","title":"Systemd service","text":"

For each instance that is configured a corresponding Systemd service is created. The service name follows a convention of lighthouse-beacon-${name}.service.

Config Name Service name services.ethereum.lighthouse-beacon.sepolia sepolia lighthouse-beacon-sepolia.service services.ethereum.lighthouse-beacon.goerli goerli lighthouse-beacon-goerli.service services.ethereum.lighthouse-beacon.mainnet mainnet lighthouse-beacon-mainnet.service

The service that is created can then be introspected and managed via the standard Systemd toolset.

Action Command Status systemctl status lighthouse-beacon-sepolia.service Stop systemctl stop lighthouse-beacon-sepolia.service Start systemctl start lighthouse-beacon-sepolia.service Restart systemctl restart lighthouse-beacon-sepolia.service Logs journalctl -xefu lighthouse-beacon-sepolia.service"},{"location":"getting-started/running-lighthouse-beacon/#using-a-lighthouse-beacon-fork","title":"Using a Lighthouse Beacon fork","text":"

A different version of Lighthouse Beacon can be configured via the package option.

To configure a custom fork for example:

server.nix
{ pkgs, ...}: {\n  services.ethereum.lighthouse-beacon.sepolia = {\nenable = true;\npackage = pkgs.my-lighthouse-beacon;\n...\n};\n}\n
"},{"location":"getting-started/running-lighthouse-beacon/#opening-ports","title":"Opening ports","text":"

By default, openFirewall is set to false. If set to true firewall rules are added which will expose the following ports:

Protocol Config Default value UDP discovery-port 9000 UDP/TCP quic-port 9001 TCP http-port 5052

Note: it is important when running multiple instances of Lighthouse Beacon on the same machine that you ensure they are configured with different ports.

"},{"location":"getting-started/running-prysm-beacon/","title":"Running Prysm Beacon","text":"

One or more Prysm Beacon services can be configured with the services.ethereum.prysm-beacon prefix.

server.nix
{ pkgs, ...}: {\n  services.ethereum.prysm-beacon.sepolia = {\nenable = true;\nopenFirewall = true;\nargs = {\nnetwork = \"sepolia\";\njwt-secret = secrets.prysm_jwt_secret.path;\ncheckpoint-sync-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\ngenesis-beacon-api-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\n};\nextraArgs = [\n\"--rpc-host=0.0.0.0\"\n\"--monitoring-host=0.0.0.0\"\n];\n};\n  services.ethereum.prysm-beacon.goerli = {\nenable = true;\n...\n};\n}\n

Note: It is recommended to use an attribute name that matches the network that Prysm Beacon is configured for.

"},{"location":"getting-started/running-prysm-beacon/#configuration","title":"Configuration","text":"

Many of Prysm Beacon's process arguments have been mapped to NixOS types and can be provided via the args section of the config. For a detailed list please refer to the NixOS Options reference.

Additional arguments can be provided in a list directly to the Prysm Beacon process via the extraArgs attribute as shown above.

"},{"location":"getting-started/running-prysm-beacon/#systemd-service","title":"Systemd service","text":"

For each instance that is configured a corresponding Systemd service is created. The service name follows a convention of prysm-beacon-${name}.service.

Config Name Service name services.ethereum.prysm-beacon.sepolia sepolia prysm-beacon-sepolia.service services.ethereum.prysm-beacon.goerli goerli prysm-beacon-goerli.service services.ethereum.prysm-beacon.mainnet mainnet prysm-beacon-mainnet.service

The service that is created can then be introspected and managed via the standard Systemd toolset.

Action Command Status systemctl status prysm-beacon-sepolia.service Stop systemctl stop prysm-beacon-sepolia.service Start systemctl start prysm-beacon-sepolia.service Restart systemctl restart prysm-beacon-sepolia.service Logs journalctl -xefu prysm-beacon-sepolia.service"},{"location":"getting-started/running-prysm-beacon/#using-a-prysm-beacon-fork","title":"Using a Prysm Beacon fork","text":"

A different version of Prysm Beacon can be configured via the package option.

To configure a custom fork for example:

server.nix
{ pkgs, ...}: {\n  services.ethereum.prysm-beacon.sepolia = {\nenable = true;\npackage = pkgs.my-prysm-beacon;\n...\n};\n}\n
"},{"location":"getting-started/running-prysm-beacon/#opening-ports","title":"Opening ports","text":"

By default, openFirewall is set to false. If set to true firewall rules are added which will expose the following ports:

Protocol Config Default value UDP p2p-udp-port 12000 TCP p2p-tcp-port 13000 TCP grpc-gateway-port 3500 TCP monitoring-port 8080 TCP pprofport 8080

Note: it is important when running multiple instances of Prysm Beacon on the same machine that you ensure they are configured with different ports.

"},{"location":"reference/module-options/erigon/","title":"Erigon","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigon","title":"services.ethereum.erigon","text":"

Specification of one or more erigon instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

"},{"location":"reference/module-options/erigon/#servicesethereumerigonenable","title":"services.ethereum.erigon.\\.enable

Whether to enable Erigon Ethereum Node\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonpackage","title":"services.ethereum.erigon.\\.package

Package to use as Erigon node.

Type: package

Default: pkgs.erigon

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcaddr","title":"services.ethereum.erigon.\\.args.authrpc.addr

HTTP-RPC server listening interface for the Engine API.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcjwtsecret","title":"services.ethereum.erigon.\\.args.authrpc.jwtsecret

Path to the token that ensures safe connection between CL and EL.

Type: null or string

Default: null

Example: \"/var/run/erigon/jwtsecret\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcport","title":"services.ethereum.erigon.\\.args.authrpc.port

HTTP-RPC server listening port for the Engine API

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8551

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpctimeoutsidle","title":"services.ethereum.erigon.\\.args.authrpc.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

Type: string

Default: \"2m0s\"

Example: \"30s\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpctimeoutsread","title":"services.ethereum.erigon.\\.args.authrpc.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: string

Default: \"30s\"

Example: \"30s\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpctimeoutswrite","title":"services.ethereum.erigon.\\.args.authrpc.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

Type: string

Default: \"30m0s\"

Example: \"30m0s\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcvhosts","title":"services.ethereum.erigon.\\.args.authrpc.vhosts

Comma separated list of virtual hostnames from which to accept Engine API requests (server enforced). Accepts \u2018*\u2019 wildcard.\"

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"erigon.example.org\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargschain","title":"services.ethereum.erigon.\\.args.chain

Name of the network to join. If null the network is mainnet.

Type: one of \u201cmainnet\u201d, \u201crinkeby\u201d, \u201cgoerli\u201d, \u201cholesky\u201d, \u201csokol\u201d, \u201cfermion\u201d, \u201cmumbai\u201d, \u201cbor-mainnet\u201d, \u201cbor-devnet\u201d, \u201csepolia\u201d, \u201cgnosis\u201d, \u201cchiado\u201d

Default: \"mainnet\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsexternalcl","title":"services.ethereum.erigon.\\.args.externalcl

Whether to enable enables external consensus.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpenable","title":"services.ethereum.erigon.\\.args.http.enable

Enable HTTP-RPC server

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpaddr","title":"services.ethereum.erigon.\\.args.http.addr

HTTP-RPC server listening interface.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpapi","title":"services.ethereum.erigon.\\.args.http.api

API\u2019s offered over the HTTP-RPC interface.

Type: null or (list of string)

Example:

[\n  \"net\"\n  \"eth\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpcompression","title":"services.ethereum.erigon.\\.args.http.compression

Whether to enable Enable compression over HTTP-RPC\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpcorsdomain","title":"services.ethereum.erigon.\\.args.http.corsdomain

List of domains from which to accept cross origin requests.

Type: null or (list of string)

Default: null

Example:

[\n  \"*\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpport","title":"services.ethereum.erigon.\\.args.http.port

HTTP-RPC server listening port.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptimeoutsidle","title":"services.ethereum.erigon.\\.args.http.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

Type: string

Default: \"2m0s\"

Example: \"30s\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptimeoutsread","title":"services.ethereum.erigon.\\.args.http.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: string

Default: \"30s\"

Example: \"30s\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptimeoutswrite","title":"services.ethereum.erigon.\\.args.http.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

Type: string

Default: \"30m0s\"

Example: \"30m0s\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptrace","title":"services.ethereum.erigon.\\.args.http.trace

Whether to enable Trace HTTP requests with INFO level.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpvhosts","title":"services.ethereum.erigon.\\.args.http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts \u2018*\u2019 wildcard.

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"erigon.example.org\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsmetricsenable","title":"services.ethereum.erigon.\\.args.metrics.enable

Whether to enable Enable metrics collection and reporting\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsmetricsaddr","title":"services.ethereum.erigon.\\.args.metrics.addr

Enable stand-alone metrics HTTP server listening interface.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsmetricsport","title":"services.ethereum.erigon.\\.args.metrics.port

Metrics HTTP server listening port

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 6060

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsport","title":"services.ethereum.erigon.\\.args.port

Network listening port.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsprivateapiaddr","title":"services.ethereum.erigon.\\.args.private.api.addr

Private api network address, for example: 127.0.0.1:9090, empty string means not to start the listener. Do not expose to public network. Serves remote database interface.

Type: string

Default: \"127.0.0.1:9090\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsprivateapiratelimit","title":"services.ethereum.erigon.\\.args.private.api.ratelimit

Amount of requests server handle simultaneously - requests over this limit will wait. Increase it - if clients see \u2018request timeout\u2019 while server load is low - it means your \u2018hot data\u2019 is small or have much RAM.

Type: signed integer

Default: 31872

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargssnapshots","title":"services.ethereum.erigon.\\.args.snapshots

Default: use snapshots \u201ctrue\u201d for BSC, Mainnet and Goerli. use snapshots \u201cfalse\u201d in all other cases.

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargstorrentport","title":"services.ethereum.erigon.\\.args.torrent.port

Port to listen and serve BitTorrent protocol .

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 42069

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargswsenable","title":"services.ethereum.erigon.\\.args.ws.enable

Whether to enable Erigon WebSocket API.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargswscompression","title":"services.ethereum.erigon.\\.args.ws.compression

Whether to enable Enable compression over HTTP-RPC\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonextraargs","title":"services.ethereum.erigon.\\.extraArgs

Additional arguments to pass to Erigon.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonopenfirewall","title":"services.ethereum.erigon.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonservicesupplementarygroups","title":"services.ethereum.erigon.\\.service.supplementaryGroups

Additional groups for the systemd service e.g. sops-nix group for secret access

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonsubvolume","title":"services.ethereum.erigon.\\.subVolume

Whether to enable Use a subvolume for the state directory if the underlying filesystem supports it e.g. btrfs.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/","title":"Geth bootnode","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnode","title":"services.ethereum.geth-bootnode","text":"

Specification of one or more geth bootnode instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

"},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeenable","title":"services.ethereum.geth-bootnode.\\.enable

Whether to enable Go Ethereum Boot Node.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodepackage","title":"services.ethereum.geth-bootnode.\\.package

Package to use as Go Ethereum Boot node.

Type: package

Default: pkgs.geth

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsaddr","title":"services.ethereum.geth-bootnode.\\.args.addr

Listen address

Type: string

Default: \":30301\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsgenkey","title":"services.ethereum.geth-bootnode.\\.args.genkey

Generate a node key

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnat","title":"services.ethereum.geth-bootnode.\\.args.nat

Port mapping mechanism (any|none|upnp|pmp|pmp:IP|extip:IP)

Type: string

Default: \"none\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnetrestrict","title":"services.ethereum.geth-bootnode.\\.args.netrestrict

Restrict network communication to the given IP networks (CIDR masks)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnodekey","title":"services.ethereum.geth-bootnode.\\.args.nodekey

Private key filename

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnodekeyhex","title":"services.ethereum.geth-bootnode.\\.args.nodekeyhex

Private key as hex (for testing)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsv5","title":"services.ethereum.geth-bootnode.\\.args.v5

Run a V5 topic discovery bootnode

Type: null or boolean

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsverbosity","title":"services.ethereum.geth-bootnode.\\.args.verbosity

log verbosity (0-5)

Type: integer between 0 and 5 (both inclusive)

Default: 3

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsvmodule","title":"services.ethereum.geth-bootnode.\\.args.vmodule

Log verbosity pattern

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargswriteaddress","title":"services.ethereum.geth-bootnode.\\.args.writeaddress

Write out the node\u2019s public key and quit

Type: null or boolean

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeextraargs","title":"services.ethereum.geth-bootnode.\\.extraArgs

Additional arguments to pass to the Go Ethereum Bootnode.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeopenfirewall","title":"services.ethereum.geth-bootnode.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth/","title":"Geth","text":""},{"location":"reference/module-options/geth/#servicesethereumgeth","title":"services.ethereum.geth","text":"

Specification of one or more geth instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

"},{"location":"reference/module-options/geth/#servicesethereumgethenable","title":"services.ethereum.geth.\\.enable

Whether to enable Go Ethereum Node.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethpackage","title":"services.ethereum.geth.\\.package

Package to use as Go Ethereum node.

Type: package

Default: pkgs.geth

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcaddr","title":"services.ethereum.geth.\\.args.authrpc.addr

Listen address of Go Ethereum Auth RPC API.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcjwtsecret","title":"services.ethereum.geth.\\.args.authrpc.jwtsecret

Path to a JWT secret for authenticated RPC endpoint.

Type: null or string

Default: null

Example: \"/var/run/geth/jwtsecret\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcport","title":"services.ethereum.geth.\\.args.authrpc.port

Port number of Go Ethereum Auth RPC API.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8551

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcvhosts","title":"services.ethereum.geth.\\.args.authrpc.vhosts

List of virtual hostnames from which to accept requests.

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"geth.example.org\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsbootnodes","title":"services.ethereum.geth.\\.args.bootnodes

List of bootnodes to connect to

Type: null or (list of string)

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsgcmode","title":"services.ethereum.geth.\\.args.gcmode

Blockchain garbage collection mode.

Type: one of \u201cfull\u201d, \u201carchive\u201d

Default: \"full\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpenable","title":"services.ethereum.geth.\\.args.http.enable

Whether to enable Go Ethereum HTTP API.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpaddr","title":"services.ethereum.geth.\\.args.http.addr

HTTP-RPC server listening interface

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpapi","title":"services.ethereum.geth.\\.args.http.api

API\u2019s offered over the HTTP-RPC interface

Type: null or (list of string)

Default: null

Example:

[\n  \"net\"\n  \"eth\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpcorsdomain","title":"services.ethereum.geth.\\.args.http.corsdomain

List of domains from which to accept cross origin requests

Type: null or (list of string)

Default: null

Example:

[\n  \"*\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpport","title":"services.ethereum.geth.\\.args.http.port

Port number of Go Ethereum HTTP API.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttprpcprefix","title":"services.ethereum.geth.\\.args.http.rpcprefix

HTTP path path prefix on which JSON-RPC is served. Use \u2018/\u2019 to serve on all paths.

Type: null or string

Default: null

Example: \"/\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpvhosts","title":"services.ethereum.geth.\\.args.http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts \u2018*\u2019 wildcard.

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"geth.example.org\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmaxpeers","title":"services.ethereum.geth.\\.args.maxpeers

Maximum peers to connect to.

Type: signed integer

Default: 50

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmetricsenable","title":"services.ethereum.geth.\\.args.metrics.enable

Whether to enable Go Ethereum prometheus metrics.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmetricsaddr","title":"services.ethereum.geth.\\.args.metrics.addr

Listen address of Go Ethereum metrics service.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmetricsport","title":"services.ethereum.geth.\\.args.metrics.port

Port number of Go Ethereum metrics service.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 6060

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnetrestrict","title":"services.ethereum.geth.\\.args.netrestrict

Restrict network communication to the given IP networks (CIDR masks)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnetwork","title":"services.ethereum.geth.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cgoerli\u201d, \u201cholesky\u201d, \u201ckiln\u201d, \u201crinkeby\u201d, \u201cropsten\u201d, \u201csepolia\u201d

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnetworkid","title":"services.ethereum.geth.\\.args.networkid

The network id used for peer to peer communication

Type: signed integer

Default: 1

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnodiscover","title":"services.ethereum.geth.\\.args.nodiscover

Disable discovery

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsport","title":"services.ethereum.geth.\\.args.port

Port number Go Ethereum will be listening on, both TCP and UDP.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargssyncmode","title":"services.ethereum.geth.\\.args.syncmode

Blockchain sync mode.

Type: one of \u201csnap\u201d, \u201cfast\u201d, \u201cfull\u201d, \u201clight\u201d

Default: \"snap\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsverbosity","title":"services.ethereum.geth.\\.args.verbosity

log verbosity (0-5)

Type: integer between 0 and 5 (both inclusive)

Default: 3

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsenable","title":"services.ethereum.geth.\\.args.ws.enable

Whether to enable Go Ethereum WebSocket API.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsaddr","title":"services.ethereum.geth.\\.args.ws.addr

Listen address of Go Ethereum WebSocket API.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsapi","title":"services.ethereum.geth.\\.args.ws.api

APIs to enable over WebSocket

Type: null or (list of string)

Default: null

Example:

[\n  \"net\"\n  \"eth\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsport","title":"services.ethereum.geth.\\.args.ws.port

Port number of Go Ethereum WebSocket API.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8546

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupenable","title":"services.ethereum.geth.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupbtrfsenable","title":"services.ethereum.geth.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupbtrfssnapshotdirectory","title":"services.ethereum.geth.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupbtrfssnapshotretention","title":"services.ethereum.geth.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupmetadatainterval","title":"services.ethereum.geth.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticenvironmentfile","title":"services.ethereum.geth.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticexclude","title":"services.ethereum.geth.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticextraoptions","title":"services.ethereum.geth.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticpasswordfile","title":"services.ethereum.geth.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrcloneconfig","title":"services.ethereum.geth.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrcloneconfigfile","title":"services.ethereum.geth.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrcloneoptions","title":"services.ethereum.geth.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrepository","title":"services.ethereum.geth.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrepositoryfile","title":"services.ethereum.geth.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupschedule","title":"services.ethereum.geth.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethextraargs","title":"services.ethereum.geth.\\.extraArgs

Additional arguments to pass to Go Ethereum.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethopenfirewall","title":"services.ethereum.geth.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreenable","title":"services.ethereum.geth.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticenvironmentfile","title":"services.ethereum.geth.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticexclude","title":"services.ethereum.geth.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticextraoptions","title":"services.ethereum.geth.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticpasswordfile","title":"services.ethereum.geth.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrcloneconfig","title":"services.ethereum.geth.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrcloneconfigfile","title":"services.ethereum.geth.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrcloneoptions","title":"services.ethereum.geth.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrepository","title":"services.ethereum.geth.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrepositoryfile","title":"services.ethereum.geth.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoresnapshot","title":"services.ethereum.geth.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoretimeout","title":"services.ethereum.geth.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/","title":"Lighthouse beacon","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beacon","title":"services.ethereum.lighthouse-beacon","text":"

Specification of one or more lighthouse beacon chain instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

"},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconenable","title":"services.ethereum.lighthouse-beacon.\\.enable

Whether to enable Lighthouse Ethereum Beacon Chain Node written in Rust from Sigma Prime.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconpackage","title":"services.ethereum.lighthouse-beacon.\\.package

Package to use for Lighthouse binary

Type: package

Default: pkgs.lighthouse

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargscheckpoint-sync-url","title":"services.ethereum.lighthouse-beacon.\\.args.checkpoint-sync-url

URL of a synced beacon node to trust in obtaining checkpoint sync data. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --wss-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdatadir","title":"services.ethereum.lighthouse-beacon.\\.args.datadir

Data directory for the databases.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdisable-deposit-contract-sync","title":"services.ethereum.lighthouse-beacon.\\.args.disable-deposit-contract-sync

Explicitly disables syncing of deposit logs from the execution node. This overrides any previous option that depends on it. Useful if you intend to run a non-validating beacon node.

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdisable-quic","title":"services.ethereum.lighthouse-beacon.\\.args.disable-quic

Disables the quic transport. The node will rely solely on the TCP transport for libp2p connections.

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdisable-upnp","title":"services.ethereum.lighthouse-beacon.\\.args.disable-upnp

Disable the UPnP configuration

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdiscovery-port","title":"services.ethereum.lighthouse-beacon.\\.args.discovery-port

The port used by discv5.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 9000

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsexecution-endpoint","title":"services.ethereum.lighthouse-beacon.\\.args.execution-endpoint

Listen address for the execution layer.

Type: string

Default: \"http://127.0.0.1:8551\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsexecution-jwt","title":"services.ethereum.lighthouse-beacon.\\.args.execution-jwt

Path to a file containing a hex-encoded string representing a 32 byte secret used for authentication with an execution node via HTTP

Type: string

Default: null

Example: \"/var/run/prysm/jwtsecret\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsgenesis-state-url","title":"services.ethereum.lighthouse-beacon.\\.args.genesis-state-url

URL of a synced beacon node to trust for obtaining genesis state. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --wss-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargshttpenable","title":"services.ethereum.lighthouse-beacon.\\.args.http.enable

Enable the HTTP RPC server

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargshttpaddress","title":"services.ethereum.lighthouse-beacon.\\.args.http.address

Host on which the RPC server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargshttpport","title":"services.ethereum.lighthouse-beacon.\\.args.http.port

RPC port exposed by a beacon node.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5052

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsmetricsenable","title":"services.ethereum.lighthouse-beacon.\\.args.metrics.enable

Enable Prometheus metrics exporter.

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsmetricsaddress","title":"services.ethereum.lighthouse-beacon.\\.args.metrics.address

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsmetricsport","title":"services.ethereum.lighthouse-beacon.\\.args.metrics.port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5054

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsnetwork","title":"services.ethereum.lighthouse-beacon.\\.args.network

The network to connect to. Mainnet is the default ethereum network.

Type: null or one of \u201cmainnet\u201d, \u201cprater\u201d, \u201cgoerli\u201d, \u201cgnosis\u201d, \u201cchiado\u201d, \u201csepolia\u201d, \u201cholesky\u201d

Default: \"name\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsquic-port","title":"services.ethereum.lighthouse-beacon.\\.args.quic-port

The port used by libp2p. Will use TCP if disable-quic is set

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: args.discovery-port + 1

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsuser","title":"services.ethereum.lighthouse-beacon.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupenable","title":"services.ethereum.lighthouse-beacon.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupbtrfsenable","title":"services.ethereum.lighthouse-beacon.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupbtrfssnapshotdirectory","title":"services.ethereum.lighthouse-beacon.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupbtrfssnapshotretention","title":"services.ethereum.lighthouse-beacon.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupmetadatainterval","title":"services.ethereum.lighthouse-beacon.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticenvironmentfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticexclude","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticextraoptions","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticpasswordfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrcloneconfig","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrcloneconfigfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrcloneoptions","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrepository","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrepositoryfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupschedule","title":"services.ethereum.lighthouse-beacon.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconextraargs","title":"services.ethereum.lighthouse-beacon.\\.extraArgs

Additional arguments to pass to Lighthouse Beacon Chain.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconopenfirewall","title":"services.ethereum.lighthouse-beacon.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreenable","title":"services.ethereum.lighthouse-beacon.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticenvironmentfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticexclude","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticextraoptions","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticpasswordfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrcloneconfig","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrcloneconfigfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrcloneoptions","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrepository","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrepositoryfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoresnapshot","title":"services.ethereum.lighthouse-beacon.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoretimeout","title":"services.ethereum.lighthouse-beacon.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/","title":"Lighthouse validator","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validator","title":"services.ethereum.lighthouse-validator","text":"

Specification of one or more Lighthouse validator instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

"},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorenable","title":"services.ethereum.lighthouse-validator.\\.enable

Whether to enable Lighthouse Ethereum Validator Client written in Rust from Sigma Prime.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorpackage","title":"services.ethereum.lighthouse-validator.\\.package

Package to use for Lighthouse binary

Type: package

Default: pkgs.lighthouse

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsbeacon-nodes","title":"services.ethereum.lighthouse-validator.\\.args.beacon-nodes

List of Lighthouse Beacon node HTTP APIs to connect to.

When null, looks up the http address+port from the lighthouse beacon node service with the same name. (eg services.ethereum.lighthouse-validator.holesky will look at the config of services.ethereum.lighthouse-beacon.holesky)

Type: null or (list of string)

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsdatadir","title":"services.ethereum.lighthouse-validator.\\.args.datadir

Data directory for the databases.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsgraffiti","title":"services.ethereum.lighthouse-validator.\\.args.graffiti

String to include in proposed blocks

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargshttpenable","title":"services.ethereum.lighthouse-validator.\\.args.http.enable

Whether to enable the HTTP REST API server.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargshttpaddress","title":"services.ethereum.lighthouse-validator.\\.args.http.address

Host on which the REST API server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargshttpport","title":"services.ethereum.lighthouse-validator.\\.args.http.port

REST API port exposed by a beacon node.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5062

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsmetricsenable","title":"services.ethereum.lighthouse-validator.\\.args.metrics.enable

Enable Prometheus metrics exporter.

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsmetricsaddress","title":"services.ethereum.lighthouse-validator.\\.args.metrics.address

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsmetricsport","title":"services.ethereum.lighthouse-validator.\\.args.metrics.port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5064

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsnetwork","title":"services.ethereum.lighthouse-validator.\\.args.network

The network to connect to. Mainnet is the default ethereum network.

Type: null or one of \u201cmainnet\u201d, \u201cprater\u201d, \u201cgoerli\u201d, \u201cgnosis\u201d, \u201cchiado\u201d, \u201csepolia\u201d, \u201cholesky\u201d

Default: \"name\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargssuggested-fee-recipient","title":"services.ethereum.lighthouse-validator.\\.args.suggested-fee-recipient

Sets ALL validators\u2019 mapping to a suggested eth address to receive gas fees when proposing a block. note that this is only a suggestion when integrating with a Builder API, which may choose to specify a different fee recipient as payment for the blocks it builds.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsuser","title":"services.ethereum.lighthouse-validator.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupenable","title":"services.ethereum.lighthouse-validator.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupbtrfsenable","title":"services.ethereum.lighthouse-validator.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupbtrfssnapshotdirectory","title":"services.ethereum.lighthouse-validator.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupbtrfssnapshotretention","title":"services.ethereum.lighthouse-validator.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupmetadatainterval","title":"services.ethereum.lighthouse-validator.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticenvironmentfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticexclude","title":"services.ethereum.lighthouse-validator.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticextraoptions","title":"services.ethereum.lighthouse-validator.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticpasswordfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrcloneconfig","title":"services.ethereum.lighthouse-validator.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrcloneconfigfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrcloneoptions","title":"services.ethereum.lighthouse-validator.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrepository","title":"services.ethereum.lighthouse-validator.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrepositoryfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupschedule","title":"services.ethereum.lighthouse-validator.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorextraargs","title":"services.ethereum.lighthouse-validator.\\.extraArgs

Additional arguments to pass to Lighthouse Validator Client.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatoropenfirewall","title":"services.ethereum.lighthouse-validator.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreenable","title":"services.ethereum.lighthouse-validator.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticenvironmentfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticexclude","title":"services.ethereum.lighthouse-validator.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticextraoptions","title":"services.ethereum.lighthouse-validator.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticpasswordfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrcloneconfig","title":"services.ethereum.lighthouse-validator.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrcloneconfigfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrcloneoptions","title":"services.ethereum.lighthouse-validator.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrepository","title":"services.ethereum.lighthouse-validator.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrepositoryfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoresnapshot","title":"services.ethereum.lighthouse-validator.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoretimeout","title":"services.ethereum.lighthouse-validator.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/mev-boost/","title":"Mev boost","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boost","title":"services.ethereum.mev-boost","text":"

Specification of one or more MEV-Boost chain instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

"},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostenable","title":"services.ethereum.mev-boost.\\.enable

Whether to enable MEV-Boost from Flashbots.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostpackage","title":"services.ethereum.mev-boost.\\.package

Package to use for mev-boost binary

Type: package

Default: pkgs.mev-boost

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsaddr","title":"services.ethereum.mev-boost.\\.args.addr

listen-address for mev-boost server (default \u2018localhost:18550\u2019)

Type: string

Default: \"localhost:18550\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsjson","title":"services.ethereum.mev-boost.\\.args.json

log in JSON format instead of text

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargslog-no-version","title":"services.ethereum.mev-boost.\\.args.log-no-version

disables adding the version to every log entry

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargslog-service","title":"services.ethereum.mev-boost.\\.args.log-service

add a \u2018service=\u2026\u2019 tag to all log messages

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsloglevel","title":"services.ethereum.mev-boost.\\.args.loglevel

minimum loglevel

Type: null or one of \u201ctrace\u201d, \u201cdebug\u201d, \u201cinfo\u201d, \u201cwarn\u201d, \u201cerror\u201d, \u201cfatal\u201d, \u201cpanic\u201d

Default: \"info\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsmin-bid","title":"services.ethereum.mev-boost.\\.args.min-bid

minimum bid to accept from a relay [eth]

Type: null or floating point number

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsnetwork","title":"services.ethereum.mev-boost.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cmainnet\u201d, \u201cgoerli\u201d, \u201csepolia\u201d, \u201czhejiang\u201d

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrelay-check","title":"services.ethereum.mev-boost.\\.args.relay-check

check relay status on startup and on the status API call

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrelay-monitors","title":"services.ethereum.mev-boost.\\.args.relay-monitors

relay urls

Type: null or (list of string)

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrelays","title":"services.ethereum.mev-boost.\\.args.relays

relay urls

Type: list of string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-max-retries","title":"services.ethereum.mev-boost.\\.args.request-max-retries

maximum number of retries for a relay get payload request

Type: signed integer

Default: 5

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-timeout-getheader","title":"services.ethereum.mev-boost.\\.args.request-timeout-getheader

timeout for getHeader requests to the relay [ms]

Type: signed integer

Default: 950

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-timeout-getpayload","title":"services.ethereum.mev-boost.\\.args.request-timeout-getpayload

timeout for getPayload requests to the relay [ms]

Type: signed integer

Default: 4000

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-timeout-regval","title":"services.ethereum.mev-boost.\\.args.request-timeout-regval

timeout for registerValidator requests [ms]

Type: signed integer

Default: 3000

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupenable","title":"services.ethereum.mev-boost.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupbtrfsenable","title":"services.ethereum.mev-boost.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupbtrfssnapshotdirectory","title":"services.ethereum.mev-boost.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupbtrfssnapshotretention","title":"services.ethereum.mev-boost.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupmetadatainterval","title":"services.ethereum.mev-boost.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticenvironmentfile","title":"services.ethereum.mev-boost.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticexclude","title":"services.ethereum.mev-boost.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticextraoptions","title":"services.ethereum.mev-boost.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticpasswordfile","title":"services.ethereum.mev-boost.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrcloneconfig","title":"services.ethereum.mev-boost.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrcloneconfigfile","title":"services.ethereum.mev-boost.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrcloneoptions","title":"services.ethereum.mev-boost.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrepository","title":"services.ethereum.mev-boost.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrepositoryfile","title":"services.ethereum.mev-boost.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupschedule","title":"services.ethereum.mev-boost.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostextraargs","title":"services.ethereum.mev-boost.\\.extraArgs

Additional arguments to pass to MEV-Boost.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreenable","title":"services.ethereum.mev-boost.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticenvironmentfile","title":"services.ethereum.mev-boost.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticexclude","title":"services.ethereum.mev-boost.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticextraoptions","title":"services.ethereum.mev-boost.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticpasswordfile","title":"services.ethereum.mev-boost.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrcloneconfig","title":"services.ethereum.mev-boost.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrcloneconfigfile","title":"services.ethereum.mev-boost.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrcloneoptions","title":"services.ethereum.mev-boost.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrepository","title":"services.ethereum.mev-boost.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrepositoryfile","title":"services.ethereum.mev-boost.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoresnapshot","title":"services.ethereum.mev-boost.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoretimeout","title":"services.ethereum.mev-boost.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/nethermind/","title":"Nethermind","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermind","title":"services.ethereum.nethermind","text":"

Specification of one or more Nethermind instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

"},{"location":"reference/module-options/nethermind/#servicesethereumnethermindenable","title":"services.ethereum.nethermind.\\.enable

Whether to enable Nethermind Ethereum Node\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindpackage","title":"services.ethereum.nethermind.\\.package

Package to use as Nethermind.

Type: package

Default: pkgs.nethermind

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsbasedbpath","title":"services.ethereum.nethermind.\\.args.baseDbPath

Configures the path of the Nethermind\u2019s database folder.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsconfig","title":"services.ethereum.nethermind.\\.args.config

Determines the configuration file of the network on which Nethermind will be running.

Type: null or string

Default: null

Example: \"mainnet\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsconfigsdirectory","title":"services.ethereum.nethermind.\\.args.configsDirectory

Changes the source directory of your configuration files.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargslog","title":"services.ethereum.nethermind.\\.args.log

Changes the logging level.

Type: one of \u201cOFF\u201d, \u201cTRACE\u201d, \u201cDEBUG\u201d, \u201cINFO\u201d, \u201cWARN\u201d, \u201cERROR\u201d

Default: \"INFO\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsloggerconfigsource","title":"services.ethereum.nethermind.\\.args.loggerConfigSource

Changes the path of the NLog.config file.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmoduleshealthchecksenabled","title":"services.ethereum.nethermind.\\.args.modules.HealthChecks.Enabled

If \u2018true\u2019 then Health Check endpoints is enabled at /health.

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcenabled","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.Enabled

Defines whether the JSON RPC service is enabled on node startup.

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcenginehost","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.EngineHost

Host for JSON RPC calls.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcengineport","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.EnginePort

Port for Execution Engine calls.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8551

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcjwtsecretfile","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.JwtSecretFile

Path to file with hex encoded secret for jwt authentication.

Type: null or string

Default: null

Example: \"/var/run/geth/jwtsecret\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcport","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.Port

Port number for JSON RPC calls.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcwebsocketsport","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.WebSocketsPort

Port number for JSON RPC web sockets calls.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesmetricsenabled","title":"services.ethereum.nethermind.\\.args.modules.Metrics.Enabled

If \u2018true\u2019,the node publishes various metrics to Prometheus Pushgateway at given interval.

Type: boolean

Default: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesmetricsexposeport","title":"services.ethereum.nethermind.\\.args.modules.Metrics.ExposePort

If \u2018true\u2019 then Health Check endpoints is enabled at /health

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesnetworkdiscoveryport","title":"services.ethereum.nethermind.\\.args.modules.Network.DiscoveryPort

UDP port number for incoming discovery connections.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesnetworkp2pport","title":"services.ethereum.nethermind.\\.args.modules.Network.P2PPort

TPC/IP port number for incoming P2P connections.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupenable","title":"services.ethereum.nethermind.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupbtrfsenable","title":"services.ethereum.nethermind.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupbtrfssnapshotdirectory","title":"services.ethereum.nethermind.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupbtrfssnapshotretention","title":"services.ethereum.nethermind.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupmetadatainterval","title":"services.ethereum.nethermind.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticenvironmentfile","title":"services.ethereum.nethermind.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticexclude","title":"services.ethereum.nethermind.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticextraoptions","title":"services.ethereum.nethermind.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticpasswordfile","title":"services.ethereum.nethermind.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrcloneconfig","title":"services.ethereum.nethermind.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrcloneconfigfile","title":"services.ethereum.nethermind.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrcloneoptions","title":"services.ethereum.nethermind.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrepository","title":"services.ethereum.nethermind.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrepositoryfile","title":"services.ethereum.nethermind.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupschedule","title":"services.ethereum.nethermind.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindextraargs","title":"services.ethereum.nethermind.\\.extraArgs

Additional arguments to pass to Nethermind.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindopenfirewall","title":"services.ethereum.nethermind.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreenable","title":"services.ethereum.nethermind.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticenvironmentfile","title":"services.ethereum.nethermind.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticexclude","title":"services.ethereum.nethermind.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticextraoptions","title":"services.ethereum.nethermind.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticpasswordfile","title":"services.ethereum.nethermind.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrcloneconfig","title":"services.ethereum.nethermind.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrcloneconfigfile","title":"services.ethereum.nethermind.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrcloneoptions","title":"services.ethereum.nethermind.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrepository","title":"services.ethereum.nethermind.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrepositoryfile","title":"services.ethereum.nethermind.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoresnapshot","title":"services.ethereum.nethermind.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoretimeout","title":"services.ethereum.nethermind.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/","title":"Prysm beacon","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beacon","title":"services.ethereum.prysm-beacon","text":"

Specification of one or more prysm beacon chain instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

"},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconenable","title":"services.ethereum.prysm-beacon.\\.enable

Whether to enable Ethereum Beacon Chain Node from Prysmatic Labs.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconpackage","title":"services.ethereum.prysm-beacon.\\.package

Package to use for Prysm binary

Type: package

Default: pkgs.prysm

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargscheckpoint-sync-url","title":"services.ethereum.prysm-beacon.\\.args.checkpoint-sync-url

URL of a synced beacon node to trust in obtaining checkpoint sync data. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --weak-subjectivity-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsdatadir","title":"services.ethereum.prysm-beacon.\\.args.datadir

Data directory for the databases.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsdisable-grpc-gateway","title":"services.ethereum.prysm-beacon.\\.args.disable-grpc-gateway

Disable the gRPC gateway for JSON-HTTP requests

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsdisable-monitoring","title":"services.ethereum.prysm-beacon.\\.args.disable-monitoring

Disable monitoring service.

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsgenesis-beacon-api-url","title":"services.ethereum.prysm-beacon.\\.args.genesis-beacon-api-url

URL of a synced beacon node to trust for obtaining genesis state. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --weak-subjectivity-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsgrpc-gateway-host","title":"services.ethereum.prysm-beacon.\\.args.grpc-gateway-host

The host on which the gateway server runs on.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsgrpc-gateway-port","title":"services.ethereum.prysm-beacon.\\.args.grpc-gateway-port

The port on which the gateway server runs.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 3500

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsjwt-secret","title":"services.ethereum.prysm-beacon.\\.args.jwt-secret

Path to a file containing a hex-encoded string representing a 32 byte secret used for authentication with an execution node via HTTP

Type: string

Default: null

Example: \"/var/run/prysm/jwtsecret\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsmonitoring-host","title":"services.ethereum.prysm-beacon.\\.args.monitoring-host

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsmonitoring-port","title":"services.ethereum.prysm-beacon.\\.args.monitoring-port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8080

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsnetwork","title":"services.ethereum.prysm-beacon.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cgoerli\u201d, \u201cholesky\u201d, \u201cprater\u201d, \u201cropsten\u201d, \u201csepolia\u201d

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsp2p-tcp-port","title":"services.ethereum.prysm-beacon.\\.args.p2p-tcp-port

The port used by libp2p.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 13000

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsp2p-udp-port","title":"services.ethereum.prysm-beacon.\\.args.p2p-udp-port

The port used by discv5.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 12000

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargspprof","title":"services.ethereum.prysm-beacon.\\.args.pprof

Enable the pprof HTTP server.

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargspprofaddr","title":"services.ethereum.prysm-beacon.\\.args.pprofaddr

pprof HTTP server listening interface.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargspprofport","title":"services.ethereum.prysm-beacon.\\.args.pprofport

pprof HTTP server listening port.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 6060

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsrpc-host","title":"services.ethereum.prysm-beacon.\\.args.rpc-host

Host on which the RPC server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsrpc-port","title":"services.ethereum.prysm-beacon.\\.args.rpc-port

RPC port exposed by a beacon node.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 4000

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsuser","title":"services.ethereum.prysm-beacon.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupenable","title":"services.ethereum.prysm-beacon.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupbtrfsenable","title":"services.ethereum.prysm-beacon.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupbtrfssnapshotdirectory","title":"services.ethereum.prysm-beacon.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupbtrfssnapshotretention","title":"services.ethereum.prysm-beacon.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupmetadatainterval","title":"services.ethereum.prysm-beacon.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticenvironmentfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticexclude","title":"services.ethereum.prysm-beacon.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticextraoptions","title":"services.ethereum.prysm-beacon.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticpasswordfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrcloneconfig","title":"services.ethereum.prysm-beacon.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrcloneconfigfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrcloneoptions","title":"services.ethereum.prysm-beacon.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrepository","title":"services.ethereum.prysm-beacon.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrepositoryfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupschedule","title":"services.ethereum.prysm-beacon.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconextraargs","title":"services.ethereum.prysm-beacon.\\.extraArgs

Additional arguments to pass to Prysm Beacon Chain.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconopenfirewall","title":"services.ethereum.prysm-beacon.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreenable","title":"services.ethereum.prysm-beacon.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticenvironmentfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticexclude","title":"services.ethereum.prysm-beacon.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticextraoptions","title":"services.ethereum.prysm-beacon.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticpasswordfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrcloneconfig","title":"services.ethereum.prysm-beacon.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrcloneconfigfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrcloneoptions","title":"services.ethereum.prysm-beacon.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrepository","title":"services.ethereum.prysm-beacon.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrepositoryfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoresnapshot","title":"services.ethereum.prysm-beacon.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoretimeout","title":"services.ethereum.prysm-beacon.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/","title":"Prysm validator","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validator","title":"services.ethereum.prysm-validator","text":"

Specification of one or more prysm validator instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

"},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorenable","title":"services.ethereum.prysm-validator.\\.enable

Whether to enable Ethereum Prysm validator client.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorpackage","title":"services.ethereum.prysm-validator.\\.package

Package to use for Prysm binary

Type: package

Default: pkgs.prysm

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsdatadir","title":"services.ethereum.prysm-validator.\\.args.datadir

Data directory for the databases. Defaults to the default datadir for Prysm Beacon

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsdisable-monitoring","title":"services.ethereum.prysm-validator.\\.args.disable-monitoring

Disable monitoring service.

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsgraffiti","title":"services.ethereum.prysm-validator.\\.args.graffiti

String to include in proposed blocks

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsgrpc-gateway-host","title":"services.ethereum.prysm-validator.\\.args.grpc-gateway-host

The host on which the gateway server runs on.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsgrpc-gateway-port","title":"services.ethereum.prysm-validator.\\.args.grpc-gateway-port

The port on which the gateway server runs.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 7500

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsmonitoring-host","title":"services.ethereum.prysm-validator.\\.args.monitoring-host

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsmonitoring-port","title":"services.ethereum.prysm-validator.\\.args.monitoring-port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8081

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsnetwork","title":"services.ethereum.prysm-validator.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cgoerli\u201d, \u201cholesky\u201d, \u201cprater\u201d, \u201cropsten\u201d, \u201csepolia\u201d

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsrpcenable","title":"services.ethereum.prysm-validator.\\.args.rpc.enable

Enable the Enables the RPC server for the validator.

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsrpchost","title":"services.ethereum.prysm-validator.\\.args.rpc.host

Host on which the RPC server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsrpcport","title":"services.ethereum.prysm-validator.\\.args.rpc.port

RPC port exposed by a validator client.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 7000

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargssuggested-fee-recipient","title":"services.ethereum.prysm-validator.\\.args.suggested-fee-recipient

Sets ALL validators\u2019 mapping to a suggested eth address to receive gas fees when proposing a block. note that this is only a suggestion when integrating with a Builder API, which may choose to specify a different fee recipient as payment for the blocks it builds.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsuser","title":"services.ethereum.prysm-validator.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargswallet-dir","title":"services.ethereum.prysm-validator.\\.args.wallet-dir

Path to a wallet directory on-disk for Prysm validator accounts

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargswallet-password-file","title":"services.ethereum.prysm-validator.\\.args.wallet-password-file

Path to a plain-text, .txt file containing your wallet password

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupenable","title":"services.ethereum.prysm-validator.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupbtrfsenable","title":"services.ethereum.prysm-validator.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupbtrfssnapshotdirectory","title":"services.ethereum.prysm-validator.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupbtrfssnapshotretention","title":"services.ethereum.prysm-validator.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupmetadatainterval","title":"services.ethereum.prysm-validator.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticenvironmentfile","title":"services.ethereum.prysm-validator.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticexclude","title":"services.ethereum.prysm-validator.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticextraoptions","title":"services.ethereum.prysm-validator.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticpasswordfile","title":"services.ethereum.prysm-validator.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrcloneconfig","title":"services.ethereum.prysm-validator.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrcloneconfigfile","title":"services.ethereum.prysm-validator.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrcloneoptions","title":"services.ethereum.prysm-validator.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrepository","title":"services.ethereum.prysm-validator.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrepositoryfile","title":"services.ethereum.prysm-validator.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupschedule","title":"services.ethereum.prysm-validator.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorextraargs","title":"services.ethereum.prysm-validator.\\.extraArgs

Additional arguments to pass to Prysm validator.

Type: list of string

Default: [ ]

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatoropenfirewall","title":"services.ethereum.prysm-validator.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreenable","title":"services.ethereum.prysm-validator.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticenvironmentfile","title":"services.ethereum.prysm-validator.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticexclude","title":"services.ethereum.prysm-validator.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticextraoptions","title":"services.ethereum.prysm-validator.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticpasswordfile","title":"services.ethereum.prysm-validator.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrcloneconfig","title":"services.ethereum.prysm-validator.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrcloneconfigfile","title":"services.ethereum.prysm-validator.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrcloneoptions","title":"services.ethereum.prysm-validator.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrepository","title":"services.ethereum.prysm-validator.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrepositoryfile","title":"services.ethereum.prysm-validator.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoresnapshot","title":"services.ethereum.prysm-validator.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoretimeout","title":"services.ethereum.prysm-validator.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/rfhryn8hmlna5jzscgg9qbcy0d12q6gx-source/modules/prysm-validator/options.nix

","text":""}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"About the Project","text":"

Ethereum.nix is a collection of Nix packages and NixOS modules designed to make it easier to operate Ethereum related services and infrastructure.

"},{"location":"#background","title":"Background","text":"

In the beginning Ethereum.nix was a playground for Aldo Borrero to experiment with nix'ifying Ethereum related processes. Since then, it has grown into an ever-increasing number of packages and modules targeted towards streamlining day-to-day operations across a variety of different projects.

"},{"location":"license/","title":"License","text":"

Copyright (c) 2022-2023 Ethereum.nix contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"},{"location":"development/contributing/","title":"Contribution Guidelines","text":"

This file contains instructions that will help you make a contribution.

"},{"location":"development/contributing/#licensing","title":"Licensing","text":"

The Ethereum.nix packages, modules and this user guide are licensed under the MIT license.

"},{"location":"development/contributing/#before-you-contribute","title":"Before you contribute","text":"

Here you can take a look at the existing issues. Feel free to contribute, but make sure you have a GitHub account first :) .

If you're new to open source, please read GitHub's guide on How to Contribute to Open Source. It's a quick read, and it's a great way to introduce yourself to how things work behind the scenes in open-source projects.

Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please state your question clearly in an issue.

"},{"location":"development/contributing/#creating-an-issue","title":"Creating an issue","text":"

If you need to create an issue, make sure to clearly describe it, including:

  • The steps to reproduce it if it's a bug
  • The version of ethereum.nix used
"},{"location":"development/contributing/#making-changes","title":"Making changes","text":"

If you want to introduce changes to the project, please follow these steps:

  • Fork the repository on GitHub
  • Create a branch on your fork. Don't commit directly to main
  • Add the necessary tests for your changes
  • Push your changes to the branch in your repository fork
  • Submit a pull request to the original repository

Make sure you based your commits on logical and atomic units!

"},{"location":"development/contributing/#examples-of-git-history","title":"Examples of git history","text":"

Git history that we want to have:

Git history that we are trying to avoid:

Git history that we want to have
*   e3ed88b (HEAD -> contribution-guide, upstream/main, origin/main, origin/HEAD, main) Merge pull request #470 from zimbatm/fix_lru_cache\n\n|\\\n\n| * 1ab7d9f Use rayon for multithreading command\n\n|/\n\n*   e9c5bb4 Merge pull request #468 from zimbatm/multithread\n\n|\\\n\n| * de2d6cf Add lint property for Formatter struct\n\n| * cd2ed17 Fix impl on Formatter get_command() function\n\n|/\n\n*   028c344 Merge pull request #465 from rayon/0.15.0-release\n\n|\\\n\n| * 7b619d6 0.15.0 release\n\n|/\n\n*   acdf7df Merge pull request #463 from zimbatm/support-multi-part-namespaces\n
Git history that we are trying to avoid:
*   4c8aca8 Merge pull request #120 from zimbatm/add-rayon\n\n|\\\n\n| * fc2b449 use rayon for engine now\n\n| * 2304683 add rayon config\n\n| * 5285bd3 bump base image to F30\n\n* |   4d0fbe2 Merge pull request #114 from rizary/create_method_create_release\n\n|\\ \\\n\n| * | 36a9396 test changed\n\n| * | 22f681d method create release for github created\n\n* | |   2ef4ea1 Merge pull request #119 from rizary/config.rs\n\n|\\ \\ \\\n\n| |/ /\n\n|/| |\n\n| * | 5f1b8f0 unused functions removed\n\n* | |   a93c361 Merge pull request #117 from zimbatm/add-getreleases-to-abstract\n\n|\\ \\ \\\n\n| |/ /\n\n|/| |\n\n| * | 0a97236 add get_releses for Cargo\n\n| * | 55e4c57 add get_releases/get_release into engine.rs\n\n|/ /\n\n* |   badeddd Merge pull request #101 from zimbatm/extreme-cachin\n

Additionally, it's always good to work on improving documentation and adding examples.

Thank you for considering contributing to ethereum.nix.

"},{"location":"getting-started/backup-and-restore/","title":"Backup and restore","text":"

The following service modules support backups:

  • Geth
  • Prysm Beacon
  • Nethermind

Backup and restore functionality is implemented with Restic.

"},{"location":"getting-started/backup-and-restore/#storage-providers","title":"Storage providers","text":"

At the time of writing Restic supports the following storage backends:

  • Local
  • SFTP
  • REST Server
  • Amazon S3
  • Minio Server
  • Wasabi
  • Alibaba Cloud Object Storage System
  • OpenStack Swift
  • Backblaze B3
  • Microsoft Azure Blob Storage
  • Google Cloud Storage
  • Other services vis RClone
"},{"location":"getting-started/backup-and-restore/#configuring-backups","title":"Configuring backups","text":"

Backup options are set inside the backup section of supporting modules.

backup.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nbackup = {\nenable = true;\nschedule = \"0/1:00:00\";\nrestic = {\nrepository = \"s3:http://dione:9000/geth-sepolia\";\npasswordFile = sops.secrets.restic_password.path;\nenvironmentFile = sops.secrets.restic_env.path;\n};\n};\n};\n}\n

By default, backups are scheduled daily. This can be modified through the schedule option which follows the same format as systemd.time.

To access a Restic repository, a password (also called a key) must be specified. This can be done via restic.passwordFile.

And since Restic can be configured with a wide variety of storage providers, an environment file can be provided to accommodate their configuration. When using an Amazon S3 backend for example the environment file might look like this:

aws.env
AWS_DEFAULT_REGION=eu-west-1\nAWS_ACCESS_KEY_ID=my_access_key\nAWS_SECRET_ACCESS_KEY=my_secret_key\n

For a detailed list of options please see here.

"},{"location":"getting-started/backup-and-restore/#systemd-services","title":"Systemd services","text":"

When backups are enabled several new Systemd services and timers will be introduced to facilitate the backup process.

For an instance of Geth named sepolia for example, the following services will be added:

  • geth-sepolia-metadata.service which captures metadata such as chain height and persists it in the state directory.
  • geth-sepolia-metadata.timer which triggers the metadata service every 10 seconds by default. This interval is configurable via metadata.interval.
  • geth-sepolia-backup.service which is responsible for stopping geth-sepolia.service, backing up its state directory, and restarting it.
  • geth-sepolia-backup.timer which triggers the backup service once daily by default. This schedule is configurable via backup.schedule.
"},{"location":"getting-started/backup-and-restore/#restoring-from-backup","title":"Restoring from backup","text":"

Restore options are set inside the restore section of supporting modules and share many of the same config options as backups.

restore.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nrestore = {\nenable = true;\nsnapshot = \"latest\";\nrestic = {\nrepository = \"s3:http://dione:9000/geth-sepolia\";\npasswordFile = sops.secrets.restic_password.path;\nenvironmentFile = sops.secrets.restic_env.path;\n};\n};\n};\n}\n

The one key difference is the snapshot option which details which snapshot to restore from. This can be latest as seen in the example above, or a specific snapshot id as listed by running restic snapshots:

\u276f restic snapshots -c | head\nID        Time                 Host    Tags\n-------------------------------------------------------------------------------------------------------------------\n5e2006e9  2023-03-22 07:00:07  phoebe  height:3139753\n                                       number:0x2fe8a9\n                                       stateRoot:0x1be15cbc48fbd1ddb2fee1332f5fd6eacca60a737b4e87874c82be32810b19a5\n                                       hash:0x04a53f7cc92888de4ea743419855abdfff4ba84454db211846d984609578b265\n                                       name:geth-sepolia\nbdf903fc  2023-03-22 08:00:18  phoebe  height:3140008\n                                       number:0x2fe9a8\n                                       stateRoot:0xac1fd086f4e5afe152afd110f67ce86a5787895ca75c3fffa516229fc10ec9b2\n                                       hash:0x330594bc56d97b30c9794f33c692f32f3e29a6de1acb495cc4e66b0a437dc4c3\n                                       name:geth-sepolia\ne83e3f49  2023-03-22 09:00:17  phoebe  height:3140256\n                                       number:0x2feaa0\n                                       stateRoot:0x0a82d296b70638063187208707681d8976769594e65cd823da7429e215cce2a7\n                                       hash:0x6b39cfca2375b0cfb11e59c9f159e7a19108aa25cfbf4a88de53a9c1e089e233\n                                       name:geth-sepolia\n

Note: restoring from backup will only be attempted if the state directory for the service in question is empty. The presence of any files will cause the restoration attempt to be aborted.

This means it is safe to leave the restore config in place as it only has an effect when initialising a fresh instance.

"},{"location":"getting-started/installation/","title":"Installation","text":"

Below you'll find several examples of how to use ethereum.nix. Choose appropriately depending on if you're using Nix Flakes or not.

With flakes without using overlays (recommended) flake.nix
{\ninputs = {\n    nixpkgs.url = \"github:nixos/nixpkgs/22.11\";\nethereum-nix = {\nurl = \"github:nix-community/ethereum.nix\";\n      inputs.nixpkgs.follows = \"nixpkgs\";\n};\n};\noutputs = inputs @ { self, ethereum-nix, nixpkgs, ... }: let\nsystem = \"x86_64-linux\";\nin {\n    nixosConfigurations.my-system = nixpkgs.lib.nixosSystem {\ninherit system;\npkgs = nixpkgs.legacyPackages.${system};\nmodules = [\n# optional: add nixos modules via the default nixosModule\n        ethereum-nix.nixosModules.${system}.default\n\n({pkgs, system, ...}: {\n          environment.systemPackages = (with ethereum-nix.packages.${system}; [\n            teku\n            lighthouse\n            # ...\n]);\n})\n];\n};\n};\n}\n
With flakes using overlays flake.nix
{\ninputs = {\n    nixpkgs.url = \"github:nixos/nixpkgs/22.11\";\nethereum-nix = {\nurl = \"github:nix-community/ethereum.nix\";\n      inputs.nixpkgs.follows = \"nixpkgs\";\n};\n};\noutputs = inputs @ { self, ethereum-nix, nixpkgs, ... }: let\nsystem = \"x86_64-linux\";\npkgs = import inputs.nixpkgs {\ninherit system;\noverlays = [\n# add packages via the default overlay\n        ethereum-nix.overlays.default\n      ];\n};\nin {\n    nixosConfigurations.my-system = nixpkgs.lib.nixosSystem {\ninherit system pkgs;\nmodules = [\n# optional: add nixos modules via the default nixosModule\n        ethereum-nix.nixosModules.${system}.default\n      ];\n};\n};\n}\n
Without flakes default.nix
{\n  ethereum-nix ? import (fetchTarball \"https://github.com/nix-community/ethereum.nix/archive/main.tar.gz\"),\n  system ? \"x86_64-linux\",\n  pkgs ?\nimport <nixpkgs> # (1) {\ninherit system;\noverlays = [\n# add packages via the default overlay\n        ethereum-nix.overlays.default\n      ];\n},\n}: {\nmy-machine = pkgs.lib.nixosSystem {\ninherit system pkgs;\nmodules = [\n# optional: add nixos modules via the default nixosModule\n      ethereum-nix.nixosModules.${system}.default\n    ];\n};\n}\n
1. You must ensure that your `NIX_PATH` has `nixpkgs` pointing to a version that contains nixos modules e.g. `nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-22.11.tar.gz`"},{"location":"getting-started/restore-from-backup/","title":"Restoring from a backup","text":"

The following service modules support restoring from backups:

  • Geth
  • Prysm Beacon
  • Nethermind

For an overview of how to configure backups please see here

"},{"location":"getting-started/restore-from-backup/#basic-configuration","title":"Basic configuration","text":"

Restore options are set inside the restore section of supporting modules.

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nrestore = {\nenable = true;\nsnapshot = \"3090378\";\nborg = {\nrepo = \"ssh://borg@backup.server/data/borgbackup/ethereum/geth-sepolia\";\nkeyPath = \"/root/ed25519\";\nunencryptedRepoAccess = true;\n};\n};\n};\n}\n
"},{"location":"getting-started/restore-from-backup/#borg-backup","title":"Borg Backup","text":""},{"location":"getting-started/restore-from-backup/#host-key-checking","title":"Host key checking","text":"

Borg Backup uses ssh when connecting to a remote repository and as such requires an ssh private key. This key path can be provided via the keyPath option.

When connecting to a backup host for the first time a restoration may fail if the provided host key has not been added to the remote machine's known host list.

For testing and development purposes this check can be disabled via the strictHostKeyChecking option.

For production setups it is recommended to update the remote server's known host list first before any backups are scheduled.

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\n...\nrestore = {\nenable = true;\nsnapshot = \"3090378\";\nborg = {\nrepo = \"ssh://borg@dione/data/borgbackup/ethereum/geth-sepolia\";\nkeyPath = \"/root/ed25519\";\nstrictHostKeyChecking = false;\n};\n};\n};\n}\n
"},{"location":"getting-started/restore-from-backup/#repository-encryption","title":"Repository encryption","text":"

There are several encryption schemes available for securing backup repositories.

**Note: ** The encryption mode can only be configured when creating a new repository - you can neither configure it on a per-archive basis nor change the encryption mode of an existing repository.

For an overview of the encryption schemes available please refer to the borg backup official docs.

Suitable corresponding NixOS options for configuring encryption are available.

"},{"location":"getting-started/running-geth/","title":"Running Geth","text":"

One or more Geth services can be configured with the services.ethereum.geth prefix.

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\nenable = true;\npackage = pkgs.geth;\nopenFirewall = true;\nargs = {\nsyncmode = \"full\";\nnetwork = \"sepolia\";\nhttp = {\nenable = true;\naddr = \"0.0.0.0\";\nvhosts = [\"localhost\" \"phoebe\"];\napi = [\"net\" \"web3\" \"eth\"];\n};\n      authrpc.jwtsecret = sops.secrets.geth_jwt_secret.path;\n};\nextraArgs = [\n\"--bootnodes\"\n\"enode://8ae4559db1b1e160be8cc46018d7db123ed6d03fbbfe481da5ec05f71f0aa4d5f4b02ad059127096aa994568706a0d02933984083b87c5e1e3de2b7692444d37@35.161.233.158:46855,enode://d0b3b290422f35ec3e68356f3a4cdf9c661f71a868110670e31441a5021d7abd0440ae8dfb9360aafdd0198f177863361e3a7a7eb5e1a3e26575bf1ac3ef4ab3@162.19.136.65:48264,enode://d64624bda3cdb65d542c90757a4a661cfe9dddf8328bdb1ea97a8d70fad287c360f0101c492d8fd6ab30d79160a3bf148cacfd68f5d2e47eab0b709516419304@51.195.63.10:30040,enode://c7df835939e027325c6bba926220fae5912a33c83d96b3eef8ef445c98083f3191788581c9a0e8f74cadb0b13229b847f5c1ebd315b22bcf11faf6468020eb48@54.163.51.157:30303,enode://da0609bad3afcab9b93175a41a2d621d07aa7ff6c134a00792d4541f0ce8d30d8f3c51bb37a47573508a0bf18865b04066af2a661edf1d3a3d8d133fc1031aa0@88.151.101.14:45192,enode://7a4534d392c59369eae6befa56ac670476d9edc16597cf53c92bbefa6e741b6b0b9e6822cab12afb09123e03ca1131026fbef145adec429fe2e50182dfb650a5@94.130.18.108:31312,enode://db6fa13b63a885440de581ee3fc8df9c6a590326b39fc5ccba7991707ee0cebac306211f7eca5270a350201a3132511f2338481edd81f3dc819c2a1c60419cf2@65.21.89.157:30303,enode://fcf03e9404cace34c60e4eed374ef9a779471014319b3346352fbc2f992a399af6517486e8e65a4ab55f4645fe55420bbea1cddc13a4af4df63b0f731915c6a6@13.125.238.49:46173,enode://8b973816278fdd56966709e4794c7ccce1f256eaa9165a6b013b991a9bdf3886a8f2d23af50ee723a5614a9fe9d197252b803b4455a87ab2468e128f7b06e0ca@172.104.107.145:30303,enode://5a1fb15f826a213d3ef4adb9be47ab58b2240ea05df0d760a244f04762b0847dcb08276b1284f726c22eea30fce0c601cf121b81bac0c151f1b3b4ad00d1482a@34.159.55.147:51262,enode://560928dd14819f88113586726e452b16bbc694ed4144ddadd6290053e7f3fc66bfad13add6889f7d8f37e0c21ccbb6948eb8899c8b30743f4b45a3081f1efed8@34.138.254.5:29888,enode://69a13b575b8c5278431409e9f7db36e7218667ae286bfb65a72dfec9201b2c5bbbe2797a1babbdf17a7bf7ca68fa3fbe1554612637eb1b2425fa975e1bccb54c@35.223.41.3:30303,enode://66158b31eecff939f220b291d2b448edbfe94f1d4c992d9395b5d476e55e54b5abd11d3ee44daf1e18ee27b910ef99cdf6f19775eb4820ebe4f77d7aa948e3b6@51.195.63.10:55198,enode://bf94acbd51170bf075cacb9f149b21ff46354d659ab434a0d40688f776e1e1556bc62be2dc2867ba513844268c0dc8240099a6b60efe1713fbc25da7fdeb6ff1@3.82.105.139:30303,enode://41329e5ceb51cdddbe6a475db00b682505768b71ff8ee37d2d3500ca1b78918f9fad57d6006dd9f79cd418437dbcf87ec2fd58d60710f925cb17da05a51197cf@65.21.34.60:30303\"\n];\n};\n  services.ethereum.geth.goerli = {\nenable = true;\n...\n};\n}\n

Note: It is recommended to use an attribute name that matches the network that Geth is configured for.

"},{"location":"getting-started/running-geth/#configuration","title":"Configuration","text":"

Many of Geth's process arguments have been mapped to NixOS types and can be provided via the args section of the config. For a detailed list please refer to the NixOS Options reference.

Additional arguments can be provided in a list directly to the Geth process via the extraArgs attribute as shown above.

"},{"location":"getting-started/running-geth/#systemd-service","title":"Systemd service","text":"

For each instance that is configured a corresponding Systemd service is created. The service name follows a convention of geth-${name}.service.

Config Name Service name services.ethereum.geth.sepolia sepolia geth-sepolia.service services.ethereum.geth.goerli goerli geth-goerli.service services.ethereum.geth.mainnet mainnet geth-mainnet.service

The service that is created can then be introspected and managed via the standard Systemd toolset.

Action Command Status systemctl status geth-sepolia.service Stop systemctl stop geth-sepolia.service Start systemctl start geth-sepolia.service Restart systemctl restart geth-sepolia.service Logs journalctl -xefu geth-sepolia.service"},{"location":"getting-started/running-geth/#using-a-geth-fork","title":"Using a Geth fork","text":"

A different version of Geth can be configured via the package option.

To configure Geth Sealer for example:

server.nix
{ pkgs, ...}: {\n  services.ethereum.geth.sepolia = {\nenable = true;\npackage = pkgs.geth-sealer;\n...\n};\n}\n
"},{"location":"getting-started/running-geth/#opening-ports","title":"Opening ports","text":"

By default, openFirewall is set to false. If set to true, firewall rules are added which will expose the following ports:

Protocol Config Default value TCP, UDP port 30303 TCP authrpc.port 8551 TCP http.port 8545 TCP ws.port 8546 TCP metrics.port 6060

Note: it is important when running multiple instances of Geth on the same machine that you ensure they are configured with different ports.

"},{"location":"getting-started/running-lighthouse-beacon/","title":"Running Lighthouse Beacon","text":"

One or more Lighthouse Beacon services can be configured with the services.ethereum.lighthouse-beacon prefix.

server.nix
{ pkgs, ...}: {\n  services.ethereum.lighthouse-beacon.sepolia = {\nenable = true;\nopenFirewall = true;\nargs = {\nnetwork = \"sepolia\"; # (Optional) defaults to beacon name\nexecution-jwt = secrets.lighthouse_jwt_secret.path;\ncheckpoint-sync-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\ngenesis-state-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\n};\nhttp-address = \"0.0.0.0\";\n};\n  services.ethereum.lighthouse-beacon.goerli = {\nenable = true;\n...\n};\n}\n

Note: It is recommended to use an attribute name that matches the network that Lighthouse Beacon is configured for.

"},{"location":"getting-started/running-lighthouse-beacon/#configuration","title":"Configuration","text":"

Many of Lighthouse Beacon's process arguments have been mapped to NixOS types and can be provided via the args section of the config. For a detailed list please refer to the NixOS Options reference.

Additional arguments can be provided in a list directly to the Lighthouse Beacon process via the extraArgs attribute as shown above.

"},{"location":"getting-started/running-lighthouse-beacon/#systemd-service","title":"Systemd service","text":"

For each instance that is configured a corresponding Systemd service is created. The service name follows a convention of lighthouse-beacon-${name}.service.

Config Name Service name services.ethereum.lighthouse-beacon.sepolia sepolia lighthouse-beacon-sepolia.service services.ethereum.lighthouse-beacon.goerli goerli lighthouse-beacon-goerli.service services.ethereum.lighthouse-beacon.mainnet mainnet lighthouse-beacon-mainnet.service

The service that is created can then be introspected and managed via the standard Systemd toolset.

Action Command Status systemctl status lighthouse-beacon-sepolia.service Stop systemctl stop lighthouse-beacon-sepolia.service Start systemctl start lighthouse-beacon-sepolia.service Restart systemctl restart lighthouse-beacon-sepolia.service Logs journalctl -xefu lighthouse-beacon-sepolia.service"},{"location":"getting-started/running-lighthouse-beacon/#using-a-lighthouse-beacon-fork","title":"Using a Lighthouse Beacon fork","text":"

A different version of Lighthouse Beacon can be configured via the package option.

To configure a custom fork for example:

server.nix
{ pkgs, ...}: {\n  services.ethereum.lighthouse-beacon.sepolia = {\nenable = true;\npackage = pkgs.my-lighthouse-beacon;\n...\n};\n}\n
"},{"location":"getting-started/running-lighthouse-beacon/#opening-ports","title":"Opening ports","text":"

By default, openFirewall is set to false. If set to true firewall rules are added which will expose the following ports:

Protocol Config Default value UDP discovery-port 9000 UDP/TCP quic-port 9001 TCP http-port 5052

Note: it is important when running multiple instances of Lighthouse Beacon on the same machine that you ensure they are configured with different ports.

"},{"location":"getting-started/running-prysm-beacon/","title":"Running Prysm Beacon","text":"

One or more Prysm Beacon services can be configured with the services.ethereum.prysm-beacon prefix.

server.nix
{ pkgs, ...}: {\n  services.ethereum.prysm-beacon.sepolia = {\nenable = true;\nopenFirewall = true;\nargs = {\nnetwork = \"sepolia\";\njwt-secret = secrets.prysm_jwt_secret.path;\ncheckpoint-sync-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\ngenesis-beacon-api-url = \"https://sepolia.checkpoint-sync.ethdevops.io\";\n};\nextraArgs = [\n\"--rpc-host=0.0.0.0\"\n\"--monitoring-host=0.0.0.0\"\n];\n};\n  services.ethereum.prysm-beacon.goerli = {\nenable = true;\n...\n};\n}\n

Note: It is recommended to use an attribute name that matches the network that Prysm Beacon is configured for.

"},{"location":"getting-started/running-prysm-beacon/#configuration","title":"Configuration","text":"

Many of Prysm Beacon's process arguments have been mapped to NixOS types and can be provided via the args section of the config. For a detailed list please refer to the NixOS Options reference.

Additional arguments can be provided in a list directly to the Prysm Beacon process via the extraArgs attribute as shown above.

"},{"location":"getting-started/running-prysm-beacon/#systemd-service","title":"Systemd service","text":"

For each instance that is configured a corresponding Systemd service is created. The service name follows a convention of prysm-beacon-${name}.service.

Config Name Service name services.ethereum.prysm-beacon.sepolia sepolia prysm-beacon-sepolia.service services.ethereum.prysm-beacon.goerli goerli prysm-beacon-goerli.service services.ethereum.prysm-beacon.mainnet mainnet prysm-beacon-mainnet.service

The service that is created can then be introspected and managed via the standard Systemd toolset.

Action Command Status systemctl status prysm-beacon-sepolia.service Stop systemctl stop prysm-beacon-sepolia.service Start systemctl start prysm-beacon-sepolia.service Restart systemctl restart prysm-beacon-sepolia.service Logs journalctl -xefu prysm-beacon-sepolia.service"},{"location":"getting-started/running-prysm-beacon/#using-a-prysm-beacon-fork","title":"Using a Prysm Beacon fork","text":"

A different version of Prysm Beacon can be configured via the package option.

To configure a custom fork for example:

server.nix
{ pkgs, ...}: {\n  services.ethereum.prysm-beacon.sepolia = {\nenable = true;\npackage = pkgs.my-prysm-beacon;\n...\n};\n}\n
"},{"location":"getting-started/running-prysm-beacon/#opening-ports","title":"Opening ports","text":"

By default, openFirewall is set to false. If set to true firewall rules are added which will expose the following ports:

Protocol Config Default value UDP p2p-udp-port 12000 TCP p2p-tcp-port 13000 TCP grpc-gateway-port 3500 TCP monitoring-port 8080 TCP pprofport 8080

Note: it is important when running multiple instances of Prysm Beacon on the same machine that you ensure they are configured with different ports.

"},{"location":"reference/module-options/erigon/","title":"Erigon","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigon","title":"services.ethereum.erigon","text":"

Specification of one or more erigon instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

"},{"location":"reference/module-options/erigon/#servicesethereumerigonenable","title":"services.ethereum.erigon.\\.enable

Whether to enable Erigon Ethereum Node\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonpackage","title":"services.ethereum.erigon.\\.package

Package to use as Erigon node.

Type: package

Default: pkgs.erigon

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcaddr","title":"services.ethereum.erigon.\\.args.authrpc.addr

HTTP-RPC server listening interface for the Engine API.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcjwtsecret","title":"services.ethereum.erigon.\\.args.authrpc.jwtsecret

Path to the token that ensures safe connection between CL and EL.

Type: null or string

Default: null

Example: \"/var/run/erigon/jwtsecret\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcport","title":"services.ethereum.erigon.\\.args.authrpc.port

HTTP-RPC server listening port for the Engine API

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8551

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpctimeoutsidle","title":"services.ethereum.erigon.\\.args.authrpc.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

Type: string

Default: \"2m0s\"

Example: \"30s\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpctimeoutsread","title":"services.ethereum.erigon.\\.args.authrpc.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: string

Default: \"30s\"

Example: \"30s\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpctimeoutswrite","title":"services.ethereum.erigon.\\.args.authrpc.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

Type: string

Default: \"30m0s\"

Example: \"30m0s\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsauthrpcvhosts","title":"services.ethereum.erigon.\\.args.authrpc.vhosts

Comma separated list of virtual hostnames from which to accept Engine API requests (server enforced). Accepts \u2018*\u2019 wildcard.\"

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"erigon.example.org\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargschain","title":"services.ethereum.erigon.\\.args.chain

Name of the network to join. If null the network is mainnet.

Type: one of \u201cmainnet\u201d, \u201crinkeby\u201d, \u201cgoerli\u201d, \u201cholesky\u201d, \u201csokol\u201d, \u201cfermion\u201d, \u201cmumbai\u201d, \u201cbor-mainnet\u201d, \u201cbor-devnet\u201d, \u201csepolia\u201d, \u201cgnosis\u201d, \u201cchiado\u201d

Default: \"mainnet\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsexternalcl","title":"services.ethereum.erigon.\\.args.externalcl

Whether to enable enables external consensus.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpenable","title":"services.ethereum.erigon.\\.args.http.enable

Enable HTTP-RPC server

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpaddr","title":"services.ethereum.erigon.\\.args.http.addr

HTTP-RPC server listening interface.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpapi","title":"services.ethereum.erigon.\\.args.http.api

API\u2019s offered over the HTTP-RPC interface.

Type: null or (list of string)

Example:

[\n  \"net\"\n  \"eth\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpcompression","title":"services.ethereum.erigon.\\.args.http.compression

Whether to enable Enable compression over HTTP-RPC\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpcorsdomain","title":"services.ethereum.erigon.\\.args.http.corsdomain

List of domains from which to accept cross origin requests.

Type: null or (list of string)

Default: null

Example:

[\n  \"*\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpport","title":"services.ethereum.erigon.\\.args.http.port

HTTP-RPC server listening port.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptimeoutsidle","title":"services.ethereum.erigon.\\.args.http.timeouts.idle

Maximum amount of time to wait for the next request when keep-alives are enabled. If http.timeouts.idle is zero, the value of http.timeouts.read is used.

Type: string

Default: \"2m0s\"

Example: \"30s\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptimeoutsread","title":"services.ethereum.erigon.\\.args.http.timeouts.read

Maximum duration for reading the entire request, including the body.

Type: string

Default: \"30s\"

Example: \"30s\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptimeoutswrite","title":"services.ethereum.erigon.\\.args.http.timeouts.write

Maximum duration before timing out writes of the response. It is reset whenever a new request's header is read.

Type: string

Default: \"30m0s\"

Example: \"30m0s\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttptrace","title":"services.ethereum.erigon.\\.args.http.trace

Whether to enable Trace HTTP requests with INFO level.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargshttpvhosts","title":"services.ethereum.erigon.\\.args.http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts \u2018*\u2019 wildcard.

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"erigon.example.org\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsmetricsenable","title":"services.ethereum.erigon.\\.args.metrics.enable

Whether to enable Enable metrics collection and reporting\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsmetricsaddr","title":"services.ethereum.erigon.\\.args.metrics.addr

Enable stand-alone metrics HTTP server listening interface.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsmetricsport","title":"services.ethereum.erigon.\\.args.metrics.port

Metrics HTTP server listening port

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 6060

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsport","title":"services.ethereum.erigon.\\.args.port

Network listening port.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsprivateapiaddr","title":"services.ethereum.erigon.\\.args.private.api.addr

Private api network address, for example: 127.0.0.1:9090, empty string means not to start the listener. Do not expose to public network. Serves remote database interface.

Type: string

Default: \"127.0.0.1:9090\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargsprivateapiratelimit","title":"services.ethereum.erigon.\\.args.private.api.ratelimit

Amount of requests server handle simultaneously - requests over this limit will wait. Increase it - if clients see \u2018request timeout\u2019 while server load is low - it means your \u2018hot data\u2019 is small or have much RAM.

Type: signed integer

Default: 31872

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargssnapshots","title":"services.ethereum.erigon.\\.args.snapshots

Default: use snapshots \u201ctrue\u201d for BSC, Mainnet and Goerli. use snapshots \u201cfalse\u201d in all other cases.

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargstorrentport","title":"services.ethereum.erigon.\\.args.torrent.port

Port to listen and serve BitTorrent protocol .

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 42069

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargswsenable","title":"services.ethereum.erigon.\\.args.ws.enable

Whether to enable Erigon WebSocket API.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonargswscompression","title":"services.ethereum.erigon.\\.args.ws.compression

Whether to enable Enable compression over HTTP-RPC\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonextraargs","title":"services.ethereum.erigon.\\.extraArgs

Additional arguments to pass to Erigon.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonopenfirewall","title":"services.ethereum.erigon.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonservicesupplementarygroups","title":"services.ethereum.erigon.\\.service.supplementaryGroups

Additional groups for the systemd service e.g. sops-nix group for secret access

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/erigon/#servicesethereumerigonsubvolume","title":"services.ethereum.erigon.\\.subVolume

Whether to enable Use a subvolume for the state directory if the underlying filesystem supports it e.g. btrfs.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/erigon/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/","title":"Geth bootnode","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnode","title":"services.ethereum.geth-bootnode","text":"

Specification of one or more geth bootnode instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

"},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeenable","title":"services.ethereum.geth-bootnode.\\.enable

Whether to enable Go Ethereum Boot Node.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodepackage","title":"services.ethereum.geth-bootnode.\\.package

Package to use as Go Ethereum Boot node.

Type: package

Default: pkgs.geth

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsaddr","title":"services.ethereum.geth-bootnode.\\.args.addr

Listen address

Type: string

Default: \":30301\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsgenkey","title":"services.ethereum.geth-bootnode.\\.args.genkey

Generate a node key

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnat","title":"services.ethereum.geth-bootnode.\\.args.nat

Port mapping mechanism (any|none|upnp|pmp|pmp:IP|extip:IP)

Type: string

Default: \"none\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnetrestrict","title":"services.ethereum.geth-bootnode.\\.args.netrestrict

Restrict network communication to the given IP networks (CIDR masks)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnodekey","title":"services.ethereum.geth-bootnode.\\.args.nodekey

Private key filename

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsnodekeyhex","title":"services.ethereum.geth-bootnode.\\.args.nodekeyhex

Private key as hex (for testing)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsv5","title":"services.ethereum.geth-bootnode.\\.args.v5

Run a V5 topic discovery bootnode

Type: null or boolean

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsverbosity","title":"services.ethereum.geth-bootnode.\\.args.verbosity

log verbosity (0-5)

Type: integer between 0 and 5 (both inclusive)

Default: 3

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargsvmodule","title":"services.ethereum.geth-bootnode.\\.args.vmodule

Log verbosity pattern

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeargswriteaddress","title":"services.ethereum.geth-bootnode.\\.args.writeaddress

Write out the node\u2019s public key and quit

Type: null or boolean

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeextraargs","title":"services.ethereum.geth-bootnode.\\.extraArgs

Additional arguments to pass to the Go Ethereum Bootnode.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth-bootnode/#servicesethereumgeth-bootnodeopenfirewall","title":"services.ethereum.geth-bootnode.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth-bootnode/options.nix

","text":""},{"location":"reference/module-options/geth/","title":"Geth","text":""},{"location":"reference/module-options/geth/#servicesethereumgeth","title":"services.ethereum.geth","text":"

Specification of one or more geth instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

"},{"location":"reference/module-options/geth/#servicesethereumgethenable","title":"services.ethereum.geth.\\.enable

Whether to enable Go Ethereum Node.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethpackage","title":"services.ethereum.geth.\\.package

Package to use as Go Ethereum node.

Type: package

Default: pkgs.geth

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcaddr","title":"services.ethereum.geth.\\.args.authrpc.addr

Listen address of Go Ethereum Auth RPC API.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcjwtsecret","title":"services.ethereum.geth.\\.args.authrpc.jwtsecret

Path to a JWT secret for authenticated RPC endpoint.

Type: null or string

Default: null

Example: \"/var/run/geth/jwtsecret\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcport","title":"services.ethereum.geth.\\.args.authrpc.port

Port number of Go Ethereum Auth RPC API.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8551

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsauthrpcvhosts","title":"services.ethereum.geth.\\.args.authrpc.vhosts

List of virtual hostnames from which to accept requests.

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"geth.example.org\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsbootnodes","title":"services.ethereum.geth.\\.args.bootnodes

List of bootnodes to connect to

Type: null or (list of string)

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsgcmode","title":"services.ethereum.geth.\\.args.gcmode

Blockchain garbage collection mode.

Type: one of \u201cfull\u201d, \u201carchive\u201d

Default: \"full\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpenable","title":"services.ethereum.geth.\\.args.http.enable

Whether to enable Go Ethereum HTTP API.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpaddr","title":"services.ethereum.geth.\\.args.http.addr

HTTP-RPC server listening interface

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpapi","title":"services.ethereum.geth.\\.args.http.api

API\u2019s offered over the HTTP-RPC interface

Type: null or (list of string)

Default: null

Example:

[\n  \"net\"\n  \"eth\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpcorsdomain","title":"services.ethereum.geth.\\.args.http.corsdomain

List of domains from which to accept cross origin requests

Type: null or (list of string)

Default: null

Example:

[\n  \"*\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpport","title":"services.ethereum.geth.\\.args.http.port

Port number of Go Ethereum HTTP API.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttprpcprefix","title":"services.ethereum.geth.\\.args.http.rpcprefix

HTTP path path prefix on which JSON-RPC is served. Use \u2018/\u2019 to serve on all paths.

Type: null or string

Default: null

Example: \"/\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargshttpvhosts","title":"services.ethereum.geth.\\.args.http.vhosts

Comma separated list of virtual hostnames from which to accept requests (server enforced). Accepts \u2018*\u2019 wildcard.

Type: list of string

Default:

[\n  \"localhost\"\n]\n

Example:

[\n  \"localhost\"\n  \"geth.example.org\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmaxpeers","title":"services.ethereum.geth.\\.args.maxpeers

Maximum peers to connect to.

Type: signed integer

Default: 50

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmetricsenable","title":"services.ethereum.geth.\\.args.metrics.enable

Whether to enable Go Ethereum prometheus metrics.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmetricsaddr","title":"services.ethereum.geth.\\.args.metrics.addr

Listen address of Go Ethereum metrics service.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsmetricsport","title":"services.ethereum.geth.\\.args.metrics.port

Port number of Go Ethereum metrics service.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 6060

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnetrestrict","title":"services.ethereum.geth.\\.args.netrestrict

Restrict network communication to the given IP networks (CIDR masks)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnetwork","title":"services.ethereum.geth.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cgoerli\u201d, \u201cholesky\u201d, \u201ckiln\u201d, \u201crinkeby\u201d, \u201cropsten\u201d, \u201csepolia\u201d

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnetworkid","title":"services.ethereum.geth.\\.args.networkid

The network id used for peer to peer communication

Type: signed integer

Default: 1

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsnodiscover","title":"services.ethereum.geth.\\.args.nodiscover

Disable discovery

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsport","title":"services.ethereum.geth.\\.args.port

Port number Go Ethereum will be listening on, both TCP and UDP.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargssyncmode","title":"services.ethereum.geth.\\.args.syncmode

Blockchain sync mode.

Type: one of \u201csnap\u201d, \u201cfast\u201d, \u201cfull\u201d, \u201clight\u201d

Default: \"snap\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargsverbosity","title":"services.ethereum.geth.\\.args.verbosity

log verbosity (0-5)

Type: integer between 0 and 5 (both inclusive)

Default: 3

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsenable","title":"services.ethereum.geth.\\.args.ws.enable

Whether to enable Go Ethereum WebSocket API.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsaddr","title":"services.ethereum.geth.\\.args.ws.addr

Listen address of Go Ethereum WebSocket API.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsapi","title":"services.ethereum.geth.\\.args.ws.api

APIs to enable over WebSocket

Type: null or (list of string)

Default: null

Example:

[\n  \"net\"\n  \"eth\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethargswsport","title":"services.ethereum.geth.\\.args.ws.port

Port number of Go Ethereum WebSocket API.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8546

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupenable","title":"services.ethereum.geth.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupbtrfsenable","title":"services.ethereum.geth.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupbtrfssnapshotdirectory","title":"services.ethereum.geth.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupbtrfssnapshotretention","title":"services.ethereum.geth.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupmetadatainterval","title":"services.ethereum.geth.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticenvironmentfile","title":"services.ethereum.geth.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticexclude","title":"services.ethereum.geth.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticextraoptions","title":"services.ethereum.geth.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticpasswordfile","title":"services.ethereum.geth.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrcloneconfig","title":"services.ethereum.geth.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrcloneconfigfile","title":"services.ethereum.geth.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrcloneoptions","title":"services.ethereum.geth.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrepository","title":"services.ethereum.geth.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupresticrepositoryfile","title":"services.ethereum.geth.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethbackupschedule","title":"services.ethereum.geth.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethextraargs","title":"services.ethereum.geth.\\.extraArgs

Additional arguments to pass to Go Ethereum.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethopenfirewall","title":"services.ethereum.geth.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreenable","title":"services.ethereum.geth.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticenvironmentfile","title":"services.ethereum.geth.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticexclude","title":"services.ethereum.geth.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticextraoptions","title":"services.ethereum.geth.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticpasswordfile","title":"services.ethereum.geth.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrcloneconfig","title":"services.ethereum.geth.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrcloneconfigfile","title":"services.ethereum.geth.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrcloneoptions","title":"services.ethereum.geth.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrepository","title":"services.ethereum.geth.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoreresticrepositoryfile","title":"services.ethereum.geth.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoresnapshot","title":"services.ethereum.geth.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/geth/#servicesethereumgethrestoretimeout","title":"services.ethereum.geth.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/geth/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/","title":"Lighthouse beacon","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beacon","title":"services.ethereum.lighthouse-beacon","text":"

Specification of one or more lighthouse beacon chain instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

"},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconenable","title":"services.ethereum.lighthouse-beacon.\\.enable

Whether to enable Lighthouse Ethereum Beacon Chain Node written in Rust from Sigma Prime.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconpackage","title":"services.ethereum.lighthouse-beacon.\\.package

Package to use for Lighthouse binary

Type: package

Default: pkgs.lighthouse

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargscheckpoint-sync-url","title":"services.ethereum.lighthouse-beacon.\\.args.checkpoint-sync-url

URL of a synced beacon node to trust in obtaining checkpoint sync data. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --wss-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdatadir","title":"services.ethereum.lighthouse-beacon.\\.args.datadir

Data directory for the databases.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdisable-deposit-contract-sync","title":"services.ethereum.lighthouse-beacon.\\.args.disable-deposit-contract-sync

Explicitly disables syncing of deposit logs from the execution node. This overrides any previous option that depends on it. Useful if you intend to run a non-validating beacon node.

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdisable-quic","title":"services.ethereum.lighthouse-beacon.\\.args.disable-quic

Disables the quic transport. The node will rely solely on the TCP transport for libp2p connections.

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdisable-upnp","title":"services.ethereum.lighthouse-beacon.\\.args.disable-upnp

Disable the UPnP configuration

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsdiscovery-port","title":"services.ethereum.lighthouse-beacon.\\.args.discovery-port

The port used by discv5.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 9000

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsexecution-endpoint","title":"services.ethereum.lighthouse-beacon.\\.args.execution-endpoint

Listen address for the execution layer.

Type: string

Default: \"http://127.0.0.1:8551\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsexecution-jwt","title":"services.ethereum.lighthouse-beacon.\\.args.execution-jwt

Path to a file containing a hex-encoded string representing a 32 byte secret used for authentication with an execution node via HTTP

Type: string

Default: null

Example: \"/var/run/prysm/jwtsecret\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsgenesis-state-url","title":"services.ethereum.lighthouse-beacon.\\.args.genesis-state-url

URL of a synced beacon node to trust for obtaining genesis state. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --wss-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargshttpenable","title":"services.ethereum.lighthouse-beacon.\\.args.http.enable

Enable the HTTP RPC server

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargshttpaddress","title":"services.ethereum.lighthouse-beacon.\\.args.http.address

Host on which the RPC server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargshttpport","title":"services.ethereum.lighthouse-beacon.\\.args.http.port

RPC port exposed by a beacon node.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5052

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsmetricsenable","title":"services.ethereum.lighthouse-beacon.\\.args.metrics.enable

Enable Prometheus metrics exporter.

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsmetricsaddress","title":"services.ethereum.lighthouse-beacon.\\.args.metrics.address

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsmetricsport","title":"services.ethereum.lighthouse-beacon.\\.args.metrics.port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5054

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsnetwork","title":"services.ethereum.lighthouse-beacon.\\.args.network

The network to connect to. Mainnet is the default ethereum network.

Type: null or one of \u201cmainnet\u201d, \u201cprater\u201d, \u201cgoerli\u201d, \u201cgnosis\u201d, \u201cchiado\u201d, \u201csepolia\u201d, \u201cholesky\u201d

Default: \"name\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsquic-port","title":"services.ethereum.lighthouse-beacon.\\.args.quic-port

The port used by libp2p. Will use TCP if disable-quic is set

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: args.discovery-port + 1

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconargsuser","title":"services.ethereum.lighthouse-beacon.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupenable","title":"services.ethereum.lighthouse-beacon.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupbtrfsenable","title":"services.ethereum.lighthouse-beacon.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupbtrfssnapshotdirectory","title":"services.ethereum.lighthouse-beacon.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupbtrfssnapshotretention","title":"services.ethereum.lighthouse-beacon.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupmetadatainterval","title":"services.ethereum.lighthouse-beacon.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticenvironmentfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticexclude","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticextraoptions","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticpasswordfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrcloneconfig","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrcloneconfigfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrcloneoptions","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrepository","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupresticrepositoryfile","title":"services.ethereum.lighthouse-beacon.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconbackupschedule","title":"services.ethereum.lighthouse-beacon.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconextraargs","title":"services.ethereum.lighthouse-beacon.\\.extraArgs

Additional arguments to pass to Lighthouse Beacon Chain.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconopenfirewall","title":"services.ethereum.lighthouse-beacon.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreenable","title":"services.ethereum.lighthouse-beacon.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticenvironmentfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticexclude","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticextraoptions","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticpasswordfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrcloneconfig","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrcloneconfigfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrcloneoptions","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrepository","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoreresticrepositoryfile","title":"services.ethereum.lighthouse-beacon.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoresnapshot","title":"services.ethereum.lighthouse-beacon.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-beacon/#servicesethereumlighthouse-beaconrestoretimeout","title":"services.ethereum.lighthouse-beacon.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-beacon/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/","title":"Lighthouse validator","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validator","title":"services.ethereum.lighthouse-validator","text":"

Specification of one or more Lighthouse validator instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

"},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorenable","title":"services.ethereum.lighthouse-validator.\\.enable

Whether to enable Lighthouse Ethereum Validator Client written in Rust from Sigma Prime.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorpackage","title":"services.ethereum.lighthouse-validator.\\.package

Package to use for Lighthouse binary

Type: package

Default: pkgs.lighthouse

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsbeacon-nodes","title":"services.ethereum.lighthouse-validator.\\.args.beacon-nodes

List of Lighthouse Beacon node HTTP APIs to connect to.

When null, looks up the http address+port from the lighthouse beacon node service with the same name. (eg services.ethereum.lighthouse-validator.holesky will look at the config of services.ethereum.lighthouse-beacon.holesky)

Type: null or (list of string)

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsdatadir","title":"services.ethereum.lighthouse-validator.\\.args.datadir

Data directory for the databases.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsgraffiti","title":"services.ethereum.lighthouse-validator.\\.args.graffiti

String to include in proposed blocks

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargshttpenable","title":"services.ethereum.lighthouse-validator.\\.args.http.enable

Whether to enable the HTTP REST API server.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargshttpaddress","title":"services.ethereum.lighthouse-validator.\\.args.http.address

Host on which the REST API server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargshttpport","title":"services.ethereum.lighthouse-validator.\\.args.http.port

REST API port exposed by a beacon node.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5062

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsmetricsenable","title":"services.ethereum.lighthouse-validator.\\.args.metrics.enable

Enable Prometheus metrics exporter.

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsmetricsaddress","title":"services.ethereum.lighthouse-validator.\\.args.metrics.address

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsmetricsport","title":"services.ethereum.lighthouse-validator.\\.args.metrics.port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 5064

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsnetwork","title":"services.ethereum.lighthouse-validator.\\.args.network

The network to connect to. Mainnet is the default ethereum network.

Type: null or one of \u201cmainnet\u201d, \u201cprater\u201d, \u201cgoerli\u201d, \u201cgnosis\u201d, \u201cchiado\u201d, \u201csepolia\u201d, \u201cholesky\u201d

Default: \"name\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargssuggested-fee-recipient","title":"services.ethereum.lighthouse-validator.\\.args.suggested-fee-recipient

Sets ALL validators\u2019 mapping to a suggested eth address to receive gas fees when proposing a block. note that this is only a suggestion when integrating with a Builder API, which may choose to specify a different fee recipient as payment for the blocks it builds.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorargsuser","title":"services.ethereum.lighthouse-validator.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupenable","title":"services.ethereum.lighthouse-validator.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupbtrfsenable","title":"services.ethereum.lighthouse-validator.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupbtrfssnapshotdirectory","title":"services.ethereum.lighthouse-validator.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupbtrfssnapshotretention","title":"services.ethereum.lighthouse-validator.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupmetadatainterval","title":"services.ethereum.lighthouse-validator.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticenvironmentfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticexclude","title":"services.ethereum.lighthouse-validator.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticextraoptions","title":"services.ethereum.lighthouse-validator.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticpasswordfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrcloneconfig","title":"services.ethereum.lighthouse-validator.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrcloneconfigfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrcloneoptions","title":"services.ethereum.lighthouse-validator.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrepository","title":"services.ethereum.lighthouse-validator.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupresticrepositoryfile","title":"services.ethereum.lighthouse-validator.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorbackupschedule","title":"services.ethereum.lighthouse-validator.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorextraargs","title":"services.ethereum.lighthouse-validator.\\.extraArgs

Additional arguments to pass to Lighthouse Validator Client.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatoropenfirewall","title":"services.ethereum.lighthouse-validator.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreenable","title":"services.ethereum.lighthouse-validator.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticenvironmentfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticexclude","title":"services.ethereum.lighthouse-validator.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticextraoptions","title":"services.ethereum.lighthouse-validator.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticpasswordfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrcloneconfig","title":"services.ethereum.lighthouse-validator.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrcloneconfigfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrcloneoptions","title":"services.ethereum.lighthouse-validator.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrepository","title":"services.ethereum.lighthouse-validator.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoreresticrepositoryfile","title":"services.ethereum.lighthouse-validator.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoresnapshot","title":"services.ethereum.lighthouse-validator.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/lighthouse-validator/#servicesethereumlighthouse-validatorrestoretimeout","title":"services.ethereum.lighthouse-validator.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/lighthouse-validator/options.nix

","text":""},{"location":"reference/module-options/mev-boost/","title":"Mev boost","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boost","title":"services.ethereum.mev-boost","text":"

Specification of one or more MEV-Boost chain instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

"},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostenable","title":"services.ethereum.mev-boost.\\.enable

Whether to enable MEV-Boost from Flashbots.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostpackage","title":"services.ethereum.mev-boost.\\.package

Package to use for mev-boost binary

Type: package

Default: pkgs.mev-boost

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsaddr","title":"services.ethereum.mev-boost.\\.args.addr

listen-address for mev-boost server (default \u2018localhost:18550\u2019)

Type: string

Default: \"localhost:18550\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsjson","title":"services.ethereum.mev-boost.\\.args.json

log in JSON format instead of text

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargslog-no-version","title":"services.ethereum.mev-boost.\\.args.log-no-version

disables adding the version to every log entry

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargslog-service","title":"services.ethereum.mev-boost.\\.args.log-service

add a \u2018service=\u2026\u2019 tag to all log messages

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsloglevel","title":"services.ethereum.mev-boost.\\.args.loglevel

minimum loglevel

Type: null or one of \u201ctrace\u201d, \u201cdebug\u201d, \u201cinfo\u201d, \u201cwarn\u201d, \u201cerror\u201d, \u201cfatal\u201d, \u201cpanic\u201d

Default: \"info\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsmin-bid","title":"services.ethereum.mev-boost.\\.args.min-bid

minimum bid to accept from a relay [eth]

Type: null or floating point number

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsnetwork","title":"services.ethereum.mev-boost.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cmainnet\u201d, \u201cgoerli\u201d, \u201csepolia\u201d, \u201czhejiang\u201d

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrelay-check","title":"services.ethereum.mev-boost.\\.args.relay-check

check relay status on startup and on the status API call

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrelay-monitors","title":"services.ethereum.mev-boost.\\.args.relay-monitors

relay urls

Type: null or (list of string)

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrelays","title":"services.ethereum.mev-boost.\\.args.relays

relay urls

Type: list of string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-max-retries","title":"services.ethereum.mev-boost.\\.args.request-max-retries

maximum number of retries for a relay get payload request

Type: signed integer

Default: 5

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-timeout-getheader","title":"services.ethereum.mev-boost.\\.args.request-timeout-getheader

timeout for getHeader requests to the relay [ms]

Type: signed integer

Default: 950

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-timeout-getpayload","title":"services.ethereum.mev-boost.\\.args.request-timeout-getpayload

timeout for getPayload requests to the relay [ms]

Type: signed integer

Default: 4000

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostargsrequest-timeout-regval","title":"services.ethereum.mev-boost.\\.args.request-timeout-regval

timeout for registerValidator requests [ms]

Type: signed integer

Default: 3000

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupenable","title":"services.ethereum.mev-boost.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupbtrfsenable","title":"services.ethereum.mev-boost.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupbtrfssnapshotdirectory","title":"services.ethereum.mev-boost.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupbtrfssnapshotretention","title":"services.ethereum.mev-boost.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupmetadatainterval","title":"services.ethereum.mev-boost.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticenvironmentfile","title":"services.ethereum.mev-boost.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticexclude","title":"services.ethereum.mev-boost.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticextraoptions","title":"services.ethereum.mev-boost.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticpasswordfile","title":"services.ethereum.mev-boost.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrcloneconfig","title":"services.ethereum.mev-boost.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrcloneconfigfile","title":"services.ethereum.mev-boost.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrcloneoptions","title":"services.ethereum.mev-boost.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrepository","title":"services.ethereum.mev-boost.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupresticrepositoryfile","title":"services.ethereum.mev-boost.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostbackupschedule","title":"services.ethereum.mev-boost.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostextraargs","title":"services.ethereum.mev-boost.\\.extraArgs

Additional arguments to pass to MEV-Boost.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreenable","title":"services.ethereum.mev-boost.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticenvironmentfile","title":"services.ethereum.mev-boost.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticexclude","title":"services.ethereum.mev-boost.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticextraoptions","title":"services.ethereum.mev-boost.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticpasswordfile","title":"services.ethereum.mev-boost.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrcloneconfig","title":"services.ethereum.mev-boost.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrcloneconfigfile","title":"services.ethereum.mev-boost.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrcloneoptions","title":"services.ethereum.mev-boost.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrepository","title":"services.ethereum.mev-boost.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoreresticrepositoryfile","title":"services.ethereum.mev-boost.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoresnapshot","title":"services.ethereum.mev-boost.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/mev-boost/#servicesethereummev-boostrestoretimeout","title":"services.ethereum.mev-boost.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/mev-boost/options.nix

","text":""},{"location":"reference/module-options/nethermind/","title":"Nethermind","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermind","title":"services.ethereum.nethermind","text":"

Specification of one or more Nethermind instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

"},{"location":"reference/module-options/nethermind/#servicesethereumnethermindenable","title":"services.ethereum.nethermind.\\.enable

Whether to enable Nethermind Ethereum Node\u2026

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindpackage","title":"services.ethereum.nethermind.\\.package

Package to use as Nethermind.

Type: package

Default: pkgs.nethermind

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsbasedbpath","title":"services.ethereum.nethermind.\\.args.baseDbPath

Configures the path of the Nethermind\u2019s database folder.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsconfig","title":"services.ethereum.nethermind.\\.args.config

Determines the configuration file of the network on which Nethermind will be running.

Type: null or string

Default: null

Example: \"mainnet\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsconfigsdirectory","title":"services.ethereum.nethermind.\\.args.configsDirectory

Changes the source directory of your configuration files.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargslog","title":"services.ethereum.nethermind.\\.args.log

Changes the logging level.

Type: one of \u201cOFF\u201d, \u201cTRACE\u201d, \u201cDEBUG\u201d, \u201cINFO\u201d, \u201cWARN\u201d, \u201cERROR\u201d

Default: \"INFO\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsloggerconfigsource","title":"services.ethereum.nethermind.\\.args.loggerConfigSource

Changes the path of the NLog.config file.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmoduleshealthchecksenabled","title":"services.ethereum.nethermind.\\.args.modules.HealthChecks.Enabled

If \u2018true\u2019 then Health Check endpoints is enabled at /health.

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcenabled","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.Enabled

Defines whether the JSON RPC service is enabled on node startup.

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcenginehost","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.EngineHost

Host for JSON RPC calls.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcengineport","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.EnginePort

Port for Execution Engine calls.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8551

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcjwtsecretfile","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.JwtSecretFile

Path to file with hex encoded secret for jwt authentication.

Type: null or string

Default: null

Example: \"/var/run/geth/jwtsecret\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcport","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.Port

Port number for JSON RPC calls.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesjsonrpcwebsocketsport","title":"services.ethereum.nethermind.\\.args.modules.JsonRpc.WebSocketsPort

Port number for JSON RPC web sockets calls.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8545

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesmetricsenabled","title":"services.ethereum.nethermind.\\.args.modules.Metrics.Enabled

If \u2018true\u2019,the node publishes various metrics to Prometheus Pushgateway at given interval.

Type: boolean

Default: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesmetricsexposeport","title":"services.ethereum.nethermind.\\.args.modules.Metrics.ExposePort

If \u2018true\u2019 then Health Check endpoints is enabled at /health

Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesnetworkdiscoveryport","title":"services.ethereum.nethermind.\\.args.modules.Network.DiscoveryPort

UDP port number for incoming discovery connections.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindargsmodulesnetworkp2pport","title":"services.ethereum.nethermind.\\.args.modules.Network.P2PPort

TPC/IP port number for incoming P2P connections.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 30303

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupenable","title":"services.ethereum.nethermind.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupbtrfsenable","title":"services.ethereum.nethermind.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupbtrfssnapshotdirectory","title":"services.ethereum.nethermind.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupbtrfssnapshotretention","title":"services.ethereum.nethermind.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupmetadatainterval","title":"services.ethereum.nethermind.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticenvironmentfile","title":"services.ethereum.nethermind.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticexclude","title":"services.ethereum.nethermind.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticextraoptions","title":"services.ethereum.nethermind.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticpasswordfile","title":"services.ethereum.nethermind.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrcloneconfig","title":"services.ethereum.nethermind.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrcloneconfigfile","title":"services.ethereum.nethermind.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrcloneoptions","title":"services.ethereum.nethermind.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrepository","title":"services.ethereum.nethermind.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupresticrepositoryfile","title":"services.ethereum.nethermind.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindbackupschedule","title":"services.ethereum.nethermind.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindextraargs","title":"services.ethereum.nethermind.\\.extraArgs

Additional arguments to pass to Nethermind.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindopenfirewall","title":"services.ethereum.nethermind.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreenable","title":"services.ethereum.nethermind.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticenvironmentfile","title":"services.ethereum.nethermind.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticexclude","title":"services.ethereum.nethermind.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticextraoptions","title":"services.ethereum.nethermind.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticpasswordfile","title":"services.ethereum.nethermind.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrcloneconfig","title":"services.ethereum.nethermind.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrcloneconfigfile","title":"services.ethereum.nethermind.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrcloneoptions","title":"services.ethereum.nethermind.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrepository","title":"services.ethereum.nethermind.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoreresticrepositoryfile","title":"services.ethereum.nethermind.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoresnapshot","title":"services.ethereum.nethermind.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/nethermind/#servicesethereumnethermindrestoretimeout","title":"services.ethereum.nethermind.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/nethermind/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/","title":"Prysm beacon","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beacon","title":"services.ethereum.prysm-beacon","text":"

Specification of one or more prysm beacon chain instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

"},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconenable","title":"services.ethereum.prysm-beacon.\\.enable

Whether to enable Ethereum Beacon Chain Node from Prysmatic Labs.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconpackage","title":"services.ethereum.prysm-beacon.\\.package

Package to use for Prysm binary

Type: package

Default: pkgs.prysm

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargscheckpoint-sync-url","title":"services.ethereum.prysm-beacon.\\.args.checkpoint-sync-url

URL of a synced beacon node to trust in obtaining checkpoint sync data. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --weak-subjectivity-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsdatadir","title":"services.ethereum.prysm-beacon.\\.args.datadir

Data directory for the databases.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsdisable-grpc-gateway","title":"services.ethereum.prysm-beacon.\\.args.disable-grpc-gateway

Disable the gRPC gateway for JSON-HTTP requests

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsdisable-monitoring","title":"services.ethereum.prysm-beacon.\\.args.disable-monitoring

Disable monitoring service.

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsgenesis-beacon-api-url","title":"services.ethereum.prysm-beacon.\\.args.genesis-beacon-api-url

URL of a synced beacon node to trust for obtaining genesis state. As an additional safety measure, it is strongly recommended to only use this option in conjunction with --weak-subjectivity-checkpoint flag

Type: null or string

Default: null

Example: \"https://goerli.checkpoint-sync.ethpandaops.io\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsgrpc-gateway-host","title":"services.ethereum.prysm-beacon.\\.args.grpc-gateway-host

The host on which the gateway server runs on.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsgrpc-gateway-port","title":"services.ethereum.prysm-beacon.\\.args.grpc-gateway-port

The port on which the gateway server runs.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 3500

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsjwt-secret","title":"services.ethereum.prysm-beacon.\\.args.jwt-secret

Path to a file containing a hex-encoded string representing a 32 byte secret used for authentication with an execution node via HTTP

Type: string

Default: null

Example: \"/var/run/prysm/jwtsecret\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsmonitoring-host","title":"services.ethereum.prysm-beacon.\\.args.monitoring-host

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsmonitoring-port","title":"services.ethereum.prysm-beacon.\\.args.monitoring-port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8080

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsnetwork","title":"services.ethereum.prysm-beacon.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cgoerli\u201d, \u201cholesky\u201d, \u201cprater\u201d, \u201cropsten\u201d, \u201csepolia\u201d

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsp2p-tcp-port","title":"services.ethereum.prysm-beacon.\\.args.p2p-tcp-port

The port used by libp2p.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 13000

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsp2p-udp-port","title":"services.ethereum.prysm-beacon.\\.args.p2p-udp-port

The port used by discv5.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 12000

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargspprof","title":"services.ethereum.prysm-beacon.\\.args.pprof

Enable the pprof HTTP server.

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargspprofaddr","title":"services.ethereum.prysm-beacon.\\.args.pprofaddr

pprof HTTP server listening interface.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargspprofport","title":"services.ethereum.prysm-beacon.\\.args.pprofport

pprof HTTP server listening port.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 6060

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsrpc-host","title":"services.ethereum.prysm-beacon.\\.args.rpc-host

Host on which the RPC server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsrpc-port","title":"services.ethereum.prysm-beacon.\\.args.rpc-port

RPC port exposed by a beacon node.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 4000

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconargsuser","title":"services.ethereum.prysm-beacon.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupenable","title":"services.ethereum.prysm-beacon.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupbtrfsenable","title":"services.ethereum.prysm-beacon.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupbtrfssnapshotdirectory","title":"services.ethereum.prysm-beacon.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupbtrfssnapshotretention","title":"services.ethereum.prysm-beacon.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupmetadatainterval","title":"services.ethereum.prysm-beacon.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticenvironmentfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticexclude","title":"services.ethereum.prysm-beacon.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticextraoptions","title":"services.ethereum.prysm-beacon.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticpasswordfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrcloneconfig","title":"services.ethereum.prysm-beacon.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrcloneconfigfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrcloneoptions","title":"services.ethereum.prysm-beacon.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrepository","title":"services.ethereum.prysm-beacon.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupresticrepositoryfile","title":"services.ethereum.prysm-beacon.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconbackupschedule","title":"services.ethereum.prysm-beacon.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconextraargs","title":"services.ethereum.prysm-beacon.\\.extraArgs

Additional arguments to pass to Prysm Beacon Chain.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconopenfirewall","title":"services.ethereum.prysm-beacon.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreenable","title":"services.ethereum.prysm-beacon.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticenvironmentfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticexclude","title":"services.ethereum.prysm-beacon.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticextraoptions","title":"services.ethereum.prysm-beacon.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticpasswordfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrcloneconfig","title":"services.ethereum.prysm-beacon.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrcloneconfigfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrcloneoptions","title":"services.ethereum.prysm-beacon.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrepository","title":"services.ethereum.prysm-beacon.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoreresticrepositoryfile","title":"services.ethereum.prysm-beacon.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoresnapshot","title":"services.ethereum.prysm-beacon.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-beacon/#servicesethereumprysm-beaconrestoretimeout","title":"services.ethereum.prysm-beacon.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-beacon/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/","title":"Prysm validator","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validator","title":"services.ethereum.prysm-validator","text":"

Specification of one or more prysm validator instances.

Type: attribute set of (submodule)

Default: { }

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

"},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorenable","title":"services.ethereum.prysm-validator.\\.enable

Whether to enable Ethereum Prysm validator client.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorpackage","title":"services.ethereum.prysm-validator.\\.package

Package to use for Prysm binary

Type: package

Default: pkgs.prysm

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsdatadir","title":"services.ethereum.prysm-validator.\\.args.datadir

Data directory for the databases. Defaults to the default datadir for Prysm Beacon

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsdisable-monitoring","title":"services.ethereum.prysm-validator.\\.args.disable-monitoring

Disable monitoring service.

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsgraffiti","title":"services.ethereum.prysm-validator.\\.args.graffiti

String to include in proposed blocks

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsgrpc-gateway-host","title":"services.ethereum.prysm-validator.\\.args.grpc-gateway-host

The host on which the gateway server runs on.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsgrpc-gateway-port","title":"services.ethereum.prysm-validator.\\.args.grpc-gateway-port

The port on which the gateway server runs.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 7500

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsmonitoring-host","title":"services.ethereum.prysm-validator.\\.args.monitoring-host

Host used to listen and respond with metrics for prometheus.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsmonitoring-port","title":"services.ethereum.prysm-validator.\\.args.monitoring-port

Port used to listen and respond with metrics for prometheus.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 8081

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsnetwork","title":"services.ethereum.prysm-validator.\\.args.network

The network to connect to. Mainnet (null) is the default ethereum network.

Type: null or one of \u201cgoerli\u201d, \u201cholesky\u201d, \u201cprater\u201d, \u201cropsten\u201d, \u201csepolia\u201d

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsrpcenable","title":"services.ethereum.prysm-validator.\\.args.rpc.enable

Enable the Enables the RPC server for the validator.

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsrpchost","title":"services.ethereum.prysm-validator.\\.args.rpc.host

Host on which the RPC server should listen.

Type: string

Default: \"127.0.0.1\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsrpcport","title":"services.ethereum.prysm-validator.\\.args.rpc.port

RPC port exposed by a validator client.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 7000

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargssuggested-fee-recipient","title":"services.ethereum.prysm-validator.\\.args.suggested-fee-recipient

Sets ALL validators\u2019 mapping to a suggested eth address to receive gas fees when proposing a block. note that this is only a suggestion when integrating with a Builder API, which may choose to specify a different fee recipient as payment for the blocks it builds.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargsuser","title":"services.ethereum.prysm-validator.\\.args.user

User to run the systemd service.

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargswallet-dir","title":"services.ethereum.prysm-validator.\\.args.wallet-dir

Path to a wallet directory on-disk for Prysm validator accounts

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorargswallet-password-file","title":"services.ethereum.prysm-validator.\\.args.wallet-password-file

Path to a plain-text, .txt file containing your wallet password

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupenable","title":"services.ethereum.prysm-validator.\\.backup.enable

Whether to enable Enable backup.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupbtrfsenable","title":"services.ethereum.prysm-validator.\\.backup.btrfs.enable

Whether to enable Enable btrfs snapshots for the state directory, if supported by the underlying filesystem.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupbtrfssnapshotdirectory","title":"services.ethereum.prysm-validator.\\.backup.btrfs.snapshotDirectory

Directory in which to create the btrfs snapshots. Must be located on the same volume as the state directory

Type: path

Default: \"/snapshots\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupbtrfssnapshotretention","title":"services.ethereum.prysm-validator.\\.backup.btrfs.snapshotRetention

Number of days to retain snapshots

Type: signed integer

Default: 7

Example: \"10\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupmetadatainterval","title":"services.ethereum.prysm-validator.\\.backup.metadata.interval

Time interval in seconds between capturing backup metadata

Type: integer between 1 and 60 (both inclusive)

Default: 10

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticenvironmentfile","title":"services.ethereum.prysm-validator.\\.backup.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticexclude","title":"services.ethereum.prysm-validator.\\.backup.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticextraoptions","title":"services.ethereum.prysm-validator.\\.backup.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticpasswordfile","title":"services.ethereum.prysm-validator.\\.backup.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrcloneconfig","title":"services.ethereum.prysm-validator.\\.backup.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrcloneconfigfile","title":"services.ethereum.prysm-validator.\\.backup.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrcloneoptions","title":"services.ethereum.prysm-validator.\\.backup.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrepository","title":"services.ethereum.prysm-validator.\\.backup.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupresticrepositoryfile","title":"services.ethereum.prysm-validator.\\.backup.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorbackupschedule","title":"services.ethereum.prysm-validator.\\.backup.schedule

Schedule for creating a backup. Format is the same as systemd.time

Type: string

Default: \"hourly\"

Example: \"daily\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorextraargs","title":"services.ethereum.prysm-validator.\\.extraArgs

Additional arguments to pass to Prysm validator.

Type: list of string

Default: [ ]

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatoropenfirewall","title":"services.ethereum.prysm-validator.\\.openFirewall

Open ports in the firewall for any enabled networking services

Type: boolean

Default: false

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreenable","title":"services.ethereum.prysm-validator.\\.restore.enable

Whether to enable Enable restore from snapshot.

Type: boolean

Default: false

Example: true

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticenvironmentfile","title":"services.ethereum.prysm-validator.\\.restore.restic.environmentFile

file containing the credentials to access the repository, in the format of an EnvironmentFile as described by systemd.exec(5)

Type: null or string

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticexclude","title":"services.ethereum.prysm-validator.\\.restore.restic.exclude

Patterns to exclude when backing up. See https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for details on syntax.

Type: list of string

Default:

[\n  \"**/LOCK\"\n  \"keystore\"\n  \"**/nodekey\"\n]\n

Example:

[\n  \"/var/cache\"\n  \"/home/*/.cache\"\n  \".git\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticextraoptions","title":"services.ethereum.prysm-validator.\\.restore.restic.extraOptions

Extra extended options to be passed to the restic --option flag.

Type: list of string

Default: [ ]

Example:

[\n  \"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'\"\n]\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticpasswordfile","title":"services.ethereum.prysm-validator.\\.restore.restic.passwordFile

Read the repository password from a file.

Type: string

Example: \"/etc/nixos/restic-password\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrcloneconfig","title":"services.ethereum.prysm-validator.\\.restore.restic.rcloneConfig

Configuration for the rclone remote being used for backup. See the remote\u2019s specific options under rclone\u2019s docs at https://rclone.org/docs/. When specifying option names, use the \u201cconfig\u201d name specified in the docs. For example, to set --b2-hard-delete for a B2 remote, use hard_delete = true in the attribute set. Warning: Secrets set in here will be world-readable in the Nix store! Consider using the rcloneConfigFile option instead to specify secret values separately. Note that options set here will override those set in the config file.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  account = \"xxx\";\n  hard_delete = true;\n  key = \"xxx\";\n  type = \"b2\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrcloneconfigfile","title":"services.ethereum.prysm-validator.\\.restore.restic.rcloneConfigFile

Path to the file containing rclone configuration. This file must contain configuration for the remote specified in this backup set and also must be readable by root. Options set in rcloneConfig will override those set in this file.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrcloneoptions","title":"services.ethereum.prysm-validator.\\.restore.restic.rcloneOptions

Options to pass to rclone to control its behavior. See https://rclone.org/docs/#options for available options. When specifying option names, strip the leading --. To set a flag such as --drive-use-trash, which does not take a value, set the value to the Boolean true.

Type: null or (attribute set of (string or boolean))

Default: null

Example:

{\n  bwlimit = \"10M\";\n  drive-use-trash = \"true\";\n}\n

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrepository","title":"services.ethereum.prysm-validator.\\.restore.restic.repository

repository to backup to.

Type: null or string

Default: null

Example: \"sftp:backup@192.168.1.100:/backups/my-bucket\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoreresticrepositoryfile","title":"services.ethereum.prysm-validator.\\.restore.restic.repositoryFile

Path to the file containing the repository location to backup to.

Type: null or path

Default: null

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoresnapshot","title":"services.ethereum.prysm-validator.\\.restore.snapshot

The id of the snapshot to restore from

Type: string

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""},{"location":"reference/module-options/prysm-validator/#servicesethereumprysm-validatorrestoretimeout","title":"services.ethereum.prysm-validator.\\.restore.timeout

The max time to wait before timing out on startup. This value is used for TimeoutStartSec in the systemd service config.

Type: signed integer

Default: 600

Example: \"900\"

Declared by: - /nix/store/k9j7h4279imh4msrjw54abrnw0vg46qc-source/modules/prysm-validator/options.nix

","text":""}]} \ No newline at end of file