nps.stacks.romm.enable

Whether to enable romm.

Type: boolean

Default: false

Example: true

Declared by:

nps.stacks.romm.adminProvisioning.enable

Whether to automatically create an admin user on the first run. If set to false, you will be prompted to create an admin user when visiting the web ui.

Type: boolean

Default: true

Declared by:

nps.stacks.romm.adminProvisioning.email

Email address for the admin user

Type: string

Declared by:

nps.stacks.romm.adminProvisioning.passwordFile

Path to a file containing the admin user password

Type: absolute path

Declared by:

nps.stacks.romm.adminProvisioning.username

Username for the admin user

Type: string

Default: "admin"

Declared by:

nps.stacks.romm.authSecretKeyFile

Path to the file containing the random secret key. Can be generated with openssl rand -hex 32.

Type: absolute path

Declared by:

nps.stacks.romm.containers.romm

Alias of services.podman.containers.romm.

Type: submodule

Declared by:

nps.stacks.romm.containers.romm-db

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

Type: submodule

Declared by:

nps.stacks.romm.db.rootPasswordFile

Path to the file containing the password for the MariaDB root user

Type: absolute path

Declared by:

nps.stacks.romm.db.userPasswordFile

Path to the file containing the password for the romm database user

Type: absolute path

Declared by:

nps.stacks.romm.extraEnv

Extra environment variables to set for the container. Variables can be either set directly or sourced from a file (e.g. for secrets).

See https://docs.romm.app/latest/Getting-Started/Environment-Variables/

Type: attribute set of (null or boolean or signed integer or string or absolute path or (submodule))

Default: { }

Example:

{
  IGDB_CLIENT_SECRET = {
    fromFile = "/run/secrets/igdb_client_secret";
  };
  UPLOAD_TIMEOUT = 900;
}

Declared by:

nps.stacks.romm.igir.enable

Whether to install a helper program igir-romm-cleanup that can organize your ROM collection. Will setup defaults for dat, input & output dirs based on the configured library location.

Also adds parameters to copy remaining (undetected) ROMs as well as grouping multi-disk games.

See

Type: boolean

Default: false

Declared by:

nps.stacks.romm.igir.package

The igir package to use.

Type: package

Default: pkgs.igir

Declared by:

nps.stacks.romm.oidc.enable

Whether to enable OIDC login with Authelia. This will register an OIDC client in Authelia and setup the necessary environment variables in RomM.

For details, see:

Type: boolean

Default: false

Declared by:

nps.stacks.romm.oidc.clientSecretFile

Path to the file containing that client secret that will be used by RomM to authenticate against Authelia.

Type: absolute path

Declared by:

nps.stacks.romm.oidc.clientSecretHash

The hashed client_secret. Will be set in the Authelia client config. For examples on how to generate a client secret, see

https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

Type: string

Declared by:

nps.stacks.romm.oidc.userGroup

Users of this group will be able to log in

Type: string

Default: "romm_user"

Declared by:

nps.stacks.romm.romLibraryPath

Base path on the host where the rom library is stored.

Type: absolute path not in the Nix store

Default: "${config.nps.storageBaseDir}/romm/library"

Example: "${config.nps.externalStorageBaseDir}/romm/library"

Declared by:

nps.stacks.romm.settings

RomM settings. Will be mounted as the config.yml.

See https://docs.romm.app/latest/Getting-Started/Configuration-File/

Type: YAML 1.1 value

Default: { }

Example:

{
  platforms = {
    gc = "ngc";
    psx = "ps";
  };
}

Declared by: