diff options
Diffstat (limited to 'doc/integration/index.md')
| -rw-r--r-- | doc/integration/index.md | 108 |
1 files changed, 56 insertions, 52 deletions
diff --git a/doc/integration/index.md b/doc/integration/index.md index 147edcc9e0f..b2a4201e88c 100644 --- a/doc/integration/index.md +++ b/doc/integration/index.md @@ -7,56 +7,67 @@ comments: false # GitLab integrations **(FREE)** -GitLab can be integrated with external services for enhanced functionality. +You can integrate GitLab with external services for enhanced functionality. ## Services -Services such as Campfire, Flowdock, Jira, Pivotal Tracker, and Slack are available as [integrations](../user/project/integrations/index.md). +Services such as Campfire, Flowdock, Jira, Pivotal Tracker, and Slack +are available as [integrations](../user/project/integrations/index.md). ## Issue trackers -You can use an [external issue tracker](external-issue-tracker.md) at the same time as the GitLab -issue tracker, or use only the external issue tracker. +You can use an [external issue tracker](external-issue-tracker.md) with the GitLab +issue tracker or use an external issue tracker only. ## Authentication sources -GitLab can be configured to authenticate access requests with the following authentication sources: +You can integrate GitLab with the following authentication sources: - Enable the [Auth0 OmniAuth](auth0.md) provider. -- Enable sign in with [Bitbucket](bitbucket.md) accounts. -- Integrate with [Kerberos](kerberos.md). -- Enable sign in via [LDAP](../administration/auth/ldap/index.md). -- Enable [OAuth2 provider](oauth_provider.md) application creation. -- Use [OmniAuth](omniauth.md) to enable sign in through Twitter, GitHub, GitLab.com, Google, - Bitbucket, Facebook, SAML, Crowd, Azure, or Authentiq ID. +- Enable sign-in with [Bitbucket](bitbucket.md) accounts. +- Authenticate with [Kerberos](kerberos.md). +- Enable sign-in with [LDAP](../administration/auth/ldap/index.md). +- Enable creating [OAuth 2.0](oauth_provider.md) applications. +- Use [OmniAuth](omniauth.md) to enable sign-in through: + - Authentiq ID + - Azure + - Bitbucket + - Crowd + - Facebook + - GitHub + - GitLab.com + - Google + - SAML + - Twitter - Use GitLab as an [OpenID Connect](openid_connect_provider.md) identity provider. -- Authenticate to [Vault](vault.md) through GitLab OpenID Connect. -- Configure GitLab as a [SAML](saml.md) 2.0 Service Provider. +- Authenticate with [Vault](vault.md) through GitLab OpenID Connect. +- Configure GitLab as a [SAML 2.0](saml.md) Service Provider. ## Security enhancements -GitLab can be integrated with the following external services to enhance security: +You can integrate GitLab with the following security enhancements: -- [Akismet](akismet.md) helps reduce spam. -- Google [reCAPTCHA](recaptcha.md) helps verify new users. +- [Akismet](akismet.md) to reduce spam. +- Google [reCAPTCHA](recaptcha.md) to verify new users. -GitLab also provides features to improve the security of your own application. For more details see [GitLab Secure](../user/application_security/index.md). +GitLab also provides features to improve the security of your own application. +For more details, see [Secure your application](../user/application_security/index.md). ## Security partners -GitLab has integrated with several security partners. For more information, see -[Security partners integration](security_partners/index.md). +You can integrate GitLab with several security partners. For more information, see +[Security partner integrations](security_partners/index.md). ## Continuous integration -GitLab can be integrated with the following external services for continuous integration: +You can integrate GitLab with the following external services for continuous integration: - [Jenkins](jenkins.md) CI. -- [Datadog](datadog.md), to monitor for CI/CD job failures and performance issues. +- [Datadog](datadog.md) to monitor for CI/CD job failures and performance issues. ## Feature enhancements -GitLab can be integrated with the following enhancements: +You can integrate GitLab with the following feature enhancements: - Add GitLab actions to [Gmail actions buttons](gmail_action_buttons_for_gitlab.md). - Configure [PlantUML](../administration/integration/plantuml.md) @@ -69,40 +80,28 @@ or [Kroki](../administration/integration/kroki.md) to use diagrams in AsciiDoc a ### SSL certificate errors -When trying to integrate GitLab with services using self-signed certificates, -SSL certificate errors can occur in different parts of the application. Sidekiq -is a common culprit. +When integrating GitLab with services using a self-signed certificate, you might +encounter SSL certificate errors in different parts of the application. -There are two approaches you can take to solve this: +As a workaround, you can do one of the following: -1. Add the root certificate to the trusted chain of the OS. -1. If using Omnibus, you can add the certificate to the GitLab trusted certificates. +- Add the certificate to the OS trusted chain. See: + - [Adding trusted root certificates to the server](https://manuals.gfi.com/en/kerio/connect/content/server-configuration/ssl-certificates/adding-trusted-root-certificates-to-the-server-1605.html) + - [How do you add a certificate authority (CA) to Ubuntu?](https://superuser.com/questions/437330/how-do-you-add-a-certificate-authority-ca-to-ubuntu) +- In Omnibus GitLab, add the certificate to the Omnibus trusted chain: + 1. [Install the self-signed certificate](https://docs.gitlab.com/omnibus/settings/ssl.html#install-custom-public-certificates). + 1. Concatenate the self-signed certificate with the GitLab trusted certificate. + The self-signed certificate might be overwritten during upgrades. -**OS main trusted chain** + ```shell + cat jira.pem >> /opt/gitlab/embedded/ssl/certs/cacert.pem + ``` -This [resource](https://manuals.gfi.com/en/kerio/connect/content/server-configuration/ssl-certificates/adding-trusted-root-certificates-to-the-server-1605.html) -has all the information you need to add a certificate to the main trusted chain. + 1. Restart GitLab. -This [answer](https://superuser.com/questions/437330/how-do-you-add-a-certificate-authority-ca-to-ubuntu) -at Super User also has relevant information. - -**Omnibus Trusted Chain** - -[Install the self signed certificate or custom certificate authorities](https://docs.gitlab.com/omnibus/troubleshooting.html#using-self-signed-certificate-or-custom-certificate-authorities) -in to Omnibus GitLab. - -It is enough to concatenate the certificate to the main trusted certificate -however it may be overwritten during upgrades: - -```shell -cat jira.pem >> /opt/gitlab/embedded/ssl/certs/cacert.pem -``` - -After that restart GitLab with: - -```shell -sudo gitlab-ctl restart -``` + ```shell + sudo gitlab-ctl restart + ``` ### Search Sidekiq logs in Kibana @@ -112,4 +111,9 @@ To locate a specific integration in Kibana, use the following KQL search string: `json.integration_class.keyword : "Integrations::Jira" and json.project_path : "path/to/project"` ``` -You can find information in `json.exception.backtrace`, `json.exception.class`, `json.exception.message`, and `json.message`. +You can find information in: + +- `json.exception.backtrace` +- `json.exception.class` +- `json.exception.message` +- `json.message` |