diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/Setup.md | 8 | ||||
| -rw-r--r-- | doc/install/Production-Ubuntu.md | 3 | ||||
| -rw-r--r-- | doc/install/Troubleshooting.md | 5 | ||||
| -rw-r--r-- | doc/integrations/services/Gitlab-Integration-Service-for-Mattermost.md | 9 | ||||
| -rw-r--r-- | doc/integrations/webhooks/Incoming-Webhooks.md | 18 |
5 files changed, 31 insertions, 12 deletions
diff --git a/doc/developer/Setup.md b/doc/developer/Setup.md index d806b7a9b..e78d4dff2 100644 --- a/doc/developer/Setup.md +++ b/doc/developer/Setup.md @@ -16,7 +16,9 @@ Developer Machine Setup 1. `mkdir ~/go` 2. Add the following to your ~/.bash_profile `export GOPATH=$HOME/go` - `export PATH=$PATH:$GOPATH/bin` + `export PATH=$PATH:$GOPATH/bin` + `ulimit -n 8096` + If you don't increase the file handle limit you may see some weird build issues with browserify or npm. 3. Reload your bash profile `source ~/.bash_profile` 4. Install Node.js using Homebrew @@ -57,7 +59,9 @@ Any issues? Please let us know on our forums at: http://forum.mattermost.org 2. Add the following to your ~/.bashrc `export GOPATH=$HOME/go` `export GOROOT=/usr/local/go` - `export PATH=$PATH:$GOROOT/bin` + `export PATH=$PATH:$GOROOT/bin` + `ulimit -n 8096` + If you don't increase the file handle limit you may see some weird build issues with browserify or npm. 3. Reload your bashrc `source ~/.bashrc` 6. Install Node.js diff --git a/doc/install/Production-Ubuntu.md b/doc/install/Production-Ubuntu.md index 87f8edb84..836af3995 100644 --- a/doc/install/Production-Ubuntu.md +++ b/doc/install/Production-Ubuntu.md @@ -160,10 +160,11 @@ exec bin/platform proxy_set_header X-Forwarded-Ssl on; ``` ## Finish Mattermost Server setup + 1. Navigate to https://mattermost.example.com and create a team and user. 1. The first user in the system is automatically granted the `system_admin` role, which gives you access to the System Console. 1. From the `town-square` channel click the dropdown and choose the `System Console` option -1. Update Email Settings. We recommend using an email sending service. The example below assumes AmazonSES. +1. Update Email Settings. We recommend using an email sending service. The example shows how an Amazon SES setup might look (sample credentials shown below are not real). * Set *Send Email Notifications* to true * Set *Require Email Verification* to true * Set *Feedback Name* to `No-Reply` diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index b87663ab3..6a7260ddf 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -5,3 +5,8 @@ 1. **DO NOT manipulate the Mattermost database** - In particular, DO NOT delete data from the database, as Mattermost is designed to stop working if data integrity has been compromised. The system is designed to archive content continously and generally assumes data is never deleted. + +#### Common Issues + +1. Error message in logs when attempting to sign-up: `x509: certificate signed by unknown authority` + - This error may appear when attempt to use a self-signed certificate to setup SSL, which is not yet supported by Mattermost. You can resolve this issue by setting up a load balancer like Ngnix. A ticket exists to [add support for self-signed certificates in future](x509: certificate signed by unknown authority). diff --git a/doc/integrations/services/Gitlab-Integration-Service-for-Mattermost.md b/doc/integrations/services/Gitlab-Integration-Service-for-Mattermost.md new file mode 100644 index 000000000..2ce56bb72 --- /dev/null +++ b/doc/integrations/services/Gitlab-Integration-Service-for-Mattermost.md @@ -0,0 +1,9 @@ +# [GitLab Integration Service for Mattermost](https://github.com/mattermost/mattermost-integration-gitlab) + +This [open source integration service](https://github.com/mattermost/mattermost-integration-gitlab) let you configure real-time notifications on GitLab issues, merge requests and comments to be delivered to selected Mattermost channels. + +The service can be installed on any Linux-based web server and instructions for **Heroku** and **Ubuntu 14.04** are included. Please see [Mattermost incoming webhooks documentation](https://github.com/mattermost/platform/blob/master/doc/integrations/webhooks/Incoming-Webhooks.md) for details on formatting options within the service. + +The Mattermost community is invited to fork, extend and repurpose this service for other applications. If you'd like your integration featured on http://mattermost.org/webhooks, please mail info@mattermost.org or tweet to us at @mattermosthq. + + diff --git a/doc/integrations/webhooks/Incoming-Webhooks.md b/doc/integrations/webhooks/Incoming-Webhooks.md index c6323a24a..be17d6a8e 100644 --- a/doc/integrations/webhooks/Incoming-Webhooks.md +++ b/doc/integrations/webhooks/Incoming-Webhooks.md @@ -13,26 +13,26 @@ Suppose you wanted to create a notification of the status of a daily build, with ``` payload={"text": " -*** +--- ##### Build Break - Project X - December 12, 2015 - 15:32 GMT +0 | Component | Tests Run | Tests Failed | |:-----------|:------------|:-----------------------------------------------| | Server | 948 | :white_check_mark: 0 | | Web Client | 123 | :warning: [2 (see details)](http://linktologs) | | iOS Client | 78 | :warning: [3 (see details)](http://linktologs) | -*** +--- "} ``` Which would render in a Mattermost message as follows: -*** +--- ##### Build Break - Project X - December 12, 2015 - 15:32 GMT +0 -| Component | Tests Run | Tests Failed | -|:------------ |:---------------|:-----| -| Server | 948 | :white_check_mark: 0 | -| Web Client | 123 | :warning: [2 (see details)](http://linktologs) | -| iOS Client | 78 | :warning: [3 (see details)](http://linktologs) | -*** +| Component | Tests Run | Tests Failed | +|:-----------|:------------|:-----------------------------------------------| +| Server | 948 | :white_check_mark: 0 | +| Web Client | 123 | :warning: [2 (see details)](http://linktologs) | +| iOS Client | 78 | :warning: [3 (see details)](http://linktologs) | +--- ### Enabling Incoming Webhooks Incoming webhooks should be enabled on your Mattermost instance by default, but if they are not you'll need to get your system administrator to enable them. If you are the system administrator you can enable them by doing the following: |