Config

Type: object

Configuration settings

AppConfig

Type: object

Application configuration settings

No Additional Properties

Type: object

Settings regarding non-admin users

No Additional Properties

Type: boolean Default: false

Allow non-admin users to edit their own profiles and change their passwords. In the server this is done using the administrator credentials since in a directory only administrators have edit access (administrator@{PUBLICLDAPDOMAIN}, ADMINPASSWD, PUBLICLDAPDOMAIN and ADMINPASSWD are .env variables). @default false

Type: boolean Default: false

Allow non-admin users to access the "/users" and "/users/[dn]" pages. @default false

Type: boolean Default: false

Allow non-admin users to access the "/groups" and "/groups/[dn]" pages. @default false

Type: boolean Default: false

Allow non-admin users to access the "/ous" and "/ous/[dn]" pages. @default false

Type: boolean Default: false

Allow non-admin users to access the "/tree" page. @default false

Type: boolean Default: false

Allow non-admin users to access the "/logs" page. @default false

CaptchaConfig

Type: object

Captcha personalization options. Uses @link https://www.npmjs.com/package/svg-captcha

No Additional Properties

Type: integer Default: 5

Length of the captcha shown in the authentication page, recommended to use a low value for development. @default 5

Value must be greater or equal to 1

Type: integer Default: 96

Height of the captcha image. @default 96

Type: integer Default: 345

Width of the captcha image. @default 345

Type: integer Default: 90

Font size of the characters in the captcha. @default 30

Value must be greater or equal to 0

Type: string Default: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

Characters used to generate the random string in the captcha. @default "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

Type: boolean Default: false

If false, captcha will be black and white otherwise, it will be randomly colorized @default false

Type: string Default: ""

Characters that will be ignored in the captcha. @default ""

Type: integer Default: 5

Number of noise lines in the captcha. @default 5

Value must be greater or equal to 0

Type: string Default: "white"

CSS color of the captcha background. Can use other css variants other than hex. @default "#FFFFFF"


Examples:

"#FFFFFF"
"rgb(255,255,255)"
"hsl(0, 0%, 100%)"
"white"

ViewsConfig

Type: object

Configuration regarding de different pages of the web app

No Additional Properties

GroupsPageConfig

Type: object

Configuration regarding the groups page

No Additional Properties

GroupDetailsConfig

Type: object

Configuration regarding the detailed view of a group ("/groups/[dn]")

No Additional Properties

Type: object

Configuration regarding the "cn" attribute of the group

No Additional Properties

Type: string Default: "cn"

@default "cn"

Type: boolean Default: true

Wether or not to show the "cn" attribute in the "/groups/[dn]" page. @default true

Type: object

Configuration regarding the "description" attribute of the group

No Additional Properties

Type: string Default: "description"

@default "description"

Type: boolean Default: true

Wether or not to show the "description" attribute in the "/groups/[dn]" page. @default true

Type: object

Configuration regarding the "distinguishedName" attribute of the group

No Additional Properties

Type: string Default: "distinguishedName"

@default "distinguishedName"

Type: boolean Default: true

Wether or not to show the "distinguishedName" attribute in the "/groups/[dn]" page. @default true

Type: object

Configuration regarding the "groupType" attribute of the group

No Additional Properties

Type: string Default: "groupType"

@default "groupType"

Type: boolean Default: true

Wether or not to show the "groupType" attribute in the "/groups/[dn]" page. @default true

Type: object

Configuration regarding the "mail" attribute of the group

No Additional Properties

Type: string Default: "mail"

@default "mail"

Type: boolean Default: true

Wether or not to show the "mail" attribute in the "/groups/[dn]" page. @default true

ParentDetailsConfig

Type: object

Configuration regarding the parent entry of the group

No Additional Properties

Type: string Default: "parent"

@default "parent"

Type: boolean Default: true

Wether or not to show the parent of the group in the "/groups/[dn]" page. @default true

Type: boolean Default: false

If false the parent of the group will be shown as the full distinguishedName, else only the CN is shown. @default false

MemberDetailsConfig

Type: object

Configuration regarding the "member(s)" of the entry

No Additional Properties

Type: string Default: "member"

@default "member"

Type: boolean Default: false

