2017-12-16 13:29:17 +01:00
---
id: plugins
2018-06-23 16:42:14 +02:00
title: "Plugins"
2017-12-16 13:29:17 +01:00
---
2018-07-25 07:56:23 +02:00
Verdaccio is an plugabble aplication. It can be extended in many ways, either new authentication methods, adding endpoints or using a custom storage.
2018-05-27 08:07:59 +02:00
2018-07-06 07:11:59 +02:00
> If you are interested to develop your own plugin, read the [development](dev-plugins.md) section.
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
## Uso
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
### Instalación
2017-12-16 13:29:17 +01:00
```bash
$> npm install --global verdaccio-activedirectory
```
2018-06-23 16:42:14 +02:00
`verdaccio` como un fork de sinopia tiene compatibilidad con versiones anteriores, con plugins que son compatibles con `sinopia@1.4.0` . En tal caso la instalación es la misma.
2017-12-16 13:29:17 +01:00
2018-05-29 07:32:59 +02:00
$> npm install --global sinopia-memory
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
### Configuración
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
Abra el archivo `config.yaml` y actualice la sección `auth` como a continuación:
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
La configuración por defecto luce así, debido a que usamos un plugin `htpasswd` incorporado por defecto que puede desactivar con solo comentar las siguientes líneas.
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
### Configuración del Plugin Auth
2018-05-27 08:07:59 +02:00
2017-12-16 13:29:17 +01:00
```yaml
htpasswd:
file: ./htpasswd
#max_users: 1000
```
2018-06-20 07:46:52 +02:00
y reemplazándolos con (en caso de que decida usar un plugin `ldap` ).
2017-12-16 13:29:17 +01:00
```yaml
auth:
activedirectory:
url: "ldap://10.0.100.1"
baseDN: 'dc=sample,dc=local'
domainSuffix: 'sample.local'
```
2018-06-20 07:46:52 +02:00
#### Múltiples Plugins Auth
2017-12-16 13:29:17 +01:00
2018-08-17 08:03:53 +02:00
This is tecnically possible, making the plugin order important, as the credentials will be resolved in order.
2017-12-16 13:29:17 +01:00
```yaml
auth:
htpasswd:
file: ./htpasswd
#max_users: 1000
activedirectory:
url: "ldap://10.0.100.1"
baseDN: 'dc=sample,dc=local'
domainSuffix: 'sample.local'
```
2018-06-20 07:46:52 +02:00
### Configuración del Plugin Middleware
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
Este es un ejemplo de como se instala un plugin middleware. Todos los plugins middleware deben estar definidos en el namespace **middlewares** .
2018-05-27 08:07:59 +02:00
```yaml
middlewares:
audit:
enabled: true
```
2018-07-25 07:56:23 +02:00
> You might follow the [audit middle plugin](https://github.com/verdaccio/verdaccio-audit) as base example.
2018-06-23 16:42:14 +02:00
### Configuración del Plugin Store (Almacén)
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
Este es un ejemplo de como instalar un plugin de almacenamiento. Todos los plugins de almacenamiento debe estar definidos en el namespace **store** .
2018-05-27 08:07:59 +02:00
```yaml
store:
memory:
limit: 1000
```
2018-07-25 07:56:23 +02:00
> If you define a custom store, the property **storage** in the configuration file will be ignored.
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
## Plugins heredados
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
### Plugins de Sinopia
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
(compatible con todas las versiones)
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
* [sinopia-npm ](https://www.npmjs.com/package/sinopia-npm ): plugin auth para sinopia soportando un registro npm.
* [sinopia-memory ](https://www.npmjs.com/package/sinopia-memory ): plugin auth para sinopia que mantiene a los usuarios en la memoria.
2017-12-16 13:29:17 +01:00
* [sinopia-github-oauth-cli ](https://www.npmjs.com/package/sinopia-github-oauth-cli ).
2018-06-23 16:42:14 +02:00
* [sinopia-crowd ](https://www.npmjs.com/package/sinopia-crowd ): plugin auth para sinopia que soporta atlassian crowd.
2018-06-20 07:46:52 +02:00
* [sinopia-activedirectory ](https://www.npmjs.com/package/sinopia-activedirectory ): plugin de autenticación Active Directory para sinopia.
* [sinopia-github-oauth ](https://www.npmjs.com/package/sinopia-github-oauth ): plugin de autenticación para sinopia2, el cual soporta el flujo web de github oauth.
* [sinopia-delegated-auth ](https://www.npmjs.com/package/sinopia-delegated-auth ): plugin de autenticación de Sinopia que delega autenticación a otro URL HTTP
* [sinopia-altldap ](https://www.npmjs.com/package/sinopia-altldap ): Alterna el plugin LDAP Auth para Sinopia
2018-06-23 16:42:14 +02:00
* [sinopia-request ](https://www.npmjs.com/package/sinopia-request ): Un plugin sencillo y completamente auth con configuración para usar una API externa.
* [sinopia-htaccess-gpg-email ](https://www.npmjs.com/package/sinopia-htaccess-gpg-email ): Genera contraseña en formato htaccess, encripta con GPG y la evía a través de la API MailGun a los usuarios.
* [sinopia-mongodb ](https://www.npmjs.com/package/sinopia-mongodb ): Un plugin fácil y completamente auth con configuración para usar una base de datos mongodb.
2018-06-20 07:46:52 +02:00
* [sinopia-htpasswd ](https://www.npmjs.com/package/sinopia-htpasswd ): plugin auth para sinopia que soporta el formato htpasswd.
* [sinopia-leveldb ](https://www.npmjs.com/package/sinopia-leveldb ): un plugin auth leveldb respaldado para el npm privado de sinopia.
* [sinopia-gitlabheres ](https://www.npmjs.com/package/sinopia-gitlabheres ): plugin de autenticación de Gitlab para sinopia.
* [sinopia-gitlab ](https://www.npmjs.com/package/sinopia-gitlab ): plugin de autenticación de Gitlab para sinopia
* [sinopia-ldap ](https://www.npmjs.com/package/sinopia-ldap ): plugin LDAP auth para sinopia.
* [sinopia-github-oauth-env ](https://www.npmjs.com/package/sinopia-github-oauth-env ) plugin de autenticación de Sinopia con flujo web github oauth.
2017-12-16 13:29:17 +01:00
2018-07-25 07:56:23 +02:00
> All sinopia plugins should be compatible with all future verdaccio versions. Anyhow, we encourage contributors to migrate them to the modern verdaccio API and using the prefix as *verdaccio-xx-name*.
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
## Plugins de Verdaccio
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
(compatible desde 2.1.x)
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
### Plugins de Autorización
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
* [verdaccio-bitbucket ](https://github.com/idangozlan/verdaccio-bitbucket ): plugin de autenticación de Bitbucket para verdaccio.
* [verdaccio-ldap ](https://www.npmjs.com/package/verdaccio-ldap ): plugin LDAP auth para verdaccio.
* [verdaccio-active-directory ](https://github.com/nowhammies/verdaccio-activedirectory ): plugin de autenticación Active Directory para verdaccio
* [verdaccio-gitlab ](https://github.com/bufferoverflow/verdaccio-gitlab ): use la Token de Acceso Personal de GitLab para autenticarse
2018-06-23 16:42:14 +02:00
* [verdaccio-htpasswd ](https://github.com/verdaccio/verdaccio-htpasswd ): Auth basado en el plugin del archivo htpasswd (incorporado) para verdaccio
2018-07-17 10:41:31 +02:00
* [verdaccio-github-oauth ](https://github.com/aroundus-inc/verdaccio-github-oauth ): Github oauth authentication plugin for verdaccio.
2018-08-01 22:25:11 +02:00
* [verdaccio-github-oauth-ui ](https://github.com/n4bb12/verdaccio-github-oauth-ui ): GitHub OAuth plugin for the verdaccio login button.
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
### Plugins de Middleware
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
* [verdaccio-audit ](https://github.com/verdaccio/verdaccio-audit ): plugin de verdaccio para soporte cli de *npm audit* (incorporado) (compatible desde 3.x)
2017-12-16 13:29:17 +01:00
2018-06-20 07:46:52 +02:00
* [verdaccio-profile-api ](https://github.com/ahoracek/verdaccio-profile-api ): plugin de verdaccio para soporte cli de *npm profile* y *npm profile set password* para la autenticación basada en *verdaccio-htpasswd*
2018-06-08 07:07:51 +02:00
2018-06-20 07:46:52 +02:00
### Plugins de Storage (Almacenamiento)
2018-03-29 08:09:59 +02:00
2018-06-20 07:46:52 +02:00
(compatible desde 3.x)
2018-05-27 08:07:59 +02:00
2018-06-20 07:46:52 +02:00
* [verdaccio-memory ](https://github.com/verdaccio/verdaccio-memory ) Plugin de almacenamiento para alojar paquetes en la Memoria
* [verdaccio-s3-storage ](https://github.com/remitly/verdaccio-s3-storage ) Plugin de almacenamiento para alojar paquetes **Amazon S3**
* [verdaccio-google-cloud ](https://github.com/verdaccio/verdaccio-google-cloud ) Plugin de almacenamiento para alojar paquetes **Google Cloud Storage**
2018-03-29 08:09:59 +02:00
2018-06-20 07:46:52 +02:00
## Advertencias
2017-12-16 13:29:17 +01:00
2018-07-25 07:56:23 +02:00
> 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.