diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/tests/test-links.md | 16 | ||||
| -rw-r--r-- | doc/help/Messaging.md | 34 | ||||
| -rw-r--r-- | doc/install/Administration.md | 65 | ||||
| -rw-r--r-- | doc/install/Production-Ubuntu.md | 10 | ||||
| -rw-r--r-- | doc/install/Troubleshooting.md | 32 | ||||
| -rw-r--r-- | doc/integrations/webhooks/Incoming-Webhooks.md | 27 | ||||
| -rw-r--r-- | doc/process/documentation-guidelines.md | 8 |
7 files changed, 178 insertions, 14 deletions
diff --git a/doc/developer/tests/test-links.md b/doc/developer/tests/test-links.md new file mode 100644 index 000000000..62b729b30 --- /dev/null +++ b/doc/developer/tests/test-links.md @@ -0,0 +1,16 @@ + +# Link Testing + +Links in Mattermosts should render as specified below. Paste the below text into Mattermost to test text processing. + +``` +These strings should auto-link: + +http://wikipedia.com +https://wikipedia.com +www.wikipedia.com + +These strings should not auto-link: + +Readme.md +``` diff --git a/doc/help/Messaging.md b/doc/help/Messaging.md new file mode 100644 index 000000000..03adc1ce8 --- /dev/null +++ b/doc/help/Messaging.md @@ -0,0 +1,34 @@ +# Messaging + +## Writing Messages + +You can write messages using the input box with the text "Write a message..." at the bottom of Mattermost. + +Press **ENTER** to send a message. Use **Ctrl+ENTER** to create a new line without sending a message. + +## Formatting Messages + +Mattermost messages are formatted using a standard called "markdown". Here are examples: + +| Text Entered | How it appears | +|:---------------|:---------------| +|`**bold**`| **bold** | +| `_italic_`|_italic_| +|`[hyperlink](http://mattermost.org)`|[hyperlink](http://mattermost.org)| +|``|| + +## Mentioning Teammates + +You can mention a teammate by using the `@` symbol plus their username to send them a special notification to draw their attention. + +For example, you might write: + +``` +@alice how did your interview go with the new candidate? +``` + +Which sends a special mention notification to **alice** to check your message. + +To mention a teammate, press `@` and you should see a list of team members who can be messaged. You can either type their username or use the **Up** and **Down** arrow keys and then **ENTER** to select them to be mentioned. + +You can configure how you'd like to be alerted about mentions of your username, your first name, your nickname, or other keywords from **Account Settings** > **Notifications** and you can set channel-specific preferences from **[Channel Name]** > **Notification Preferences** diff --git a/doc/install/Administration.md b/doc/install/Administration.md index ee996088c..76ec78abd 100644 --- a/doc/install/Administration.md +++ b/doc/install/Administration.md @@ -17,3 +17,68 @@ This document provides instructions for common administrator tasks - Team Admin or System Admin can go to **Main Menu** > **Manage Members** > **Make Inactive** to deactivate a user, which removes them from the team. - To preserve audit history, users are never deleted from the system. It is highly recommended that System Administrators do not attempt to delete users manually from the database, as this may compromise system integrity and ability to upgrade in future. + +## GitLab Mattermost Administration + +GitLab Mattermost is a special version of Mattermost bundled with GitLab omnibus. Here we consolidate administrative instructions, guides and troubleshooting guidance. + +### Installing GitLab Mattermost + +Please follow the [GitLab Omnibus documentation for installing GitLab Mattermost](http://doc.gitlab.com/omnibus/gitlab-mattermost/). + +### Community Support Resources + +For help and support around your GitLab Mattermost deployment please see: + +- [GitLab Mattermost discussion forum](https://forum.mattermost.org/c/general/gitlab) +- [GitLab Mattermost issue tracker on GitLab.com](https://gitlab.com/gitlab-org/gitlab-mattermost/issues) + +### Setting up realtime notifications from GitLab to Mattermost + +To set up standard notification from GitLab to Mattermost [follow these steps](https://github.com/mattermost/platform/blob/master/doc/integrations/webhooks/Incoming-Webhooks.md#connecting-mattermost-to-gitlab-using-slack-ui). + +To set up a set of fully customizable realtime notifications from GitLab to Mattermost you can run the [GitLab Integration Service for Mattermost](https://github.com/mattermost/mattermost-integration-gitlab). + +### Upgrading GitLab Mattermost manually + +If you choose to upgrade Mattermost outside of GitLab's omnibus automation, please [follow this guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md#upgrading-mattermost-to-next-major-release). + +### Upgrading GitLab Mattermost from GitLab 8.0 (containing Mattermost 0.7.1-beta) + +To upgrade GitLab Mattermost from the 0.7.1-beta release of Mattermost in GitLab 8.0, please [follow this guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md#upgrading-mattermost-in-gitlab-80-to-gitlab-81-with-omnibus). + +### Troubleshooting GitLab Mattermost + +- If you're having issues installing GitLab Mattermost with GitLab Omnibus, as a first step please turn on logging by updating the [log settings](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md#log-file-settings) section in your `config.json` file installed by omnibus, and they try a general web search for the error message you receive. + +#### GitLab Mattermost Error Messages + +###### `We received an unexpected status code from the server (200)` + +- If you have upgraded from a pre-released version of GitLab Mattermost or if an unforseen issue has arrisen during the [upgrade procedure](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md), you may be able to restore Mattermost using the following procedure: + - `sudo stop mattermost`, so DB can be dropped + - `sudo gitlab-ctl reconfigure` + - `sudo -u gitlab-psql /opt/gitlab/embedded/bin/dropdb -h /var/opt/gitlab/postgresql mattermost_production` + - `sudo start mattermost` + - `sudo gitlab-ctl reconfigure` + - [Manually set up GitLab SSO](https://github.com/mattermost/platform/blob/master/doc/integrations/Single-Sign-On/Gitlab.md) by copying Secret and ID into `/var/opt/gitlab/mattermost/config.json` + - `sudo gitlab-ctl restart` + +###### `Token request failed` + - This error can appear in the web browser after attempting to create a new team with GitLab SSO enabled + - **Solutions:** + 1. Check that your SSL settings for the SSO provider match the `http://` or `https://` choice selected in `config.json` under `GitLabSettings` + 2. Follow steps 1 to 3 of the manual [GitLab SSO configuration procedure](https://github.com/mattermost/platform/blob/master/doc/integrations/Single-Sign-On/Gitlab.md) to confirm your `Secret` and `Id` settings in `config.json` match your GitLab settings, and if they don't, manually update `config.json` to the correct settings and see if this clears the issue. + +###### `We couldn't find the existing account` + - This error appears when a user attempts to sign in using a single-sign-on option with an account that was not created using that single-sign-on option. For example, if a user creates Account A using email sign-up, then attempts to sign-in using GitLab SSO, the error appears since Account A was not created using GitLab SSO. + - **Solution:** + - If you're switching from email auth to GitLab SSO, and you're getting this issue on an admin account, consider deactivating your email-based account, then creating a new account with System Admin privileges using GitLab SSO. Specifically: + 1. Deactivate your email-based System Admin account (note: this process is [scheduled to improve](https://mattermost.atlassian.net/browse/PLT-975)) + 1. Temporarily turn off email verification (**System Console** > **Email Settings** > **Require Email Verification** > **false**, or set `"RequireEmailVerification": false` in `config.json`). + 2. Change email for account to random address so you can create a new GitLab SSO account using your regular address. + 2. Create a new Mattermost account using GitLab SSO + 1. With GitLab SSO enabled, go to `https://domain.com/teamname` and sign-up for a new Mattermost account using your GitLab SSO account with preferred email address. + 2. [Upgrade the new account to System Admin privileges](https://github.com/mattermost/platform/blob/master/doc/install/Troubleshooting.md#lost-system-administrator-account). + 3. Deactivate the previous System Admin account that used email authentication. + 1. Using the new GitLab SSO System Admin account go to **System Console** > **[TEAMNAME]** > **Users**, find the previous account and set it to "Inactive" diff --git a/doc/install/Production-Ubuntu.md b/doc/install/Production-Ubuntu.md index e792a551c..098707ada 100644 --- a/doc/install/Production-Ubuntu.md +++ b/doc/install/Production-Ubuntu.md @@ -24,6 +24,16 @@ * ```postgre=# \q``` 1. You can exit the postgres account by typing: * ``` exit``` +1. Allow Postgres to listen on all assigned IP Addresses + * ```sudo vi /etc/postgresql/9.3/main/postgresql.conf``` + * Uncomment 'listen_addresses' and change 'localhost' to '*' +1. Alter pg_hba.conf to allow the mattermost server to talk to the postgres database + * ```sudo vi /etc/postgresql/9.3/main/pg_hba.conf``` + * Add the following line to the 'IPv4 local connections' + * host all all 10.10.10.2/32 md5 +1. Reload Postgres database + * ```sudo /etc/init.d/postgresql reload``` + ## 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 diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md index 51699a39c..78ab5617d 100644 --- a/doc/install/Troubleshooting.md +++ b/doc/install/Troubleshooting.md @@ -12,7 +12,7 @@ - If the System Administrator account becomes unavailable, a person leaving the organization for example, you can set a new system admin from the commandline using `./platform -assign_role -team_name="yourteam" -email="you@example.com" -role="system_admin"`. - After assigning the role the user needs to log out and log back in before the System Administrator role is applied. -#### Error Messages +#### Mattermost Error Messages The following is a list of common error messages and solutions: @@ -29,8 +29,38 @@ The following is a list of common error messages and solutions: - This error can occur if you have manually manipulated the Mattermost database, typically with deletions. Mattermost is designed to serve as a searchable archive, and manual manipulation of the database elements compromises integrity and may prevent upgrade. - **Solution:** Restore from database backup created prior to manual database updates, or reinstall the system. +### Troubleshooting GitLab Mattermost + +- If you're having issues installing GitLab Mattermost with GitLab Omnibus, as a first step please turn on logging by updating the [log settings](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md#log-file-settings) section in your `config.json` file installed by omnibus, and they try a general web search for the error message you receive. + +#### GitLab Mattermost Error Messages + +###### `We received an unexpected status code from the server (200)` + +- If you have upgraded from a pre-released version of GitLab Mattermost or if an unforseen issue has arrisen during the [upgrade procedure](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md), you may be able to restore Mattermost using the following procedure: + - `sudo stop mattermost`, so DB can be dropped + - `sudo gitlab-ctl reconfigure` + - `sudo -u gitlab-psql /opt/gitlab/embedded/bin/dropdb -h /var/opt/gitlab/postgresql mattermost_production` + - `sudo start mattermost` + - `sudo gitlab-ctl reconfigure` + - [Manually set up GitLab SSO](https://github.com/mattermost/platform/blob/master/doc/integrations/Single-Sign-On/Gitlab.md) by copying Secret and ID into `/var/opt/gitlab/mattermost/config.json` + - `sudo gitlab-ctl restart` + ###### `Token request failed` - This error can appear in the web browser after attempting to create a new team with GitLab SSO enabled - **Solutions:** 1. Check that your SSL settings for the SSO provider match the `http://` or `https://` choice selected in `config.json` under `GitLabSettings` 2. Follow steps 1 to 3 of the manual [GitLab SSO configuration procedure](https://github.com/mattermost/platform/blob/master/doc/integrations/Single-Sign-On/Gitlab.md) to confirm your `Secret` and `Id` settings in `config.json` match your GitLab settings, and if they don't, manually update `config.json` to the correct settings and see if this clears the issue. + +###### `We couldn't find the existing account` + - This error appears when a user attempts to sign in using a single-sign-on option with an account that was not created using that single-sign-on option. For example, if a user creates Account A using email sign-up, then attempts to sign-in using GitLab SSO, the error appears since Account A was not created using GitLab SSO. + - **Solution:** + - If you're switching from email auth to GitLab SSO, and you're getting this issue on an admin account, consider deactivating your email-based account, then creating a new account with System Admin privileges using GitLab SSO. Specifically: + 1. Deactivate your email-based System Admin account (note: this process is [scheduled to improve](https://mattermost.atlassian.net/browse/PLT-975)) + 1. Temporarily turn off email verification (**System Console** > **Email Settings** > **Require Email Verification** > **false**, or set `"RequireEmailVerification": false` in `config.json`). + 2. Change email for account to random address so you can create a new GitLab SSO account using your regular address. + 2. Create a new Mattermost account using GitLab SSO + 1. With GitLab SSO enabled, go to `https://domain.com/teamname` and sign-up for a new Mattermost account using your GitLab SSO account with preferred email address. + 2. [Upgrade the new account to System Admin privileges](https://github.com/mattermost/platform/blob/master/doc/install/Troubleshooting.md#lost-system-administrator-account). + 3. Deactivate the previous System Admin account that used email authentication. + 1. Using the new GitLab SSO System Admin account go to **System Console** > **[TEAMNAME]** > **Users**, find the previous account and set it to "Inactive" diff --git a/doc/integrations/webhooks/Incoming-Webhooks.md b/doc/integrations/webhooks/Incoming-Webhooks.md index b5ae0fde2..5e93c4ac7 100644 --- a/doc/integrations/webhooks/Incoming-Webhooks.md +++ b/doc/integrations/webhooks/Incoming-Webhooks.md @@ -81,18 +81,27 @@ Additional Notes: ### 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: +Mattermost makes it easy to take integrations written for Slack's proprietary JSON payload format and repurpose them to become Mattermost integrations. For example: + +#### Connecting Mattermost to GitLab using Slack UI + +GitLab is the leading open-source alternative to GitHub and offers built-in integrations with Slack. Rather than having to change code to support Mattermost, users can add Mattermost webhooks directly into the interface for Slack. + +1. In GitLab, go to **Settings** > **Services** and select **Slack**. +2. Paste in the incoming webhook URL provided by Mattermost from under **Account Settings** > **Integration** > **Incoming Webhooks**. +3. Optionally set the **Username** you'd like displayed when the notification is made. Leave the **Channel** field blank +4. Click **Save** then test the settings to confirm posts will be made to Mattermost + +#### Translating Slack's proprietary data format to Mattermost + +The following describes the automatic translations Mattermost performance to process data coming from Slack: 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 +3. Like Slack, by overriding the channel name with a `@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>. -#### Known Issues in v1.1 - -- The `attachments` payload used in Slack is not yet supported -- Overriding of usernames does not yet apply to notifications (fixed on master) -- Cannot supply `icon_emoji` to override the message icon -- Webhook UI fails when connected to deleted channel (fixed on master) +#### Known Issues +- Mattermost does not yet support Slack's feature of using _icon_emoji_ to override the message icon. diff --git a/doc/process/documentation-guidelines.md b/doc/process/documentation-guidelines.md index 59ed0a445..f186da6bd 100644 --- a/doc/process/documentation-guidelines.md +++ b/doc/process/documentation-guidelines.md @@ -102,20 +102,20 @@ A support person should be able to say "Did you complete step 7?" instead of "Di ---- -### Lists end without periods +### End Lists Consistently -Sentences within bullet points or numbered lists should end in normal punctuation. The sentence or fragment at the end of a bullet point should not have a period. +Full sentences in lists should end with proper punctuation. If one point in a bulleted list or numbered list ends with a period, end all points in the list with a period. If all points in the list are fragments, use no end punctuation. ##### Correct ---- -- This is a sentence within a bullet point. This is the end of a bullet point without a period +- This is an example of a bullet point that ends with a period. ---- ##### Incorrect ---- -- This is an incorrect ending of a bullet point with a period. +- Example of an incorrect period at the end of a bullet point. ---- ### Avoid Passive Phrases |