nps.stacks.paperless.enable

Whether to enable paperless.

Type: boolean

Default: false

Example: true

Declared by:

nps.stacks.paperless.adminProvisioning.enable

Whether to automatically create an admin user on the first run. If set to false, an admin user can be manually created using the createsuperuser command.

See https://docs.paperless-ngx.com/administration/#create-superuser

Type: boolean

Default: true

Declared by:

nps.stacks.paperless.adminProvisioning.email

Email address for the admin user

Type: string

Declared by:

nps.stacks.paperless.adminProvisioning.passwordFile

Path to a file containing the admin user password

Type: absolute path

Default: null

Declared by:

nps.stacks.paperless.adminProvisioning.username

Username for the admin user

Type: string

Default: "admin"

Declared by:

nps.stacks.paperless.containers.paperless

Alias of services.podman.containers.paperless.

Type: submodule

Declared by:

nps.stacks.paperless.containers.paperless-broker

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

Type: submodule

Declared by:

nps.stacks.paperless.containers.paperless-db

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

Type: submodule

Declared by:

nps.stacks.paperless.containers.paperless-ftp

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

Type: submodule

Declared by:

nps.stacks.paperless.db.passwordFile

Path to the file containing the database password for Paperless

Type: absolute path

Declared by:

nps.stacks.paperless.db.username

Database user name for Paperless

Type: string

Default: "paperless"

Declared by:

nps.stacks.paperless.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.paperless-ngx.com/configuration

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

Default: { }

Declared by:

nps.stacks.paperless.ftp.enable

Whether to enable FTP server.

Type: boolean

Default: false

Example: true

Declared by:

nps.stacks.paperless.ftp.passwordFile

Path to the file containing the FTP password

Type: absolute path

Declared by:

nps.stacks.paperless.oidc.enable

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

For details, see:

For details, see:

Type: boolean

Default: false

Declared by:

nps.stacks.paperless.oidc.clientSecretFile

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

Type: string

Declared by:

nps.stacks.paperless.oidc.clientSecretHash

The hashed client_secret. 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.paperless.oidc.userGroup

Users of this group will be able to log in

Type: string

Default: "paperless_user"

Declared by:

nps.stacks.paperless.secretKeyFile

Path to the file containing the Paperless secret key

See https://docs.paperless-ngx.com/configuration/#PAPERLESS_SECRET_KEY

Type: absolute path

Declared by: