📦🔐 Verdaccio GitLab OAuth plugin
A GitLab OAuth Plugin for Verdaccio
The plugin is similar to verdaccio-github-oauth-ui, but adapted to use GitLab APIs. When clicking the login button, instead of filling in a login form, you are asked to log in with itLab.
In case you need CLI support for automation purposes, the plugin is also compatible with it, adapting the functionality from sinopia-github-oauth-cli to work with GitLab.
- Verdaccio 3 and 4
- Node >=10
- Chrome, Firefox, Firefox ESR, Edge, Safari, IE 11
$ npm install verdaccio-gitlab-oauth
- Create an OAuth app at https://gitlab.com/profile/applications
- The callback URL should be
- The scope needed is
Merge the below options with your existing Verdaccio config:
middlewares:gitlab-oauth:enabled: trueauth:gitlab-oauth:group: GITLAB_GROUP_PATHclient-id: GITLAB_CLIENT_IDclient-secret: GITLAB_CLIENT_SECRETgitlab-host: # Optional, default points to gitlab.comurl_prefix: YOUR_REGISTRY_URL
- The configured values can either be the actual value or the name of an environment variable that contains the value.
- The config props can be specified under either the
authnode. Just make sure, the addon is included under both nodes.
Users within this group will be able to authenticate.
These values can be obtained from GitLab OAuth app page at https://gitlab.com/profile/applications.
Set this if you are using self-hosted GitLab. Example:
If configured, it must match
YOUR_REGISTRY_URL. See GitLab Config.
If you are behind a proxy server, the plugin needs to know the proxy server in order to make GitLab requests.
Configure the below environment variable.
$ export GLOBAL_AGENT_HTTP_PROXY=http://127.0.0.1:8080
See the global-agent docs for detailed configuration instrcutions.
- Click the login button and login via GitLab, if not logged in already.
- Authorize the registry - this needs to be done only once.
- After authorizing the registry with GitLab, you'll be redirected back to the Verdaccio registry.
You are now logged in.
To set up authentication with the registry in your npm CLI, you'll need to run the commands shown on the UI.
- Verdaccio 4: open the "Register Info" dialog and klick "Copy to clipboard"
- Verdaccio 3: Select the text in the header and copy it. In case the text is too long, you can double-click it. The invisible part will still be selected and copied.
- Run the copied commands on your terminal.
$ npm config set //localhost:4873:_authToken "SECRET_TOKEN" $ npm config set //localhost:4873:always-auth true
- Verify npm is set up correctly by running the
$ npm whoami --registry http://localhost:4873 n4bb12
If you see your GitLab username, you are ready to start publishing packages.
Click the Logout button as per usual.
Unless OAuth access is revoked in the GitLab settings, the token is valid indefinitely.