nps.stacks.filebrowser-quantum.enable

Whether to enable filebrowser-quantum.

Type: boolean

Default: false

Example: true

Declared by:

nps.stacks.filebrowser-quantum.containers.filebrowser-quantum

Alias of services.podman.containers.filebrowser-quantum.

Type: submodule

Declared by:

nps.stacks.filebrowser-quantum.mounts

Mount configuration for the file browser. Format: { 'hostPath' = container-source-config }

The mounts will be added to the settings source section and a volume mount will be added for each configured source.

See https://github.com/gtsteffaniak/filebrowser/wiki/Configuration-And-Examples#example-advanced-source-config

Type: attribute set of (submodule)

Default: { }

Example:

{
  "/home/foo/media" = {
    config = {
      disableIndexing = false;
      exclude = {
        fileEndsWith = [
          ".zip"
          ".txt"
        ];
      };
    };
    path = "/media";
  };
  "/mnt/ext/data" = {
    name = "ext-data";
    path = "/data";
  };
}

Declared by:

nps.stacks.filebrowser-quantum.mounts.<name>.config

Additional configuration options for the source.

See https://github.com/gtsteffaniak/filebrowser/wiki/Configuration-And-Examples#example-advanced-source-config

Type: YAML 1.1 value

Default: { }

Declared by:

nps.stacks.filebrowser-quantum.mounts.<name>.name

Optional name of the source, otherwise the source gets named the folder name

Type: null or string

Default: null

Example: "folder"

Declared by:

nps.stacks.filebrowser-quantum.mounts.<name>.path

Path of the source in the container

Type: absolute path

Example: "/mnt/folder"

Declared by:

nps.stacks.filebrowser-quantum.oidc.enable

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

For details, see:

Type: boolean

Default: false

Declared by:

nps.stacks.filebrowser-quantum.oidc.adminGroup

Users of this group will be assigned admin rights

Type: string

Default: "filebrowser-quantum_admin"

Declared by:

nps.stacks.filebrowser-quantum.oidc.clientSecretFile

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

Type: string

Declared by:

nps.stacks.filebrowser-quantum.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.filebrowser-quantum.oidc.userGroup

Users of this group will be able to log in

Type: string

Default: "filebrowser-quantum_user"

Declared by:

nps.stacks.filebrowser-quantum.settings

Settings that will be added to the config.yml. To configure sources, you should prefer using the mounts option, as the corresponding volume mappings will be configured automatically.

See https://github.com/gtsteffaniak/filebrowser/wiki/Configuration-And-Examples#configuring-your-application

Type: YAML 1.1 value

Declared by: