Nix Podman Stacks
Search K

Appearance

romm ​

Retro games ROM manager

Example ​

nix
{config, ...}: {
  nps.stacks.romm = {
    enable = true;

    authSecretKeyFile = config.sops.secrets."romm/auth_secret_key".path;
    romLibraryPath = "${config.nps.externalStorageBaseDir}/romm/library";

    db = {
      userPasswordFile = config.sops.secrets."romm/db/user_password".path;
      rootPasswordFile = config.sops.secrets."romm/db/root_password".path;
    };

    extraEnv = {
      IGDB_CLIENT_ID.fromFile = config.sops.secrets."romm/igdb_client_id".path;
      IGDB_CLIENT_SECRET.fromFile = config.sops.secrets."romm/igdb_client_secret".path;
    };

    oidc = {
      enable = true;
      clientSecretFile = config.sops.secrets."romm/authelia/client_secret".path;
      clientSecretHash = "$pbkdf2-sha512$...";
    };
  };
}

Stack Options ​

nps.stacks.romm.adminProvisioning.email ​

Email address for the admin user

Type
plaintext
string
Declaration
<nps/modules/romm>

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
plaintext
boolean
Default
nix
true
Declaration
<nps/modules/romm>

nps.stacks.romm.adminProvisioning.passwordFile ​

Path to a file containing the admin user password

Type
plaintext
absolute path
Declaration
<nps/modules/romm>

nps.stacks.romm.adminProvisioning.username ​

Username for the admin user

Type
plaintext
string
Default
nix
"admin"
Declaration
<nps/modules/romm>

nps.stacks.romm.authSecretKeyFile ​

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

Type
plaintext
absolute path
Declaration
<nps/modules/romm>

nps.stacks.romm.containers.romm ​

Alias of {option}services.podman.containers.romm.

Type
plaintext
submodule
Declaration
<nps/modules/romm>

nps.stacks.romm.containers.romm-db ​

Alias of {option}services.podman.containers.romm-db.

Type
plaintext
submodule
Declaration
<nps/modules/romm>

nps.stacks.romm.db.rootPasswordFile ​

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

Type
plaintext
absolute path
Declaration
<nps/modules/romm>

nps.stacks.romm.db.userPasswordFile ​

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

Type
plaintext
absolute path
Declaration
<nps/modules/romm>

nps.stacks.romm.enable ​

Whether to enable romm.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/romm>

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
plaintext
attribute set of (null or boolean or signed integer or string or absolute path or (submodule))
Default
nix
{ }
Example
nix
{
  IGDB_CLIENT_SECRET = {
    fromFile = "/run/secrets/igdb_client_secret";
  };
  UPLOAD_TIMEOUT = 900;
}
Declaration
<nps/modules/romm>

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
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/romm>

nps.stacks.romm.igir.package ​

The igir package to use.

Type
plaintext
package
Default
nix
pkgs.igir
Declaration
<nps/modules/romm>

nps.stacks.romm.oidc.adminGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"romm_admin"
Declaration
<nps/modules/romm>

nps.stacks.romm.oidc.clientSecretFile ​

The file containing the client secret for the OIDC client that will be registered in Authelia.

For examples on how to generate a client secret, see

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

Type
plaintext
string
Example
nix
config.sops.secrets."immich/authelia/client_secret".path"
Declaration
<nps/modules/romm>

nps.stacks.romm.oidc.clientSecretHash ​

The client secret hash. For examples on how to generate a client secret, see https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

The value can be passed in multiple ways:

  1. As a literal string
  2. As an absolute path to a file containing the hash (toFile)
  3. As an absolute oath to a file containing the client_secret, in which case the hash will be automatically computed (toHash)
  4. As null

If left unset (null), the client secret will be read from the file specified in the clientSecretFile option and hashed automatically before being passed to the Authelia container.

Type
plaintext
null or string or (submodule)
Default
nix
null
Example
nix
# Literal String:
"$pbkdf2-sha512$310000$cbOAIWbfz3vCVXIPIp6d2A$J0klwULa6TvPRCU1HAfuKua/dMKTl8gbTYJz2N73ejGUu0LUGz/y3kwmJLuKuAYGg3WQOT0q9ZzVHHUvpKpgvQ"

# Client secret hash stored in a file
{ fromFile = config.sops.secrets."immich/client_secret_hash".path; }

# Client secret stored in a file: Hash will be computed dynamically
{ toHash = config.sops.secrets."immich/client_secret".path; }

# Null (default): Hash will be computed automatically based on the clientSecretFile option
# Equivalent to { toHash = cfg.oidc.clientSecretFile; }
null
Declaration
<nps/modules/romm>

nps.stacks.romm.oidc.editorGroup ​

Users of this group will be assigned the 'editor' role

Type
plaintext
string
Default
nix
"romm_editor"
Declaration
<nps/modules/romm>

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
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/romm>

nps.stacks.romm.oidc.viewerGroup ​

Users of this group will assigned the 'viewer' role

Type
plaintext
string
Default
nix
"romm_viewer"
Declaration
<nps/modules/romm>

nps.stacks.romm.romLibraryPath ​

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

Type
plaintext
absolute path not in the Nix store
Default
nix
"${config.nps.storageBaseDir}/romm/library"
Example
nix
"${config.nps.externalStorageBaseDir}/romm/library"
Declaration
<nps/modules/romm>

nps.stacks.romm.settings ​

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

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

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Example
nix
{
  platforms = {
    gc = "ngc";
    psx = "ps";
  };
}
Declaration
<nps/modules/romm>