Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -206,89 +206,6 @@ Available on [Enterprise Advanced](https://mattermost.com/pricing/) from Matterm
</tbody>
</table>

### Enable theme selection

**True**: Enables the **Display \> Theme** tab in **Settings** so users can select their theme.

**False**: Users cannot select a different theme. The **Display \> Theme** tab is hidden in **Settings**.

<table style={{width: '95%'}}>
<colgroup>
<col style={{width: '95%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>"EnableThemeSelection": true</code> with options <code>true</code> and <code>false</code>.</td>
</tr>
</tbody>
</table>

### Allow custom themes

**True**: Enables the **Display \> Theme \> Custom Theme** section in **Settings**.

**False**: Users cannot use a custom theme. The **Display \> Theme \> Custom Theme** section is hidden in **Settings**.

<table style={{width: '92%'}}>
<colgroup>
<col style={{width: '92%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>"AllowCustomThemes": true</code> with options <code>true</code> and <code>false</code>.</td>
</tr>
</tbody>
</table>

### Default theme

Set a default theme that applies to all new users on the system.

<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>"DefaultTheme": "default"</code> with options <code>"default"</code>, <code>"organization"</code>, <code>"mattermostDark"</code>, and <code>"windows10"</code>.</td>
</tr>
</tbody>
</table>

### Enable tutorial

**True**: Users are prompted with a tutorial when they open Mattermost for the first time after account creation.

**False**: The tutorial is disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation.

<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>"ServiceSettings.EnableTutorial": true</code> with options <code>true</code> and <code>false</code>.</td>
</tr>
</tbody>
</table>

### Enable onboarding flow

**True**: New Mattermost users are shown key tasks to complete as part of initial onboarding.

**False**: User onboarding tasks are disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation.

<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>"ServiceSettings.EnableOnboardingFlow": true</code> with options <code>true</code> and <code>false</code>.</td>
</tr>
</tbody>
</table>

### User's status and profile fetching poll interval

This setting configures the number of milliseconds to wait between fetching user statuses and profiles periodically. Set to `0` to disable.
Expand Down Expand Up @@ -544,23 +461,6 @@ Each configuration value below includes a JSON path to access the value programm

</Tip>

### Allowed themes

This setting isn't available in the System Console and can only be set in `config.json`.

Select the themes that can be chosen by users when `EnableThemeSelection` is set to `true`.

<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>"AllowedThemes": []</code> with string array input consisting of the options <code>"default"</code>, <code>"organization"</code>, <code>"mattermostDark"</code>, and <code>"windows10"</code>, such as <code>["mattermostDark", "windows10"]</code>.</td>
</tr>
</tbody>
</table>

### File Location

<PlanAvailability slug="ent-plus" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,74 @@ Access the following configuration settings in the System Console by going to **
</tbody>
</table>

### Enable theme selection

<PlanAvailability slug="pro-plus" />

<table>
<colgroup>
<col style={{width: '49%'}} />
<col style={{width: '50%'}} />
</colgroup>
<tbody>
<tr>
<td><ul><li><strong>true</strong>: <strong>(Default)</strong> Enables the <strong>Display &gt; Theme</strong> tab in <strong>Settings</strong> so users can select their theme.</li><li><strong>false</strong>: Users can't select a different theme. The <strong>Display &gt; Theme</strong> tab is hidden in <strong>Settings</strong>.</li></ul></td>
<td><ul><li>System Config path: <strong>Site Configuration &gt; Customization</strong></li><li><code>config.json</code> setting: <code>ThemeSettings</code> &gt; <code>EnableThemeSelection</code> &gt; <code>true</code></li><li>Environment variable: <code>MM_THEMESETTINGS_ENABLETHEMESELECTION</code></li></ul></td>
</tr>
</tbody>
</table>

### Allow custom themes

<PlanAvailability slug="pro-plus" />

<table>
<colgroup>
<col style={{width: '49%'}} />
<col style={{width: '50%'}} />
</colgroup>
<tbody>
<tr>
<td><ul><li><strong>true</strong>: <strong>(Default)</strong> Enables the <strong>Display &gt; Theme &gt; Custom Theme</strong> section in <strong>Settings</strong>.</li><li><strong>false</strong>: Users can't use a custom theme. The <strong>Display &gt; Theme &gt; Custom Theme</strong> section is hidden in <strong>Settings</strong>.</li></ul></td>
<td><ul><li>System Config path: <strong>Site Configuration &gt; Customization</strong></li><li><code>config.json</code> setting: <code>ThemeSettings</code> &gt; <code>AllowCustomThemes</code> &gt; <code>true</code></li><li>Environment variable: <code>MM_THEMESETTINGS_ALLOWCUSTOMTHEMES</code></li></ul></td>
</tr>
</tbody>
</table>

### Allowed themes

<PlanAvailability slug="pro-plus" />

<table>
<colgroup>
<col style={{width: '49%'}} />
<col style={{width: '50%'}} />
</colgroup>
<tbody>
<tr>
<td><p>Restrict the themes users can select in <strong>Display &gt; Theme</strong> to a comma-separated list of theme names. Requires <a href="#enable-theme-selection">Enable theme selection</a> to be set to <strong>true</strong>.</p><p>String array input consisting of the options <code>denim</code>, <code>sapphire</code>, <code>quartz</code>, <code>indigo</code>, and <code>onyx</code>. Default is an empty array, which allows all themes.</p></td>
<td><ul><li>System Config path: <strong>Site Configuration &gt; Customization</strong></li><li><code>config.json</code> setting: <code>ThemeSettings</code> &gt; <code>AllowedThemes</code> &gt; <code>[]</code></li><li>Environment variable: <code>MM_THEMESETTINGS_ALLOWEDTHEMES</code></li></ul></td>
</tr>
</tbody>
</table>

### Default theme

<PlanAvailability slug="pro-plus" />

<table>
<colgroup>
<col style={{width: '49%'}} />
<col style={{width: '50%'}} />
</colgroup>
<tbody>
<tr>
<td><p>Set a default theme that applies to all new users on the system.</p><p>String input. One of <code>denim</code>, <code>sapphire</code>, <code>quartz</code>, <code>indigo</code>, or <code>onyx</code>. Default is <code>default</code>, which resolves to the Denim theme.</p></td>
<td><ul><li>System Config path: <strong>Site Configuration &gt; Customization</strong></li><li><code>config.json</code> setting: <code>ThemeSettings</code> &gt; <code>DefaultTheme</code> &gt; <code>default</code></li><li>Environment variable: <code>MM_THEMESETTINGS_DEFAULTTHEME</code></li></ul></td>
</tr>
</tbody>
</table>

### Enable Ask Community link

<table>
Expand Down Expand Up @@ -364,6 +432,36 @@ This setting is applicable to self-hosted deployments only.

</Note>

### Enable tutorial

<table>
<colgroup>
<col style={{width: '49%'}} />
<col style={{width: '50%'}} />
</colgroup>
<tbody>
<tr>
<td><ul><li><strong>true</strong>: <strong>(Default)</strong> Users are prompted with a tutorial when they open Mattermost for the first time after account creation.</li><li><strong>false</strong>: The tutorial is disabled. Users are placed in Town Square when they open Mattermost for the first time after account creation.</li></ul></td>
<td><ul><li>System Config path: <strong>Site Configuration &gt; Customization</strong></li><li><code>config.json</code> setting: <code>ServiceSettings</code> &gt; <code>EnableTutorial</code> &gt; <code>true</code></li><li>Environment variable: <code>MM_SERVICESETTINGS_ENABLETUTORIAL</code></li></ul></td>
</tr>
</tbody>
</table>

### Enable onboarding

<table>
<colgroup>
<col style={{width: '49%'}} />
<col style={{width: '50%'}} />
</colgroup>
<tbody>
<tr>
<td><ul><li><strong>true</strong>: <strong>(Default)</strong> New users are shown key tasks to complete as part of initial onboarding.</li><li><strong>false</strong>: User onboarding tasks are disabled.</li></ul></td>
<td><ul><li>System Config path: <strong>Site Configuration &gt; Customization</strong></li><li><code>config.json</code> setting: <code>ServiceSettings</code> &gt; <code>EnableOnboardingFlow</code> &gt; <code>true</code></li><li>Environment variable: <code>MM_SERVICESETTINGS_ENABLEONBOARDINGFLOW</code></li></ul></td>
</tr>
</tbody>
</table>

### Enable desktop app landing page

<table>
Expand Down
12 changes: 6 additions & 6 deletions server/public/model/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -445,8 +445,8 @@ type ServiceSettings struct {
EnableUserStatuses *bool `access:"write_restrictable,cloud_restrictable"`
ExperimentalEnableAuthenticationTransfer *bool `access:"experimental_features"`
ClusterLogTimeoutMilliseconds *int `access:"write_restrictable,cloud_restrictable"`
EnableTutorial *bool `access:"experimental_features"`
EnableOnboardingFlow *bool `access:"experimental_features"`
EnableTutorial *bool `access:"site_customization"`
EnableOnboardingFlow *bool `access:"site_customization"`
ExperimentalEnableDefaultChannelLeaveJoinMessages *bool `access:"experimental_features"`
ExperimentalGroupUnreadChannels *string `access:"experimental_features"`
EnableAPITeamDeletion *bool
Expand Down Expand Up @@ -2499,10 +2499,10 @@ func (s *AnnouncementSettings) SetDefaults() {
}

type ThemeSettings struct {
EnableThemeSelection *bool `access:"experimental_features"`
DefaultTheme *string `access:"experimental_features"`
AllowCustomThemes *bool `access:"experimental_features"`
AllowedThemes []string
EnableThemeSelection *bool `access:"site_customization"`
DefaultTheme *string `access:"site_customization"`
AllowCustomThemes *bool `access:"site_customization"`
AllowedThemes []string `access:"site_customization"`
}

func (s *ThemeSettings) SetDefaults() {
Expand Down
Loading
Loading