README.md

Gerrit OAuth2 authentication provider

With this plugin Gerrit can use OAuth2 protocol for authentication. Supported OAuth providers:

• AirVantage
• Bitbucket
• CAS
• CoreOS Dex
• Facebook
• GitHub
• GitLab
• Google
• Keycloak
• LemonLDAP::NG
• Azure (previously named Office365)
• Phabricator

See the Wiki what it can do for you.

Prebuilt artifacts

Prebuilt binary artifacts are available on release page. Make sure to pick the right JAR for your Gerrit version.

Build

To build the plugin with Bazel, install Bazel and run the following:

  git clone https://gerrit.googlesource.com/plugins/oauth gerrit-oauth-provider
  nix-shell -p bazel_4 jdk11
  cd gerrit-oauth-provider
  echo "4.2.2" > .bazelversion
   bazel build gerrit-oauth-provider
  find ~/.cache/bazel/ -name "gerrit-oauth-provider.jar"

Install

Copy the bazel-bin/oauth.jar to $gerrit_site/plugins and re-run init to configure it:

  java -jar gerrit.war init -d <site>
  [...]
  *** OAuth Authentication Provider
  ***
  Use Bitbucket OAuth provider for Gerrit login ? [Y/n]? n
  Use Google OAuth provider for Gerrit login ? [Y/n]?
  Application client id          : <client-id>
  Application client secret      : 
                confirm password : 
  Link to OpenID accounts? [true]: 
  Use GitHub OAuth provider for Gerrit login ? [Y/n]? n

Reporting bugs

Make sure to read the FAQ before reporting issues.

License

Apache License 2.0