diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 4 | ||||
| -rw-r--r-- | doc/install/dev-setup.md | 11 | ||||
| -rw-r--r-- | doc/install/single-container-install.md | 8 | ||||
| -rw-r--r-- | doc/integrations/webhook/incoming.md | 62 |
4 files changed, 76 insertions, 9 deletions
diff --git a/doc/README.md b/doc/README.md index 6bf96492a..7713c40ab 100644 --- a/doc/README.md +++ b/doc/README.md @@ -23,3 +23,7 @@ - [Code Contribution Guidelines](developer/code-contribution.md) - [Developer Machine Setup](install/dev-setup.md) - [Mattermost Style Guide](developer/style-guide.md) + +## End User Help + +- [Mattermost Markdown Formatting](help/enduser/markdown.md) diff --git a/doc/install/dev-setup.md b/doc/install/dev-setup.md index b90b6a351..c63bde512 100644 --- a/doc/install/dev-setup.md +++ b/doc/install/dev-setup.md @@ -3,13 +3,14 @@ Developer Machine Setup ### Mac OS X ### -1. Download and set up Boot2Docker +1. Download and set up Docker Toolbox 1. Follow the instructions at http://docs.docker.com/installation/mac/ - 1. Use the Boot2Docker command-line utility - 2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”` - 2. Get your Docker IP address with `boot2docker ip` + 2. Start a new docker host + `docker-machine create -d virtualbox dev` + 2. Get the IP address of your docker host + `docker-machine ip dev` 3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost` - 4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile + 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/ 3. Set up your Go workspace 1. `mkdir ~/go` diff --git a/doc/install/single-container-install.md b/doc/install/single-container-install.md index 772f3becf..fa5265773 100644 --- a/doc/install/single-container-install.md +++ b/doc/install/single-container-install.md @@ -4,11 +4,11 @@ The following install instructions are for single-container installs of Mattermo ### Mac OSX ### -1. Install Boot2Docker using instructions at: http://docs.docker.com/installation/mac/ - 1. Start Boot2Docker from the command line and run: `boot2docker init eval “$(boot2docker shellinit)”` -2. Get your Docker IP address with: `boot2docker ip` +1. Install Docker Toolbox using instructions at: http://docs.docker.com/installation/mac/ + 1. Start Docker Toolbox from the command line and run: `docker-machine create -d virtualbox dev”` +2. Get your Docker IP address with: `docker-machine ip dev` 3. Use `sudo nano /etc/hosts` to add `<Docker IP> dockerhost` to your /etc/hosts file -4. Run: `boot2docker shellinit` and copy the export statements to your ~/.bash\_profile by running `sudo nano ~/.bash_profile`. Then run: `source ~/.bash_profile` +4. Run: `docker-machine env dev` and copy the export statements to your ~/.bash\_profile by running `sudo nano ~/.bash_profile`. Then run: `source ~/.bash_profile` 5. Run: `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform` 6. When docker is done fetching the image, open http://dockerhost:8065/ in your browser. diff --git a/doc/integrations/webhook/incoming.md b/doc/integrations/webhook/incoming.md new file mode 100644 index 000000000..e391cba92 --- /dev/null +++ b/doc/integrations/webhook/incoming.md @@ -0,0 +1,62 @@ +# 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](../../help/enduser/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 '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. |