diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-26 03:09:07 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-26 03:09:07 +0000 |
commit | d393deba773bb1fab09273850fe5d5986066d76d (patch) | |
tree | b08d599196d09a91561f6f43b9c5660987060ecb /doc/integration | |
parent | 32fd4cd5e2134511936899d6bcc4aaf18b9be6fd (diff) | |
download | gitlab-ce-d393deba773bb1fab09273850fe5d5986066d76d.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/integration')
-rw-r--r-- | doc/integration/bitbucket.md | 3 | ||||
-rw-r--r-- | doc/integration/elasticsearch.md | 22 | ||||
-rw-r--r-- | doc/integration/saml.md | 8 | ||||
-rw-r--r-- | doc/integration/shibboleth.md | 12 |
4 files changed, 27 insertions, 18 deletions
diff --git a/doc/integration/bitbucket.md b/doc/integration/bitbucket.md index 7a1bdf0d65c..1ce361761ff 100644 --- a/doc/integration/bitbucket.md +++ b/doc/integration/bitbucket.md @@ -1,7 +1,8 @@ # Integrate your GitLab server with Bitbucket Cloud NOTE: **Note:** -You need to [enable OmniAuth](omniauth.md) in order to use this. +Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an +earlier version, you'll need to explicitly enable it. Import projects from Bitbucket.org and login to your GitLab instance with your Bitbucket.org account. diff --git a/doc/integration/elasticsearch.md b/doc/integration/elasticsearch.md index 3f286ca1057..cffd261e757 100644 --- a/doc/integration/elasticsearch.md +++ b/doc/integration/elasticsearch.md @@ -47,24 +47,26 @@ updated automatically. For indexing Git repository data, GitLab uses an [indexer written in Go](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer). +The way you install the Go indexer depends on your version of GitLab: + +- For GitLab Omnibus 11.8 and above, see [GitLab Omnibus](#gitlab-omnibus). +- For older versions of GitLab, install the indexer [From Source](#from-source). + +### GitLab Omnibus + The Go indexer was included in Omnibus GitLab 11.8 as an optional replacement to a Ruby-based indexer. [Since GitLab v12.3](https://gitlab.com/gitlab-org/gitlab/issues/6481), -all indexing is done by the Go indexer, and the Ruby indexer is removed. -If you would like to use the Elasticsearch Go indexer with a source installation or an older version of GitLab, please follow the instructions below. - -### Installation +### From source First, we need to install some dependencies, then we'll build and install the indexer itself. -#### Dependencies - This project relies on [ICU](http://site.icu-project.org/) for text encoding, therefore we need to ensure the development packages for your platform are installed before running `make`. -##### Debian / Ubuntu +#### Debian / Ubuntu To install on Debian or Ubuntu, run: @@ -72,7 +74,7 @@ To install on Debian or Ubuntu, run: sudo apt install libicu-dev ``` -##### CentOS / RHEL +#### CentOS / RHEL To install on CentOS or RHEL, run: @@ -89,7 +91,7 @@ brew install icu4c export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:$PKG_CONFIG_PATH" ``` -#### Building and installing +### Building and installing To build and install the indexer, run: @@ -622,7 +624,7 @@ Here are some common pitfalls and how to overcome them: ``` You probably have not used either `http://` or `https://` as part of your value in the **"URL"** field of the Elasticseach Integration Menu. Please make sure you are using either `http://` or `https://` in this field as the [Elasticsearch client for Go](https://github.com/olivere/elastic) that we are using [needs the prefix for the URL to be acceped as valid](https://github.com/olivere/elastic/commit/a80af35aa41856dc2c986204e2b64eab81ccac3a). - Once you have corrected the formatting of the URL please delete the index (via the [dedicated rake task](#gitlab-elasticsearch-rake-tasks)) and [index the content of your intance](#adding-gitlabs-data-to-the-elasticsearch-index) once more. + Once you have corrected the formatting of the URL, delete the index (via the [dedicated rake task](#gitlab-elasticsearch-rake-tasks)) and [reindex the content of your instance](#adding-gitlabs-data-to-the-elasticsearch-index). ### Reverting to basic search diff --git a/doc/integration/saml.md b/doc/integration/saml.md index 30ba390f5cd..31d41433e6b 100644 --- a/doc/integration/saml.md +++ b/doc/integration/saml.md @@ -1,9 +1,11 @@ # SAML OmniAuth Provider -> This topic is for SAML on self-managed GitLab instances. For SAML on GitLab.com, see [SAML SSO for GitLab.com Groups](../user/group/saml_sso/index.md). +Note that: -NOTE: **Note:** -You need to [enable OmniAuth](omniauth.md) in order to use this. +- SAML OmniAuth Provider is for SAML on self-managed GitLab instances. For SAML on + GitLab.com, see [SAML SSO for GitLab.com Groups](../user/group/saml_sso/index.md). +- Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an + earlier version, you'll need to explicitly enable it. GitLab can be configured to act as a SAML 2.0 Service Provider (SP). This allows GitLab to consume assertions from a SAML 2.0 Identity Provider (IdP) such as diff --git a/doc/integration/shibboleth.md b/doc/integration/shibboleth.md index 71ac6012ce6..4cc686cc0b6 100644 --- a/doc/integration/shibboleth.md +++ b/doc/integration/shibboleth.md @@ -16,7 +16,7 @@ The following changes are needed to enable Shibboleth: 1. Protect OmniAuth Shibboleth callback URL: - ``` + ```apache <Location /users/auth/shibboleth/callback> AuthType shibboleth ShibRequestSetting requireSession 1 @@ -36,7 +36,7 @@ The following changes are needed to enable Shibboleth: 1. Exclude Shibboleth URLs from rewriting. Add `RewriteCond %{REQUEST_URI} !/Shibboleth.sso` and `RewriteCond %{REQUEST_URI} !/shibboleth-sp`. Config should look like this: - ``` + ```apache # Apache equivalent of Nginx try files RewriteEngine on RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f @@ -46,8 +46,12 @@ The following changes are needed to enable Shibboleth: RequestHeader set X_FORWARDED_PROTO 'https' ``` -1. Edit `/etc/gitlab/gitlab.rb` configuration file to enable OmniAuth and add - Shibboleth as an OmniAuth provider. User attributes will be sent from the + **NOTE:** + Starting from GitLab 11.4, OmniAuth is enabled by default. If you're using an + earlier version, you'll need to explicitly enable it in `/etc/gitlab/gitlab.rb`. + +1. In addition, add Shibboleth to `/etc/gitlab/gitlab.rb` as an OmniAuth provider. + User attributes will be sent from the Apache reverse proxy to GitLab as headers with the names from the Shibboleth attribute mapping. Therefore the values of the `args` hash should be in the form of `"HTTP_ATTRIBUTE"`. The keys in the hash are arguments |