Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarified what user data remains on logout #6572

Merged
merged 23 commits into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
9da8780
Update conf.py
amyblais Jul 14, 2023
6268253
Merge branch 'master' into v8.1-documentation
amyblais Jul 14, 2023
ea1c344
Merge branch 'master' into v8.1-documentation
amyblais Jul 17, 2023
a92e949
Merge branch 'master' into v8.1-documentation
amyblais Jul 18, 2023
e0971d3
Merge branch 'master' into v8.1-documentation
amyblais Jul 19, 2023
bac8533
Merge branch 'master' into v8.1-documentation
amyblais Jul 20, 2023
86efee3
Merge branch 'master' into v8.1-documentation
amyblais Jul 21, 2023
8b30962
Merge branch 'master' into v8.1-documentation
amyblais Jul 25, 2023
5a3a587
Merge branch 'master' into v8.1-documentation
amyblais Jul 26, 2023
fa62ea3
Merge branch 'master' into v8.1-documentation
amyblais Jul 27, 2023
19f4433
Merge branch 'master' into v8.1-documentation
amyblais Jul 31, 2023
37f1868
Added support for hiding guest badges (#6556)
cwarnermm Jul 31, 2023
260e465
Merge branch 'master' into v8.1-documentation
amyblais Aug 1, 2023
2973204
Clarified guest & system admin access (#6558)
cwarnermm Aug 1, 2023
44c7d1c
Removing a server not obvious on mobile (#6562)
cwarnermm Aug 1, 2023
da176d3
Added support for custom forgot password flow/URL (#6557)
cwarnermm Aug 2, 2023
ea063ba
Clarified what user data remains on logout
cwarnermm Aug 2, 2023
9b2f7bd
Update source/welcome/log-out.rst
cwarnermm Aug 11, 2023
243a52d
Merge branch 'master' into logout-clarifications
cwarnermm Aug 15, 2023
d4d3800
Merge branch 'master' into logout-clarifications
cwarnermm Aug 15, 2023
ffe06c5
Merge branch 'master' into logout-clarifications
cwarnermm Aug 28, 2023
abe3026
Merge branch 'master' into logout-clarifications
cwarnermm Aug 28, 2023
02412f4
Incorporated reviewer feedback
cwarnermm Aug 28, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2394,9 +2394,9 @@ def setup(_: Sphinx):
# built documents.
#
# The short X.Y version.
# version = '8.0'
# version = '8.1'
# The full version, including alpha/beta/rc tags.
# release = '8.0'
# release = '8.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
41 changes: 41 additions & 0 deletions source/configure/authentication-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,28 @@ Maximum login attempts
| Numerical input. Default is **10**. | - Environment variable: ``MM_SERVICESETTINGS_MAXIMUMLOGINATTEMPTS`` |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+

.. config:setting:: password-forgotpasswordlink
:displayname: Enable forgot password link (Password)
:systemconsole: Authentication > Password
:configjson: .ServiceSettings.ForgotPasswordLink
:environment: MM_SERVICESETTINGS_FORGOTPASSWORDLINK
:description: Show or hide the Forgot Password link on the Mattermost login page.

- **true**: **(Default)** Displays the Forgot Password link on the Mattermost login page.
- **false**: Hides the Forgot Password link from the Mattermost login page.

Enable forgot password link
~~~~~~~~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------------------------+------------------------------------------------------------------------+
| - **true**: **(Default)** Displays the **Forget Password** link on the | - System Config path: **Authentication > Enable forgot password link** |
| Mattermost login page. | - ``config.json`` setting: ``.LdapSettings.ForgotPasswordLink: true`` |
| - **false**: Hides the **Forgot Password** link from the Mattermost login page. | - Environment variable: ``MM_LDAPSETTINGS_FORGOTPASSWORDLINK`` |
+---------------------------------------------------------------------------------+------------------------------------------------------------------------+
| **Note**: You can customize the **Forgot Password** link URL by going to **Site Configuration > Customization > Forgot Password Custom Link**. |
| See the `configuration </configure/site-configuration-settings.html#forgot-password-custom-link>`__ documentation for details. |
+---------------------------------------------------------------------------------+------------------------------------------------------------------------+

----

MFA
Expand Down Expand Up @@ -2712,3 +2734,22 @@ Enforce multi-factor authentication
| **Note**: This setting defaults to false and cannot be changed if MFA isn't enforced for non-guest users. |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: guest-showtag
:displayname: Show guest tag (Guest Access)
:systemconsole: Authentication > Guest Access
:configjson: .GuestAccountsSettings.HideTags
:environment: MM_GUESTACCOUNTSSETTINGS_HIDETAGS

- **True**: **(Default)** Guest tags are visible in Mattermost.
- **False**: **(Default)** Guest tags aren't visible in Mattermost.

Show guest tag
~~~~~~~~~~~~~~

+-----------------------------------------------------------------+----------------------------------------------------------------------+
| - **true**: **(Default)** Guest tags are visible in Mattermost. | - System Config path: **Authentication > Guest Access** |
| - **false**: Guest tags aren't visible in Mattermost. | - ``config.json`` setting: ``.GuestAccountsSettings.HideTags: true`` |
| | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_HIDETAGS`` |
+-----------------------------------------------------------------+----------------------------------------------------------------------+
| **Note**: See the `guest accounts <https://docs.mattermost.com/onboard/guest-accounts.html>`__ documentation for details. |
+----------------------------------------------------------------------------------------------------------------------------------------+
20 changes: 20 additions & 0 deletions source/configure/site-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,26 @@ About link
| String input. Default is ``https://about.mattermost.com/default-about/``. | - Environment variable: ``MM_SUPPORTSETTINGS_ABOUTLINK`` |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+

.. config:setting:: custom-forgotpasswordurl
:displayname: Forgot Password custom link (Customization)
:systemconsole: Site Configuration > Customization
:configjson: .SupportSettings.ForgetPasswordCustomLink
:environment: MM_SUPPORTSETTINGS_FORGETPASSWORDCUSTOMLINK
:description: Set a custom URL for the **Forgot Password** link on the Mattermost login page. Leave this field blank to use Mattermost's Password Reset workflow.

Forgot Password custom link
~~~~~~~~~~~~~~~~~~~~~~~~~~~

+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| When the **Forgot Password** link is enabled on the Mattermost login page, | - System Config path: **Site Configuration > Forgot password custom link** |
| users are taken to a custom URL to recover or change their password. | - ``config.json`` setting: ``.SupportSettings.ForgetPasswordCustomLink`` |
| | - Environment variable: ``MM_SUPPORTSETTINGS_FORGETPASSWORDCUSTOMLINK`` |
| Leave this field blank to use Mattermost's Password Reset workflow. | |
+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| **Note**: You can control whether the **Forgot Password** link is visible or hidden by going to **Authentication > Password > Enable Forgot Password Link**. |
| See the `configuration </configure/authentication-configuration-settings.html#enable-forgot-password-link>`__ documentation for details. |
+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------+

.. config:setting:: custom-reportaproblemlink
:displayname: Report a Problem link (Customization)
:systemconsole: Site Configuration > Customization
Expand Down
Binary file modified source/images/Guest_Badges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/swipe-left-to-remove.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion source/manage/telemetry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Server Configuration Settings

**True/false (boolean)** value whether setting remains default (true) or non-default (false). **NOTE: No input data is used**:

**ServiceSettings**: bool SiteURL, bool WebsocketURL, bool TLSCertFile, bool TLSKeyFile, bool ReadTimeout, bool WriteTimeout,bool IdleTimeout, bool GoogleDeveloperKey, bool AllowCorsFrom, bool CorsExposedHeaders, bool AllowedUntrustedInternalConnections, bool GfycatApiKey, bool GfycatApiSecret, bool ManagedResourcePaths, bool CollapsedThreads, bool PostPriority, bool AllowPersistentNotifications, bool PersistentNotificationMaxCount, bool PersistentNotificationIntervalMinutes, bool PersistentNotificationMaxRecipients; **TeamSettings**: bool SiteName, bool CustomBrandText, bool CustomDescriptionText, bool UserStatusAwayTimeout, bool ExperimentalPrimaryTeam; **DisplaySettings**: bool CustomUrlSchemes; **GuestAccountSettings**: bool RestrictCreationToDomains; **LogSettings**: bool FileLocation; **NotificationLogSettings**: bool FileLocation; **EmailSettings**: bool FeedbackName, bool FeedbackEmail, bool FeedbackOrganization, bool LoginButtonColor, bool LoginButtonBorderColor, bool LoginButtonTextColor, bool ImageProxyType, bool ImageProxyURL, bool ImageProxyOptions; **RateLimitSettings**: bool VaryByHeader; **SupportSettings**: bool TermsOfServiceLink, bool PrivacyPolicyLink, bool AboutLink, bool HelpLink, bool ReportAProblemLink, bool AppCustomURLSchemes, bool SupportEmail; **ThemeSettings**: bool DefaultTheme; **TimeZoneSettings**: bool SupportedTimezonesPath; **LdapSettings**: bool FirstNameAttribute, bool LastNameAttribute, bool EmailAttribute, bool UserNameAttribute, bool NicknameAttribute, bool IdAttribute, bool PositionAttribute, bool LoginFieldName, bool LoginButtonColor, bool LoginButtonBorderColor, bool LoginButtonTextColor, bool GroupFilter, bool GroupDisplayNameAttribute, bool GroupIdAttribute, bool GuestFilter, bool AdminFilter; **SamlSettings**: bool SignatureAlgorithm, bool CanonicalAlgorithm, bool ScopingIDPProviderId, bool ScopingIDPName, bool IdAttribute, bool GuestAttribute, bool FirstNameAttribute, bool LastNameAttribute, bool EmailAttribute, bool UserNameAttribute, bool NicknameAttribute, bool LocaleAttribute, bool PositionAttribute, bool LoginIdAttribute, bool LoginButtonText, bool LoginButtonColor, bool LoginButtonBorderColor, bool LoginButtonTextColor, bool AdminFilter; **NativeAppSettings**: bool AppDownloadLink, bool AndroidAppDownloadLink, bool IosAppDownloadLink; **WebrtcSettings** (only in v5.5 and earlier): bool StunURI, bool TurnURI; **ClusterSettings**: bool NetworkInterface, bool BindAddress, bool AdvertiseAddress; **MetricsSettings**: bool BlockProfileRate; **AnalyticsSettings**: bool MaxUsersForStatistics; **ExperimentalSettings** bool ClientSideCertCheck; **AnnouncementSettings**: bool BannerColor, bool BannerTextColor; **ElasticsearchSettings**: bool ConnectionUrl, bool Username, bool Password, bool IndexPrefix; **PluginSettings**: bool MarketplaceUrl, bool SignaturePublicKeyFiles, bool ChimeraOAuthProxyUrl; **MessageExportSettings**: bool GlobalRelaySettings.SmtpUsername, bool GlobalRelaySettings.SmtpPassword, bool GlobalRelaySettings.EmailAddress
**ServiceSettings**: bool SiteURL, bool WebsocketURL, bool TLSCertFile, bool TLSKeyFile, bool ReadTimeout, bool WriteTimeout,bool IdleTimeout, bool GoogleDeveloperKey, bool AllowCorsFrom, bool CorsExposedHeaders, bool AllowedUntrustedInternalConnections, bool GfycatApiKey, bool GfycatApiSecret, bool ManagedResourcePaths, bool CollapsedThreads, bool PostPriority, bool AllowPersistentNotifications, bool PersistentNotificationMaxCount, bool PersistentNotificationIntervalMinutes, bool PersistentNotificationMaxRecipients; **TeamSettings**: bool SiteName, bool CustomBrandText, bool CustomDescriptionText, bool UserStatusAwayTimeout, bool ExperimentalPrimaryTeam; **DisplaySettings**: bool CustomUrlSchemes; **GuestAccountSettings**: bool RestrictCreationToDomains, bool EnforceMultifactorAuthentication, bool HideTags; **LogSettings**: bool FileLocation; **NotificationLogSettings**: bool FileLocation; **EmailSettings**: bool FeedbackName, bool FeedbackEmail, bool FeedbackOrganization, bool LoginButtonColor, bool LoginButtonBorderColor, bool LoginButtonTextColor, bool ImageProxyType, bool ImageProxyURL, bool ImageProxyOptions; **RateLimitSettings**: bool VaryByHeader; **SupportSettings**: bool TermsOfServiceLink, bool PrivacyPolicyLink, bool AboutLink, bool HelpLink, bool ReportAProblemLink, bool AppCustomURLSchemes, bool SupportEmail; **ThemeSettings**: bool DefaultTheme; **TimeZoneSettings**: bool SupportedTimezonesPath; **LdapSettings**: bool FirstNameAttribute, bool LastNameAttribute, bool EmailAttribute, bool UserNameAttribute, bool NicknameAttribute, bool IdAttribute, bool PositionAttribute, bool LoginFieldName, bool LoginButtonColor, bool LoginButtonBorderColor, bool LoginButtonTextColor, bool GroupFilter, bool GroupDisplayNameAttribute, bool GroupIdAttribute, bool GuestFilter, bool AdminFilter; **SamlSettings**: bool SignatureAlgorithm, bool CanonicalAlgorithm, bool ScopingIDPProviderId, bool ScopingIDPName, bool IdAttribute, bool GuestAttribute, bool FirstNameAttribute, bool LastNameAttribute, bool EmailAttribute, bool UserNameAttribute, bool NicknameAttribute, bool LocaleAttribute, bool PositionAttribute, bool LoginIdAttribute, bool LoginButtonText, bool LoginButtonColor, bool LoginButtonBorderColor, bool LoginButtonTextColor, bool AdminFilter; **NativeAppSettings**: bool AppDownloadLink, bool AndroidAppDownloadLink, bool IosAppDownloadLink; **WebrtcSettings** (only in v5.5 and earlier): bool StunURI, bool TurnURI; **ClusterSettings**: bool NetworkInterface, bool BindAddress, bool AdvertiseAddress; **MetricsSettings**: bool BlockProfileRate; **AnalyticsSettings**: bool MaxUsersForStatistics; **ExperimentalSettings** bool ClientSideCertCheck; **AnnouncementSettings**: bool BannerColor, bool BannerTextColor; **ElasticsearchSettings**: bool ConnectionUrl, bool Username, bool Password, bool IndexPrefix; **PluginSettings**: bool MarketplaceUrl, bool SignaturePublicKeyFiles, bool ChimeraOAuthProxyUrl; **MessageExportSettings**: bool GlobalRelaySettings.SmtpUsername, bool GlobalRelaySettings.SmtpPassword, bool GlobalRelaySettings.EmailAddress

Commercial License Information (Enterprise Edition only)
Information about commercial license key purchased or trial license key used for Enterprise Edition servers: Company ID, license ID, license issue date, license start date, license expiry date, number of licensed users, license name, list of unlocked subscription features.
Expand Down
18 changes: 18 additions & 0 deletions source/onboard/guest-account-access.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:orphan:
:nosearch:

Guests can:

- Pin messages to channels
- Use slash commands (excluding restricted commands such as invite members, rename channels, change headers, etc)
- Favorite channels
- Mute channels
- Update their profile
- Use different authentication methods than other users

Guests cannot:

- Discover public channels
- Join open teams
- Create direct messages or group messages with members who aren’t within the same channel
- Invite people
31 changes: 9 additions & 22 deletions source/onboard/guest-accounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,10 @@ Guest accounts

Guest accounts are a way to collaborate with individuals, such as vendors and contractors, outside of your organization by controlling their access to channels and team members. For example, guest accounts can be used to collaborate with customers on a support issue or work on a website project with resources from an external design firm.

Guests can:

- Pin messages to channels
- Use slash commands (excluding restricted commands such as invite members, rename channels, change headers, etc)
- Favorite channels
- Mute channels
- Update their profile
- Use different authentication methods than other users

Guests cannot:

- Discover public channels
- Join open teams
- Create direct messages or group messages with members who aren’t within the same channel
- Invite people
.. include:: /onboard/guest-account-access.rst
:start-after: :nosearch:

Additionally, guest accounts count as a paid user in your Mattermost workspace, but guests are not automatically added to the default **Town-square** and **Off-topic** channels upon logging in. Guests must be invited/added to these channels manually.
Additionally, guest accounts count as a paid user in your Mattermost workspace, but guests aren't automatically added to the default **Town-square** and **Off-topic** channels when they log in. Guests must be invited/added to these channels manually.

Enable guest accounts
----------------------
Expand Down Expand Up @@ -112,31 +99,31 @@ There are `additional permissions </onboard/advanced-permissions.html>`__ in Mat
Guest identification
---------------------

Guests are identified with a **Guest** badge. This badge is visible in various places on the interface and mobile apps, such as on a guest’s profile and next to their name on user lists, including @mentions. When guests are added to a channel, a system message informs other channel members that the added user is a guest.
Guests are identified with a **Guest** badge unless your system admin has `disabled guest badges </configure/authentication-configuration-settings.html#guest-access>`__. When visible, this badge is visible in various places in the Mattermost interface, such as on a guest’s profile and next to their name on user lists, including @mentions. Additionally, when badges are visible, and guests are added to a channel, a system message notifies other channel members that the added user is a guest.

Channels containing guests display the message: *This channel has guests*.
Additionally, when guest badges are visible, channels containing guests display the message: *This channel has guests*.

.. image:: ../images/Guest_Badges.png

Manage guests
--------------

Add guests to additional channels
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Users with the permissions to invite guests can **Invite Guests** to additional channels. A system message will be posted in the channels to let other members know a guest user has been added.

Remove guests from channels and teams
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Guests can be removed from a channel through **Manage members**, or by using the ``/kick`` or ``/remove`` slash commands.

When a guest has been removed from all channels within a team, and if they belong to other teams, they will default into the last channel on the last team they have accessed. If they are removed from all channels on all teams, they'll be taken to a screen letting them know they have no channels assigned.

Promote and demote user roles
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

System admins can demote a user from a member to a guest by updating the user's role in **System Console > User Management > Users**. Select the member, then select **Demote to Guest**. System admins should also purge all of the demoted guest's sessions by selecting the guest user, then selecting **Revoke Sessions**.
System admins can demote a user from a member to a guest by updating the user's role in **System Console > User Management > Users**. Select the member, then select **Demote to Guest**. All system and custom roles assigned to the demoted user are removed. System admins should also purge all of the demoted guest's sessions by selecting the guest user, then selecting **Revoke Sessions**.

The demoted guest user retains their existing channel and team memberships, but is restricted from discovering public channels and collaborating with users outside of the channels they're in. This is useful if you're already collaborating with external contractors, and want to restrict their abilities within Mattermost.

Expand Down
Loading