diff --git a/docs/configuration.md b/docs/configuration.md index 211e233f..9a1447ab 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,39 +1,3 @@ # Mattermost Desktop Configuration Guides -## Build-time Configuration -You can customize and distribute your own Mattermost Desktop application -by configuring `src/common/config/buildConfig.js`. -To build the application, please follow -[Mattermost Desktop Development Guides](./development.md). - -### Parameters - -#### `defaultTeams` -`Array` - -Servers which are initially added to the application. -They are displayed prior to user-defined servers and users can't modify them. - -##### `Team.name` -`String` - -The tab name for the server. - -##### `Team.url` -`String` - -The URL for the server. - -#### `helpLink` -`String | null` - -The URL to open when clicking "Help->Learn More..." menu item. -If null is specified, the menu disappears. - -#### `enableServerManagement` -`Boolean` - -Whether users can edit servers configuration. -Specify at least one server for `defaultTeams` when `enableServerManagement` is -set to false. -Otherwise, users can't interact with any servers. +Please refer to [the Custom Build Configuration section of the Desktop App Deployment Guide](Custom Build Configuration). diff --git a/src/common/config/buildConfig.js b/src/common/config/buildConfig.js index 4a007c31..b614abfb 100644 --- a/src/common/config/buildConfig.js +++ b/src/common/config/buildConfig.js @@ -1,3 +1,5 @@ +// For detailed guides, please refer to https://docs.mattermost.com/deployment/desktop-app-deployment.html + /** * Build-time configuration. End-users can't change these parameters. * @prop {Object[]} defaultTeams