Integrate your server with JWT

To enable the JWT OmniAuth provider you must register your application with JWT. JWT will provide you with a secret key for you to use.

On your GitLab server, open the configuration file.

For omnibus package:

  sudo editor /etc/gitlab/gitlab.rb

For installations from source:

  cd /home/git/gitlab

  sudo -u git -H editor config/gitlab.yml

See Initial OmniAuth Configuration for initial settings.

Add the provider configuration:

For omnibus package:

  gitlab_rails['omniauth_providers'] = [
    { name: 'jwt',
      app_secret: 'YOUR_APP_SECRET',
      args: {
              algorithm: 'HS256',
              uid_claim: 'email',
              required_claims: ["name", "email"],
              info_maps: { name: "name", email: "email" },
              auth_url: 'https://example.com/',
              valid_within: nil,
            }
    }
  ]

For installation from source:

  - { name: 'jwt',
      app_secret: 'YOUR_APP_SECRET',
      args: {
              algorithm: 'HS256',
              uid_claim: 'email',
              required_claims: ["name", "email"],
              info_map: { name: "name", email: "email" },
              auth_url: 'https://example.com/',
              valid_within: nil,
            }
    }

For more information on each configuration option refer to the OmniAuth JWT usage documentation.

Change 'YOUR_APP_SECRET' to the client secret.
Save the configuration file.
Reconfigure GitLab or restart GitLab 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 JWT icon below the regular sign in form. Click the icon to begin the authentication process. JWT 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.

2.3 KiB Raw Blame History

Integrate your server with JWT

2.3 KiB

Raw Blame History