summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAsaad Mahmood <Unknowngi@live.com>2015-10-02 22:26:28 +0500
committerAsaad Mahmood <Unknowngi@live.com>2015-10-02 22:26:28 +0500
commitd8c5c4f7468bb07d8de904437726557c6fa9b436 (patch)
treec19af28e1ad6c2bf068bf64956461c25502f9bb3 /doc
parent813792dd600f4e485d52cc1066a8c1297578432d (diff)
parent41069d83d2b6ad5cca599f75292027e13d5b10f7 (diff)
downloadchat-d8c5c4f7468bb07d8de904437726557c6fa9b436.tar.gz
chat-d8c5c4f7468bb07d8de904437726557c6fa9b436.tar.bz2
chat-d8c5c4f7468bb07d8de904437726557c6fa9b436.zip
Merge branch 'master' of https://github.com/mattermost/platform into plt-375
Conflicts: web/react/components/user_settings/user_settings_appearance.jsx
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md2
-rw-r--r--doc/import/slack-import.md18
-rw-r--r--doc/install/prod-ubuntu.md17
3 files changed, 28 insertions, 9 deletions
diff --git a/doc/README.md b/doc/README.md
index 7713c40ab..dc1591705 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -9,6 +9,7 @@
### Installation
- [Software and Hardware Requirements](install/requirements.md)
+- [Production Installation](install/prod-ubuntu.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)
@@ -27,3 +28,4 @@
## End User Help
- [Mattermost Markdown Formatting](help/enduser/markdown.md)
+- [Slack Import](https://github.com/mattermost/platform/blob/master/doc/import/slack-import.md)
diff --git a/doc/import/slack-import.md b/doc/import/slack-import.md
new file mode 100644
index 000000000..c30de0567
--- /dev/null
+++ b/doc/import/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).
+
diff --git a/doc/install/prod-ubuntu.md b/doc/install/prod-ubuntu.md
index 866b1bdbe..d2490062d 100644
--- a/doc/install/prod-ubuntu.md
+++ b/doc/install/prod-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.