If false the each member will be shown as the full distinguishedName, else only the name will be shown. @default false

Type: boolean Default: true

Wether or not to show the "member(s)" of the entry in the details view. If false "shortMember" will be ignored @default true

Type: object

Configuration regarding the "sAMAccountName" attribute of the group

No Additional Properties

Type: string Default: "sAMAccountName"

@default "sAMAccountName"

Type: boolean Default: true

Wether or not to show the "sAMAccountName" attribute in the "/groups/[dn]" page. @default true

Type: object

Configuration regarding the "whenChanged" attribute of the group

No Additional Properties

Type: string Default: "whenChanged"

@default "whenChanged"

Type: boolean Default: true

Wether or not to show the "whenChanged" attribute in the "/groups/[dn]" page. @default true

Type: object

Configuration regarding the "whenCreated" attribute of the group

No Additional Properties

Type: string Default: "whenCreated"

@default "whenCreated"

Type: boolean Default: true

Wether or not to show the "whenCreated" attribute in the "/groups/[dn]" page. @default true

Type: boolean Default: true

Weather or not to show the "/groups" page in navigation. Accessing directly to this route will result on a "403 This page has been disabled by configuration" error. @default true

GroupsTableConfig

Type: object

Groups table view configuration

No Additional Properties

Type: object

Groups table column settings

No Additional Properties

Type: object

Configure groups table "description" column.

No Additional Properties

Type: string Default: "description"

Header for the "description" column of the groups table. @default "description"

Type: boolean Default: true

Wether or not allow the "description" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "description" group table column. @default true

Type: object

Configure groups table "dn" column.

No Additional Properties

Type: string Default: "distinguishedName"

Header for the "dn" column of the groups table. @default "dn"

Type: boolean Default: true

Wether or not allow the "dn" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "dn" group table column. @default true

Type: object

Configure groups table "groupType" column.

No Additional Properties

Type: string Default: "userAccountControl"

Header for the "groupType" column of the groups table. @default "groupType"

Type: boolean Default: true

Wether or not allow the "groupType" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "groupType" group table column. @default true

Type: object

Configure groups table "mail" column.

No Additional Properties

Type: string Default: "mail"

Header for the "mail" column of the groups table. @default "mail"

Type: boolean Default: true

Wether or not allow the "mail" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "mail" group table column. @default true

Type: object

Configure groups table "sAMAccountName" column.

No Additional Properties

Type: string Default: "sAMAccountName"

Header for the "sAMAccountName" column of the groups table. @default "sAMAccountName"

Type: boolean Default: false

Wether or not allow the "sAMAccountName" column to be hidable. @default false

Type: boolean Default: true

Wether or not to show the "sAMAccountName" group table column. @default true

Type: object

Configure groups table "whenCreated" column.

No Additional Properties

Type: string Default: "whenCreated"

Header for the "whenCreated" column of the groups table. @default "whenCreated"

Type: boolean Default: true

Wether or not allow the "whenCreated" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "whenCreated" group table column. @default true

LogsPageConfig

Type: object

configuration regarding the logs page

No Additional Properties

Type: boolean Default: false

Weather or not to show the /logs page in navigation. Accessing directly to this route will result on a '403 This page has been disabled by configuration' error

OrganizationalUnitsPageConfig

Type: object

Configuration regarding the organizational units page

No Additional Properties

OuDetailsConfig

Type: object

Configuration regarding the detailed view of a OU ("/ous/[dn]")

No Additional Properties

Type: object

Configuration regarding the "name" attribute of the OU

No Additional Properties

Type: string Default: "name"

@default "name"

Type: boolean Default: true

Wether or not to show the "name" attribute in the "/ous/[dn]" page. @default true

Type: object

Configuration regarding the "description" attribute of the OU

No Additional Properties

Type: string Default: "description"

@default "description"

Type: boolean Default: true

Wether or not to show the "description" attribute in the "/ous/[dn]" page. @default true

ParentDetailsConfig

Type: object

Configuration regarding the parent entry of the group

Same definition as parent

MemberDetailsConfig

Type: object

Configuration regarding the "member(s)" of the entry

Same definition as member

Type: object

Configuration regarding the "distinguishedName" attribute of the ou

