Skip to content
Snippets Groups Projects
Commit 72a91622 authored by Marcel Amirault's avatar Marcel Amirault Committed by Achilleas Pipinellis
Browse files

Update capitalization in /integrations and /raketasks

Also updates redirect text in /project-services
parent f91b5d58
No related branches found
No related tags found
No related merge requests found
Showing
with 54 additions and 55 deletions
Loading
Loading
@@ -30,7 +30,7 @@ application.
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -48,7 +48,7 @@ application.
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -32,7 +32,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -50,7 +50,7 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -4,7 +4,7 @@ To enable the CAS OmniAuth provider you must register your application with your
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -22,7 +22,7 @@ To enable the CAS OmniAuth provider you must register your application with your
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -123,8 +123,8 @@ production instances, they recommend considerably more resources.
 
Storage requirements also vary based on the installation side, but as a rule of
thumb, you should allocate the total size of your production database, **plus**
two-thirds of the total size of your git repositories. Efforts to reduce this
total are being tracked in this epic: [gitlab-org&153](https://gitlab.com/groups/gitlab-org/-/epics/153).
two-thirds of the total size of your Git repositories. Efforts to reduce this
total are being tracked in [epic &153](https://gitlab.com/groups/gitlab-org/-/epics/153).
 
## Enabling Elasticsearch
 
Loading
Loading
@@ -341,27 +341,27 @@ Currently for repository and snippet files, GitLab would only index up to 1 MB o
 
There are several rake tasks available to you via the command line:
 
- [sudo gitlab-rake gitlab:elastic:index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This is a wrapper task. It does the following:
- `sudo gitlab-rake gitlab:elastic:create_empty_index`
- `sudo gitlab-rake gitlab:elastic:clear_index_status`
- `sudo gitlab-rake gitlab:elastic:index_projects`
- `sudo gitlab-rake gitlab:elastic:index_snippets`
- [sudo gitlab-rake gitlab:elastic:index_projects](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index_projects`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This iterates over all projects and queues sidekiq jobs to index them in the background.
- [sudo gitlab-rake gitlab:elastic:index_projects_status](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index_projects_status`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This determines the overall status of the indexing. It is done by counting the total number of indexed projects, dividing by a count of the total number of projects, then multiplying by 100.
- [sudo gitlab-rake gitlab:elastic:create_empty_index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:create_empty_index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This generates an empty index on the Elasticsearch side.
- [sudo gitlab-rake gitlab:elastic:clear_index_status](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:clear_index_status`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This deletes all instances of IndexStatus for all projects.
- [sudo gitlab-rake gitlab:elastic:delete_index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:delete_index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- This removes the GitLab index on the Elasticsearch instance.
- [sudo gitlab-rake gitlab:elastic:recreate_index](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:recreate_index`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- Does the same thing as `sudo gitlab-rake gitlab:elastic:create_empty_index`
- [sudo gitlab-rake gitlab:elastic:index_snippets](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:index_snippets`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- Performs an Elasticsearch import that indexes the snippets data.
- [sudo gitlab-rake gitlab:elastic:projects_not_indexed](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- [`sudo gitlab-rake gitlab:elastic:projects_not_indexed`](https://gitlab.com/gitlab-org/gitlab-ee/blob/master/ee/lib/tasks/gitlab/elastic.rake)
- Displays which projects are not indexed.
 
### Environment Variables
Loading
Loading
Loading
Loading
@@ -49,7 +49,7 @@ To enable the Facebook OmniAuth provider you must register your application with
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -67,7 +67,7 @@ To enable the Facebook OmniAuth provider you must register your application with
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -36,7 +36,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -54,7 +54,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
For GitHub.com:
 
Loading
Loading
@@ -124,7 +124,7 @@ certificate and the imports are failing, you will need to disable SSL verificati
It should be disabled by adding `verify_ssl` to `false` in the provider configuration
and changing the global Git `sslVerify` option to `false` in the GitLab server.
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -30,7 +30,7 @@ GitLab.com will generate an application ID and secret key for you to use.
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -48,7 +48,7 @@ GitLab.com will generate an application ID and secret key for you to use.
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -14,12 +14,12 @@ Integration includes:
Requirements:
 
- [Jenkins GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
- git clone access for Jenkins from GitLab repo (via ssh key)
- Git clone access for Jenkins from GitLab repo (via ssh key)
 
## Jenkins
 
1. Install [GitLab Hook plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Hook+Plugin)
1. Set up jenkins project
1. Set up Jenkins project
 
![screen](img/jenkins_project.png)
 
Loading
Loading
Loading
Loading
@@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/jira.md'
---
 
This document was moved to [integrations/jira](../user/project/integrations/jira.md).
This document was moved to [another location](../user/project/integrations/jira.md).
Loading
Loading
@@ -23,7 +23,7 @@ or instance admin (in the case of self-hosted GitLab) set up the integration,
in order to simplify administration.
 
TIP: **Tip:**
Create and use a single-purpose "jira" user in GitLab, so that removing
Create and use a single-purpose `jira` user in GitLab, so that removing
regular users won't impact your integration.
 
## Requirements
Loading
Loading
Loading
Loading
@@ -46,7 +46,7 @@ sudo chmod 0600 /etc/http.keytab
For source installations, make sure the `kerberos` gem group
[has been installed](../install/installation.md#install-gems).
 
1. Edit the kerberos section of [gitlab.yml] to enable Kerberos ticket-based
1. Edit the `kerberos` section of [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example) to enable Kerberos ticket-based
authentication. In most cases, you only need to enable Kerberos and specify
the location of the keytab:
 
Loading
Loading
@@ -153,7 +153,7 @@ keep offering only `basic` authentication.
listen [::]:8443 ipv6only=on ssl;
```
 
1. Update the Kerberos section of [gitlab.yml]:
1. Update the `kerberos` section of [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example):
 
```yaml
kerberos:
Loading
Loading
@@ -203,7 +203,7 @@ remove the OmniAuth provider named `kerberos` from your `gitlab.yml` /
 
**For installations from source**
 
1. Edit [gitlab.yml] and remove the `- { name: 'kerberos' }` line under omniauth
1. Edit [`gitlab.yml`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example) and remove the `- { name: 'kerberos' }` line under omniauth
providers:
 
```yaml
Loading
Loading
@@ -295,7 +295,6 @@ See also: [Git v2.11 release notes](https://github.com/git/git/blob/master/Docum
- <http://blog.manula.org/2012/04/setting-up-kerberos-server-with-debian.html>
- <http://www.roguelynn.com/words/explain-like-im-5-kerberos/>
 
[gitlab.yml]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/config/gitlab.yml.example
[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
Loading
Loading
Loading
Loading
@@ -69,7 +69,7 @@ that are in common for all providers that we need to consider.
 
To change these settings:
 
- **For omnibus package**
- **For Omnibus package**
 
Open the configuration file:
 
Loading
Loading
Loading
Loading
@@ -29,7 +29,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -46,7 +46,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -17,7 +17,7 @@ in your SAML IdP:
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -34,7 +34,7 @@ in your SAML IdP:
1. To allow your users to use SAML to sign up without having to manually create
an account first, don't forget to add the following values to your configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_enabled'] = true
Loading
Loading
@@ -54,7 +54,7 @@ in your SAML IdP:
1. You can also automatically link SAML users with existing GitLab users if their
email addresses match by adding the following setting:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_auto_link_saml_user'] = true
Loading
Loading
@@ -68,7 +68,7 @@ in your SAML IdP:
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
@@ -342,7 +342,7 @@ You can add this setting to your GitLab configuration to automatically redirect
to your SAML server for authentication, thus removing the need to click a button
before actually signing in.
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_auto_sign_in_with_provider'] = 'saml'
Loading
Loading
# Shibboleth OmniAuth Provider
 
This documentation is for enabling shibboleth with omnibus-gitlab package.
This documentation is for enabling Shibboleth with the Omnibus GitLab package.
 
In order to enable Shibboleth support in gitlab we need to use Apache instead of Nginx (It may be possible to use Nginx, however this is difficult to configure using the bundled Nginx provided in the omnibus-gitlab package). Apache uses mod_shib2 module for shibboleth authentication and can pass attributes as headers to omniauth-shibboleth provider.
In order to enable Shibboleth support in GitLab we need to use Apache instead of Nginx (It may be possible to use Nginx, however this is difficult to configure using the bundled Nginx provided in the Omnibus GitLab package). Apache uses mod_shib2 module for Shibboleth authentication and can pass attributes as headers to Omniauth Shibboleth provider.
 
To enable the Shibboleth OmniAuth provider you must configure Apache shibboleth module.
To enable the Shibboleth OmniAuth provider you must configure Apache Shibboleth module.
The installation and configuration of the module itself is out of the scope of this document.
Check <https://wiki.shibboleth.net/confluence/display/SP3/Apache> for more info.
 
You can find Apache config in gitlab-recipes (<https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server/apache>).
You can find Apache config in [GitLab Recipes](https://gitlab.com/gitlab-org/gitlab-recipes/tree/master/web-server/apache).
 
The following changes are needed to enable Shibboleth:
 
1. Protect omniauth-shibboleth callback URL:
1. Protect Omniauth Shibboleth callback URL:
 
```
<Location /users/auth/shibboleth/callback>
Loading
Loading
@@ -32,7 +32,7 @@ The following changes are needed to enable Shibboleth:
</Location>
```
 
1. Exclude shibboleth URLs from rewriting. Add `RewriteCond %{REQUEST_URI} !/Shibboleth.sso` and `RewriteCond %{REQUEST_URI} !/shibboleth-sp`. Config should look like this:
1. Exclude Shibboleth URLs from rewriting. Add `RewriteCond %{REQUEST_URI} !/Shibboleth.sso` and `RewriteCond %{REQUEST_URI} !/shibboleth-sp`. Config should look like this:
 
```
# Apache equivalent of Nginx try files
Loading
Loading
@@ -50,7 +50,7 @@ The following changes are needed to enable 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
to the [OmniAuth::Strategies::Shibboleth class](https://github.com/toyokazu/omniauth-shibboleth/blob/master/lib/omniauth/strategies/shibboleth.rb)
and are documented by the [omniauth-shibboleth gem](https://github.com/toyokazu/omniauth-shibboleth)
and are documented by the [`omniauth-shibboleth` gem](https://github.com/toyokazu/omniauth-shibboleth)
(take care to note the version of the gem packaged with GitLab). If some of
your users appear to be authenticated by Shibboleth and Apache, but GitLab
rejects their account with a URI that contains "e-mail is invalid" then your
Loading
Loading
@@ -94,7 +94,7 @@ On the sign in page, there should now be a "Sign in with: Shibboleth" icon below
## Apache 2.4 / GitLab 8.6 update
 
The order of the first 2 Location directives is important. If they are reversed,
you will not get a shibboleth session!
you will not get a Shibboleth session!
 
```
<Location />
Loading
Loading
Loading
Loading
@@ -32,7 +32,7 @@ To enable the Twitter OmniAuth provider you must register your application with
 
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -50,7 +50,7 @@ To enable the Twitter OmniAuth provider you must register your application with
 
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -25,7 +25,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
1. Select **Register application**.
1. On your GitLab server, open the configuration file.
 
For omnibus package:
For Omnibus package:
 
```sh
sudo editor /etc/gitlab/gitlab.rb
Loading
Loading
@@ -41,7 +41,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings.
1. Add the provider configuration:
 
For omnibus package:
For Omnibus package:
 
```ruby
gitlab_rails['omniauth_providers'] = [
Loading
Loading
Loading
Loading
@@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/bamboo.md'
---
 
This document was moved to [user/project/integrations/bamboo.md](../user/project/integrations/bamboo.md).
This document was moved to [another location](../user/project/integrations/bamboo.md).
Loading
Loading
@@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/bugzilla.md'
---
 
This document was moved to [user/project/integrations/bugzilla.md](../user/project/integrations/bugzilla.md).
This document was moved to [another location](../user/project/integrations/bugzilla.md).
Loading
Loading
@@ -2,4 +2,4 @@
redirect_to: '../user/project/integrations/emails_on_push.md'
---
 
This document was moved to [user/project/integrations/emails_on_push.md](../user/project/integrations/emails_on_push.md).
This document was moved to [another location](../user/project/integrations/emails_on_push.md).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment