Commit 0b7b0d66 authored by Russell Dickenson's avatar Russell Dickenson Committed by Achilleas Pipinellis

Removed reference style links

- Replaced reference style links with the current
  GitLab docs standard.
parent c056c7bf
# Search API # Search API
[Introduced][ce-41763] in GitLab 10.5 > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/41763) in GitLab 10.5.
Every API call to search must be authenticated. Every API call to search must be authenticated.
...@@ -312,7 +312,7 @@ Example response: ...@@ -312,7 +312,7 @@ Example response:
] ]
``` ```
**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). **Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/issues/34521).
### Scope: commits **(STARTER)** ### Scope: commits **(STARTER)**
...@@ -383,7 +383,7 @@ Example response: ...@@ -383,7 +383,7 @@ Example response:
] ]
``` ```
**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). **Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/issues/34521).
### Scope: users ### Scope: users
...@@ -653,7 +653,7 @@ Example response: ...@@ -653,7 +653,7 @@ Example response:
] ]
``` ```
**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). **Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/issues/34521).
### Scope: commits **(STARTER)** ### Scope: commits **(STARTER)**
...@@ -724,7 +724,7 @@ Example response: ...@@ -724,7 +724,7 @@ Example response:
] ]
``` ```
**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). **Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/issues/34521).
### Scope: users ### Scope: users
...@@ -1009,7 +1009,7 @@ Example response: ...@@ -1009,7 +1009,7 @@ Example response:
] ]
``` ```
**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). **Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/issues/34521).
### Scope: commits ### Scope: commits
...@@ -1082,7 +1082,7 @@ Example response: ...@@ -1082,7 +1082,7 @@ Example response:
] ]
``` ```
**Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path (see [this issue][gitlab-34521]). **Note:** `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/issues/34521).
### Scope: users ### Scope: users
...@@ -1104,6 +1104,3 @@ Example response: ...@@ -1104,6 +1104,3 @@ Example response:
} }
] ]
``` ```
[ce-41763]: https://gitlab.com/gitlab-org/gitlab-foss/issues/41763
[gitlab-34521]: https://gitlab.com/gitlab-org/gitlab/issues/34521
This diff is collapsed.
...@@ -81,13 +81,10 @@ application. ...@@ -81,13 +81,10 @@ application.
1. Change `YOUR_AUTH0_CLIENT_SECRET` to the client secret from the Auth0 Console 1. Change `YOUR_AUTH0_CLIENT_SECRET` to the client secret from the Auth0 Console
page from step 5. 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. 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 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 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 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. 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
...@@ -81,10 +81,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap ...@@ -81,10 +81,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
1. Save the configuration file. 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. 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. 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
...@@ -118,8 +118,8 @@ you to use. ...@@ -118,8 +118,8 @@ you to use.
from the Bitbucket application page. from the Bitbucket application page.
1. Save the configuration file. 1. Save the configuration file.
1. For the changes to take effect, [reconfigure GitLab][] if you installed via 1. For the changes to take effect, [reconfigure GitLab](../administration/restart_gitlab.md#omnibus-gitlab-reconfigure) if you installed via
Omnibus, or [restart][] if installed from source. 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 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 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. ...@@ -129,11 +129,7 @@ well, the user will be returned to GitLab and will be signed in.
## Bitbucket project import ## Bitbucket project import
Once the above configuration is set up, you can use Bitbucket to sign into 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, 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). 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
...@@ -57,10 +57,8 @@ To enable the CAS OmniAuth provider you must register your application with your ...@@ -57,10 +57,8 @@ To enable the CAS OmniAuth provider you must register your application with your
1. Save the configuration file. 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
installed GitLab via Omnibus or from source respectively. [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. 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
...@@ -92,10 +92,7 @@ To enable the Facebook OmniAuth provider you must register your application with ...@@ -92,10 +92,7 @@ To enable the Facebook OmniAuth provider you must register your application with
1. Save the configuration file. 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. 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. 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
...@@ -75,12 +75,9 @@ GitLab.com will generate an application ID and secret key for you to use. ...@@ -75,12 +75,9 @@ GitLab.com will generate an application ID and secret key for you to use.
1. Save the configuration file. 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. 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. 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. 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. 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
...@@ -108,13 +108,10 @@ On your GitLab server: ...@@ -108,13 +108,10 @@ On your GitLab server:
``` ```
1. Save the configuration file. 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. 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 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 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 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. 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
# GitLab Jira development panel integration **(PREMIUM)** # 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 Complementary to our [existing Jira](../user/project/integrations/jira.md) project integration, you're now able to integrate
GitLab projects with [Jira Development Panel][jira-development-panel]. Both can be used 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: simultaneously. This works with self-managed GitLab or GitLab.com integrated with:
- Jira hosted by you. - Jira hosted by you.
...@@ -17,7 +17,7 @@ as well as projects of the top-level group's subgroups nesting down, are connect ...@@ -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. a GitLab personal namespace in the Jira configuration, which will then connect the projects in that personal namespace to Jira.
NOTE: **Note**: 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. is one GitLab project to the entire Jira instance.
We recommend that a GitLab group admin We recommend that a GitLab group admin
...@@ -164,7 +164,7 @@ Click the links to see your GitLab repository data. ...@@ -164,7 +164,7 @@ Click the links to see your GitLab repository data.
## Limitations ## 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 ## Changelog
...@@ -175,9 +175,3 @@ Click the links to see your GitLab repository data. ...@@ -175,9 +175,3 @@ Click the links to see your GitLab repository data.
### 11.1 ### 11.1
- [Support GitLab subgroups in Jira development panel](https://gitlab.com/gitlab-org/gitlab/issues/3561) - [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
# Kerberos integration **(STARTER ONLY)** # 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 ## 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 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. mythology; Kerberos was a three-headed dog who guarded the gates of Hades.
## Use-cases ## Use-cases
- GitLab can be configured to allow your users to sign with their Kerberos credentials. - 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 ## Configuration
...@@ -65,7 +65,7 @@ For source installations, make sure the `kerberos` gem group ...@@ -65,7 +65,7 @@ For source installations, make sure the `kerberos` gem group
keytab: /etc/http.keytab 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** **Omnibus package installations**
...@@ -78,7 +78,7 @@ For source installations, make sure the `kerberos` gem group ...@@ -78,7 +78,7 @@ For source installations, make sure the `kerberos` gem group
gitlab_rails['kerberos_keytab'] = "/etc/http.keytab" 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 GitLab will now offer the `negotiate` authentication method for signing in and
HTTP Git access, enabling Git clients that support this authentication protocol HTTP Git access, enabling Git clients that support this authentication protocol
...@@ -165,7 +165,7 @@ keep offering only `basic` authentication. ...@@ -165,7 +165,7 @@ keep offering only `basic` authentication.
https: true 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** **For Omnibus package installations**
...@@ -177,7 +177,7 @@ keep offering only `basic` authentication. ...@@ -177,7 +177,7 @@ keep offering only `basic` authentication.
gitlab_rails['kerberos_https'] = true 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 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 `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` / ...@@ -212,7 +212,7 @@ remove the OmniAuth provider named `kerberos` from your `gitlab.yml` /
- { name: 'kerberos' } # <-- remove this line - { 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** **For Omnibus installations**
...@@ -225,7 +225,7 @@ remove the OmniAuth provider named `kerberos` from your `gitlab.yml` / ...@@ -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 ## Support for Active Directory Kerberos environments
...@@ -233,7 +233,7 @@ When using Kerberos ticket-based authentication in an Active Directory domain, ...@@ -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, 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 as extensions to the Kerberos protocol may result in HTTP authentication headers
larger than the default size of 8kB. Configure `large_client_header_buffers` 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 ## Troubleshooting
...@@ -293,11 +293,3 @@ See also: [Git v2.11 release notes](https://github.com/git/git/blob/master/Docum ...@@ -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> - <https://help.ubuntu.com/community/Kerberos>
- <http://blog.manula.org/2012/04/setting-up-kerberos-server-with-debian.html> - <http://blog.manula.org/2012/04/setting-up-kerberos-server-with-debian.html>
- <https://www.roguelynn.com/words/explain-like-im-5-kerberos/> - <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/
...@@ -51,7 +51,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc ...@@ -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. 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 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 ...@@ -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 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 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. 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
...@@ -16,13 +16,13 @@ mobile applications. ...@@ -16,13 +16,13 @@ mobile applications.
On the client side, you can use [OmniAuth::OpenIDConnect](https://github.com/jjbohn/omniauth-openid-connect/) for Rails 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). 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 to its README for more details about which parts of the specifications
are supported. are supported.
## Enabling OpenID Connect for OAuth applications ## 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 applications in GitLab. To enable OIDC for an application, all you have to do
is select the `openid` scope in the application settings. is select the `openid` scope in the application settings.
...@@ -45,6 +45,3 @@ Currently the following user information is shared with clients: ...@@ -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 | `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. 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"
...@@ -120,7 +120,7 @@ in your SAML IdP: ...@@ -120,7 +120,7 @@ in your SAML IdP:
1. Change the value of `issuer` to a unique name, which will identify the application 1. Change the value of `issuer` to a unique name, which will identify the application
to the IdP. 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 1. Register the GitLab SP in your SAML 2.0 IdP, using the application name specified
in `issuer`. in `issuer`.
...@@ -294,7 +294,7 @@ If you want some SAML authentication methods to count as 2FA on a per session ba ...@@ -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 ...@@ -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 In addition to the changes in GitLab, make sure that your Idp is returning the
`AuthnContext`. For example: `AuthnContext`. For example:
...@@ -630,6 +630,3 @@ For this you need take the following into account: ...@@ -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 Make sure that one of the above described scenarios is valid, or the requests will
fail with one of the mentioned errors. fail with one of the mentioned errors.
[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source
...@@ -36,7 +36,5 @@ from Trello. ...@@ -36,7 +36,5 @@ from Trello.
your user **Settings** > **Access Tokens**. your user **Settings** > **Access Tokens**.
Learn more about generating a personal access token in the 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! Don't forget to check the API scope checkbox!
[personal-access-token-documentation]: ../user/profile/personal_access_tokens.md
...@@ -75,10 +75,7 @@ To enable the Twitter OmniAuth provider you must register your application with ...@@ -75,10 +75,7 @@ To enable the Twitter OmniAuth provider you must register your application with
1. Save the configuration file. 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. 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. 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
...@@ -44,12 +44,12 @@ That's all! You can now start using the Slack slash commands. ...@@ -44,12 +44,12 @@ That's all! You can now start using the Slack slash commands.
## Usage ## Usage
After confirming the installation, you, and everyone else in your Slack team, After confirming the installation, you, and everyone else in your Slack team,
can use all the [slash commands]. can use all the [slash commands](../../../integration/slash_commands.md).
When you perform your first slash command you will be asked to authorize your When you perform your first slash command you will be asked to authorize your
Slack user on GitLab.com. Slack user on GitLab.com.
The only difference with the [manually configurable Slack slash commands][slack-manual] The only difference with the [manually configurable Slack slash commands](slack_slash_commands.md)
is that all the commands should be prefixed with the `/gitlab` keyword. is that all the commands should be prefixed with the `/gitlab` keyword.
We are working on making this configurable in the future. We are working on making this configurable in the future.
...@@ -59,6 +59,3 @@ project, you would do: ...@@ -59,6 +59,3 @@ project, you would do:
```plaintext ```plaintext
/gitlab gitlab-org/gitlab issue show 1001 /gitlab gitlab-org/gitlab issue show 1001
``` ```
[slash commands]: ../../../integration/slash_commands.md
[slack-manual]: slack_slash_commands.md
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
You can find the available integrations under your project's You can find the available integrations under your project's
**Settings ➔ Integrations** page. You need to have at least **Settings ➔ Integrations** page. You need to have at least
[maintainer permission][permissions] on the project. [maintainer permission](../../permissions.md) on the project.
## Integrations ## Integrations
...@@ -20,5 +20,3 @@ like pushes, issues or merge requests. GitLab will send a POST request with data ...@@ -20,5 +20,3 @@ like pushes, issues or merge requests. GitLab will send a POST request with data
to the webhook URL. to the webhook URL.
[Learn more about webhooks.](webhooks.md) [Learn more about webhooks.](webhooks.md)
[permissions]: ../../permissions.md
...@@ -37,7 +37,7 @@ configured. Therefore, you will not have to explicitly associate ...@@ -37,7 +37,7 @@ configured. Therefore, you will not have to explicitly associate
a GitLab project with any single Jira project. a GitLab project with any single Jira project.
If you have one Jira instance, you can pre-fill the settings page with a default If you have one Jira instance, you can pre-fill the settings page with a default
template. See the [Services Templates][services-templates] docs. template. See the [Services Templates](services_templates.md) docs.
In order to enable the Jira service in GitLab, you need to first configure the project in Jira and then enter the correct values in GitLab. In order to enable the Jira service in GitLab, you need to first configure the project in Jira and then enter the correct values in GitLab.
...@@ -212,5 +212,3 @@ which may lead to a `401 unauthorized` error when testing your Jira integration. ...@@ -212,5 +212,3 @@ which may lead to a `401 unauthorized` error when testing your Jira integration.
If CAPTCHA has been triggered, you will not be able to use Jira's REST API to If CAPTCHA has been triggered, you will not be able to use Jira's REST API to
authenticate with the Jira site. You will need to log in to your Jira instance authenticate with the Jira site. You will need to log in to your Jira instance
and complete the CAPTCHA. and complete the CAPTCHA.
[services-templates]: services_templates.md
...@@ -15,7 +15,7 @@ Mattermost 3.4 and up is required. ...@@ -15,7 +15,7 @@ Mattermost 3.4 and up is required.
If you have the Omnibus GitLab package installed, Mattermost is already bundled If you have the Omnibus GitLab package installed, Mattermost is already bundled
in it. All you have to do is configure it. Read more in the in it. All you have to do is configure it. Read more in the
[Omnibus GitLab Mattermost documentation][omnimmdocs]. [Omnibus GitLab Mattermost documentation](https://docs.gitlab.com/omnibus/gitlab-mattermost/).
## Automated Configuration ## Automated Configuration
...@@ -133,7 +133,7 @@ The available slash commands are: ...@@ -133,7 +133,7 @@ The available slash commands are:
| ------- | ----------- | ------- | | ------- | ----------- | ------- |
| <kbd>/&lt;trigger&gt; issue new &lt;title&gt; <kbd>⇧ Shift</kbd>+<kbd>↵ Enter</kbd> &lt;description&gt;</kbd> | Create a new issue in the project that `<trigger>` is tied to. `<description>` is optional. | `/gitlab issue new We need to change the homepage` | | <kbd>/&lt;trigger&gt; issue new &lt;title&gt; <kbd>⇧ Shift</kbd>+<kbd>↵ Enter</kbd> &lt;description&gt;</kbd> | Create a new issue in the project that `<trigger>` is tied to. `<description>` is optional. | `/gitlab issue new We need to change the homepage` |
| <kbd>/&lt;trigger&gt; issue show &lt;issue-number&gt;</kbd> | Show the issue with ID `<issue-number>` from the project that `<trigger>` is tied to. | `/gitlab issue show 42` | | <kbd>/&lt;trigger&gt; issue show &lt;issue-number&gt;</kbd> | Show the issue with ID `<issue-number>` from the project that `<trigger>` is tied to. | `/gitlab issue show 42` |
| <kbd>/&lt;trigger&gt; deploy &lt;environment&gt; to &lt;environment&gt;</kbd> | Start the CI job that deploys from one environment to another, for example `staging` to `production`. CI/CD must be [properly configured][ciyaml]. | `/gitlab deploy staging to production` | | <kbd>/&lt;trigger&gt; deploy &lt;environment&gt; to &lt;environment&gt;</kbd> | Start the CI job that deploys from one environment to another, for example `staging` to `production`. CI/CD must be [properly configured](../../../ci/yaml/README.md). | `/gitlab deploy staging to production` |
To see a list of available commands to interact with GitLab, type the To see a list of available commands to interact with GitLab, type the
trigger word followed by <kbd>help</kbd>. Example: `/gitlab help` trigger word followed by <kbd>help</kbd>. Example: `/gitlab help`
...@@ -147,9 +147,5 @@ the [permissions you have on the project](../../permissions.md#project-members-p ...@@ -147,9 +147,5 @@ the [permissions you have on the project](../../permissions.md#project-members-p
## Further reading ## Further reading
- [Mattermost slash commands documentation][mmslashdocs] - [Mattermost slash commands documentation](https://docs.mattermost.com/developer/slash-commands.html)
- [Omnibus GitLab Mattermost][omnimmdocs] - [Omnibus GitLab Mattermost](https://docs.gitlab.com/omnibus/gitlab-mattermost/)
[omnimmdocs]: https://docs.gitlab.com/omnibus/gitlab-mattermost/
[mmslashdocs]: https://docs.mattermost.com/developer/slash-commands.html
[ciyaml]: ../../../ci/yaml/README.md
# Prometheus integration # Prometheus integration
> [Introduced][ce-8935] in GitLab 9.0. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8935) in GitLab 9.0.
GitLab offers powerful integration with [Prometheus] for monitoring key metrics of your apps, directly within GitLab. GitLab offers powerful integration with [Prometheus](https://prometheus.io) for monitoring key metrics of your apps, directly within GitLab.
Metrics for each environment are retrieved from Prometheus, and then displayed Metrics for each environment are retrieved from Prometheus, and then displayed
within the GitLab interface. within the GitLab interface.
...@@ -727,7 +727,7 @@ If the metric exceeds the threshold of the alert for over 5 minutes, an email wi ...@@ -727,7 +727,7 @@ If the metric exceeds the threshold of the alert for over 5 minutes, an email wi
## Determining the performance impact of a merge ## Determining the performance impact of a merge
> - [Introduced][ce-10408] in GitLab 9.2. > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10408) in GitLab 9.2.
> - GitLab 9.3 added the [numeric comparison](https://gitlab.com/gitlab-org/gitlab-foss/issues/27439) of the 30 minute averages. > - GitLab 9.3 added the [numeric comparison](https://gitlab.com/gitlab-org/gitlab-foss/issues/27439) of the 30 minute averages.
Developers can view the performance impact of their changes within the merge Developers can view the performance impact of their changes within the merge
...@@ -755,7 +755,7 @@ Prometheus server. ...@@ -755,7 +755,7 @@ Prometheus server.
### Embedding GitLab-managed Kubernetes metrics ### Embedding GitLab-managed Kubernetes metrics
> [Introduced][ce-29691] in GitLab 12.2. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29691) in GitLab 12.2.
It is possible to display metrics charts within [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm) fields such as issue or merge request descriptions. The maximum number of embedded charts allowed in a GitLab Flavored Markdown field is 100. It is possible to display metrics charts within [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm) fields such as issue or merge request descriptions. The maximum number of embedded charts allowed in a GitLab Flavored Markdown field is 100.
...@@ -895,18 +895,3 @@ If the "No data found" screen continues to appear, it could be due to: ...@@ -895,18 +895,3 @@ If the "No data found" screen continues to appear, it could be due to:
[run a query](prometheus_library/kubernetes.md#metrics-supported), replacing `$CI_ENVIRONMENT_SLUG` [run a query](prometheus_library/kubernetes.md#metrics-supported), replacing `$CI_ENVIRONMENT_SLUG`
with the name of your environment. with the name of your environment.
- You may need to re-add the GitLab predefined common metrics. This can be done by running the [import common metrics Rake task](../../../administration/raketasks/maintenance.md#import-common-metrics). - You may need to re-add the GitLab predefined common metrics. This can be done by running the [import common metrics Rake task](../../../administration/raketasks/maintenance.md#import-common-metrics).
[autodeploy]: ../../../topics/autodevops/index.md#auto-deploy
[kubernetes]: https://kubernetes.io
[kube]: ./kubernetes.md
[prometheus-k8s-sd]: https://prometheus.io/docs/operating/configuration/#<kubernetes_sd_config>
[prometheus]: https://prometheus.io
[gitlab-prometheus-k8s-monitor]: ../../../administration/monitoring/prometheus/index.md#configuring-prometheus-to-monitor-kubernetes
[prometheus-docker-image]: https://hub.docker.com/r/prom/prometheus/
[prometheus-yml]:samples/prometheus.yml
[gitlab.com-ip-range]: https://gitlab.com/gitlab-com/infrastructure/issues/434
[ci-environment-slug]: ../../../ci/variables/#predefined-environment-variables
[ce-8935]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8935
[ce-10408]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10408
[ce-29691]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29691
[promgldocs]: ../../../administration/monitoring/prometheus/index.md
# Advanced Global Search **(STARTER ONLY)** # Advanced Global Search **(STARTER ONLY)**
> - [Introduced][ee-109] in GitLab [Starter][ee] 8.4. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109) in GitLab [Starter](https://about.gitlab.com/pricing/) 8.4.
> - This is the user documentation. To install and configure Elasticsearch, > - This is the user documentation. To install and configure Elasticsearch,
> visit the [administrator documentation](../../integration/elasticsearch.md). > visit the [administrator documentation](../../integration/elasticsearch.md).
...@@ -16,7 +16,7 @@ The Advanced Global Search in GitLab is a powerful search service that saves ...@@ -16,7 +16,7 @@ The Advanced Global Search in GitLab is a powerful search service that saves
you time. Instead of creating duplicate code and wasting time, you can you time. Instead of creating duplicate code and wasting time, you can
now search for code within other teams that can help your own project. now search for code within other teams that can help your own project.
GitLab leverages the search capabilities of [Elasticsearch] and enables it when GitLab leverages the search capabilities of [Elasticsearch](https://www.elastic.co/elasticsearch/) and enables it when
searching in: searching in:
- GitLab application - GitLab application
...@@ -56,20 +56,8 @@ project you have access to. ...@@ -56,20 +56,8 @@ project you have access to.
You can also use the [Advanced Syntax Search](advanced_search_syntax.md) which You can also use the [Advanced Syntax Search](advanced_search_syntax.md) which
provides some useful queries. provides some useful queries.
>**Note:** NOTE: **Note:**
Elasticsearch has only data for the default branch. That means that if you go Elasticsearch has only data for the default branch. That means that if you go
to the repository tree and switch the branch from the default to something else, to the repository tree and switch the branch from the default to something else,
then the "Code" tab in the search result page will be served by the regular then the "Code" tab in the search result page will be served by the regular
search even if Elasticsearch is enabled. search even if Elasticsearch is enabled.
[ee-1305]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1305
[aws-elastic]: https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-gsg.html
[aws-iam]: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html
[aws-instance-profile]: http://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-iam-instance-profile.html#getting-started-create-iam-instance-profile-cli
[ee-109]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/109 "Elasticsearch Merge Request"
[elasticsearch]: https://www.elastic.co/elasticsearch "Elasticsearch website"
[install]: https://www.elastic.co/guide/en/elasticsearch/reference/current/_installation.html "Elasticsearch installation documentation"
[pkg]: https://about.gitlab.com/downloads/ "Download Omnibus GitLab"
[elastic-settings]: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-configuration.html#settings "Elasticsearch configuration settings"
[ee]: https://about.gitlab.com/pricing/
[es]: https://www.elastic.co/elasticsearch
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
> **Notes:** > **Notes:**
> >
> - Introduced in [GitLab Enterprise Starter][ee] 9.2 > - Introduced in [GitLab Enterprise Starter](https://about.gitlab.com/pricing/) 9.2
> - This is the user documentation. To install and configure Elasticsearch, > - This is the user documentation. To install and configure Elasticsearch,
> visit the [administrator documentation](../../integration/elasticsearch.md). > visit the [administrator documentation](../../integration/elasticsearch.md).
...@@ -37,7 +37,7 @@ better results. ...@@ -37,7 +37,7 @@ better results.
The Advanced Syntax Search supports fuzzy or exact search queries with prefixes, The Advanced Syntax Search supports fuzzy or exact search queries with prefixes,
boolean operators, and much more. boolean operators, and much more.
Full details can be found in the [Elasticsearch documentation][elastic], but Full details can be found in the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/5.3/query-dsl-simple-query-string-query.html#_simple_query_string_syntax), but
here's a quick guide: here's a quick guide:
- Searches look for all the words in a query, in any order - e.g.: searching - Searches look for all the words in a query, in any order - e.g.: searching
...@@ -67,6 +67,3 @@ Examples: ...@@ -67,6 +67,3 @@ Examples:
- Finding the text 'def create' inside files with the `.rb` extension: `def create extension:rb` - Finding the text 'def create' inside files with the `.rb` extension: `def create extension:rb`
- Finding the text `sha` inside files in a folder called `encryption`: `sha path:encryption` - Finding the text `sha` inside files in a folder called `encryption`: `sha path:encryption`
- Finding any file starting with `hello` containing `world` and with the `.js` extension: `world filename:hello* extension:js` - Finding any file starting with `hello` containing `world` and with the `.js` extension: `world filename:hello* extension:js`
[ee]: https://about.gitlab.com/pricing/
[elastic]: https://www.elastic.co/guide/en/elasticsearch/reference/5.3/query-dsl-simple-query-string-query.html#_simple_query_string_syntax
...@@ -171,5 +171,3 @@ GitLab instance. ...@@ -171,5 +171,3 @@ GitLab instance.
Use advanced queries for more targeted search results. Use advanced queries for more targeted search results.
[Learn how to use the Advanced Syntax Search.](advanced_search_syntax.md) [Learn how to use the Advanced Syntax Search.](advanced_search_syntax.md)
[ee]: https://about.gitlab.com/pricing/
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment