Refer to the documentation for configuration guides

This commit is contained in:
Yuya Ochiai
2018-02-23 20:12:36 +09:00
parent bdff27a573
commit 95e81bf5a8
2 changed files with 3 additions and 37 deletions

View File

@@ -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<Object(Team)>`
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).

View File

@@ -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