nps.stacks.lldap.enable

Whether to enable lldap.

Type: boolean

Default: false

Example: true

Declared by:

nps.stacks.lldap.adminPasswordFile

Path to the file containing the admin password.

Type: absolute path

Declared by:

nps.stacks.lldap.adminUsername

Admin username for LDAP as well as the web interface.

Type: string

Default: "admin"

Declared by:

nps.stacks.lldap.baseDn

The starting point in the LDAP directory tree from which searches begin.

Type: string

Default: "DC=example,DC=com"

Example: "DC=mydomain,DC=net"

Declared by:

nps.stacks.lldap.bootstrap.cleanUp

Whether to delete groups and users not specified in the config, also remove users from groups that they do not belong to

Type: boolean

Default: false

Declared by:

nps.stacks.lldap.bootstrap.groupSchemas

Group schemas. Can be used to create custom group attributes.

Type: attribute set of (submodule)

Default: { }

Declared by:

nps.stacks.lldap.bootstrap.groupSchemas.<name>.attributeType

Type of the attribute

Type: one of “STRING”, “INTEGER”, “JPGEG”, “DATE_TIME”

Declared by:

nps.stacks.lldap.bootstrap.groupSchemas.<name>.isEditable

Whether the attribute is editable by users

Type: boolean

Default: false

Declared by:

nps.stacks.lldap.bootstrap.groupSchemas.<name>.isList

Whether the attribute can have multiple values

Type: boolean

Default: false

Declared by:

nps.stacks.lldap.bootstrap.groupSchemas.<name>.isVisible

Whether the attribute is visible by users

Type: boolean

Default: true

Declared by:

nps.stacks.lldap.bootstrap.groupSchemas.<name>.name

Name of field, case insensitve - you should use lowercase

Type: string matching the pattern ^[a-zA-Z0-9-]+$

Default: <name>

Declared by:

nps.stacks.lldap.bootstrap.groups

Groups that will be created. Besides the name, you can also specify custom attributes for the group, if they are defined in the groupSchemas option.

See https://github.com/lldap/lldap/blob/main/example_configs/bootstrap/bootstrap.md#group-config-file-example

Type: attribute set of (string or signed integer or boolean)

Default: { }

Declared by:

nps.stacks.lldap.bootstrap.groups.<name>.name

Name of the group. Defaults to the name of the attribute.

Type: string

Default: <name>

Declared by:

nps.stacks.lldap.bootstrap.userSchemas

User schema. Can be used to create custom user attributes.

Type: attribute set of (submodule)

Default: { }

Declared by:

nps.stacks.lldap.bootstrap.userSchemas.<name>.attributeType

Type of the attribute

Type: one of “STRING”, “INTEGER”, “JPGEG”, “DATE_TIME”

Declared by:

nps.stacks.lldap.bootstrap.userSchemas.<name>.isEditable

Whether the attribute is editable by users

Type: boolean

Default: false

Declared by:

nps.stacks.lldap.bootstrap.userSchemas.<name>.isList

Whether the attribute can have multiple values

Type: boolean

Default: false

Declared by:

nps.stacks.lldap.bootstrap.userSchemas.<name>.isVisible

Whether the attribute is visible by users

Type: boolean

Default: true

Declared by:

nps.stacks.lldap.bootstrap.userSchemas.<name>.name

Name of field, case insensitve - you should use lowercase

Type: string matching the pattern ^[a-zA-Z0-9-]+$

Default: <name>

Declared by:

nps.stacks.lldap.bootstrap.users

LLDAP users that will be provisioned at startup. You can also specify custom attributes for the user, if they are defined in the useSchemas option.

See https://github.com/lldap/lldap/blob/main/example_configs/bootstrap/bootstrap.md#user-config-file-example

Type: attribute set of (string or signed integer or boolean)

Default: [ ]

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.avatar_url

Must be a valid URL to jpeg file. (ignored if gravatar_avatar specified)

Type: null or string

Default: null

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.displayName

Display name of the user

Type: null or string

Default: null

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.email

E-Mail of the user

Type: string

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.firstName

First name of the user

Type: null or string

Default: null

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.gravatar_avatar

the script will try to get an avatar from gravatar by previously specified email

Type: boolean

Default: false

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.groups

An array of groups the user will be a member of (all the groups must be specified in the bootstrap.groups option)

Type: list of string

Default: [ ]

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.id

ID of the user. Defaults to the name of the attribute.

Type: string

Default: <name>

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.lastName

Last name of the user

Type: null or string

Default: null

Declared by:

nps.stacks.lldap.bootstrap.users.<name>.password_file

Path to the file containing the user password

Type: null or absolute path

Default: null

Declared by:

nps.stacks.lldap.containers.lldap

Alias of services.podman.containers.lldap.

Type: submodule

Declared by:

nps.stacks.lldap.jwtSecretFile

Path to the file containing the JWT secret

Type: absolute path

Declared by:

nps.stacks.lldap.keySeedFile

Path to the file containing the key seed

Type: absolute path

Declared by:

nps.stacks.lldap.settings

Additional lldap configuration. If provided, will be mounted as lldap_config.toml;

See https://github.com/lldap/lldap/blob/main/lldap_config.docker_template.toml

Type: null or TOML value

Declared by: