diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 1 | ||||
| -rw-r--r-- | doc/import/slack-import.md | 18 | ||||
| -rw-r--r-- | doc/install/prod-ubuntu.md | 9 | ||||
| -rw-r--r-- | doc/install/single-container-install.md | 2 |
4 files changed, 24 insertions, 6 deletions
diff --git a/doc/README.md b/doc/README.md index c339f2279..dc1591705 100644 --- a/doc/README.md +++ b/doc/README.md @@ -28,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 20c4976d7..d2490062d 100644 --- a/doc/install/prod-ubuntu.md +++ b/doc/install/prod-ubuntu.md @@ -31,7 +31,7 @@ * ``` 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: @@ -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; @@ -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/single-container-install.md b/doc/install/single-container-install.md index fa5265773..304467678 100644 --- a/doc/install/single-container-install.md +++ b/doc/install/single-container-install.md @@ -5,7 +5,7 @@ The following install instructions are for single-container installs of Mattermo ### Mac OSX ### 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”` + 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: `docker-machine env dev` and copy the export statements to your ~/.bash\_profile by running `sudo nano ~/.bash_profile`. Then run: `source ~/.bash_profile` |