No Additional Properties

Type: string Default: "distinguishedName"

@default "distinguishedName"

Type: boolean Default: true

Wether or not to show the "distinguishedName" attribute in the "/ous/[dn]" page. @default true

Type: object

Configuration regarding the "whenChanged" attribute of the ou

No Additional Properties

Type: string Default: "whenChanged"

@default "whenChanged"

Type: boolean Default: true

Wether or not to show the "whenChanged" attribute in the "/ous/[dn]" page. @default true

Type: object

Configuration regarding the "whenCreated" attribute of the ou

No Additional Properties

Type: string Default: "whenCreated"

@default "whenCreated"

Type: boolean Default: true

Wether or not to show the "whenCreated" attribute in the "/ous/[dn]" page. @default true

Type: boolean Default: true

Weather or not to show the "/ous" page in navigation. Accessing directly to this route will result on a "403 This page has been disabled by configuration" error. @default true

OusTableConfig

Type: object

Ous table view configuration

No Additional Properties

Type: object

Ous table column settings

No Additional Properties

Type: object

Configure ous table "description" column.

No Additional Properties

Type: string Default: "description"

Header for the "description" column of the ous table. @default "description"

Type: boolean Default: true

Wether or not allow the "description" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "description" ou table column. @default true

Type: object

Configure ous table "dn" column.

No Additional Properties

Type: string Default: "distinguishedName"

Header for the "dn" column of the ous table. @default "dn"

Type: boolean Default: true

Wether or not allow the "dn" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "dn" ou table column. @default true

Type: object

Configure ous table "name" column.

No Additional Properties

Type: string Default: "name"

Header for the "name" column of the ous table. @default "name"

Type: boolean Default: false

Wether or not allow the "name" column to be hidable. @default false

Type: boolean Default: true

Wether or not to show the "name" ou table column. @default true

Type: object

Configure ous table "whenCreated" column.

No Additional Properties

Type: string Default: "whenCreated"

Header for the "whenCreated" column of the ous table. @default "whenCreated"

Type: boolean Default: true

Wether or not allow the "whenCreated" column to be hidable. @default true

Type: boolean Default: true

Wether or not to show the "whenCreated" ou table column. @default true

SettingsPageConfig

Type: object

Configuration regarding the settings page

No Additional Properties

Type: boolean Default: true

Weather or not to allow the user to change the configuration. @default false

Type: boolean Default: false

Allow to toggle dark/light modes. @default false

TreePageConfig

Type: object

Configuration regarding the tree page

No Additional Properties

Type: boolean Default: true

Wether or not to show the /tree page in navigation. Accessing directly to this route will result on a '403 This page has been disabled by configuration' error. @default true

UsersPageConfig

Type: object

Configuration regarding the users page

No Additional Properties

UserDetailsConfig

Type: object

Configuration regarding the detailed view of a user ("/users/[dn]" or "/users/me")

No Additional Properties

Type: object

Configuration regarding the "description" attribute of the user

No Additional Properties

Type: string Default: "description"

@default "description"

Type: boolean Default: true

Wether or not to show the "description" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "displayName" attribute of the user

No Additional Properties

Type: string Default: "displayName"

@default "displayName"

Type: boolean Default: true

Wether or not to show the "displayName" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "distinguishedName" attribute of the user

No Additional Properties

Type: string Default: "distinguishedName"

@default "distinguishedName"

Type: boolean Default: true

Wether or not to show the "distinguishedName" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "givenName" attribute of the user

No Additional Properties

Type: string Default: "givenName"

@default "givenName"

Type: boolean Default: true

Wether or not to show the "givenName" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "jpegPhoto" attribute of the user. If "showFallback" and "show" are false then nothing will be shown

No Additional Properties

Type: boolean Default: true

Wether or not to show the "jpegPhoto" in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "mail" attribute of the user

No Additional Properties

Type: string Default: "mail"

@default "mail"

Type: boolean Default: true

Wether or not to show the "mail" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

ParentDetailsConfig

Type: object

Configuration regarding the parent entry of the group

Same definition as parent

MemberDetailsConfig

Type: object

Configuration regarding the "member(s)" of the entry

Same definition as member

Type: object

