summaryrefslogtreecommitdiff
path: root/doc/integration
diff options
context:
space:
mode:
Diffstat (limited to 'doc/integration')
-rw-r--r--doc/integration/auth0.md4
-rw-r--r--doc/integration/azure.md4
-rw-r--r--doc/integration/cas.md4
-rw-r--r--doc/integration/elasticsearch.md48
-rw-r--r--doc/integration/facebook.md4
-rw-r--r--doc/integration/gitlab.md4
-rw-r--r--doc/integration/google.md4
-rw-r--r--doc/integration/kerberos.md2
-rw-r--r--doc/integration/oauth2_generic.md4
-rw-r--r--doc/integration/omniauth.md12
-rw-r--r--doc/integration/salesforce.md4
-rw-r--r--doc/integration/saml.md4
-rw-r--r--doc/integration/sourcegraph.md2
-rw-r--r--doc/integration/twitter.md4
-rw-r--r--doc/integration/ultra_auth.md4
-rw-r--r--doc/integration/vault.md12
16 files changed, 60 insertions, 60 deletions
diff --git a/doc/integration/auth0.md b/doc/integration/auth0.md
index 2dd6fa3d5a2..521223e626b 100644
--- a/doc/integration/auth0.md
+++ b/doc/integration/auth0.md
@@ -32,13 +32,13 @@ application.
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
diff --git a/doc/integration/azure.md b/doc/integration/azure.md
index c30d79e3dab..60885f7d9ba 100644
--- a/doc/integration/azure.md
+++ b/doc/integration/azure.md
@@ -34,13 +34,13 @@ To enable the Microsoft Azure OAuth2 OmniAuth provider you must register your ap
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
diff --git a/doc/integration/cas.md b/doc/integration/cas.md
index 83b64773c9f..8aadfaad4e9 100644
--- a/doc/integration/cas.md
+++ b/doc/integration/cas.md
@@ -6,13 +6,13 @@ To enable the CAS OmniAuth provider you must register your application with your
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
diff --git a/doc/integration/elasticsearch.md b/doc/integration/elasticsearch.md
index 9cba1465fa1..c3e85002db8 100644
--- a/doc/integration/elasticsearch.md
+++ b/doc/integration/elasticsearch.md
@@ -68,7 +68,7 @@ installed before running `make`.
To install on Debian or Ubuntu, run:
-```sh
+```shell
sudo apt install libicu-dev
```
@@ -76,7 +76,7 @@ sudo apt install libicu-dev
To install on CentOS or RHEL, run:
-```sh
+```shell
sudo yum install libicu-devel
```
@@ -84,7 +84,7 @@ sudo yum install libicu-devel
To install on macOS, run:
-```sh
+```shell
brew install icu4c
export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:$PKG_CONFIG_PATH"
```
@@ -93,7 +93,7 @@ export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:$PKG_CONFIG_PATH"
To build and install the indexer, run:
-```sh
+```shell
indexer_path=/home/git/gitlab-elasticsearch-indexer
# Run the installation task for gitlab-elasticsearch-indexer:
@@ -108,7 +108,7 @@ Please remember to pass the `-E` flag to `sudo` if you do so.
Example:
-```sh
+```shell
PREFIX=/usr sudo -E make install
```
@@ -184,7 +184,7 @@ To disable the Elasticsearch integration:
1. Click **Save changes** for the changes to take effect.
1. (Optional) Delete the existing index by running one of these commands:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:delete_index
@@ -206,7 +206,7 @@ To index via the Admin Area:
1. [Configure your Elasticsearch host and port](#enabling-elasticsearch).
1. Create empty indexes using one of the following commands:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:create_empty_index
@@ -219,7 +219,7 @@ To index via the Admin Area:
1. Click **Check progress** in the confirmation message to see the status of the background jobs.
1. Personal snippets need to be indexed manually by running one of these commands:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index_snippets
@@ -241,7 +241,7 @@ If the database size is less than 500 MiB, and the size of all hosted repos is l
1. [Enable **Elasticsearch indexing** and configure your host and port](#enabling-elasticsearch).
1. Index your data using one of the following commands:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index
@@ -261,7 +261,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
1. [Configure your Elasticsearch host and port](#enabling-elasticsearch).
1. Create empty indexes using one of the following commands:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:create_empty_index
@@ -274,7 +274,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
can temporarily disable auto-refreshing and replicating. In our experience, you can expect a 20%
decrease in indexing time. We'll enable them when indexing is done. This step is optional!
- ```bash
+ ```shell
curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' --data '{
"index" : {
"refresh_interval" : "-1",
@@ -284,7 +284,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
1. Index projects and their associated data:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index_projects
@@ -296,7 +296,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
You can view the jobs in **Admin Area > Monitoring > Background Jobs > Queues Tab**
and click `elastic_indexer`, or you can query indexing status using a rake task:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index_projects_status
@@ -309,7 +309,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
If you want to limit the index to a range of projects you can provide the
`ID_FROM` and `ID_TO` parameters:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index_projects ID_FROM=1001 ID_TO=2000
@@ -331,7 +331,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
it will check every project repository again to make sure that every commit in
a repository is indexed, which can be useful in case if your index is outdated:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index_projects UPDATE_INDEX=true ID_TO=1000
@@ -346,7 +346,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
1. Personal snippets are not associated with a project and need to be indexed separately
by running one of these commands:
- ```sh
+ ```shell
# Omnibus installations
sudo gitlab-rake gitlab:elastic:index_snippets
@@ -356,7 +356,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
1. Enable replication and refreshing again after indexing (only if you previously disabled it):
- ```bash
+ ```shell
curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' ---data '{
"index" : {
"number_of_replicas" : 1,
@@ -368,7 +368,7 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
For Elasticsearch 6.x, the index should be in read-only mode before proceeding with the force merge:
- ```bash
+ ```shell
curl --request PUT localhost:9200/gitlab-production/_settings ---header 'Content-Type: application/json' --data '{
"settings": {
"index.blocks.write": true
@@ -377,13 +377,13 @@ or creating [extra Sidekiq processes](../administration/operations/extra_sidekiq
Then, initiate the force merge:
- ```bash
+ ```shell
curl --request POST 'localhost:9200/gitlab-production/_forcemerge?max_num_segments=5'
```
After this, if your index is in read-only mode, switch back to read-write:
- ```bash
+ ```shell
curl --request PUT localhost:9200/gitlab-production/_settings ---header 'Content-Type: application/json' --data '{
"settings": {
"index.blocks.write": false
@@ -437,7 +437,7 @@ In addition to the rake tasks, there are some environment variables that can be
Because the `ID_TO` and `ID_FROM` environment variables use the `or equal to` comparison, you can index only one project by using both these variables with the same project ID number:
-```sh
+```shell
root@git:~# sudo gitlab-rake gitlab:elastic:index_projects ID_TO=5 ID_FROM=5
Indexing project repositories...I, [2019-03-04T21:27:03.083410 #3384] INFO -- : Indexing GitLab User / test (ID=33)...
I, [2019-03-04T21:27:05.215266 #3384] INFO -- : Indexing GitLab User / test (ID=33) is done!
@@ -471,7 +471,7 @@ However, some larger installations may wish to tune the merge policy settings:
- Consider reducing the `index.merge.policy.max_merged_segment` size from the default 5 GB to maybe 2 GB or 3 GB. Merging only happens when a segment has at least 50% deletions. Smaller segment sizes will allow merging to happen more frequently.
- ```bash
+ ```shell
curl --request PUT localhost:9200/gitlab-production/_settings ---header 'Content-Type: application/json' --data '{
"index" : {
"merge.policy.max_merged_segment": "2gb"
@@ -481,7 +481,7 @@ However, some larger installations may wish to tune the merge policy settings:
- You can also adjust `index.merge.policy.reclaim_deletes_weight`, which controls how aggressively deletions are targeted. But this can lead to costly merge decisions, so we recommend not changing this unless you understand the tradeoffs.
- ```bash
+ ```shell
curl --request PUT localhost:9200/gitlab-production/_settings ---header 'Content-Type: application/json' --data '{
"index" : {
"merge.policy.reclaim_deletes_weight": "3.0"
@@ -604,7 +604,7 @@ Here are some common pitfalls and how to overcome them:
If you have a **hard requirement to have a green status for your single node Elasticsearch cluster**, please make sure you understand the risks outlined in the previous paragraph and then simply run the following query to set the number of replicas to `0`(the cluster will no longer try to create any shard replicas):
- ```bash
+ ```shell
curl --request PUT localhost:9200/gitlab-production/_settings --header 'Content-Type: application/json' --data '{
"index" : {
"number_of_replicas" : 0
diff --git a/doc/integration/facebook.md b/doc/integration/facebook.md
index d46486ad888..878d6c38230 100644
--- a/doc/integration/facebook.md
+++ b/doc/integration/facebook.md
@@ -51,13 +51,13 @@ To enable the Facebook OmniAuth provider you must register your application with
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
diff --git a/doc/integration/gitlab.md b/doc/integration/gitlab.md
index 74f2d5cb403..e8c104bbe6f 100644
--- a/doc/integration/gitlab.md
+++ b/doc/integration/gitlab.md
@@ -32,13 +32,13 @@ GitLab.com will generate an application ID and secret key for you to use.
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
diff --git a/doc/integration/google.md b/doc/integration/google.md
index 97323557878..38cc33e3971 100644
--- a/doc/integration/google.md
+++ b/doc/integration/google.md
@@ -54,13 +54,13 @@ On your GitLab server:
For Omnibus GitLab:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
diff --git a/doc/integration/kerberos.md b/doc/integration/kerberos.md
index 1cdbdb1c40e..3998089a0e4 100644
--- a/doc/integration/kerberos.md
+++ b/doc/integration/kerberos.md
@@ -275,7 +275,7 @@ authenticate to other Kerberos services.
### HTTP Basic: Access denied when cloning
-```sh
+```shell
remote: HTTP Basic: Access denied
fatal: Authentication failed for '<KRB5 path>'
```
diff --git a/doc/integration/oauth2_generic.md b/doc/integration/oauth2_generic.md
index ad59592c45f..c53c5751f1f 100644
--- a/doc/integration/oauth2_generic.md
+++ b/doc/integration/oauth2_generic.md
@@ -38,13 +38,13 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
diff --git a/doc/integration/omniauth.md b/doc/integration/omniauth.md
index 6ac2e3e13d6..2e89093321a 100644
--- a/doc/integration/omniauth.md
+++ b/doc/integration/omniauth.md
@@ -73,7 +73,7 @@ To change these settings:
Open the configuration file:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
@@ -96,7 +96,7 @@ To change these settings:
Open the configuration file:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
@@ -188,19 +188,19 @@ from the OmniAuth provider's documentation.
- Stop GitLab:
- ```sh
+ ```shell
sudo service gitlab stop
```
- Add the gem to your [Gemfile](https://gitlab.com/gitlab-org/gitlab/blob/master/Gemfile):
- ```sh
+ ```shell
gem "omniauth-your-auth-provider"
```
- Install the new OmniAuth provider gem by running the following command:
- ```sh
+ ```shell
sudo -u git -H bundle install --without development test mysql --path vendor/bundle --no-deployment
```
@@ -208,7 +208,7 @@ from the OmniAuth provider's documentation.
- Start GitLab:
- ```sh
+ ```shell
sudo service gitlab start
```
diff --git a/doc/integration/salesforce.md b/doc/integration/salesforce.md
index 958f05cf030..d0e25ae2d44 100644
--- a/doc/integration/salesforce.md
+++ b/doc/integration/salesforce.md
@@ -31,13 +31,13 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
diff --git a/doc/integration/saml.md b/doc/integration/saml.md
index 261fe6e8c18..a4e96adca47 100644
--- a/doc/integration/saml.md
+++ b/doc/integration/saml.md
@@ -19,13 +19,13 @@ in your SAML IdP:
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
diff --git a/doc/integration/sourcegraph.md b/doc/integration/sourcegraph.md
index 25d1ef457c0..c400d5a9a63 100644
--- a/doc/integration/sourcegraph.md
+++ b/doc/integration/sourcegraph.md
@@ -35,7 +35,7 @@ by instance administrators.
Use these commands to start the Rails console:
-```sh
+```shell
# Omnibus GitLab
gitlab-rails console
diff --git a/doc/integration/twitter.md b/doc/integration/twitter.md
index b2bd1b57d0f..cf6492d7372 100644
--- a/doc/integration/twitter.md
+++ b/doc/integration/twitter.md
@@ -34,13 +34,13 @@ To enable the Twitter OmniAuth provider you must register your application with
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
diff --git a/doc/integration/ultra_auth.md b/doc/integration/ultra_auth.md
index 83b2d7fe096..091887d8eb8 100644
--- a/doc/integration/ultra_auth.md
+++ b/doc/integration/ultra_auth.md
@@ -27,13 +27,13 @@ To get the credentials (a pair of Client ID and Client Secret), you must registe
For Omnibus package:
- ```sh
+ ```shell
sudo editor /etc/gitlab/gitlab.rb
```
For installations from source:
- ```sh
+ ```shell
cd /home/git/gitlab
sudo -u git -H editor config/gitlab.yml
```
diff --git a/doc/integration/vault.md b/doc/integration/vault.md
index 8bd0897548a..ea3aeeb0f64 100644
--- a/doc/integration/vault.md
+++ b/doc/integration/vault.md
@@ -30,13 +30,13 @@ The following assumes you already have Vault installed and running.
Open a terminal session and run the following command to enable the OpenID Connect authentication provider in Vault:
- ```bash
+ ```shell
vault auth enable oidc
```
You should see the following output in the terminal:
- ```bash
+ ```shell
Success! Enabled oidc auth method at: oidc/
```
@@ -48,7 +48,7 @@ The following assumes you already have Vault installed and running.
Replace `your_application_id` and `your_secret` in the example below with the application ID and secret generated for your app:
- ```bash
+ ```shell
$ vault write auth/oidc/config \
oidc_discovery_url="https://gitlab.com" \
oidc_client_id="your_application_id" \
@@ -59,7 +59,7 @@ The following assumes you already have Vault installed and running.
You should see the following output in the terminal:
- ```bash
+ ```shell
Success! Data written to: auth/oidc/config
```
@@ -69,7 +69,7 @@ The following assumes you already have Vault installed and running.
This configuration is saved under the name of the role you are creating. In this case, we are creating a `demo` role. Later, we'll show how you can access this role through the Vault CLI.
- ```bash
+ ```shell
vault write auth/oidc/role/demo \
user_claim="sub" \
allowed_redirect_uris="http://localhost:8250/oidc/callback,http://127.0.0.1:8200/ui/vault/auth/oidc/oidc/callback" \
@@ -96,7 +96,7 @@ The following assumes you already have Vault installed and running.
After writing the same configurations from above, you can run the command below in your terminal to sign in with the role configuration created in step 4 above:
- ```bash
+ ```shell
vault login -method=oidc port=8250 role=demo
```