Skip to content

GitLab OAuth2 authentication client module for The Bug Genie issue tracker.

License

Notifications You must be signed in to change notification settings

shoreless-ltd/tbg-oauth2-gitlab

Repository files navigation

The Bug Genie GitLab OAuth2 authentication module

Description

This is an authentication module for The Bug Genie issue tracker. It allows authenticating The Bug Genie users against GitLab as OAuth2 provider.

Requirements

Installation

REMARKS: Replace thebuggenie within the examples with your path to your The Bug Genie installation.

1: The Bug Genie Module Installation

Clone this repository either straight into a folder under thebuggenie/modules/oauth2_gitlab, download the sources and extract them to thebuggenie/modules/oauth2_gitlab, or symlink the sources to the same folder (IMPORTANT: The folder name under thebuggenie/modules MUST be oauth2_gitlab, as The Bug Genie requires the module folder to match the module name):

cd thebuggenie/modules
git clone [email protected]:shoreless-ltd/tbg-oauth2-gitlab.git oauth2_gitlab

2: Install Composer Dependencies

This module uses the omines/oauth2-gitlab composer package, which must be installed after you installed the module to The Bug Genie.

Navigate to the thebuggenie/modules/oauth2_gitlab folder and install the composer dependencies:

cd thebuggenie/modules/oauth2_gitlab
composer install

3: Activate the Module

You can now enable the module from the configuration section in The Bug Genie.

4: Configure GitLab / The Bug Genie

After activating the module, head over to the GitLab OAuth2 settings in The Bug Genie to setup the application key and secret, as well as the GitLab instance you like to authenticate against.

To generate an application key and secret, follow the instructions under Adding an application through the profile within the GitLab docs. (Depending on the GitLab version you are using, the GUI might slightly differ from the given screenshots of this tutorial.)

Reporting issues

If you find any issues, please report them in the issue tracker: https://github.com/shoreless-ltd/tbg-oauth2-gitlab/issues

About

GitLab OAuth2 authentication client module for The Bug Genie issue tracker.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages