Nix Podman Stacks
Search K

Appearance

freshrss ​

News feed agregator

Example ​

nix
{config, ...}: {
  nps.stacks.freshrss = {
    enable = true;
    oidc = {
      enable = true;
      clientSecretHash = "$pbkdf2-sha512$...";
      clientSecretFile = config.sops.secrets."freshrss/authelia/client_secret".path;
      cryptoKeyFile = config.sops.secrets."freshrss/authelia/crypto_key".path;
    };
  };
}

Stack Options ​

nps.stacks.freshrss.adminProvisioning.apiPasswordFile ​

Path to a file containing the admin API password

Type
plaintext
absolute path
Default
nix
null
Declaration
<nps/modules/freshrss>

nps.stacks.freshrss.adminProvisioning.email ​

Email address for the admin user

Type
plaintext
string
Declaration
<nps/modules/freshrss>

nps.stacks.freshrss.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 FreshRSS web interface for the first time. This only affects the first run of the container.

If you want to use OIDC login, disable this option. The first logged in OIDC user will be admin in that case. See https://freshrss.github.io/FreshRSS/en/admins/16_OpenID-Connect.html

Type
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/freshrss>

nps.stacks.freshrss.adminProvisioning.passwordFile ​

Path to a file containing the admin user password

Type
plaintext
absolute path
Default
nix
null
Declaration
<nps/modules/freshrss>

nps.stacks.freshrss.adminProvisioning.username ​

Username for the admin user

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

nps.stacks.freshrss.containers.freshrss ​

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

Type
plaintext
submodule
Declaration
<nps/modules/freshrss>

nps.stacks.freshrss.enable ​

Whether to enable freshrss.

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

nps.stacks.freshrss.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/freshrss>

nps.stacks.freshrss.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/freshrss>

nps.stacks.freshrss.oidc.cryptoKeyFile ​

Opaque key used for internal encryption.

Type
plaintext
string
Declaration
<nps/modules/freshrss>

nps.stacks.freshrss.oidc.enable ​

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

The first user created with OIDC login on initial setup will be admin. Make sure to follow the 'Initial Setup Process' instructions at https://freshrss.github.io/FreshRSS/en/admins/16_OpenID-Connect.html

For details, see:

Type
plaintext
boolean
Default
nix
false
Declaration
<nps/modules/freshrss>

nps.stacks.freshrss.oidc.userGroup ​

Users of this group will be able to log in

Type
plaintext
string
Default
nix
"freshrss_user"
Declaration
<nps/modules/freshrss>