diff options
Diffstat (limited to 'doc/install')
-rw-r--r-- | doc/install/Configuration-Settings.md | 10 | ||||
-rw-r--r-- | doc/install/Release-Numbering.md | 2 | ||||
-rw-r--r-- | doc/install/SMTP-Email-Setup.md | 14 | ||||
-rw-r--r-- | doc/install/Troubleshooting.md | 7 |
4 files changed, 27 insertions, 6 deletions
diff --git a/doc/install/Configuration-Settings.md b/doc/install/Configuration-Settings.md index 804a94c30..a92893753 100644 --- a/doc/install/Configuration-Settings.md +++ b/doc/install/Configuration-Settings.md @@ -257,19 +257,19 @@ Settings to configure account and team creation using GitLab OAuth. “true”: Allow team creation and account signup using GitLab OAuth. To configure, input the **Secret** and **Id** credentials. ```"Secret": ""``` -Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "<your-mattermost-url>/login/gitlab/complete" (example: http://localhost:8065/login/gitlab/complete) and "<your-mattermost-url>/signup/gitlab/complete". +Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "https://<your-mattermost-url>/login/gitlab/complete" (example: https://example.com:8065/login/gitlab/complete) and "https://<your-mattermost-url>/signup/gitlab/complete". ```"Id": ""``` -Obtain this value by logging into your GitLab account. Go to Applications -> Profile Settings. Enter Redirect URLs "<your-mattermost-url>/login/gitlab/complete" (example: http://localhost:8065/login/gitlab/complete) and "<your-mattermost-url>/signup/gitlab/complete". +Obtain this value by logging into your GitLab account. Go to Profile Settings -> Applications -> New Application, enter a Name, then enter Redirect URLs "https://<your-mattermost-url>/login/gitlab/complete" (example: https://example.com:8065/login/gitlab/complete) and "https://<your-mattermost-url>/signup/gitlab/complete". ```"AuthEndpoint": ""``` -Enter <your-gitlab-url>/oauth/authorize (example: http://localhost:3000/oauth/authorize). Use HTTP or HTTPS in your URLs as appropriate. +Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/oauth/authorize). Use HTTP or HTTPS depending on how your server is configured. ```"TokenEndpoint": ""``` -Enter <your-gitlab-url>/oauth/token (example: http://localhost:3000/oauth/token). Use HTTP or HTTPS in your URLs as appropriate. +Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/oauth/token). Use HTTP or HTTPS depending on how your server is configured. ```"UserApiEndpoint": ""``` -Enter <your-gitlab-url>/api/v3/user (example: http://localhost:3000/api/v3/user). Use HTTP or HTTPS in your URLs as appropriate. +Enter https://<your-gitlab-url>/oauth/authorize (example: https://example.com:3000/api/v3/user). Use HTTP or HTTPS depending on how your server is configured. ## Config.json Settings Not in System Console diff --git a/doc/install/Release-Numbering.md b/doc/install/Release-Numbering.md index 71374f7ef..3b0391cff 100644 --- a/doc/install/Release-Numbering.md +++ b/doc/install/Release-Numbering.md @@ -14,4 +14,4 @@ Major Build Number: Minor Build Number: -- Indicates bugfix/security releases (e.g. 1.2.5, 1.2.6) +- Indicates a bug fix or security release (e.g. 1.2.5, 1.2.6) diff --git a/doc/install/SMTP-Email-Setup.md b/doc/install/SMTP-Email-Setup.md index b908d04dd..8bf094714 100644 --- a/doc/install/SMTP-Email-Setup.md +++ b/doc/install/SMTP-Email-Setup.md @@ -44,3 +44,17 @@ To enable email, turn this option on by setting `SendEmailNotifications=true` an 2. Kill the process `kill pid` 3. The service should restart automatically. Verify the Mattermost service is running with `ps -A` 4. Current logged in users will not be affected, but upon logging out or session expiration users will be required to verify their email address. + +### Troubleshooting SMTP + +If you have issues with your SMTP install, from your Mattermost team site go to the main menu and open `System Console > Logs` to look for error messages related to your setup. You can do a search for the error code to narrow down the issue. Sometimes ISPs require nuanced setups for SMTP and error codes can hint at how to make the proper adjustments. + +For example, if `System Console > Logs` has an error code reading: + +``` +Connection unsuccessful: Failed to add to email address - 554 5.7.1 <unknown[IP-ADDRESS]>: Client host rejected: Access denied +``` + +Search for `554 5.7.1 error` and `Client host rejected: Access denied`. + + diff --git a/doc/install/Troubleshooting.md b/doc/install/Troubleshooting.md new file mode 100644 index 000000000..8d82100d8 --- /dev/null +++ b/doc/install/Troubleshooting.md @@ -0,0 +1,7 @@ +### Mattermost Troubleshooting + +#### Important notes + +1. **DO NOT manipulate the Mattermost database** + - In particular, DO NOT delete data from the database, as this will most likely crash Mattermost in strange ways. Mattermost is designed to archive content continously and generally assumes data is never deleted. + |