summaryrefslogtreecommitdiff
path: root/doc/integration
diff options
context:
space:
mode:
Diffstat (limited to 'doc/integration')
-rw-r--r--doc/integration/auth0.md5
-rw-r--r--doc/integration/azure.md5
-rw-r--r--doc/integration/bitbucket.md10
-rw-r--r--doc/integration/cas.md8
-rw-r--r--doc/integration/facebook.md5
-rw-r--r--doc/integration/gitlab.md5
-rw-r--r--doc/integration/google.md5
-rw-r--r--doc/integration/jira_development_panel.md16
-rw-r--r--doc/integration/kerberos.md30
-rw-r--r--doc/integration/oauth2_generic.md4
-rw-r--r--doc/integration/openid_connect_provider.md7
-rw-r--r--doc/integration/saml.md9
-rw-r--r--doc/integration/trello_power_up.md4
-rw-r--r--doc/integration/twitter.md5
14 files changed, 35 insertions, 83 deletions
diff --git a/doc/integration/auth0.md b/doc/integration/auth0.md
index 521223e626b..d851b9f5dc7 100644
--- a/doc/integration/auth0.md
+++ b/doc/integration/auth0.md
@@ -81,13 +81,10 @@ application.
1. Change `YOUR_AUTH0_CLIENT_SECRET` to the client secret from the Auth0 Console
page from step 5.
-1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
On the sign in page there should now be an Auth0 icon below the regular sign in
form. Click the icon to begin the authentication process. Auth0 will ask the
user to sign in and authorize the GitLab application. If everything goes well
the user will be returned to GitLab and will be signed in.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/azure.md b/doc/integration/azure.md
index d6205b60f3d..75469fcbb98 100644
--- a/doc/integration/azure.md
+++ b/doc/integration/azure.md
@@ -81,10 +81,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
1. Save the configuration file.
-1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
On the sign in page there should now be a Microsoft icon below the regular sign in form. Click the icon to begin the authentication process. Microsoft will ask the user to sign in and authorize the GitLab application. If everything goes well the user will be returned to GitLab and will be signed in.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/bitbucket.md b/doc/integration/bitbucket.md
index ac462ff7bec..dc5c7a138f8 100644
--- a/doc/integration/bitbucket.md
+++ b/doc/integration/bitbucket.md
@@ -118,8 +118,8 @@ you to use.
from the Bitbucket application page.
1. Save the configuration file.
-1. For the changes to take effect, [reconfigure GitLab][] if you installed via
- Omnibus, or [restart][] if installed from source.
+1. For the changes to take effect, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) if you installed via
+ Omnibus, or [restart](../administration/restart_gitlab.md#installations-from-source) if installed from source.
On the sign in page there should now be a Bitbucket icon below the regular sign
in form. Click the icon to begin the authentication process. Bitbucket will ask
@@ -129,11 +129,7 @@ well, the user will be returned to GitLab and will be signed in.
## Bitbucket project import
Once the above configuration is set up, you can use Bitbucket to sign into
-GitLab and [start importing your projects][bb-import].
+GitLab and [start importing your projects](../user/project/import/bitbucket.md).
If you want to import projects from Bitbucket, but don't want to enable signing in,
you can [disable Sign-Ins in the admin panel](omniauth.md#enable-or-disable-sign-in-with-an-omniauth-provider-without-disabling-import-sources).
-
-[bb-import]: ../user/project/import/bitbucket.md
-[reconfigure GitLab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/cas.md b/doc/integration/cas.md
index cb92198f88d..cf4e501e772 100644
--- a/doc/integration/cas.md
+++ b/doc/integration/cas.md
@@ -57,10 +57,8 @@ To enable the CAS OmniAuth provider you must register your application with your
1. Save the configuration file.
-1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
- installed GitLab via Omnibus or from source respectively.
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or
+ [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to
+ take effect if you installed GitLab via Omnibus or from source respectively.
On the sign in page there should now be a CAS tab in the sign in form.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/facebook.md b/doc/integration/facebook.md
index 97623b2a782..fc65191994d 100644
--- a/doc/integration/facebook.md
+++ b/doc/integration/facebook.md
@@ -92,10 +92,7 @@ To enable the Facebook OmniAuth provider you must register your application with
1. Save the configuration file.
-1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
On the sign in page there should now be a Facebook icon below the regular sign in form. Click the icon to begin the authentication process. Facebook will ask the user to sign in and authorize the GitLab application. If everything goes well the user will be returned to GitLab and will be signed in.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/gitlab.md b/doc/integration/gitlab.md
index 36810e7c513..4e62f6389c8 100644
--- a/doc/integration/gitlab.md
+++ b/doc/integration/gitlab.md
@@ -75,12 +75,9 @@ GitLab.com will generate an application ID and secret key for you to use.
1. Save the configuration file.
-1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
On the sign in page there should now be a GitLab.com icon below the regular sign in form.
Click the icon to begin the authentication process. GitLab.com will ask the user to sign in and authorize the GitLab application.
If everything goes well the user will be returned to your GitLab instance and will be signed in.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/google.md b/doc/integration/google.md
index ee7e7fd6193..0f848bbc7aa 100644
--- a/doc/integration/google.md
+++ b/doc/integration/google.md
@@ -108,13 +108,10 @@ On your GitLab server:
```
1. Save the configuration file.
-1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
On the sign in page there should now be a Google icon below the regular sign in
form. Click the icon to begin the authentication process. Google will ask the
user to sign in and authorize the GitLab application. If everything goes well
the user will be returned to GitLab and will be signed in.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/jira_development_panel.md b/doc/integration/jira_development_panel.md
index 8b83f885fdd..7753629c371 100644
--- a/doc/integration/jira_development_panel.md
+++ b/doc/integration/jira_development_panel.md
@@ -1,9 +1,9 @@
# GitLab Jira development panel integration **(PREMIUM)**
-> [Introduced][ee-2381] in [GitLab Premium][eep] 10.0.
+> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2381) in [GitLab Premium](https://about.gitlab.com/pricing/) 10.0.
-Complementary to our [existing Jira][existing-jira] project integration, you're now able to integrate
-GitLab projects with [Jira Development Panel][jira-development-panel]. Both can be used
+Complementary to our [existing Jira](../user/project/integrations/jira.md) project integration, you're now able to integrate
+GitLab projects with [Jira Development Panel](https://confluence.atlassian.com/adminjiraserver070/). Both can be used
simultaneously. This works with self-managed GitLab or GitLab.com integrated with:
- Jira hosted by you.
@@ -17,7 +17,7 @@ as well as projects of the top-level group's subgroups nesting down, are connect
a GitLab personal namespace in the Jira configuration, which will then connect the projects in that personal namespace to Jira.
NOTE: **Note**:
-Note this is different from the [existing Jira][existing-jira] project integration, where the mapping
+Note this is different from the [existing Jira](../user/project/integrations/jira.md) project integration, where the mapping
is one GitLab project to the entire Jira instance.
We recommend that a GitLab group admin
@@ -164,7 +164,7 @@ Click the links to see your GitLab repository data.
## Limitations
-- This integration is currently not supported on GitLab instances under a [relative url][relative-url] (e.g. `http://example.com/gitlab`).
+- This integration is currently not supported on GitLab instances under a [relative url](https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-a-relative-url-for-gitlab) (for example, `http://example.com/gitlab`).
## Changelog
@@ -175,9 +175,3 @@ Click the links to see your GitLab repository data.
### 11.1
- [Support GitLab subgroups in Jira development panel](https://gitlab.com/gitlab-org/gitlab/issues/3561)
-
-[existing-jira]: ../user/project/integrations/jira.md
-[jira-development-panel]: https://confluence.atlassian.com/adminjiraserver070/integrating-with-development-tools-776637096.html#Integratingwithdevelopmenttools-Developmentpanelonissues
-[eep]: https://about.gitlab.com/pricing/
-[ee-2381]: https://gitlab.com/gitlab-org/gitlab/issues/2381
-[relative-url]: https://docs.gitlab.com/omnibus/settings/configuration.html#configuring-a-relative-url-for-gitlab
diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md
index b77f7a952aa..01bd2a8c0a0 100644
--- a/doc/integration/kerberos.md
+++ b/doc/integration/kerberos.md
@@ -1,18 +1,18 @@
# Kerberos integration **(STARTER ONLY)**
-GitLab can integrate with [Kerberos][kerb] as an authentication mechanism.
+GitLab can integrate with [Kerberos](https://web.mit.edu/kerberos/) as an authentication mechanism.
## Overview
-[Kerberos][kerb] is a secure method for authenticating a request for a service in a
+[Kerberos](https://web.mit.edu/kerberos/) is a secure method for authenticating a request for a service in a
computer network. Kerberos was developed in the Athena Project at the
-[Massachusetts Institute of Technology (MIT)][mit]. The name is taken from Greek
+[Massachusetts Institute of Technology (MIT)](http://web.mit.edu/). The name is taken from Greek
mythology; Kerberos was a three-headed dog who guarded the gates of Hades.
## Use-cases
- GitLab can be configured to allow your users to sign with their Kerberos credentials.
-- You can use Kerberos to [prevent][why-kerb] anyone from intercepting or eavesdropping on the transmitted password.
+- You can use Kerberos to [prevent](http://web.mit.edu/sipb/doc/working/guide/guide/node20.html) anyone from intercepting or eavesdropping on the transmitted password.
## Configuration
@@ -65,7 +65,7 @@ For source installations, make sure the `kerberos` gem group
keytab: /etc/http.keytab
```
-1. [Restart GitLab] for the changes to take effect.
+1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect.
**Omnibus package installations**
@@ -78,7 +78,7 @@ For source installations, make sure the `kerberos` gem group
gitlab_rails['kerberos_keytab'] = "/etc/http.keytab"
```
-1. [Reconfigure GitLab] for the changes to take effect.
+1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
GitLab will now offer the `negotiate` authentication method for signing in and
HTTP Git access, enabling Git clients that support this authentication protocol
@@ -165,7 +165,7 @@ keep offering only `basic` authentication.
https: true
```
-1. [Restart GitLab] and NGINX for the changes to take effect.
+1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) and NGINX for the changes to take effect.
**For Omnibus package installations**
@@ -177,7 +177,7 @@ keep offering only `basic` authentication.
gitlab_rails['kerberos_https'] = true
```
-1. [Reconfigure GitLab] for the changes to take effect.
+1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
After this change, all Git remote URLs will have to be updated to
`https://gitlab.example.com:8443/mygroup/myproject.git` in order to use
@@ -212,7 +212,7 @@ remove the OmniAuth provider named `kerberos` from your `gitlab.yml` /
- { name: 'kerberos' } # <-- remove this line
```
-1. [Restart GitLab] for the changes to take effect.
+1. [Restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect.
**For Omnibus installations**
@@ -225,7 +225,7 @@ remove the OmniAuth provider named `kerberos` from your `gitlab.yml` /
]
```
-1. [Reconfigure GitLab] for the changes to take effect.
+1. [Reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
## Support for Active Directory Kerberos environments
@@ -233,7 +233,7 @@ When using Kerberos ticket-based authentication in an Active Directory domain,
it may be necessary to increase the maximum header size allowed by NGINX,
as extensions to the Kerberos protocol may result in HTTP authentication headers
larger than the default size of 8kB. Configure `large_client_header_buffers`
-to a larger value in [the NGINX configuration][nginx].
+to a larger value in [the NGINX configuration](http://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers).
## Troubleshooting
@@ -293,11 +293,3 @@ See also: [Git v2.11 release notes](https://github.com/git/git/blob/master/Docum
- <https://help.ubuntu.com/community/Kerberos>
- <http://blog.manula.org/2012/04/setting-up-kerberos-server-with-debian.html>
- <https://www.roguelynn.com/words/explain-like-im-5-kerberos/>
-
-[restart gitlab]: ../administration/restart_gitlab.md#installations-from-source
-[reconfigure gitlab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[nginx]: http://nginx.org/en/docs/http/ngx_http_core_module.html#large_client_header_buffers
-[kerb]: https://web.mit.edu/kerberos/
-[mit]: http://web.mit.edu/
-[why-kerb]: http://web.mit.edu/sipb/doc/working/guide/guide/node20.html
-[ee]: https://about.gitlab.com/pricing/
diff --git a/doc/integration/oauth2_generic.md b/doc/integration/oauth2_generic.md
index 7fd96d727b5..8566134815a 100644
--- a/doc/integration/oauth2_generic.md
+++ b/doc/integration/oauth2_generic.md
@@ -51,7 +51,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings
-1. Add the provider-specific configuration for your provider, as [described in the gem's README][1]
+1. Add the provider-specific configuration for your provider, as [described in the gem's README](https://gitlab.com/satorix/omniauth-oauth2-generic#gitlab-config-example)
1. Save the configuration file
@@ -61,5 +61,3 @@ On the sign in page there should now be a new button below the regular sign in f
Click the button to begin your provider's authentication process. This will direct
the browser to your OAuth2 Provider's authentication page. If everything goes well
the user will be returned to your GitLab instance and will be signed in.
-
-[1]: https://gitlab.com/satorix/omniauth-oauth2-generic#gitlab-config-example
diff --git a/doc/integration/openid_connect_provider.md b/doc/integration/openid_connect_provider.md
index f75630b93a2..3da17347e91 100644
--- a/doc/integration/openid_connect_provider.md
+++ b/doc/integration/openid_connect_provider.md
@@ -16,13 +16,13 @@ mobile applications.
On the client side, you can use [OmniAuth::OpenIDConnect](https://github.com/jjbohn/omniauth-openid-connect/) for Rails
applications, or any of the other available [client implementations](https://openid.net/developers/libraries/#connect).
-GitLab's implementation uses the [doorkeeper-openid_connect] gem, refer
+GitLab's implementation uses the [doorkeeper-openid_connect](https://github.com/doorkeeper-gem/doorkeeper-openid_connect "Doorkeeper::OpenidConnect website") gem, refer
to its README for more details about which parts of the specifications
are supported.
## Enabling OpenID Connect for OAuth applications
-Refer to the [OAuth guide] for basic information on how to set up OAuth
+Refer to the [OAuth guide](oauth_provider.md) for basic information on how to set up OAuth
applications in GitLab. To enable OIDC for an application, all you have to do
is select the `openid` scope in the application settings.
@@ -45,6 +45,3 @@ Currently the following user information is shared with clients:
| `groups` | `array` | Names of the groups the user is a member of
Only the `sub` and `sub_legacy` claims are included in the ID token, all other claims are available from the `/oauth/userinfo` endpoint used by OIDC clients.
-
-[doorkeeper-openid_connect]: https://github.com/doorkeeper-gem/doorkeeper-openid_connect "Doorkeeper::OpenidConnect website"
-[OAuth guide]: oauth_provider.md "GitLab as OAuth2 authentication service provider"
diff --git a/doc/integration/saml.md b/doc/integration/saml.md
index b4f5bfda8c5..47ffe333c0f 100644
--- a/doc/integration/saml.md
+++ b/doc/integration/saml.md
@@ -120,7 +120,7 @@ in your SAML IdP:
1. Change the value of `issuer` to a unique name, which will identify the application
to the IdP.
-1. For the changes to take effect, you must [reconfigure][] GitLab if you installed via Omnibus or [restart GitLab][] if you installed from source.
+1. For the changes to take effect, you must [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab if you installed via Omnibus or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) if you installed from source.
1. Register the GitLab SP in your SAML 2.0 IdP, using the application name specified
in `issuer`.
@@ -294,7 +294,7 @@ If you want some SAML authentication methods to count as 2FA on a per session ba
]
```
-1. Save the file and [reconfigure][] GitLab for the changes to take effect.
+1. Save the file and [reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) GitLab for the changes to take effect.
---
@@ -324,7 +324,7 @@ If you want some SAML authentication methods to count as 2FA on a per session ba
}
```
-1. Save the file and [restart GitLab][] for the changes ot take effect
+1. Save the file and [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes ot take effect
In addition to the changes in GitLab, make sure that your Idp is returning the
`AuthnContext`. For example:
@@ -630,6 +630,3 @@ For this you need take the following into account:
Make sure that one of the above described scenarios is valid, or the requests will
fail with one of the mentioned errors.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
diff --git a/doc/integration/trello_power_up.md b/doc/integration/trello_power_up.md
index 834d63d1166..fc55dbb9654 100644
--- a/doc/integration/trello_power_up.md
+++ b/doc/integration/trello_power_up.md
@@ -36,7 +36,5 @@ from Trello.
your user **Settings** > **Access Tokens**.
Learn more about generating a personal access token in the
-[Personal Access Token Documentation][personal-access-token-documentation].
+[Personal Access Token Documentation](../user/profile/personal_access_tokens.md).
Don't forget to check the API scope checkbox!
-
-[personal-access-token-documentation]: ../user/profile/personal_access_tokens.md
diff --git a/doc/integration/twitter.md b/doc/integration/twitter.md
index 8056c672d67..95de56f24d8 100644
--- a/doc/integration/twitter.md
+++ b/doc/integration/twitter.md
@@ -75,10 +75,7 @@ To enable the Twitter OmniAuth provider you must register your application with
1. Save the configuration file.
-1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
+1. [Reconfigure](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) or [restart GitLab](../administration/restart_gitlab.md#installations-from-source) for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
On the sign in page there should now be a Twitter icon below the regular sign in form. Click the icon to begin the authentication process. Twitter will ask the user to sign in and authorize the GitLab application. If everything goes well the user will be returned to GitLab and will be signed in.
-
-[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
-[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
View Lorry Controller Status