diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 33 | ||||
| -rw-r--r-- | doc/api/Overview.md | 2 | ||||
| -rw-r--r-- | doc/developer/Code-Contribution-Guidelines.md | 10 | ||||
| -rw-r--r-- | doc/developer/Setup.md | 4 | ||||
| -rw-r--r-- | doc/help/Manage-Members.md | 37 | ||||
| -rw-r--r-- | doc/help/README.md | 12 | ||||
| -rw-r--r-- | doc/help/Slack-Import.md | 29 | ||||
| -rw-r--r-- | doc/install/Configuration-Settings.md | 10 | ||||
| -rw-r--r-- | doc/install/Release-Numbering.md | 2 | ||||
| -rw-r--r-- | doc/install/SMTP-Email-Setup.md | 14 | ||||
| -rw-r--r-- | doc/install/Troubleshooting.md | 7 | ||||
| -rw-r--r-- | doc/integrations/Single-Sign-On/Gitlab.md | 12 | ||||
| -rw-r--r-- | doc/integrations/webhooks/Incoming-Webhooks.md | 92 | ||||
| -rw-r--r-- | doc/integrations/webhooks/Incoming.md | 62 | ||||
| -rw-r--r-- | doc/usage/Slack-Import.md | 18 |
15 files changed, 237 insertions, 107 deletions
diff --git a/doc/README.md b/doc/README.md index 4c7c4cc0e..7ee2bb46c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2,17 +2,23 @@ ## Installation +#### Preview Installation +Get up and running quickly with Docker-based install + - [AWS Elastic Beanstalk Setup](install/Amazon-Elastic-Beanstalk.md) - [Docker Single Container Preview Setup](install/Docker-Single-Container.md) -- [Production Ubuntu Setup](install/Production-Ubuntu.md) -- [Mattermost Release Numbering Scheme](install/Release-Numbering.md) -- [Software and Hardware Requirements](install/Requirements.md) - [SMTP Email Setup](install/SMTP-Email-Setup.md) -## Integrations +#### Production Installation +Set up Mattermost in your data center +- [Software and Hardware Requirements](install/Requirements.md) +- [Production Ubuntu Setup](install/Production-Ubuntu.md) +- [SMTP Email Setup](install/SMTP-Email-Setup.md) -- [GitLab SSO Configuration](integrations/Single-Sign-On/Gitlab.md) -- [Incoming Webhooks](integrations/webhooks/Incoming.md) +#### Configuration and Management +- Configuration Settings Overview + - [GitLab SSO Configuration](integrations/Single-Sign-On/Gitlab.md) +- [Mattermost Release Numbering Scheme](install/Release-Numbering.md) ## Developer Documentation @@ -20,8 +26,17 @@ - [Developer Machine Setup](developer/Setup.md) - [Mattermost Style Guide](developer/Style-Guide.md) - [API Overview](api/Overview.md) + - [Incoming Webhooks](integrations/webhooks/Incoming-Webhooks.md) + +## Help + +_Note: End user help documentation is a new feature being completed for the v1.2 release. The materials below are work in progress._ + +- User Interface + - [Manage Members](help/Manage-Members.md) + - Team Settings + - [Slack Import](help/Slack-Import.md) -## Usage Help +- Messaging + - [Mattermost Markdown Formatting](usage/Markdown.md) -- [Slack Import](usage/Slack-Import.md) -- [Mattermost Markdown Formatting](usage/Markdown.md) diff --git a/doc/api/Overview.md b/doc/api/Overview.md index 02e11974e..0a407b1e9 100644 --- a/doc/api/Overview.md +++ b/doc/api/Overview.md @@ -77,7 +77,7 @@ X-Ratelimit-Reset: 1441983590 These headers are telling you your current rate limit status. Header | Description ---------------------- | ----------- +:--------------------- |:----------- X-Ratelimit-Limit | The maximum number of requests you can make per second. X-Ratelimit-Remaining | The number of requests remaining in the current window. X-Ratelimit-Reset | The remaining UTC epoch seconds before the rate limit resets. diff --git a/doc/developer/Code-Contribution-Guidelines.md b/doc/developer/Code-Contribution-Guidelines.md index 80676f107..48bbf2491 100644 --- a/doc/developer/Code-Contribution-Guidelines.md +++ b/doc/developer/Code-Contribution-Guidelines.md @@ -5,7 +5,6 @@ Thank you for your interest in contributing to Mattermost. This guide provides a ## Choose a Ticket 1. Review the list of [Good First Contribution](https://mattermost.atlassian.net/issues/?filter=10206) tickets listed in Jira. - 2. These projects are intended to be a straight forward first pull requests from new contributors. If you don't find something appropriate for your interests, please see the full list of tickets [Accepting Pull Requests](https://mattermost.atlassian.net/issues/?filter=10101). @@ -13,7 +12,7 @@ If you don't find something appropriate for your interests, please see the full ## Install Mattermost and set up a Fork -1. Follow [developer setup instructions](https://github.com/mattermost/platform/blob/master/doc/install/dev-setup.md) to install Mattermost. +1. Follow [developer setup instructions](https://github.com/mattermost/platform/blob/master/doc/developer/Setup.md) to install Mattermost. 2. Create a branch with <branch name> set to the ID of the ticket you're working on, for example ```PLT-394```, using command: @@ -29,15 +28,18 @@ git checkout -b <branch name> 2. Please make sure to thoroughly test your change before submitting a pull request. + Please review the ["Fast, Obvious, Forgiving" experience design principles](http://www.mattermost.org/design-principles/) for Mattermost and check that your feature meets the criteria. Also, for any changes to user interface or help text, please read the changes out loud, as a quick and easy way to catch any inconsitencies. + + ## Submitting a Pull Request 1. Please add yourself to the Mattermost [approved contributor list](https://docs.google.com/spreadsheets/d/1NTCeG-iL_VS9bFqtmHSfwETo5f-8MQ7oMDE5IUYJi_Y/pubhtml?gid=0&single=true) prior to submitting by completing the [contributor license agreement](http://www.mattermost.org/mattermost-contributor-agreement/). -2. When you submit your pull request please include the Ticket ID at the beginning of your pull request comment, followed by a colon. +2. When you submit your pull request please make it against `master` and include the Ticket ID at the beginning of your pull request comment, followed by a colon. For example, for a ticket ID `PLT-394` start your comment with: `PLT-394:`. See [previously closed pull requests](https://github.com/mattermost/platform/pulls?q=is%3Apr+is%3Aclosed) for examples. -3. Once submitted, your pull request will be checked via an automated build process and will be reviewed by the Mattermost core team, who may either accept the PR or follow-up with feedback. +3. Once submitted, your pull request will be checked via an automated build process and will be reviewed by at least two members of the Mattermost core team, who may either accept the PR or follow-up with feedback. It would then get merged into `master` for the next release. 4. If you've included your mailing address in Step 1, you'll be receiving a [Limited Edition Mattermost Mug](http://forum.mattermost.org/t/limited-edition-mattermost-mugs/143) as a thank you gift after your first pull request has been accepted. diff --git a/doc/developer/Setup.md b/doc/developer/Setup.md index c63bde512..afaef4ee4 100644 --- a/doc/developer/Setup.md +++ b/doc/developer/Setup.md @@ -11,7 +11,7 @@ Developer Machine Setup `docker-machine ip dev` 3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost` 4. Run `docker-machine env dev` and copy the export statements to your ~/.bash_profile -2. Download Go (version 1.4.2) from http://golang.org/dl/ +2. Download Go (version 1.4.2 or 1.5.1. Final release bits are built with 1.4.2) from http://golang.org/dl/ 3. Set up your Go workspace 1. `mkdir ~/go` 2. Add the following to your ~/.bash_profile @@ -51,7 +51,7 @@ Any issues? Please let us know on our forums at: http://forum.mattermost.org `127.0.0.1 dockerhost` 3. Install build essentials 1. `apt-get install build-essential` -4. Download Go (version 1.4.2) from http://golang.org/dl/ +4. Download Go (version 1.4.2 or 1.5.1. Final release bits are built with 1.4.2) from http://golang.org/dl/ 5. Set up your Go workspace and add Go to the PATH 1. `mkdir ~/go` 2. Add the following to your ~/.bashrc diff --git a/doc/help/Manage-Members.md b/doc/help/Manage-Members.md new file mode 100644 index 000000000..04243f9fb --- /dev/null +++ b/doc/help/Manage-Members.md @@ -0,0 +1,37 @@ +# Manage Members + +The Manage Members menu is used to change the user roles assigned to members belonging to a team. + +## User Roles + +The following user roles are assigned from the **Manage Members** menu option in the team site main menu. + +### System Admin + +The System Administrator is typically a member of the IT staff and has the follow privileges: + +- Access to the System Console from the main menu in any team site. +- Change any setting on the Mattermost server available in the System Console. +- Promote and demote other users to and from the System Admin role. +- This role also has all the privileges of the Team Administrator as described below + +The first user added to a newly installed Mattermost system is assigned the System Admin role. + +### Team Admin + +The Team Administrator is typically a non-technical end user and has the following privileges: + +- Access to the "Team Settings" menu from the team site main menu +- Ability to change the team name and import data from Slack export files +- Access to the "Manage Members" menu and change user roles to the levels of Team Administrator, Member and Inactive + +### Member + +This is the default role given to end users who join the system. Members have basic permissions to use the Mattermost team site. + +### Inactive + +This status is given to users whose accounts are marked inactive. These users can no longer log into the system. + +Because Mattermost is designed as a system-of-record, there is not an option to delete users from the Mattermost system, as such an operation could compromise the integrity of message archives. + diff --git a/doc/help/README.md b/doc/help/README.md new file mode 100644 index 000000000..9271d64dd --- /dev/null +++ b/doc/help/README.md @@ -0,0 +1,12 @@ +# Help + +The help section of the Mattermost documentation is intended for use by end users learning about the Mattermost concepts, usage, terminology and user interface. + +_Note: Help documentation is a work-in-progress. Community contributions highly welcome. Please see [guidelines for contributing](https://forum.mattermost.org/t/help-improve-mattermost-documentation/194)._ + +## Team Site Main Menu + +You can access the **Team Site Main Menu** by clicking on the three vertical dots at the top of the left sidebar in a team site. Here we describe the various options available from the menu: + +- [Manage Members](Manage-Members.md) + diff --git a/doc/help/Slack-Import.md b/doc/help/Slack-Import.md new file mode 100644 index 000000000..f834d5177 --- /dev/null +++ b/doc/help/Slack-Import.md @@ -0,0 +1,29 @@ +### Slack Import + +*Note: As a proprietary SaaS service, Slack is able to change its export format quickly and without notice. If you encounter issues not mentioned in the documentation below, please alert the product team by [filing an issue](https://github.com/mattermost/platform/issues).* + +#### Usage + +The Slack Import feature in Mattermost is in "Beta" and focus is on supporting migration of teams of less than 100 registered users. To use: + +1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export** + +2. In Mattermost go to **Team Settings > Import > Import from Slack**. _Team Owner_ or _Team Administrator_ role is required to access this menu option. + +3. Click **Select file** to upload Slack export file and click **Import**. + +4. Emails and usernames from Slack are used to create new Mattermost accounts + +5. Slack users can activate their new Mattermost accounts by using Mattermost's Password Reset screen with their email addresses from Slack to set new passwords for their Mattermost accounts + +6. Once logged in, the Mattermost users will have access to previous Slack messages in the public channels imported from Slack. + +**It is highly recommended that you test Slack import before applying it to an instance intended for production.** If you use Docker, you can spin up a test instance in one line (`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform`). If you don't use Docker, there are [step-by-step instructions](../install/Docker-Single-Container.md) to install Mattermost in preview mode in less than 5 minutes. + +#### Notes: + +- Newly added markdown suppport in Slack's Posts 2.0 feature announced on September 28, 2015 is not yet supported. +- Slack does not export files or images your team has stored in Slack's database. Mattermost will provide links to the location of your assets in Slack's web UI. +- Slack does not export any content from private groups or direct messages that your team has stored in Slack's database. +- In Beta, Slack accounts with username or email address collisions with existing Mattermost accounts will not import and mentions do not resolve as Mattermost usernames (still shows Slack ID). No pre-check or roll-back is currently offered. + diff --git a/doc/install/Configuration-Settings.md b/doc/install/Configuration-Settings.md index 804a94c30..a92893753 100644 --- a/doc/install/Configuration-Settings.md +++ b/doc/install/Configuration-Settings.md @@ -257,19 +257,19 @@ Settings to configure account and team creation using GitLab OAuth. “true”: Allow team creation and account signup using GitLab OAuth. To configure, input the **Secret** and **Id** credentials. ```"Secret": ""``` -Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "<your-mattermost-url>/login/gitlab/complete" (example: http://localhost:8065/login/gitlab/complete) and "<your-mattermost-url>/signup/gitlab/complete". +Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "https://<your-mattermost-url>/login/gitlab/complete" (example: https://example.com:8065/login/gitlab/complete) and "https://<your-mattermost-url>/signup/gitlab/complete". ```"Id": ""``` -Obtain this value by logging into your GitLab account. Go to Applications -> Profile Settings. Enter Redirect URLs "<your-mattermost-url>/login/gitlab/complete" (example: http://localhost:8065/login/gitlab/complete) and "<your-mattermost-url>/signup/gitlab/complete". +Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "https://<your-mattermost-url>/login/gitlab/complete" (example: https://example.com:8065/login/gitlab/complete) and "https://<your-mattermost-url>/signup/gitlab/complete". ```"AuthEndpoint": ""``` -Enter <your-gitlab-url>/oauth/authorize (example: http://localhost:3000/oauth/authorize). Use HTTP or HTTPS in your URLs as appropriate. +Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/oauth/authorize). Use HTTP or HTTPS depending on how your server is configured. ```"TokenEndpoint": ""``` -Enter <your-gitlab-url>/oauth/token (example: http://localhost:3000/oauth/token). Use HTTP or HTTPS in your URLs as appropriate. +Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/oauth/token). Use HTTP or HTTPS depending on how your server is configured. ```"UserApiEndpoint": ""``` -Enter <your-gitlab-url>/api/v3/user (example: http://localhost:3000/api/v3/user). Use HTTP or HTTPS in your URLs as appropriate. +Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/api/v3/user). Use HTTP or HTTPS depending on how your server is configured. ## Config.json Settings Not in System Console diff --git a/doc/install/Release-Numbering.md b/doc/install/Release-Numbering.md index 71374f7ef..3b0391cff 100644 --- a/doc/install/Release-Numbering.md +++ b/doc/install/Release-Numbering.md @@ -14,4 +14,4 @@ Major Build Number: Minor Build Number: -- Indicates bugfix/security releases (e.g. 1.2.5, 1.2.6) +- Indicates a bug fix or security release (e.g. 1.2.5, 1.2.6) diff --git a/doc/install/SMTP-Email-Setup.md b/doc/install/SMTP-Email-Setup.md index b908d04dd..8bf094714 100644 --- a/doc/install/SMTP-Email-Setup.md +++ b/doc/install/SMTP-Email-Setup.md @@ -44,3 +44,17 @@ To enable email, turn this option on by setting `SendEmailNotifications=true` an 2. Kill the process `kill pid` 3. The service should restart automatically. Verify the Mattermost service is running with `ps -A` 4. Current logged in users will not be affected, but upon logging out or session expiration users will be required to verify their email address. + +### Troubleshooting SMTP + +If you have issues with your SMTP install, from your Mattermost team site go to the main menu and open `System Console > Logs` to look for error messages related to your setup. You can do a search for the error code to narrow down the issue. Sometimes ISPs require nuanced setups for SMTP and error codes can hint at how to make the proper adjustments. + +For example, if `System Console > Logs` has an error code reading: + +``` +Connection unsuccessful: Failed to add to email address - 554 5.7.1 <unknown[IP-ADDRESS]>: Client host rejected: Access denied +``` + +Search for `554 5.7.1 error` and `Client host rejected: Access denied`. + + diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md new file mode 100644 index 000000000..8d82100d8 --- /dev/null +++ b/doc/install/Troubleshooting.md @@ -0,0 +1,7 @@ +### Mattermost Troubleshooting + +#### Important notes + +1. **DO NOT manipulate the Mattermost database** + - In particular, DO NOT delete data from the database, as this will most likely crash Mattermost in strange ways. Mattermost is designed to archive content continously and generally assumes data is never deleted. + diff --git a/doc/integrations/Single-Sign-On/Gitlab.md b/doc/integrations/Single-Sign-On/Gitlab.md index 87889df66..e503a158b 100644 --- a/doc/integrations/Single-Sign-On/Gitlab.md +++ b/doc/integrations/Single-Sign-On/Gitlab.md @@ -12,10 +12,12 @@ The following steps can be used to configure Mattermost to use GitLab as a singl 3. Submit the application and copy the given _Id_ and _Secret_ into the appropriate _SSOSettings_ fields in config/config.json 4. Also in config/config.json, set _Allow_ to `true` for the _gitlab_ section, leave _Scope_ blank and use the following for the endpoints: - * _AuthEndpoint_: `<your-gitlab-url>/oauth/authorize` (example http://localhost:3000/oauth/authorize) - * _TokenEndpoint_: `<your-gitlab-url>/oauth/token` - * _UserApiEndpoint_: `<your-gitlab-url>/api/v3/user` + * _AuthEndpoint_: `https://<your-gitlab-url>/oauth/authorize` (example https://example.com/oauth/authorize) + * _TokenEndpoint_: `https://<your-gitlab-url>/oauth/token` + * _UserApiEndpoint_: `https://<your-gitlab-url>/api/v3/user` + + Note: Make sure your `HTTPS` or `HTTP` prefix for endpoint URLs matches how your server configuration. -6. (Optional) If you would like to force all users to sign-up with GitLab only, in the _ServiceSettings_ section of config/config.json please set _DisableEmailSignUp_ to `true`. +5. (Optional) If you would like to force all users to sign-up with GitLab only, in the _ServiceSettings_ section of config/config.json please set _DisableEmailSignUp_ to `true`. -7. Restart your Mattermost server to see the changes take effect. +6. Restart your Mattermost server to see the changes take effect. diff --git a/doc/integrations/webhooks/Incoming-Webhooks.md b/doc/integrations/webhooks/Incoming-Webhooks.md new file mode 100644 index 000000000..c6323a24a --- /dev/null +++ b/doc/integrations/webhooks/Incoming-Webhooks.md @@ -0,0 +1,92 @@ +# Incoming Webhooks + +Incoming webhooks allow external applications, written in the programming language of your choice--to post messages into Mattermost channels and private groups by sending a specifically formatted JSON payload via HTTP POST request to a secret Mattermost URL generated specifically for each application. + +A couple key points: + +- **Mattermost incoming webhooks are Slack-compatible.** If you've used Slack's incoming webhooks to create integrations, you can copy and paste that code to create Mattermost integrations. Mattermost automatically translates Slack's propretiary JSON payload format into markdown to render in Mattermost messages. +- **Mattermost incoming webhooks support full markdown.** A rich range of formatting unavailable in Slack is made possible through [markdown support](../../usage/Markdown.md) in Mattermost, incuding headings, formatted fonts, tables, inline images and other options supported by [Mattermost Markdown]. + +_Example:_ + +Suppose you wanted to create a notification of the status of a daily build, with a table of total tests run and total tests failed by component category, with links to failed tests by category. You could create the following JSON payload to post to a Mattermost channel using webhooks: + +``` +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) | +*** + +### 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: + +1. Login to your Mattermost team account that has the system administrator role. +1. Enable incoming webhooks from **System Console -> Service Settings**. +1. (Optional) Configure the **Enable Overriding of Usernames from Webhooks** option to allow external applications to post messages under any name. If not enabled, the username of the creator of the webhook URL is used to post messages. +2. (Optional) Configure the **Enable Overriding of Icon from Webhooks** option to allow external applciations to change the icon of the account posting messages. If not enabled, the icon of the creator of the webhook URL is used to post messages. + +### Setting Up Existing Integrations +If you've already found or built an integration and are just looking to hook it up, then you should just need to follow the specific instructions of that integration. If the integration is using Mattermost incoming webhooks, then at some point in the instructions it will ask for a webhook URL. You can get this URL by following the first step in the next section _Creating Integrations using Incoming Webhooks_. + +### Creating Integrations using Incoming Webhooks +You can create a webhook integration to post into Mattermost channels and private groups using these steps: + +**Note: Incoming webhooks must be enabled. Only your Mattermost system administrator can enable incoming webhooks if they are currently disabled.** + +2. Create a Mattermost Incoming Webhook URL + 1. Login to your Mattermost team site and go to **Account Settings -> Integrations** + 2. Next to **Incoming Webhooks** click **Edit** + 3. Select the channel or private group to receive webhook payloads, then click **Add** to create the webhook + 4. To see your new webhook in action, try a curl command from your terminal or command-line to send a JSON string as the `payload` parameter in a HTTP POST request. + 1. Example: + ``` +curl -i -X POST -d 'payload={"text": "Hello, this is some text."}' http://yourmattermost.com/hooks/xxx-generatedkey-xxx +``` + +3. Build your integration in the programming language of your choice + 1. Most integrations will be used to translate some sort of output from another system to an appropriately formatted input that will be passed into the Mattermost webhook URL. For example, an integration could take events generated by [GitLab outgoing webhooks](http://doc.gitlab.com/ee/web_hooks/web_hooks.html) and parse them into a JSON body to post into Mattermost. + 1. To get the message posted into Mattermost, your integration will need to create an HTTP POST request that will submit to the incoming webhook URL you created before. The body of the request must have a `payload` that contains a JSON object that specifies a `text` parameter. For example, `payload={"text": "Hello, this is some text."}` is a valid body for a request. + 2. Setup your integration running on Heroku, an AWS server or a server of your own to start sending real time updates to Mattermost channels and private groups. + +Additional Notes: + +1. For the HTTP request body, if `Content-Type` is specified as `application/json` in the headers of the HTTP request then the body of the request can be direct JSON. For example, ```{"text": "Hello, this is some text."}``` + +2. You can override the channel specified in the webhook definition by specifying a `channel` parameter in your payload. For example, you might have a single webhook created for _Town Square_, but you can use ```payload={"channel": "off-topic", "text": "Hello, this is some text."}``` to send a message to the _Off-Topic_ channel using the same webhook URL. + +1. In addition, with **Enable Overriding of Usernames from Webhooks** turned on, you can also override the username the message posts as by providing a `username` parameter in your JSON payload. For example, you might want your message looking like it came from a robot so you can use ```payload={"username": "robot", "text": "Hello, this is some text."}``` to change the username of the post to robot. Note, to combat any malicious users from trying to use this to perform [phishing attacks](https://en.wikipedia.org/wiki/Phishing) a `BOT` indicator appears next to posts coming from incoming webhooks. + +2. With **Enable Overriding of Icon from Webhooks** turned on, you can similarly change the icon the message posts with by providing a link to an image in the `icon_url` parameter of your payload. For example, ```payload={"icon_url": "http://somewebsite.com/somecoolimage.jpg", "text": "Hello, this is some text."}``` will post using whatever image is located at `http://somewebsite.com/somecoolimage.jpg` as the icon for the post. + +3. Also, as mentioned previously, [markdown](../../usage/Markdown.md) can be used to create richly formatted payloads, for example: ```payload={"text": "# A Header\nThe _text_ below **the** header."}``` creates a messages with a header, a carriage return and bold text for "the". + +4. Just like regular posts, the text will be limited to 4000 characters at maximum. + +### Slack Compatibility + +As mentioned above, Mattermost makes it easy to take integrations written for Slack's proprietary JSON payload format and repurpose them to become Mattermost integrations. The following automatic translations are supported: + +1. Payloads designed for Slack using `<>` to note the need to hyperlink a URL, such as ```payload={"text": "<http://www.mattermost.com/>"}```, are translated to the equivalent markdown in Mattermost and rendered the same as you would see in Slack. +2. Similiarly, payloads designed for Slack using `|` within a `<>` to define linked text, such as ```payload={"text": "Click <http://www.mattermost.com/|here> for a link."}```, are also translated to the equivalent markdown in Mattermost and rendered the same as you would see in Slack. +3. Like Slack, by overriding the channel name with an @username, such as payload={"text": "Hi", channel: "@jim"}, you can send the message to a user through your direct message chat. +4. Channel names can be prepended with a #, like they are in Slack incoming webhooks, and the message will still be sent to the correct channel. + +To see samples and community contributions, please visit <http://mattermost.org/webhooks>. + diff --git a/doc/integrations/webhooks/Incoming.md b/doc/integrations/webhooks/Incoming.md deleted file mode 100644 index 0814eb420..000000000 --- a/doc/integrations/webhooks/Incoming.md +++ /dev/null @@ -1,62 +0,0 @@ -# Incoming Webhooks - -With incoming webhooks practically any external source - once given a URL by you - can post a message to any channel you have access to. This is done through a HTTP POST request with a simple JSON payload. The payload can contain some text, and some simple options to allow the external source to customize the post. - -## Creating the Webhook URL - -To get the incoming webhook URL - where all the HTTP requests will be sent - follow these steps: - -1. Login to your Mattermost account. -2. Open the menu by clicking near your profile picture in the top-left and open Account Settings. -3. Go to the Integrations tab and click the 'Edit' button next to 'Incoming Webhooks'. -4. Use the selector to choose a channel and click the 'Add' button to create the webhook. -5. Your webhook URL will be displayed below in the 'Existing incoming webhooks' section. - - -## Posting a Message - -You can send the message by including a JSON string as the `payload` parameter in a HTTP POST request. -``` -payload={"text": "Hello, this is some text."} -``` - -In addition, if `Content-Type` is specified as `application/json` in the headers of the HTTP request then the body of the request can be direct JSON. -``` -{"text": "Hello, this is some text."} -``` - -It is also possible to post richly formatted messages using [Markdown](../../usage/Markdown.md). -``` -payload={"text": "# A Header\nThe _text_ below **the** header."} -``` - -Just like regular posts, the text will be limited to 4000 characters at maximum. - -## Adding Links - -In addition to including links in the standard Markdown format, links can also be specified by enclosing the URL in `<>` brackets -``` -payload={"text": "<http://www.mattermost.com/>"} -``` - -They can also include a `|` character to specify some clickable text. -``` -payload={"text": "Click <http://www.mattermost.com/|here> for a link."} -``` - -## Channel Override - -You can use a single webhook URL to post messages to different channels by overriding the channel. You can do this by adding the channel name - as it is seen in the channel URL - to the request payload. -``` -payload={"channel": "off-topic", "text": "Hello, this is some text."} -``` - -## Finishing up - -Combining everything above, here is an example message made using a curl command: - -``` -curl -i -X POST -d 'payload={"channel": "off-topic", "text": "Hello, this is some text."}' http://yourmattermost.com/hooks/xxxxxxxxxxxxxxxxxxxxxxxxxx -``` - -A post with that text will be made to the Off-Topic channel. diff --git a/doc/usage/Slack-Import.md b/doc/usage/Slack-Import.md deleted file mode 100644 index c30de0567..000000000 --- a/doc/usage/Slack-Import.md +++ /dev/null @@ -1,18 +0,0 @@ -#### Slack Import (Preview) - -*Note: As a SaaS service, Slack is able to change its export format quickly. If you encounter issues not mentioned in the documentation below, please let us know by [filing an issue](https://github.com/mattermost/platform/issues).* - -The Slack Import feature in Mattermost is in "Preview" and focus is on supporting migration of teams of less than 100 registered users. The feature can be accessed from by Team Administrators and Team Owners via the `Team Settings -> Import` menu option. - -Mattermost currently supports the processing of an "Export" file from Slack containing account information and public channel archives from a Slack team. - -- In the feature preview, emails and usernames from Slack are used to create new Mattermost accounts, connected to messages history in imported Slack channels. Users can activate these accounts and by going to the Password Reset screen in Mattermost to set new credentials. -- Once logged in, users will have access to previous Slack messages shared in public channels, now imported to Mattermost. - -Limitations: - -- Newly added markdown suppport in Slack's Posts 2.0 feature announced on September 28, 2015 is not yet supported. -- Slack does not export files or images your team has stored in Slack's database. Mattermost will provide links to the location of your assets in Slack's web UI. -- Slack does not export any content from private groups or direct messages that your team has stored in Slack's database. -- The Preview release of Slack Import does not offer pre-checks or roll-back and will not import Slack accounts with username or email address collisions with existing Mattermost accounts. Also, Slack channel names with underscores will not import. Also, mentions do not yet resolve as Mattermost usernames (still show Slack ID). - |