summaryrefslogtreecommitdiffstats
path: root/packages/wekan-ldap/README.md
blob: 4f41d02386333404244c37ffbc76c03eed40baa9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# meteor-ldap

This packages is based on the RocketChat ldap login package

# settings definition

LDAP_Enable: Self explanatory

LDAP_Port: The port of the LDAP server

LDAP_Host: The host server for the LDAP server

LDAP_BaseDN: The base DN for the LDAP Tree

LDAP_Login_Fallback: Fallback on the default authentication method

LDAP_Reconnect: Reconnect to the server if the connection is lost

LDAP_Timeout: self explanatory

LDAP_Idle_Timeout: self explanatory

LDAP_Connect_Timeout: self explanatory

LDAP_Authentication: If the LDAP needs a user account to search

LDAP_Authentication_UserDN: The search user DN

LDAP_Authentication_Password: The password for the search user

LDAP_Internal_Log_Level: The logging level for the module

LDAP_Background_Sync: If the sync of the users should be done in the
background

LDAP_Background_Sync_Interval: At which interval does the background task sync

LDAP_Encryption: If using LDAPS, set it to 'ssl', else it will use 'ldap://'

LDAP_CA_Cert: The certification for the LDAPS server

LDAP_Reject_Unauthorized: Reject Unauthorized Certificate

LDAP_User_Search_Filter:

LDAP_User_Search_Scope:

LDAP_User_Search_Field: Which field is used to find the user

LDAP_Search_Page_Size:

LDAP_Search_Size_Limit:

LDAP_Group_Filter_Enable: enable group filtering

LDAP_Group_Filter_ObjectClass: The object class for filtering

LDAP_Group_Filter_Group_Id_Attribute:

LDAP_Group_Filter_Group_Member_Attribute:

LDAP_Group_Filter_Group_Member_Format:

LDAP_Group_Filter_Group_Name:

LDAP_Unique_Identifier_Field: This field is sometimes class GUID ( Globally Unique Identifier)

UTF8_Names_Slugify: Convert the username to utf8

LDAP_Username_Field: Which field contains the ldap username

LDAP_Fullname_Field: Which field contains the ldap full name

LDAP_Email_Match_Enable: Allow existing account matching by e-mail address when username does not match

LDAP_Email_Match_Require: Require existing account matching by e-mail address when username does match

LDAP_Email_Match_Verified: Require existing account email address to be verified for matching

LDAP_Email_Field: Which field contains the LDAP e-mail address

LDAP_Sync_User_Data:

LDAP_Sync_User_Data_FieldMap:

Accounts_CustomFields:

LDAP_Default_Domain: The default domain of the ldap it is used to create email if the field is not map correctly with the LDAP_Sync_User_Data_FieldMap




# example settings.json
```
{
  "LDAP_Port": 389,
  "LDAP_Host": "localhost",
  "LDAP_BaseDN": "ou=user,dc=example,dc=org",
  "LDAP_Login_Fallback": false,
  "LDAP_Reconnect": true,
  "LDAP_Timeout": 10000,
  "LDAP_Idle_Timeout": 10000,
  "LDAP_Connect_Timeout": 10000,
  "LDAP_Authentication": true,
  "LDAP_Authentication_UserDN": "cn=admin,dc=example,dc=org",
  "LDAP_Authentication_Password": "admin",
  "LDAP_Internal_Log_Level": "debug",
  "LDAP_Background_Sync": false,
  "LDAP_Background_Sync_Interval": "100",
  "LDAP_Encryption": false,
  "LDAP_Reject_Unauthorized": false,
  "LDAP_Group_Filter_Enable": false,
  "LDAP_Search_Page_Size": 0,
  "LDAP_Search_Size_Limit": 0,
  "LDAP_User_Search_Filter": "",
  "LDAP_User_Search_Field": "uid",
  "LDAP_User_Search_Scope": "",
  "LDAP_Unique_Identifier_Field": "guid",
  "LDAP_Username_Field": "uid",
  "LDAP_Fullname_Field": "cn",
  "LDAP_Email_Match_Enable": true,
  "LDAP_Email_Match_Require": false,
  "LDAP_Email_Match_Verified": false,
  "LDAP_Email_Field": "mail",
  "LDAP_Sync_User_Data": false,
  "LDAP_Sync_User_Data_FieldMap": "{\"cn\":\"name\", \"mail\":\"email\"}",
  "LDAP_Merge_Existing_Users": true,
  "UTF8_Names_Slugify": true
}
```