Settings Options

Most stacks will rely on some central settings. An example would be the base location where containers should create bind mounts for persistent data.

The following list contains all of the central settings.

nps.enableSocket

Whether to enable the Podman socket for user services. Note that the socket is required for the services like Traefik or Homepage to run successfully, since they access the Podman API.

If this is disabled and you use these services, you will need to manually enable the socket.

Type: boolean

Default: true

Declared by:

nps.package

The podman package to use.

Type: package

Default: pkgs.podman

Declared by:

nps.containers.adguard

Alias of services.podman.containers.adguard.

Type: submodule

Declared by:

nps.containers.aiostreams

Alias of services.podman.containers.aiostreams.

Type: submodule

Declared by:

nps.containers.alloy

Alias of services.podman.containers.alloy.

Type: submodule

Declared by:

nps.containers.audiobookshelf

Alias of services.podman.containers.audiobookshelf.

Type: submodule

Declared by:

nps.containers.authelia

Alias of services.podman.containers.authelia.

Type: submodule

Declared by:

nps.containers.bazarr

Alias of services.podman.containers.bazarr.

Type: submodule

Declared by:

nps.containers.beszel

Alias of services.podman.containers.beszel.

Type: submodule

Declared by:

nps.containers.beszel-agent

Alias of services.podman.containers.beszel-agent.

Type: submodule

Declared by:

nps.containers.blocky

Alias of services.podman.containers.blocky.

Type: submodule

Declared by:

nps.containers.bytestash

Alias of services.podman.containers.bytestash.

Type: submodule

Declared by:

nps.containers.calibre

Alias of services.podman.containers.calibre.

Type: submodule

Declared by:

nps.containers.calibre-downloader

Alias of services.podman.containers.calibre-downloader.

Type: submodule

Declared by:

nps.containers.changedetection

Alias of services.podman.containers.changedetection.

Type: submodule

Declared by:

nps.containers.crowdsec

Alias of services.podman.containers.crowdsec.

Type: submodule

Declared by:

nps.containers.dockdns

Alias of services.podman.containers.dockdns.

Type: submodule

Declared by:

nps.containers.docker-socket-proxy

Alias of services.podman.containers.docker-socket-proxy.

Type: submodule

Declared by:

nps.containers.dozzle

Alias of services.podman.containers.dozzle.

Type: submodule

Declared by:

nps.containers.filebrowser

Alias of services.podman.containers.filebrowser.

Type: submodule

Declared by:

nps.containers.forgejo

Alias of services.podman.containers.forgejo.

Type: submodule

Declared by:

nps.containers.freshrss

Alias of services.podman.containers.freshrss.

Type: submodule

Declared by:

nps.containers.gatus

Alias of services.podman.containers.gatus.

Type: submodule

Declared by:

nps.containers.gatus-db

Alias of services.podman.containers.gatus-db.

Type: submodule

Declared by:

nps.containers.gluetun

Alias of services.podman.containers.gluetun.

Type: submodule

Declared by:

nps.containers.grafana

Alias of services.podman.containers.grafana.

Type: submodule

Declared by:

nps.containers.healthchecks

Alias of services.podman.containers.healthchecks.

Type: submodule

Declared by:

nps.containers.homeassistant

Alias of services.podman.containers.homeassistant.

Type: submodule

Declared by:

nps.containers.homepage

Alias of services.podman.containers.homepage.

Type: submodule

Declared by:

nps.containers.immich

Alias of services.podman.containers.immich.

Type: submodule

Declared by:

nps.containers.immich-db

Alias of services.podman.containers.immich-db.

Type: submodule

Declared by:

nps.containers.immich-machine-learning

Alias of services.podman.containers.immich-machine-learning.

Type: submodule

Declared by:

nps.containers.immich-redis

Alias of services.podman.containers.immich-redis.

Type: submodule

Declared by:

nps.containers.ittools

Alias of services.podman.containers.ittools.

Type: submodule

Declared by:

nps.containers.jellyfin

Alias of services.podman.containers.jellyfin.

Type: submodule

Declared by:

nps.containers.karakeep

Alias of services.podman.containers.karakeep.

Type: submodule

Declared by:

nps.containers.karakeep-chrome

Alias of services.podman.containers.karakeep-chrome.

Type: submodule

Declared by:

nps.containers.karakeep-meilisearch

Alias of services.podman.containers.karakeep-meilisearch.

Type: submodule

Declared by:

nps.containers.kimai

Alias of services.podman.containers.kimai.

Type: submodule

Declared by:

nps.containers.kimai-db

Alias of services.podman.containers.kimai-db.

Type: submodule

Declared by:

nps.containers.lldap

Alias of services.podman.containers.lldap.

