summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/integration/ldap.md11
-rw-r--r--doc/integration/saml.md12
-rw-r--r--doc/project_services/jira.md4
3 files changed, 10 insertions, 17 deletions
diff --git a/doc/integration/ldap.md b/doc/integration/ldap.md
index ac15a2cdffc..cf1f98492ea 100644
--- a/doc/integration/ldap.md
+++ b/doc/integration/ldap.md
@@ -207,9 +207,7 @@ the LDAP server's SSL certificate is performed.
## Troubleshooting
-### Common problems
-
-**Invalid credentials when logging in**
+### Invalid credentials when logging in
Make sure the user you are binding with has enough permissions to read the user's
tree and traverse it.
@@ -219,15 +217,12 @@ Also make sure that the `user_filter` is not blocking otherwise valid users.
To make sure that the LDAP settings are correct and GitLab can see your users,
execute the following command:
-For Omnibus installations:
```bash
+# For Omnibus installations
sudo gitlab-rake gitlab:ldap:check
-```
-For installations from source:
-
-```bash
+# For installations from source
sudo -u git -H bundle exec rake gitlab:ldap:check RAILS_ENV=production
```
diff --git a/doc/integration/saml.md b/doc/integration/saml.md
index 16e47bb99b0..148c4ac1886 100644
--- a/doc/integration/saml.md
+++ b/doc/integration/saml.md
@@ -133,9 +133,7 @@ will be returned to GitLab and will be signed in.
## Troubleshooting
-### Common problems
-
-**500 error after login**
+### 500 error after login
If you see a "500 error" in GitLab when you are redirected back from the SAML sign in page,
this likely indicates that GitLab could not get the email address for the SAML user.
@@ -143,7 +141,7 @@ this likely indicates that GitLab could not get the email address for the SAML u
Make sure the IdP provides a claim containing the user's email address, using claim name
`email` or `mail`.
-**Redirect back to login screen with no evident error**
+### Redirect back to login screen with no evident error
If after signing in into your SAML server you are redirected back to the sign in page and
no error is displayed, check your `production.log` file. It will most likely contain the
@@ -155,13 +153,13 @@ To bypass this you can add `skip_before_action :verify_authenticity_token` to th
where it can then be seen in the usual logs, or as a flash message in the login
screen.
-**Invalid audience**
+### Invalid audience
This error means that the IdP doesn't recognize GitLab as a valid sender and
receiver of SAML requests. Make sure to add the GitLab callback URL to the approved
audiences of the IdP server.
-**Missing claims**
+### Missing claims
The IdP server needs to pass certain information in order for GitLab to either
create an account, or match the login information to an existing account. `email`
@@ -170,7 +168,7 @@ is not providing this information, all SAML requests will fail.
Make sure this information is provided.
-**Key validation error, Digest mismatch or Fingerprint mismatch**
+### Key validation error, Digest mismatch or Fingerprint mismatch
These errors all come from a similar place, the SAML certificate. SAML requests
need to be validated using a fingerprint, a certificate or a validator.
diff --git a/doc/project_services/jira.md b/doc/project_services/jira.md
index 623ec857cbe..27170c1eb19 100644
--- a/doc/project_services/jira.md
+++ b/doc/project_services/jira.md
@@ -222,13 +222,13 @@ You can see from the above image that there are four references to GitLab:
## Troubleshooting
-**GitLab is unable to comment on a ticket**
+### GitLab is unable to comment on a ticket
Make sure that the user you set up for GitLab to communicate with JIRA has the
correct access permission to post comments on a ticket and to also transition the
ticket, if you'd like GitLab to also take care of closing them.
-**GitLab is unable to close a ticket**
+### GitLab is unable to close a ticket
Make sure the the `Transition ID` you set within the JIRA settings matches the
one your project needs to close a ticket.