93 lines
4.3 KiB
Markdown
93 lines
4.3 KiB
Markdown
---
|
|
id: plugins
|
|
date: '2017-07-10T23:36:56.503Z'
|
|
title: "Plugins"
|
|
---
|
|
|
|
Verdaccio is an plugabble aplication. Currently supports multiple plugins only for [Authentication](auth.md) but there are plans to [improve the plugin system](https://github.com/verdaccio/verdaccio/issues/169). If you are interested to develop your own plugin, read the [development](development.md) section.
|
|
|
|
## Usage
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
$> npm install --global verdaccio-activedirectory
|
|
```
|
|
`verdaccio` as a sinopia fork it has backward compability with plugins that are compatible with `sinopia@1.4.0`. In such case the installation is the same.
|
|
|
|
```
|
|
&> npm install --global sinopia-memory
|
|
```
|
|
|
|
### Configuration
|
|
|
|
Open the `config.yaml` file and update the `auth` section as follows:
|
|
|
|
The default configuration looks like this, due we use a build-in `htpasswd` plugin by default that you can disable just commenting out the following lines.
|
|
|
|
```yaml
|
|
htpasswd:
|
|
file: ./htpasswd
|
|
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
# You can set this to -1 to disable registration.
|
|
#max_users: 1000
|
|
```
|
|
|
|
and replacing them with (in case you decide to use a `ldap` plugin.
|
|
|
|
```yaml
|
|
auth:
|
|
activedirectory:
|
|
url: "ldap://10.0.100.1"
|
|
baseDN: 'dc=sample,dc=local'
|
|
domainSuffix: 'sample.local'
|
|
```
|
|
|
|
### Multiple Auth plugins
|
|
|
|
This is tecnically possible, the plugins order becames important, the the credentials will resolved in order.
|
|
|
|
```yaml
|
|
auth:
|
|
htpasswd:
|
|
file: ./htpasswd
|
|
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
# You can set this to -1 to disable registration.
|
|
#max_users: 1000
|
|
activedirectory:
|
|
url: "ldap://10.0.100.1"
|
|
baseDN: 'dc=sample,dc=local'
|
|
domainSuffix: 'sample.local'
|
|
```
|
|
|
|
This is a list of plugins compatible with **Verdaccio**.
|
|
|
|
## Sinopia Legacy Plugins
|
|
|
|
* [sinopia-npm](https://www.npmjs.com/package/sinopia-npm): auth plugin for sinopia supporting an npm registry.
|
|
* [sinopia-memory](https://www.npmjs.com/package/sinopia-memory): auth plugin for sinopia that keeps users in memory.
|
|
* [sinopia-github-oauth-cli](https://www.npmjs.com/package/sinopia-github-oauth-cli).
|
|
* [sinopia-crowd](https://www.npmjs.com/package/sinopia-crowd): auth plugin for sinopia supporting atlassian crowd.
|
|
* [sinopia-activedirectory](https://www.npmjs.com/package/sinopia-activedirectory): Active Directory authentication plugin for sinopia.
|
|
* [sinopia-github-oauth](https://www.npmjs.com/package/sinopia-github-oauth): authentication plugin for sinopia2, supporting github oauth web flow.
|
|
* [sinopia-delegated-auth](https://www.npmjs.com/package/sinopia-delegated-auth): Sinopia authentication plugin that delegates authentication to another HTTP URL
|
|
* [sinopia-altldap](https://www.npmjs.com/package/sinopia-altldap): Alternate LDAP Auth plugin for Sinopia
|
|
* [sinopia-request](https://www.npmjs.com/package/sinopia-request): An easy and fully auth-plugin with configuration to use an external API.
|
|
* [sinopia-htaccess-gpg-email](https://www.npmjs.com/package/sinopia-htaccess-gpg-email): Generate password in htaccess format, encrypt with GPG and send via MailGun API to users.
|
|
* [sinopia-mongodb](https://www.npmjs.com/package/sinopia-mongodb): An easy and fully auth-plugin with configuration to use a mongodb database.
|
|
* [sinopia-htpasswd](https://www.npmjs.com/package/sinopia-htpasswd): auth plugin for sinopia supporting htpasswd format.
|
|
* [sinopia-leveldb](https://www.npmjs.com/package/sinopia-leveldb): a leveldb backed auth plugin for sinopia private npm.
|
|
* [sinopia-gitlabheres](https://www.npmjs.com/package/sinopia-gitlabheres): Gitlab authentication plugin for sinopia.
|
|
* [sinopia-gitlab](https://www.npmjs.com/package/sinopia-gitlab): Gitlab authentication plugin for sinopia
|
|
* [sinopia-ldap](https://www.npmjs.com/package/sinopia-ldap): LDAP auth plugin for sinopia.
|
|
|
|
## Verdaccio Plugins (since 2.1.x)
|
|
|
|
* [verdaccio-bitbucket](https://github.com/idangozlan/verdaccio-bitbucket): Bitbucket authentication plugin for verdaccio.
|
|
* [verdaccio-ldap](https://www.npmjs.com/package/verdaccio-ldap): LDAP auth plugin for verdaccio.
|
|
* [verdaccio-active-directory](https://github.com/nowhammies/verdaccio-activedirectory): Active Directory authentication plugin for verdaccio
|
|
|
|
## Caveats
|
|
|
|
Not all these plugins are been tested continuously, some of them might not work at all. Please if you found any issue feel free to notify the owner of each plugin.
|