The original Passport-GitLab module has not been maintained for a long time. Due to the unclear license situation and issues in the code, this library was rewritten based on Passport-Facebook and published under the MIT license.
This module lets you authenticate using GitLab in your Node.js applications. By plugging into Passport, GitLab authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
$ npm install passport-gitlab2
Passport-GitLab requires GitLab 9.0.0 or higher to work. Before using the OAuth2 authentication provider service, you have register a new application in your user profile or in the administrator portal. GitLab will then issue an application ID and a secret, which need to be provided to the strategy. You will also need to configure a redirect URI which matches the route in your application.
The GitLab authentication strategy authenticates users using a GitLab
account and OAuth 2.0 tokens. The app ID and secret obtained when creating an
application are supplied as options when creating the strategy. The strategy
also requires a
verify callback, which receives the access token and optional
refresh token, as well as
profile which contains the authenticated user's
GitLab profile. The
verify callback must call
cb providing a user to
passport.authenticate(), specifying the
'gitlab' strategy, to
For example, as route middleware in an Express application:
How do I use my own GitLab instance rather than gitlab.com?
Passport-GitLab automatically uses GitLab.com as
authentication endpoint when not configured otherwise. You can use the
parameter to point to any other GitLab instance as following:
clientID: GITLAB_APP_IDclientSecret: GITLAB_APP_SECRETcallbackURL: ""baseURL: ""...)
All URLs (e.g. token-url, authorization-url, profile-url) are automatically adapted to utilize the configured instance. You can of course overwrite all URLs manually if needed.
How do I change permissions / scope when obtaining a user profile?
GitLab supports multiple scopes at the moment like
By default, the
read_user scope is used. Changing the OAuth2 scope to
api works as following:
More information can be found in the official GitLab documentation.
We appreciate contributions in several forms, e.g. documentation, testing, coding, issues, etc. Please follow the best practice contribution guide as mentioned below when submitting code changes:
$ make lint
The test suite is located in the
test/ directory. All new features are
expected to have corresponding test cases. Ensure that the complete test suite
passes by executing:
$ make test
The test suite covers 100% of the code base. All new feature development is expected to maintain that level. Coverage reports can be viewed by executing:
$ make coverage-view
Copyright (c) 2016-2019 Fabio Huser email@example.com
Copyright (c) 2011-2016 Jared Hanson <http://jaredhanson.net/>