Configuration regarding the "sAMAccountName" attribute of the user

No Additional Properties

Type: string Default: "sAMAccountName"

@default "sAMAccountName"

Type: boolean Default: true

Wether or not to show the "sAMAccountName" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "sn" attribute of the user

No Additional Properties

Type: string Default: "sn"

@default "sn"

Type: boolean Default: true

Wether or not to show the "sn" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "userAccountControl" attribute of the user

No Additional Properties

Type: string Default: "userAccountControl"

@default "userAccountControl"

Type: boolean Default: true

Wether or not to show the "userAccountControl" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "whenChanged" attribute of the user

No Additional Properties

Type: string Default: "whenChanged"

@default "whenChanged"

Type: boolean Default: true

Wether or not to show the "whenChanged" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

Type: object

Configuration regarding the "whenCreated" attribute of the user

No Additional Properties

Type: string Default: "whenCreated"

@default "whenCreated"

Type: boolean Default: true

Wether or not to show the "whenCreated" attribute in the detail pages ("/users/[dn]" or "/users/me"). @default true

UsersTableConfig

Type: object

Users table view configuration

No Additional Properties

Type: object

Users table columns configuration

No Additional Properties

Type: object

Configure the users table description column

No Additional Properties

Type: string Default: "description"

Name of the table header for the description column. @default "description"

Type: boolean Default: true

Wether or not the "description" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the description column. If false "hidable" is ignored. @default true

Type: object

Configure the users table displayName column

No Additional Properties

Type: string Default: "displayName"

Name of the table header for the displayName column. @default "displayName"

Type: boolean Default: true

Wether or not the "displayName" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the displayName column. If false "hidable" is ignored. @default true

Type: object

Configure the users table dn column

No Additional Properties

Type: string Default: "distinguishedName"

Name of the table header for the dn column. @default "dn"

Type: boolean Default: true

Wether or not the "dn" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the dn column. If false "hidable" is ignored. @default true

Type: object

Configure the users table givenName column

No Additional Properties

Type: string Default: "givenName"

Name of the table header for the givenName column. @default "givenName"

Type: boolean Default: true

Wether or not the "givenName" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the givenName column. If false "hidable" is ignored. @default true

Type: object

Configure the users table jpegPhoto column

No Additional Properties

Type: string Default: "jpegPhoto"

Name of the table header for the jpegPhoto column. @default "jpegPhoto"

Type: boolean Default: true

Wether or not the "jpegPhoto" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the jpegPhoto column. If false "hidable" is ignored. @default true

Type: object

Configure the users table mail column

No Additional Properties

Type: string Default: "mail"

Name of the table header for the mail column. @default "mail"

Type: boolean Default: true

Wether or not the "mail" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the mail column. If false "hidable" is ignored. @default true

Type: object

Configure the users table "sAMAccountName" column

No Additional Properties

Type: string Default: "sAMAccountName"

Name of the table header for the "sAMAccountName" column. @default "sAMAccountName"

Type: boolean Default: false

Wether or not the "sAMAccountName" is hidable or not. @default false

Type: boolean Default: true

Wether or not to show the "sAMAccountName" column. If false "hidable" is ignored. @default true

Type: object

Configure the users table sn column

No Additional Properties

Type: string Default: "sn"

Name of the table header for the sn column. @default "sn"

Type: boolean Default: true

Wether or not the "sn" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the sn column. If false "hidable" is ignored. @default true

Type: object

Configure the users table userAccountControl column

No Additional Properties

Type: string Default: "userAccountControl"

Name of the table header for the userAccountControl column. @default "userAccountControl"

Type: boolean Default: true

Wether or not the "userAccountControl" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the userAccountControl column. If false "hidable" is ignored. @default true

Type: object

Configure the users table whenCreated column

No Additional Properties

Type: string Default: "whenCreated"

Name of the table header for the whenCreated column. @default "whenCreated"

Type: boolean Default: true

Wether or not the "whenCreated" is hidable or not. @default true

Type: boolean Default: true

Wether or not to show the whenCreated column. If false "hidable" is ignored. @default true

DirectoryConfig

Type: object

Directory management configuration settings

No Additional Properties

LDAPClientConfig

Type: object

LDAP client configuration

No Additional Properties

