diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/install/Administration.md | 30 | ||||
| -rw-r--r-- | doc/install/Production-Ubuntu.md | 2 | ||||
| -rw-r--r-- | doc/install/Upgrade-Guide.md | 10 |
3 files changed, 34 insertions, 8 deletions
diff --git a/doc/install/Administration.md b/doc/install/Administration.md index 76ec78abd..15bd07778 100644 --- a/doc/install/Administration.md +++ b/doc/install/Administration.md @@ -33,11 +33,35 @@ For help and support around your GitLab Mattermost deployment please see: - [GitLab Mattermost discussion forum](https://forum.mattermost.org/c/general/gitlab) - [GitLab Mattermost issue tracker on GitLab.com](https://gitlab.com/gitlab-org/gitlab-mattermost/issues) -### Setting up realtime notifications from GitLab to Mattermost +### Connecting Mattermost to integrations with incoming webhooks -To set up standard notification from GitLab to Mattermost [follow these steps](https://github.com/mattermost/platform/blob/master/doc/integrations/webhooks/Incoming-Webhooks.md#connecting-mattermost-to-gitlab-using-slack-ui). +#### Connecting Mattermost to GitLab for Slack-equivalent functionality. -To set up a set of fully customizable realtime notifications from GitLab to Mattermost you can run the [GitLab Integration Service for Mattermost](https://github.com/mattermost/mattermost-integration-gitlab). +Mattermost is designed to be _Slack-compatible, not Slack-limited_ and supports integration via the Slack UI in GitLab, as well as fully customizable integrations. + +To enable this: + +1. In Mattermost, from a team site where you have System Administration privileges, from the main menu go to **System Console** > **Serice Settings** > **Enable Incoming Webhooks** and select **true** then click **Save** + +2. Follow the step-by-step example of [connecting Mattermost incoming webhooks to GitLab's Slack webhooks UI](https://github.com/mattermost/platform/blob/master/doc/integrations/webhooks/Incoming-Webhooks.md#connecting-mattermost-to-gitlab-using-slack-ui). + +#### Connecting Mattermost to GitLab for functionality exceeding Slack integration. + +To enable this: + +1. In Mattermost, from a team site where you have System Administration privileges, from the main menu go to **System Console** > **Serice Settings** > **Enable Incoming Webhooks** and select **true** then click **Save** + +2. Set up the [GitLab Integration Service for Mattermost](https://github.com/mattermost/mattermost-integration-gitlab). + +### Connecting Mattermost to integrations with outgoing webhooks + +Mattermost offers Slack-compatible outgoing webhooks, that can connect to applications created by the Mattermost community, such as [Hubot](https://www.npmjs.com/package/hubot-mattermost) and [IRC](https://github.com/42wim/matterbridge) support. + +To enable this: + +1. In Mattermost, from a team site where you have System Administration privileges, from the main menu go to **System Console** > **Serice Settings** > **Enable Outgoing Webhooks** and select **true** then click **Save** + +2. Select a [Mattermost community application](http://www.mattermost.org/community-applications/) using outgoing webhooks--or adapt a Slack application using the same outgoing webhook standard--and follow the setup instructions provided. ### Upgrading GitLab Mattermost manually diff --git a/doc/install/Production-Ubuntu.md b/doc/install/Production-Ubuntu.md index 098707ada..482c2a0ba 100644 --- a/doc/install/Production-Ubuntu.md +++ b/doc/install/Production-Ubuntu.md @@ -38,7 +38,7 @@ ## Set up Mattermost Server 1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.2 1. Download the latest Mattermost Server by typing: - * ``` wget https://github.com/mattermost/platform/releases/download/v1.1.0/mattermost.tar.gz``` + * ``` wget https://github.com/mattermost/platform/releases/download/v1.2.1/mattermost.tar.gz``` 1. Unzip the Mattermost Server by typing: * ``` tar -xvzf mattermost.tar.gz``` 1. For the sake of making this guide simple we located the files at `/home/ubuntu/mattermost`. In the future we will give guidance for storing under `/opt`. diff --git a/doc/install/Upgrade-Guide.md b/doc/install/Upgrade-Guide.md index 7f4eeaeb9..e01bdb9a0 100644 --- a/doc/install/Upgrade-Guide.md +++ b/doc/install/Upgrade-Guide.md @@ -4,6 +4,8 @@ Each release of Mattermost contains logic to upgrade it from the previously major build version. For example, version 1.2 upgrades the database and configuration data schema for a Mattermost version 1.1 server. The following procedure outlines how to upgrade Mattermost to the next major release version. +If you're upgrading across multiple major releases, from 1.0.x to 1.2.x for example, please run the following procedure once for each incremental upgrade, in sequential order. + 1. Download the **next major build release** of your server 1. Determine the current version of your Mattermost server 1. Go to any team site, opening the main menu at the top right of the left-hand sidebar and selecting **About Mattermost** @@ -11,7 +13,7 @@ Each release of Mattermost contains logic to upgrade it from the previously majo 1. For example, if your current version is 1.1.0, you want to select version 1.2.0. 1. In some cases there will be **minor build releases**, such as 1.2.1 and 1.2.2. The minor build number indicates a bug fix or security issue release. Testing on minor build versions is less extensive than on major build versions and it is recommended that you use the minor build only if you need the specific additions included. 3. Review Release Notes - 1. Check the release notes for the version of Mattermost you are able to install, and note any setting changes in the **Compatibility** section that apply to your deployment + 1. Check the release notes for the version of Mattermost you are able to install, and note any setting changes in the **Compatibility** section that apply to your deployment (Release notes across versions are available from the [CHANGELOG](https://github.com/mattermost/platform/blob/master/CHANGELOG.md)). 4. Download the `mattermost.tar.gz` file with the correct version for your upgrade 1. You can use `wget` to retrieve a specific version. For example, to download v1.1.0 run `wget https://github.com/mattermost/platform/releases/download/v1.1.0/mattermost.tar.gz` 2. Stop the Mattermost Server @@ -26,9 +28,9 @@ Each release of Mattermost contains logic to upgrade it from the previously majo 5. Restore the state of your server by copying the backed up version of `config.json` in place of the default `config.json` 6. Start your server and address any setting changes relevant in the latest version of Mattermost 1. Run `sudo start mattermost` - 2. The server will upgrade your database schema to be compatibile with the new release, as well as upgrade your `config.json` file to the latest format, using default values for new settings added - 3. Go to the System Console to update any settings that have been added or modified based on the **Compatibility** documentation in the release notes -7. Test the system is working by going to the URL of an existing team + 2. Go to the **System Console** to update any settings that have been added or modified based on the **Compatibility** section in the release notes of the version you are installing (Release notes across versions are available from the [CHANGELOG](https://github.com/mattermost/platform/blob/master/CHANGELOG.md)). + 1. Opening the System Console and saving a change will upgrade your `config.json` schema to the latest version using default values for new settings added +7. Test the system is working by going to the URL of an existing team. You may need to refresh your Mattermost browser page in order to get the latest updates from the upgrade ### Upgrading from Mattermost Beta (Version 0.7) |