Type: submodule

Declared by:

nps.containers.loki

Alias of services.podman.containers.loki.

Type: submodule

Declared by:

nps.containers.mealie

Alias of services.podman.containers.mealie.

Type: submodule

Declared by:

nps.containers.microbin

Alias of services.podman.containers.microbin.

Type: submodule

Declared by:

nps.containers.n8n

Alias of services.podman.containers.n8n.

Type: submodule

Declared by:

nps.containers.ntfy

Alias of services.podman.containers.ntfy.

Type: submodule

Declared by:

nps.containers.omnitools

Alias of services.podman.containers.omnitools.

Type: submodule

Declared by:

nps.containers.paperless

Alias of services.podman.containers.paperless.

Type: submodule

Declared by:

nps.containers.paperless-broker

Alias of services.podman.containers.paperless-broker.

Type: submodule

Declared by:

nps.containers.paperless-db

Alias of services.podman.containers.paperless-db.

Type: submodule

Declared by:

nps.containers.paperless-ftp

Alias of services.podman.containers.paperless-ftp.

Type: submodule

Declared by:

nps.containers.pocketid

Alias of services.podman.containers.pocketid.

Type: submodule

Declared by:

nps.containers.podman-exporter

Alias of services.podman.containers.podman-exporter.

Type: submodule

Declared by:

nps.containers.prometheus

Alias of services.podman.containers.prometheus.

Type: submodule

Declared by:

nps.containers.prowlarr

Alias of services.podman.containers.prowlarr.

Type: submodule

Declared by:

nps.containers.qbittorrent

Alias of services.podman.containers.qbittorrent.

Type: submodule

Declared by:

nps.containers.radarr

Alias of services.podman.containers.radarr.

Type: submodule

Declared by:

nps.containers.romm

Alias of services.podman.containers.romm.

Type: submodule

Declared by:

nps.containers.romm-db

Alias of services.podman.containers.romm-db.

Type: submodule

Declared by:

nps.containers.sockpuppetbrowser

Alias of services.podman.containers.sockpuppetbrowser.

Type: submodule

Declared by:

nps.containers.sonarr

Alias of services.podman.containers.sonarr.

Type: submodule

Declared by:

nps.containers.stirling-pdf

Alias of services.podman.containers.stirling-pdf.

Type: submodule

Declared by:

nps.containers.traefik

Alias of services.podman.containers.traefik.

Type: submodule

Declared by:

nps.containers.uptime-kuma

Alias of services.podman.containers.uptime-kuma.

Type: submodule

Declared by:

nps.containers.vaultwarden

Alias of services.podman.containers.vaultwarden.

Type: submodule

Declared by:

nps.containers.wg-easy

Alias of services.podman.containers.wg-easy.

Type: submodule

Declared by:

nps.containers.wg-portal

Alias of services.podman.containers.wg-portal.

Type: submodule

Declared by:

nps.defaultGid

GID of the user that will be used by default for containers if they allow GID configuration. When running rootless containers, GID 0 gets mapped to the host users GID.

Type: signed integer

Default: 0

Declared by:

nps.defaultTz

Default timezone for containers. Will be passed to all containers as TZ environment variable.

Type: null or string

Default: "Etc/UTC"

Declared by:

nps.defaultUid

UID of the user that will be used by default for containers if they allow UID configuration. When running rootless containers, UID 0 gets mapped to the host users UID.

Type: signed integer

Default: 0

Declared by:

nps.externalStorageBaseDir

Base location that will be used for larger data such as downloads or media files. Could be an external disk.

Type: absolute path

Declared by:

nps.hostIP4Address

The IPv4 address which will be used in case explicit bindings are required.

Type: string

Declared by:

nps.hostUid

UID of the host user running the containers. Will be used to infer the Podman socket location (XDG_RUNTIME_DIR).

Type: signed integer

Default: 1000

Declared by:

nps.mediaStorageBaseDir

Base location for larger media files. This is where containers like Jellyfin or Immich will store their media files.

Type: absolute path

Default: "${config.nps.externalStorageBaseDir}/media"

Declared by:

nps.socketLocation

The location of the Podman socket for user services. Will be passed to containers that communicate with the Podman API, such as Traefik, Homepage or Beszel.

Type: absolute path (read only)

Default: "/run/user/${toString config.nps.hostUid}/podman/podman.sock"

Declared by:

nps.storageBaseDir

Base directory for Podman storage. This is where each stack will create its bind mounts for persistent data. For example, setting this to /home/foo/stacks would result in Adguard creating its bind mount at /home/foo/stacks/adguard.

Type: absolute path

Default: "${config.home.homeDirectory}/stacks"

Declared by: