Commit 4c1c99b5 authored by Jason Blais's avatar Jason Blais Committed by Christopher Speller
Browse files

Updates to AD/LDAP settings help text (#1268)

* Update admin_definition.jsx

* Update en.json

* Update admin_definition.jsx

* Fix syntax errors

* Fix build error

* Fix build issues

* Update en.json

* Add "help_text_html: true," for help text fields
parent 1451334e
......@@ -735,7 +735,7 @@ export default {
placeholder: 'admin.ldap.firstnameAttrEx',
placeholder_default: 'E.g.: "givenName"',
help_text: 'admin.ldap.firstnameAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server that will be used to populate the first name of users in Mattermost. When set, users will not be able to edit their first name, since it is synchronized with the LDAP server. When left blank, users can set their own first name in Account Settings.',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the first name of users in Mattermost. When set, users cannot edit their first name, since it is synchronized with the LDAP server. When left blank, users can set their first name in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
......@@ -749,7 +749,7 @@ export default {
placeholder: 'admin.ldap.lastnameAttrEx',
placeholder_default: 'E.g.: "sn"',
help_text: 'admin.ldap.lastnameAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server that will be used to populate the last name of users in Mattermost. When set, users will not be able to edit their last name, since it is synchronized with the LDAP server. When left blank, users can set their own last name in Account Settings.',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the last name of users in Mattermost. When set, users cannot edit their last name, since it is synchronized with the LDAP server. When left blank, users can set their last name in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
......@@ -763,7 +763,7 @@ export default {
placeholder: 'admin.ldap.nicknameAttrEx',
placeholder_default: 'E.g.: "nickname"',
help_text: 'admin.ldap.nicknameAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server that will be used to populate the nickname of users in Mattermost. When set, users will not be able to edit their nickname, since it is synchronized with the LDAP server. When left blank, users can set their own nickname in Account Settings.',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the nickname of users in Mattermost. When set, users cannot edit their nickname, since it is synchronized with the LDAP server. When left blank, users can set their nickname in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
......@@ -777,7 +777,7 @@ export default {
placeholder: 'admin.ldap.positionAttrEx',
placeholder_default: 'E.g.: "title"',
help_text: 'admin.ldap.positionAttrDesc',
help_text_default: '(Optional) The attribute in the AD/LDAP server that will be used to populate the position field in Mattermost.',
help_text_default: '(Optional) The attribute in the AD/LDAP server used to populate the position field in Mattermost. When set, users cannot edit their position, since it is synchronized with the LDAP server. When left blank, users can set their position in Account Settings.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
......@@ -791,7 +791,7 @@ export default {
placeholder: 'admin.ldap.emailAttrEx',
placeholder_default: 'E.g.: "mail" or "userPrincipalName"',
help_text: 'admin.ldap.emailAttrDesc',
help_text_default: 'The attribute in the AD/LDAP server that will be used to populate the email addresses of users in Mattermost.',
help_text_default: 'The attribute in the AD/LDAP server used to populate the email address field in Mattermost.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
......@@ -804,8 +804,8 @@ export default {
label_default: 'Username Attribute:',
placeholder: 'admin.ldap.usernameAttrEx',
placeholder_default: 'E.g.: "sAMAccountName"',
help_text: 'admin.ldap.uernameAttrDesc',
help_text_default: 'The attribute in the AD/LDAP server that will be used to populate the username field in Mattermost. This may be the same as the Login ID Attribute.',
help_text: 'admin.ldap.usernameAttrDesc',
help_text_default: 'The attribute in the AD/LDAP server used to populate the username field in Mattermost. This may be the same as the Login ID Attribute.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
......@@ -819,7 +819,8 @@ export default {
placeholder: 'admin.ldap.idAttrEx',
placeholder_default: 'E.g.: "objectGUID"',
help_text: 'admin.ldap.idAttrDesc',
help_text_default: 'The attribute in the AD/LDAP server that will be used as a unique identifier in Mattermost. It should be an AD/LDAP attribute with a value that does not change. If a user\'s ID Attribute changes, it will create a new Mattermost account unassociated with their old one. If you need to change this after users have already logged in, you can use the CLI tool "platform ldap idmigrate".',
help_text_html: true,
help_text_default: 'The attribute in the AD/LDAP server used as a unique identifier in Mattermost. It should be an AD/LDAP attribute with a value that does not change. If a user\'s ID Attribute changes, it will create a new Mattermost account unassociated with their old one.<br /><br />If you need to change this field after users have already logged in, use the <a href="https://about.mattermost.com/default-mattermost-ldap-idmigrate" target="_blank">mattermost ldap idmigrate</a> CLI tool.',
isDisabled: needsUtils.and(
needsUtils.stateValueEqual('LdapSettings.Enable', false),
needsUtils.stateValueEqual('LdapSettings.EnableSync', false),
......@@ -833,7 +834,8 @@ export default {
placeholder: 'admin.ldap.loginIdAttrEx',
placeholder_default: 'E.g.: "sAMAccountName"',
help_text: 'admin.ldap.loginAttrDesc',
help_text_default: 'The attribute in the AD/LDAP server that will be used by AD/LDAP users to login to Mattermost. This is the value used to log in to Mattermost in the "AD/LDAP Username" field on the sign in page. Normally this attribute is the same as the "Username Attribute" field above. If your team typically uses domain\\username to sign in to other services with AD/LDAP, you may choose to put domain\\username in this field to maintain consistency between sites.',
help_text_html: true,
help_text_default: 'The attribute in the AD/LDAP server used to log in to Mattermost. Normally this attribute is the same as the "Username Attribute" field above.<br /><br />If your team typically uses domain\\username to log in to other services with AD/LDAP, you may enter domain\\username in this field to maintain consistency between sites.',
isDisabled: needsUtils.and(
needsUtils.stateValueFalse('LdapSettings.Enable'),
needsUtils.stateValueFalse('LdapSettings.EnableSync'),
......
......@@ -739,25 +739,25 @@
"admin.ldap.bindPwdTitle": "Bind Password:",
"admin.ldap.bindUserDesc": "The username used to perform the AD/LDAP search. This should typically be an account created specifically for use with Mattermost. It should have access limited to read the portion of the AD/LDAP tree specified in the BaseDN field.",
"admin.ldap.bindUserTitle": "Bind Username:",
"admin.ldap.emailAttrDesc": "The attribute in the AD/LDAP server that will be used to populate the email addresses of users in Mattermost.",
"admin.ldap.emailAttrDesc": "The attribute in the AD/LDAP server used to populate the email address field in Mattermost.",
"admin.ldap.emailAttrEx": "E.g.: \"mail\" or \"userPrincipalName\"",
"admin.ldap.emailAttrTitle": "Email Attribute:",
"admin.ldap.enableDesc": "When true, Mattermost allows login using AD/LDAP",
"admin.ldap.enableSyncDesc": "When true, Mattermost periodically synchronizes users from AD/LDAP. When false, user attributes are updated from AD/LDAP during user login only.",
"admin.ldap.enableSyncTitle": "Enable Synchronization with AD/LDAP:",
"admin.ldap.enableTitle": "Enable sign-in with AD/LDAP:",
"admin.ldap.firstnameAttrDesc": "(Optional) The attribute in the AD/LDAP server that will be used to populate the first name of users in Mattermost. When set, users will not be able to edit their first name, since it is synchronized with the LDAP server. When left blank, users can set their own first name in Account Settings.",
"admin.ldap.firstnameAttrDesc": "(Optional) The attribute in the AD/LDAP server used to populate the first name of users in Mattermost. When set, users cannot edit their first name, since it is synchronized with the LDAP server. When left blank, users can set their first name in Account Settings.",
"admin.ldap.firstnameAttrEx": "E.g.: \"givenName\"",
"admin.ldap.firstnameAttrTitle": "First Name Attribute:",
"admin.ldap.idAttrDesc": "The attribute in the AD/LDAP server that will be used as a unique identifier in Mattermost. It should be an AD/LDAP attribute with a value that does not change. If a user's ID Attribute changes, it will create a new Mattermost account unassociated with their old one. If you need to change this after users have already logged in, you can use the CLI tool \"platform ldap idmigrate\"",
"admin.ldap.idAttrDesc": "The attribute in the AD/LDAP server used as a unique identifier in Mattermost. It should be an AD/LDAP attribute with a value that does not change. If a user's ID Attribute changes, it will create a new Mattermost account unassociated with their old one.<br /><br />If you need to change this field after users have already logged in, use the <a href=\"https://about.mattermost.com/default-platform-ldap-idmigrate\" target='_blank'>platform ldap idmigrate</a> CLI tool.",
"admin.ldap.idAttrEx": "E.g.: \"objectGUID\"",
"admin.ldap.idAttrTitle": "ID Attribute: ",
"admin.ldap.jobExtraInfo": "Scanned {ldapUsers} LDAP users, updated {updateCount}, deactivated {deleteCount}",
"admin.ldap.lastnameAttrDesc": "(Optional) The attribute in the AD/LDAP server that will be used to populate the last name of users in Mattermost. When set, users will not be able to edit their last name, since it is synchronized with the LDAP server. When left blank, users can set their own last name in Account Settings.",
"admin.ldap.lastnameAttrDesc": "(Optional) The attribute in the AD/LDAP server used to populate the last name of users in Mattermost. When set, users cannot edit their last name, since it is synchronized with the LDAP server. When left blank, users can set their last name in Account Settings.",
"admin.ldap.lastnameAttrEx": "E.g.: \"sn\"",
"admin.ldap.lastnameAttrTitle": "Last Name Attribute:",
"admin.ldap.ldap_test_button": "AD/LDAP Test",
"admin.ldap.loginAttrDesc": "The attribute in the AD/LDAP server that will be used by AD/LDAP users to login to Mattermost. This is the value used to log in to Mattermost in the \"AD/LDAP Username\" field on the sign in page. Normally this attribute is the same as the \"Username Attribute\" field above. If your team typically uses domain\\username to sign in to other services with AD/LDAP, you may choose to put domain\\username in this field to maintain consistency between sites.",
"admin.ldap.loginAttrDesc": "The attribute in the AD/LDAP server used to log in to Mattermost. Normally this attribute is the same as the \"Username Attribute\" field above.<br /><br />If your team typically uses domain\\username to log in to other services with AD/LDAP, you may enter domain\\username in this field to maintain consistency between sites.",
"admin.ldap.loginAttrTitle": "Login ID Attribute: ",
"admin.ldap.loginIdAttrEx": "E.g.: \"sAMAccountName\"",
"admin.ldap.loginNameDesc": "The placeholder text that appears in the login field on the login page. Defaults to \"AD/LDAP Username\".",
......@@ -766,14 +766,14 @@
"admin.ldap.maxPageSizeEx": "E.g.: \"2000\"",
"admin.ldap.maxPageSizeHelpText": "The maximum number of users the Mattermost server will request from the AD/LDAP server at one time. 0 is unlimited.",
"admin.ldap.maxPageSizeTitle": "Maximum Page Size:",
"admin.ldap.nicknameAttrDesc": "(Optional) The attribute in the AD/LDAP server that will be used to populate the nickname of users in Mattermost. When set, users will not be able to edit their nickname, since it is synchronized with the LDAP server. When left blank, users can set their own nickname in Account Settings.",
"admin.ldap.nicknameAttrDesc": "(Optional) The attribute in the AD/LDAP server used to populate the nickname of users in Mattermost. When set, users cannot edit their nickname, since it is synchronized with the LDAP server. When left blank, users can set their nickname in Account Settings.",
"admin.ldap.nicknameAttrEx": "E.g.: \"nickname\"",
"admin.ldap.nicknameAttrTitle": "Nickname Attribute:",
"admin.ldap.noLicense": "<h4 class=\"banner__heading\">Note:</h4><p>AD/LDAP is an enterprise feature. Your current license does not support AD/LDAP. Click <a href=\"http://mattermost.com\" target='_blank'>here</a> for information and pricing on enterprise licenses.</p>",
"admin.ldap.portDesc": "The port Mattermost will use to connect to the AD/LDAP server. Default is 389.",
"admin.ldap.portEx": "E.g.: \"389\"",
"admin.ldap.portTitle": "AD/LDAP Port:",
"admin.ldap.positionAttrDesc": "(Optional) The attribute in the AD/LDAP server that will be used to populate the position field in Mattermost.",
"admin.ldap.positionAttrDesc": "(Optional) The attribute in the AD/LDAP server used to populate the position field in Mattermost. When set, users cannot edit their position, since it is synchronized with the LDAP server. When left blank, users can set their position in Account Settings.",
"admin.ldap.positionAttrEx": "E.g.: \"title\"",
"admin.ldap.positionAttrTitle": "Position Attribute:",
"admin.ldap.queryDesc": "The timeout value for queries to the AD/LDAP server. Increase if you are getting timeout errors caused by a slow AD/LDAP server.",
......@@ -792,7 +792,7 @@
"admin.ldap.testFailure": "AD/LDAP Test Failure: {error}",
"admin.ldap.testHelpText": "Tests if the Mattermost server can connect to the AD/LDAP server specified. See log file for more detailed error messages.",
"admin.ldap.testSuccess": "AD/LDAP Test Successful",
"admin.ldap.uernameAttrDesc": "The attribute in the AD/LDAP server that will be used to populate the username field in Mattermost. This may be the same as the Login ID Attribute.",
"admin.ldap.usernameAttrDesc": "The attribute in the AD/LDAP server used to populate the username field in Mattermost. This may be the same as the Login ID Attribute.",
"admin.ldap.userFilterDisc": "(Optional) Enter an AD/LDAP Filter to use when searching for user objects. Only the users selected by the query will be able to access Mattermost. For Active Directory, the query to filter out disabled users is (&(objectCategory=Person)(!(UserAccountControl:1.2.840.113556.1.4.803:=2))).",
"admin.ldap.userFilterEx": "E.g.: \"(objectClass=user)\"",
"admin.ldap.userFilterTitle": "User Filter:",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment