summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md33
-rw-r--r--doc/developer/Code-Contribution-Guidelines.md (renamed from doc/developer/code-contribution.md)2
-rw-r--r--doc/developer/Setup.md (renamed from doc/install/dev-setup.md)11
-rw-r--r--doc/developer/Style-Guide.md (renamed from doc/developer/style-guide.md)0
-rw-r--r--doc/favicon.ico0
-rw-r--r--doc/install/Amazon-Elastic-Beanstalk.md (renamed from doc/install/aws-ebs-setup.md)6
-rw-r--r--doc/install/Docker-Single-Container.md (renamed from doc/install/single-container-install.md)12
-rw-r--r--doc/install/Production-Ubuntu.md (renamed from doc/install/prod-ubuntu.md)17
-rw-r--r--doc/install/Release-Numbering.md (renamed from doc/install/release-numbering.md)0
-rw-r--r--doc/install/Requirements.md (renamed from doc/install/requirements.md)0
-rw-r--r--doc/install/SMTP-Email-Setup.md (renamed from doc/config/smtp-email-setup.md)0
-rw-r--r--doc/integrations/Single-Sign-On/Gitlab.md (renamed from doc/integrations/sso/gitlab-sso.md)0
-rw-r--r--doc/integrations/webhooks/Incoming.md62
-rw-r--r--doc/usage/Markdown.md (renamed from doc/help/enduser/markdown.md)0
-rw-r--r--doc/usage/Slack-Import.md18
15 files changed, 121 insertions, 40 deletions
diff --git a/doc/README.md b/doc/README.md
index 6bf96492a..d711b5d53 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,25 +1,26 @@
# Mattermost Documentation
-## General Information
+## Installation
-- [Mattermost Release Numbering Scheme](install/release-numbering.md)
+- [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)
-## Administrator Documentation
+## Integrations
-### Installation
+- [GitLab SSO Configuration](integrations/Single-Sign-On/Gitlab.md)
+- [Incoming Webhooks](integrations/webhooks/Incoming.md)
-- [Software and Hardware Requirements](install/requirements.md)
-- [Local Machine Setup ](install/single-container-install.md)
-- [AWS Elastic Beanstalk Setup](install/aws-ebs-setup.md)
-- [Developer Machine Setup](install/dev-setup.md)
-
-### Configuration
+## Developer Documentation
-- [GitLab SSO Configuration](integrations/sso/gitlab-sso.md)
-- [SMTP Email Setup](config/smtp-email-setup.md)
+- [Code Contribution Guidelines](developer/Code-Contribution-Guidelines.md)
+- [Developer Machine Setup](developer/Setup.md)
+- [Mattermost Style Guide](developer/Style-Guide.md)
-## Developer Documentation
+## Usage Help
-- [Code Contribution Guidelines](developer/code-contribution.md)
-- [Developer Machine Setup](install/dev-setup.md)
-- [Mattermost Style Guide](developer/style-guide.md)
+- [Slack Import](usage/Slack-Import.md)
+- [Mattermost Markdown Formatting](usage/Markdown.md)
diff --git a/doc/developer/code-contribution.md b/doc/developer/Code-Contribution-Guidelines.md
index 51521be1b..80676f107 100644
--- a/doc/developer/code-contribution.md
+++ b/doc/developer/Code-Contribution-Guidelines.md
@@ -23,7 +23,7 @@ git checkout -b <branch name>
## Programming and Testing
-1. Please review the [Mattermost Style Guide](style-guide.md) prior to making changes.
+1. Please review the [Mattermost Style Guide](Style-Guide.md) prior to making changes.
To keep code clean and well structured, Mattermost uses ESLint to check that pull requests adhere to style guidelines for React. Code will need to follow Mattermost's React style guidelines in order to pass the automated build tests when a pull request is submitted.
diff --git a/doc/install/dev-setup.md b/doc/developer/Setup.md
index b90b6a351..c63bde512 100644
--- a/doc/install/dev-setup.md
+++ b/doc/developer/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/developer/style-guide.md b/doc/developer/Style-Guide.md
index a06f9e29b..a06f9e29b 100644
--- a/doc/developer/style-guide.md
+++ b/doc/developer/Style-Guide.md
diff --git a/doc/favicon.ico b/doc/favicon.ico
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/doc/favicon.ico
diff --git a/doc/install/aws-ebs-setup.md b/doc/install/Amazon-Elastic-Beanstalk.md
index e186fa9c1..0416b67ea 100644
--- a/doc/install/aws-ebs-setup.md
+++ b/doc/install/Amazon-Elastic-Beanstalk.md
@@ -1,14 +1,14 @@
## AWS Elastic Beanstalk Setup (Docker)
-1. Create a new Elastic Beanstalk Docker application using the [Dockerrun.aws.zip](/docker/0.7/Dockerrun.aws.zip) file provided.
+1. Create a new Elastic Beanstalk Docker application using the [Dockerrun.aws.zip](https://github.com/mattermost/platform/raw/master/docker/1.0/Dockerrun.aws.zip) file provided.
1. From the AWS console select Elastic Beanstalk.
2. Select "Create New Application" from the top right.
3. Name the application and press next.
4. Select "Create a web server" environment.
5. If asked, select create an IAM role and instance profile and press next.
6. For predefined configuration select under Generic: Docker. For environment type select single instance.
- 7. For application source, select upload your own and upload Dockerrun.aws.zip from [Dockerrun.aws.zip](/docker/0.7/Dockerrun.aws.zip). Everything else may be left at default.
+ 7. For application source, select upload your own and upload Dockerrun.aws.zip from [Dockerrun.aws.zip](https://github.com/mattermost/platform/raw/master/docker/1.0/Dockerrun.aws.zip). Everything else may be left at default.
8. Select an environment name, this is how you will refer to your environment. Make sure the URL is available then press next.
9. The options on the additional resources page may be left at default unless you wish to change them. Press Next.
10. On the configuration details place. Select an instance type of t2.small or larger.
@@ -24,4 +24,4 @@
### (Recommended) Enable Email
The default single-container Docker instance for Mattermost is designed for product evaluation, and sets `ByPassEmail=true` so the product can run without enabling email, when doing so maybe difficult.
- To see the product's full functionality, [enabling SMTP email is recommended](doc/config/smtp-email-setup.md).
+ To see the product's full functionality, [enabling SMTP email is recommended](SMTP-Email-Setup.md).
diff --git a/doc/install/single-container-install.md b/doc/install/Docker-Single-Container.md
index 772f3becf..4b952cd71 100644
--- a/doc/install/single-container-install.md
+++ b/doc/install/Docker-Single-Container.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.
@@ -75,7 +75,7 @@ The following install instructions are for single-container installs of Mattermo
## Configuration Settings
-There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in [config/config.json](config/config.json) or [docker/0.6/config_docker.json](docker/0.6/config_docker.json) if you're running a Docker instance.
+There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in `config.json` or `config_docker.json` if you're running a Docker instance.
* *EmailSettings*:*ByPassEmail* - If this is set to true, then users on the system will not need to verify their email addresses when signing up. In addition, no emails will ever be sent.
* *ServiceSettings*:*UseLocalStorage* - If this is set to true, then your Mattermost server will store uploaded files in the storage directory specified by *StorageDirectory*. *StorageDirectory* must be set if *UseLocalStorage* is set to true.
@@ -86,7 +86,7 @@ There are a few configuration settings you might want to adjust when setting up
The default single-container Docker instance for Mattermost is designed for product evaluation, and sets `ByPassEmail=true` so the product can run without enabling email, when doing so maybe difficult.
-To see the product's full functionality, [enabling SMTP email is recommended](/doc/config/smtp-email-setup.md).
+To see the product's full functionality, [enabling SMTP email is recommended](SMTP-Email-Setup.md).
## Upgrading Mattermost
diff --git a/doc/install/prod-ubuntu.md b/doc/install/Production-Ubuntu.md
index 866b1bdbe..d2490062d 100644
--- a/doc/install/prod-ubuntu.md
+++ b/doc/install/Production-Ubuntu.md
@@ -6,7 +6,7 @@
* ``` sudo apt-get update```
* ``` sudo apt-get upgrade```
-## Setup Database Server
+## Set up Database Server
1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.1
1. Install PostgreSQL 9.3+ (or MySQL 5.2+)
* ``` sudo apt-get install postgresql postgresql-contrib```
@@ -25,13 +25,13 @@
1. You can exit the postgres account by typing:
* ``` exit```
-## Setup Mattermost Server
+## 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.0.0/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`.
+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`.
1. We have also elected to run the Mattermost Server as the `ubuntu` account for simplicity. We recommend settings up and running the service under a `mattermost` user account with limited permissions.
1. Create the storage directory for files. We assume you will have attached a large drive for storage of images and files. For this setup we will assume the directory is located at `/mattermost/data`.
* Create the directory by typing:
@@ -70,7 +70,7 @@ exec bin/platform
* You should see a page titles *Mattermost - Signup*
* You can also stop the process by running the command ` sudo stop mattermost`, but we will skip this step for now.
-## Setup Nginx Server
+## Set up Nginx Server
1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.3
1. We use Nginx for proxying request to the Mattermost Server. The main benefits are:
* SSL termination
@@ -90,8 +90,7 @@ exec bin/platform
1. Configure Nginx to proxy connections from the internet to the Mattermost Server
* Create a configuration for Mattermost
* ``` sudo touch /etc/nginx/sites-available/mattermost```
- * Below is a sample configuration with the minimum settings required to configure Mattermost.
- *
+ * Below is a sample configuration with the minimum settings required to configure Mattermost
```
server {
server_name mattermost.example.com;
@@ -118,7 +117,7 @@ exec bin/platform
* ``` curl http://localhost```
* You should see a page titles *Mattermost - Signup*
-## Setup Nginx with SSL (Recommended)
+## Set up Nginx with SSL (Recommended)
1. You will need a SSL cert from a certificate authority.
1. For simplicity we will generate a test certificate.
* ``` mkdir ~/cert```
@@ -177,9 +176,9 @@ exec bin/platform
* Save the Settings
1. Update File Settings
* Change *Local Directory Location* from `./data/` to `/mattermost/data`
-1. Update Log Settings
+1. Update Log Settings.
* Set *Log to The Console* to false
-1. Update Rate Limit Settings
+1. Update Rate Limit Settings.
* Set *Vary By Remote Address* to false
* Set *Vary By HTTP Header* to X-Real-IP
1. Feel free to modify other settings.
diff --git a/doc/install/release-numbering.md b/doc/install/Release-Numbering.md
index 71374f7ef..71374f7ef 100644
--- a/doc/install/release-numbering.md
+++ b/doc/install/Release-Numbering.md
diff --git a/doc/install/requirements.md b/doc/install/Requirements.md
index 1e0a12fb9..1e0a12fb9 100644
--- a/doc/install/requirements.md
+++ b/doc/install/Requirements.md
diff --git a/doc/config/smtp-email-setup.md b/doc/install/SMTP-Email-Setup.md
index 86e2bb20e..86e2bb20e 100644
--- a/doc/config/smtp-email-setup.md
+++ b/doc/install/SMTP-Email-Setup.md
diff --git a/doc/integrations/sso/gitlab-sso.md b/doc/integrations/Single-Sign-On/Gitlab.md
index 6110db504..6110db504 100644
--- a/doc/integrations/sso/gitlab-sso.md
+++ b/doc/integrations/Single-Sign-On/Gitlab.md
diff --git a/doc/integrations/webhooks/Incoming.md b/doc/integrations/webhooks/Incoming.md
new file mode 100644
index 000000000..6e25f182e
--- /dev/null
+++ b/doc/integrations/webhooks/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](../../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 '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/help/enduser/markdown.md b/doc/usage/Markdown.md
index 9e2342a0b..9e2342a0b 100644
--- a/doc/help/enduser/markdown.md
+++ b/doc/usage/Markdown.md
diff --git a/doc/usage/Slack-Import.md b/doc/usage/Slack-Import.md
new file mode 100644
index 000000000..c30de0567
--- /dev/null
+++ b/doc/usage/Slack-Import.md
@@ -0,0 +1,18 @@
+#### 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).
+