Add 'label' to all the OAuth examples

Signed-off-by: Rémy Coutable <remy@rymai.me>

doc/administration/auth/atlassian.md

@@ -50,6 +50,7 @@ To enable the Atlassian OmniAuth provider for passwordless authentication you mu
    gitlab_rails['omniauth_providers'] = [
      {
        name: "atlassian_oauth2",
+       # label: 'Provider name', # optional label for login button, defaults to "Atlassian"
        app_id: "YOUR_CLIENT_ID",
        app_secret: "YOUR_CLIENT_SECRET",
        args: { scope: 'offline_access read:jira-user read:jira-work', prompt: 'consent' }
@@ -60,10 +61,12 @@ To enable the Atlassian OmniAuth provider for passwordless authentication you mu
    For installations from source:
 
    ```yaml
-   - name: "atlassian_oauth2",
-     app_id: "YOUR_CLIENT_ID",
-     app_secret: "YOUR_CLIENT_SECRET",
-     args: { scope: 'offline_access read:jira-user read:jira-work', prompt: 'consent' }
+   - { name: "atlassian_oauth2",
+       # label: 'Provider name', # optional label for login button, defaults to "Atlassian"
+       app_id: "YOUR_CLIENT_ID",
+       app_secret: "YOUR_CLIENT_SECRET",
+       args: { scope: 'offline_access read:jira-user read:jira-work', prompt: 'consent' }
+    }
    ```
 
 1. Change `YOUR_CLIENT_ID` and `YOUR_CLIENT_SECRET` to the Client credentials you received in [application registration](#atlassian-application-registration) steps.

doc/administration/auth/authentiq.md

@@ -37,6 +37,7 @@ Authentiq generates a Client ID and the accompanying Client Secret for you to us
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "authentiq",
+       # "label" => "Provider name", # optional label for login button, defaults to "Authentiq"
        "app_id" => "YOUR_CLIENT_ID",
        "app_secret" => "YOUR_CLIENT_SECRET",
        "args" => {
@@ -50,6 +51,7 @@ Authentiq generates a Client ID and the accompanying Client Secret for you to us
 
    ```yaml
    - { name: 'authentiq',
+       # label: 'Provider name', # optional label for login button, defaults to "Authentiq"
        app_id: 'YOUR_CLIENT_ID',
        app_secret: 'YOUR_CLIENT_SECRET',
        args: {

doc/administration/auth/cognito.md

@@ -57,7 +57,7 @@ Include the code block in the `/etc/gitlab/gitlab.rb` file:
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "cognito",
-       # "label" => "Cognito",
+       # "label" => "Provider name", # optional label for login button, defaults to "Cognito"
        # "icon" => nil,   # Optional icon URL
        "app_id" => "CLIENT ID",
        "app_secret" => "CLIENT SECRET",

doc/administration/auth/crowd.md

@@ -47,6 +47,7 @@ this provider also allows Crowd authentication for Git-over-https requests.
      gitlab_rails['omniauth_providers'] = [
        {
          "name" => "crowd",
+         # "label" => "Provider name", # optional label for login button, defaults to "Crowd"
          "args" => {
            "crowd_server_url" => "CROWD_SERVER_URL",
            "application_name" => "YOUR_APP_NAME",
@@ -60,6 +61,7 @@ this provider also allows Crowd authentication for Git-over-https requests.
 
    ```yaml
       - { name: 'crowd',
+          # label: 'Provider name', # optional label for login button, defaults to "Crowd"
           args: {
             crowd_server_url: 'CROWD_SERVER_URL',
             application_name: 'YOUR_APP_NAME',

doc/administration/auth/jwt.md

@@ -33,6 +33,7 @@ JWT will provide you with a secret key for you to use.
    ```ruby
    gitlab_rails['omniauth_providers'] = [
      { name: 'jwt',
+       label: 'Provider name', # optional label for login button, defaults to "Jwt"
        args: {
          secret: 'YOUR_APP_SECRET',
          algorithm: 'HS256', # Supported algorithms: 'RS256', 'RS384', 'RS512', 'ES256', 'ES384', 'ES512', 'HS256', 'HS384', 'HS512'
@@ -50,6 +51,7 @@ JWT will provide you with a secret key for you to use.
 
    ```yaml
    - { name: 'jwt',
+       label: 'Provider name', # optional label for login button, defaults to "Jwt"
        args: {
          secret: 'YOUR_APP_SECRET',
          algorithm: 'HS256', # Supported algorithms: 'RS256', 'RS384', 'RS512', 'ES256', 'ES384', 'ES512', 'HS256', 'HS384', 'HS512'

doc/administration/auth/oidc.md

@@ -36,7 +36,7 @@ The OpenID Connect provides you with a client's details and secret for you to us
    ```ruby
    gitlab_rails['omniauth_providers'] = [
      { 'name' => 'openid_connect',
-       'label' => '<your_oidc_label>',
+       'label' => 'Provider name', # optional label for login button, defaults to "Openid Connect"
        'icon' => '<custom_provider_icon>',
        'args' => {
          'name' => 'openid_connect',
@@ -61,7 +61,7 @@ The OpenID Connect provides you with a client's details and secret for you to us
 
    ```yaml
      - { name: 'openid_connect',
-         label: '<your_oidc_label>',
+         label: 'Provider name', # optional label for login button, defaults to "Openid Connect"
          icon: '<custom_provider_icon>',
          args: {
            name: 'openid_connect',
@@ -137,7 +137,7 @@ for more details:
 gitlab_rails['omniauth_providers'] = [
   {
     'name' => 'openid_connect',
-    'label' => 'Google OpenID',
+    'label' => 'Google OpenID', # optional label for login button, defaults to "Openid Connect"
     'args' => {
       'name' => 'openid_connect',
       'scope' => ['openid', 'profile', 'email'],
@@ -174,7 +174,7 @@ Example Omnibus configuration block:
 gitlab_rails['omniauth_providers'] = [
   {
     'name' => 'openid_connect',
-    'label' => 'Azure OIDC',
+    'label' => 'Azure OIDC', # optional label for login button, defaults to "Openid Connect"
     'args' => {
       'name' => 'openid_connect',
       'scope' => ['openid', 'profile', 'email'],
@@ -303,7 +303,7 @@ The trailing forward slash is required.
    gitlab_rails['omniauth_providers'] = [
    {
      'name' => 'openid_connect',
-     'label' => 'Azure B2C OIDC',
+     'label' => 'Azure B2C OIDC', # optional label for login button, defaults to "Openid Connect"
      'args' => {
        'name' => 'openid_connect',
        'scope' => ['openid'],
@@ -360,7 +360,7 @@ Example Omnibus configuration block:
 gitlab_rails['omniauth_providers'] = [
   {
     'name' => 'openid_connect',
-    'label' => 'Keycloak',
+    'label' => 'Keycloak', # optional label for login button, defaults to "Openid Connect"
     'args' => {
       'name' => 'openid_connect',
       'scope' => ['openid', 'profile', 'email'],
@@ -437,7 +437,7 @@ To use symmetric key encryption:
    gitlab_rails['omniauth_providers'] = [
      {
        'name' => 'openid_connect',
-       'label' => 'Keycloak',
+       'label' => 'Keycloak', # optional label for login button, defaults to "Openid Connect"
        'args' => {
          'name' => 'openid_connect',
          'scope' => ['openid', 'profile', 'email'],

doc/integration/auth0.md

@@ -59,6 +59,7 @@ application.
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "auth0",
+       # "label" => "Provider name", # optional label for login button, defaults to "Auth0"
        "args" => { client_id: 'YOUR_AUTH0_CLIENT_ID',
                    client_secret: 'YOUR_AUTH0_CLIENT_SECRET',
                    domain: 'YOUR_AUTH0_DOMAIN',
@@ -72,6 +73,7 @@ application.
 
    ```yaml
    - { name: 'auth0',
+       # label: 'Provider name', # optional label for login button, defaults to "Auth0"
        args: {
          client_id: 'YOUR_AUTH0_CLIENT_ID',
          client_secret: 'YOUR_AUTH0_CLIENT_SECRET',

doc/integration/bitbucket.md

@@ -88,6 +88,7 @@ to the end of the Bitbucket authorization callback URL.
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "bitbucket",
+       # "label" => "Provider name", # optional label for login button, defaults to "Bitbucket"
        "app_id" => "BITBUCKET_APP_KEY",
        "app_secret" => "BITBUCKET_APP_SECRET",
        "url" => "https://bitbucket.org/"
@@ -102,6 +103,7 @@ to the end of the Bitbucket authorization callback URL.
      enabled: true
      providers:
        - { name: 'bitbucket',
+           # label: 'Provider name', # optional label for login button, defaults to "Bitbucket"
            app_id: 'BITBUCKET_APP_KEY',
            app_secret: 'BITBUCKET_APP_SECRET',
            url: 'https://bitbucket.org/' }

doc/integration/cas.md

@@ -38,7 +38,7 @@ configure CAS for back-channel logout.
    gitlab_rails['omniauth_providers'] = [
      {
          "name"=> "cas3",
-         "label"=> "cas",
+         "label" => "Provider name", # optional label for login button, defaults to "Cas3"
          "args"=> {
              "url"=> 'CAS_SERVER',
              "login_url"=> '/CAS_PATH/login',
@@ -53,7 +53,7 @@ configure CAS for back-channel logout.
 
    ```yaml
    - { name: 'cas3',
-       label: 'cas',
+       label: 'Provider name', # optional label for login button, defaults to "Cas3"
        args: {
          url: 'CAS_SERVER',
          login_url: '/CAS_PATH/login',

doc/integration/ding_talk.md

@@ -61,6 +61,7 @@ Sign in to DingTalk Open Platform and create an application on it. DingTalk gene
      gitlab_rails['omniauth_providers'] = [
        {
          "name" => "ding_talk",
+         "label" => "Provider name", # optional label for login button, defaults to "Ding Talk"
          "app_id" => "YOUR_APP_ID",
          "app_secret" => "YOUR_APP_SECRET"
        }
@@ -71,6 +72,7 @@ Sign in to DingTalk Open Platform and create an application on it. DingTalk gene
 
    ```yaml
    - { name: 'ding_talk',
+       label: 'Provider name', # optional label for login button, defaults to "Ding Talk"
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET' }
    ```

doc/integration/facebook.md

@@ -82,6 +82,7 @@ Facebook. Facebook generates an app ID and secret key for you to use.
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "facebook",
+       # "label" => "Provider name", # optional label for login button, defaults to "Facebook"
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET"
      }
@@ -91,7 +92,9 @@ Facebook. Facebook generates an app ID and secret key for you to use.
    For installations from source:
 
    ```yaml
-   - { name: 'facebook', app_id: 'YOUR_APP_ID',
+   - { name: 'facebook',
+       # label: 'Provider name', # optional label for login button, defaults to "Facebook"
+       app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET' }
    ```
 

doc/integration/github.md

@@ -51,6 +51,7 @@ Follow these steps to incorporate the GitHub OAuth 2 app in your GitLab server:
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "github",
+       # "label" => "Provider name", # optional label for login button, defaults to "GitHub"
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET",
        "args" => { "scope" => "user:email" }
@@ -64,6 +65,7 @@ Follow these steps to incorporate the GitHub OAuth 2 app in your GitLab server:
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "github",
+       # "label" => "Provider name", # optional label for login button, defaults to "GitHub"
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET",
        "url" => "https://github.example.com/",
@@ -85,7 +87,9 @@ Follow these steps to incorporate the GitHub OAuth 2 app in your GitLab server:
    For GitHub.com:
 
    ```yaml
-   - { name: 'github', app_id: 'YOUR_APP_ID',
+   - { name: 'github',
+       # label: 'Provider name', # optional label for login button, defaults to "GitHub"
+       app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET',
        args: { scope: 'user:email' } }
    ```
@@ -94,6 +98,7 @@ Follow these steps to incorporate the GitHub OAuth 2 app in your GitLab server:
 
    ```yaml
    - { name: 'github',
+       # label: 'Provider name', # optional label for login button, defaults to "GitHub"
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET',
        url: "https://github.example.com/",
@@ -123,6 +128,7 @@ For Omnibus package:
 gitlab_rails['omniauth_providers'] = [
   {
     "name" => "github",
+    # "label" => "Provider name", # optional label for login button, defaults to "GitHub"
     "app_id" => "YOUR_APP_ID",
     "app_secret" => "YOUR_APP_SECRET",
     "url" => "https://github.example.com/",
@@ -142,6 +148,7 @@ For installation from source:
 
 ```yaml
 - { name: 'github',
+    # label: 'Provider name', # optional label for login button, defaults to "GitHub"
     app_id: 'YOUR_APP_ID',
     app_secret: 'YOUR_APP_SECRET',
     url: "https://github.example.com/",

doc/integration/gitlab.md

@@ -54,6 +54,7 @@ GitLab.com generates an application ID and secret key for you to use.
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "gitlab",
+       # "label" => "Provider name", # optional label for login button, defaults to "GitLab.com"
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET",
        "args" => { "scope" => "api" }
@@ -67,6 +68,7 @@ GitLab.com generates an application ID and secret key for you to use.
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "gitlab",
+       "label" => "Provider name", # optional label for login button, defaults to "GitLab.com"
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET",
        "args" => { "scope" => "api", "client_options" => { "site" => "https://gitlab.example.com/api/v4" } }
@@ -78,6 +80,7 @@ GitLab.com generates an application ID and secret key for you to use.
 
    ```yaml
    - { name: 'gitlab',
+       # label: 'Provider name', # optional label for login button, defaults to "GitLab.com"
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET',
        args: { scope: 'api' } }
@@ -87,6 +90,7 @@ GitLab.com generates an application ID and secret key for you to use.
 
    ```yaml
    - { name: 'gitlab',
+       label: 'Provider name', # optional label for login button, defaults to "GitLab.com"
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET',
        args: { scope: 'api', "client_options": { "site": 'https://gitlab.example.com/api/v4' } }

doc/integration/google.md

@@ -80,6 +80,7 @@ On your GitLab server:
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "google_oauth2",
+       # "label" => "Provider name", # optional label for login button, defaults to "Google"
        "app_id" => "YOUR_APP_ID",
        "app_secret" => "YOUR_APP_SECRET",
        "args" => { "access_type" => "offline", "approval_prompt" => '' }
@@ -91,6 +92,7 @@ On your GitLab server:
 
    ```yaml
    - { name: 'google_oauth2',
+       # label: 'Provider name', # optional label for login button, defaults to "Google"
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET',
        args: { access_type: 'offline', approval_prompt: '' } }

doc/integration/oauth2_generic.md

@@ -62,7 +62,7 @@ This strategy is designed to allow configuration of the simple OmniAuth SSO proc
    ```ruby
    gitlab_rails['omniauth_providers'] = [
      { 'name' => 'oauth2_generic',
-       'label' => '<your_oauth2_label>',
+       'label' => 'Provider name', # optional label for login button, defaults to "Oauth2 Generic"
        'app_id' => '<your_app_client_id>',
        'app_secret' => '<your_app_client_secret>',
        'args' => {

doc/integration/salesforce.md

@@ -58,6 +58,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
    gitlab_rails['omniauth_providers'] = [
      {
        "name" => "salesforce",
+       # "label" => "Provider name", # optional label for login button, defaults to "Salesforce"
        "app_id" => "SALESFORCE_CLIENT_ID",
        "app_secret" => "SALESFORCE_CLIENT_SECRET"
      }
@@ -68,6 +69,7 @@ To get the credentials (a pair of Client ID and Client Secret), you must [create
 
    ```yaml
    - { name: 'salesforce',
+       # label: 'Provider name', # optional label for login button, defaults to "Salesforce"
        app_id: 'SALESFORCE_CLIENT_ID',
        app_secret: 'SALESFORCE_CLIENT_SECRET'
    }

doc/integration/saml.md

@@ -99,14 +99,14 @@ as described in the section on [Security](#security). Otherwise, your users are
    gitlab_rails['omniauth_providers'] = [
      {
        name: 'saml',
+       label: 'Provider name', # optional label for login button, defaults to "Saml"
        args: {
                 assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback',
                 idp_cert_fingerprint: '43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8',
                 idp_sso_target_url: 'https://login.example.com/idp',
                 issuer: 'https://gitlab.example.com',
                 name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
-              },
-       label: 'Provider name' # optional label for SAML login button, defaults to "Saml"
+              }
      }
    ]
    ```
@@ -118,14 +118,14 @@ as described in the section on [Security](#security). Otherwise, your users are
      providers:
        - {
          name: 'saml',
+         label: 'Provider name', # optional label for login button, defaults to "Saml"
          args: {
            assertion_consumer_service_url: 'https://gitlab.example.com/users/auth/saml/callback',
            idp_cert_fingerprint: '43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8',
            idp_sso_target_url: 'https://login.example.com/idp',
            issuer: 'https://gitlab.example.com',
            name_identifier_format: 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
-         },
-         label: 'Company Login'  # optional label for SAML login button, defaults to "Saml"
+         }
        }
    ```
 

doc/integration/twitter.md

@@ -63,6 +63,7 @@ Twitter. Twitter generates a client ID and secret key for you to use.
      gitlab_rails['omniauth_providers'] = [
        {
          "name" => "twitter",
+         # "label" => "Provider name", # optional label for login button, defaults to "Twitter"
          "app_id" => "YOUR_APP_ID",
          "app_secret" => "YOUR_APP_SECRET"
        }
@@ -73,6 +74,7 @@ Twitter. Twitter generates a client ID and secret key for you to use.
 
    ```yaml
    - { name: 'twitter',
+       # label: 'Provider name', # optional label for login button, defaults to "Twitter"
        app_id: 'YOUR_APP_ID',
        app_secret: 'YOUR_APP_SECRET' }
    ```