Type: string Default: "ldaps://localhost:636"

LDAP connection string. @default ldaps://localhost:636


Example:

"ldaps://localhost:636"

Type: boolean Default: true

Force strict DN parsing for client methods @default true

TLSOptions

Type: object

Additional options passed to TLS connection layer when connecting via ldaps://

No Additional Properties

Type: string or null Default: "null"

Name of an OpenSSL engine which can provide the client certificate. @default null

Type: boolean Default: false

When enabled, TLS packet trace information is written to stderr. This can be used to debug TLS connection problems. @default false

Type: boolean Default: false

If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true. @default false

Type: boolean Default: false

If true the server will request a certificate from clients that connect and attempt to verify that certificate. @default false

Type: string Default: "Domain Admins"

CN of the directory's administrators group. @default Domain Admins

Type: object

Directory settings regarding group management

No Additional Properties

Type: array of string Default: []

The list of group distinguishedNames, sAMAccountNames, or cn that should not be shown in the /groups view dropdowns and search. Accessing directly to /groups/[dn] of a group that is listed here will result on a '403 This group is hidden by configuration' error. @default []

All items must be unique

No Additional Items

Each item of this array must be:

Type: string

Type: integer or null Default: null

The maximum amount of groups allowed in the directory. If set to null the limit will be ignored. Default groups are included in the count. @default null

Type: object

Directory settings regarding ou management

No Additional Properties

Type: array of string Default: []

The list of ou distinguishedNames, sAMAccountNames, or cn that should not be shown in the /ous view dropdowns and search. Accessing directly to /ous/[dn] of a ou that is listed here will result on a '403 This ou is hidden by configuration' error. @default []

All items must be unique

No Additional Items

Each item of this array must be:

Type: string

Type: boolean Default: false

[Dangerous] Allows the deletion of non-leaf Organizational Units. This will recursively delete all entries in the Organizational Unit. @default false

Type: integer or null Default: null

The maximum amount of ous allowed in the directory. If set to null the limit will be ignored. Default ous are included in the count. @default null

Type: object

Directory settings regarding tree view

No Additional Properties

Type: array of string Default: []

The list of entry distinguishedNames, sAMAccountNames, or cn that should not be shown in the /tree view panels and search. Accessing directly to /tree/[dn] of an entry that is listed here will result on a '403 This resource is hidden by configuration' error. Hiding containers or ous will also throw the error if trying to access any of the children directly. All hidden entries from users, groups, and ous will also be hidden in the tree view. Hiding the root entry will hide the whole tree, throwing the error always. @default []

All items must be unique

No Additional Items

Each item of this array must be:

Type: string

Type: object

Directory settings regarding user management

No Additional Properties

Type: array of string Default: []

The list of user distinguishedNames, sAMAccountNames, or cn that should not be shown in the /users view dropdowns and search. Accessing directly to /users/[dn] of a user that is listed here will result on a '403 This user is hidden by configuration' error, however, signing in as a listed user will not result in error. @default []

All items must be unique

No Additional Items

Each item of this array must be:

Type: string

Type: integer or null Default: null

The maximum amount of users allowed in the directory. If set to null the limit will be ignored. Default users are included in the count. @default null

SystemConfig

Type: object

System settings

No Additional Properties

LoggingConfig

Type: object

Logging configuration according to @link https://www.npmjs.com/package/sveltekit-logger-hook

No Additional Properties

Type: stringFormat: path Default: "./logs/"

Logging paths. Where the app and system logs will be stored. @default "./logs/"

Type: boolean Default: false

Enable or disable url search params decoding. @default false

Type: boolean Default: false

Enable or disable pathname decoding. @default false

Type: string Default: "\"YYYY-MM-DD HH:mm:ss A\""

Log date template as indicated by @link https://day.js.org/docs/en/display/format @default "YYYY-MM-DD HH:mm:ss A"

Type: string Default: "[{date}] {url}{urlSearchParams} {method} {status}"

Log template as indicated by @link https://www.npmjs.com/package/sveltekit-logger-hook @default "[{date}] {url}{urlSearchParams} {method} {status}"

Type: boolean Default: false

Enable or disable logging. If false basePath is ignored. If true basePath is required @default false