1
0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-13 03:35:52 +01:00
verdaccio/docs/plugins.md
2018-01-06 07:39:30 +00:00

4.3 KiB

id date title
plugins 2017-07-10T23:36:56.503Z Plugins

Verdaccio is an plugabble aplication. Currently supports multiple plugins only for Authentication but there are plans to improve the plugin system. If you are interested to develop your own plugin, read the development section.

Usage

Installation

$> 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.

 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.

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.

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

Verdaccio Plugins (since 2.1.x)

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.