Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Service Configuration Options

These are the options for the NixOS module. the Home-Manger options are almost the same, but the host, and proxy options are not functioning there right now

Top-Level Options

services.luanti.enable

Globally disables all Luanti services if set to false, regardless of individual server configurations.

  • Type: Boolean
  • Default: true

services.luanti.addOverlay

Adds pkgs.luantiPackages and pkgs.fetchFromLuantiContentDB etc.

  • Type: Boolean
  • Default: true

services.luanti.proxy

The proxy is used for the minetest-wasm package. If a server defines the host option these options are set automatically

  • services.luanti.proxy.port

    TCP port used by the proxy service.

    • Type: Integer
    • Default: 30261
  • services.luanti.proxy.directProxies

    • Type: List of configurations
    • Structure:
      • address: String (IP or hostname)
      • realAddress: String (Default: "127.0.0.1")
      • port: Integer

services.luanti.package

Specifies the default Luanti server package to use. Can be overwritten by each server specifically.

  • Type: Package reference
  • Default: pkgs.luanti-server

services.luanti.whitelist

Global default whitelist for all servers. Example: ["alice", "bob"].

  • Type: List of Strings or Null
  • Default: null

Server-Specific Options

Each server instance is configured under services.luanti.servers.<name>, where <name> is a unique identifier for the server.

services.luanti.servers.<name>.enable

Enables or disables a specific server instance.

  • Type: Boolean
  • Default: true

services.luanti.servers.<name>.openFirewall

Opens UDP port for the server and if host is set, the TCP ports for nginx in the firewall.

  • Type: Boolean
  • Default: true

services.luanti.servers.<name>.port

Port number to bind to.

  • Type: Integer
  • Default: Determined by server index

services.luanti.servers.<name>.game

Specifies the game package for the server.

  • Type: Package reference
  • Default: pkgs.luantiPackages.games.mineclone2

services.luanti.servers.<name>.package

Allows overriding the luanti-server package per server instance.

  • Type: Package reference
  • Default: Uses value of top-level package option.

services.luanti.servers.<name>.whitelist

Whitelist specific to this server, overriding global whitelist if set.

  • Type: List of Strings or Null
  • Default: null

services.luanti.servers.<name>.host

FQDN for experimental Luanti-WASM builds. Only functional in the NixOS module.

  • Type: String or Null
  • Default: null

services.luanti.servers.<name>.ssl

Enables HTTPS for the WASM build. Only functional in the NixOS module.

  • Type: Boolean
  • Default: false

services.luanti.servers.<name>.webTexturePack

The Texture Pack used by the web client (only used if host is defined)

  • Type: Package or null
  • Default null

services.luanti.servers.<name>.mods

List of Luanti mods to include.

  • Type: List of Packages
  • Default: []

services.luanti.servers.<name>.config

Additional settings for the Luanti config file.

  • Type: Configuration block (attrsOf)
  • Default: Sets the port for Prometheus to the same port as the luanti server

services.luanti.servers.<name>.mapserver.enable

Start a dedicated mapserver instance for this Luanti server (only functional in the NixOS module right now).

  • Type: Boolean
  • Default: false

services.luanti.servers.<name>.mapserver.config

Configuration written verbatim to mapserver.json. The port key is required when the mapserver is enabled; other keys follow the upstream mapserver schema.

  • Type: Configuration block (attrsOf)
  • Default: {}
  • Notes:
    • Set webapi.secretkey when the companion mod is enabled so the mod can authenticate.
    • When host is configured, the NixOS module proxies /map to this port.

services.luanti.servers.<name>.mapserver.companionMod

Installs the mapserver companion mod into the server and wires it to the configured mapserver URL and secret key.

  • Type: Boolean
  • Default: false