From bdff27a5738d5763f9337d3644de538983f1400c Mon Sep 17 00:00:00 2001 From: Yuya Ochiai Date: Fri, 26 Jan 2018 22:06:46 +0900 Subject: [PATCH] Create configuration guides --- docs/configuration.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/configuration.md diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 00000000..211e233f --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,39 @@ +# 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.