Verdaccio es una herramienta proxy para el popular administrador de paquetes Node.js que le permite crear y administrar fácilmente repositorios de paquetes npm localmente o en una red privada. A través de Verdaccio, los equipos de desarrollo pueden crear sus propios almacenes de paquetes npm para controlar y administrar mejor sus dependencias, al mismo tiempo que brindan velocidades de descarga de paquetes más rápidas y reducen la carga en el servidor central de npm. En este artículo, explicaré en detalle cómo funciona Verdaccio, su propósito, configuración y ejemplos de uso para ayudarte a comprenderlo mejor.
Cómo funciona Verdaccio
El principio básico de Verdaccio es representar el registro npm. Puede considerarse como un caché del registro npm local y proporciona una interfaz fácil de usar en la que puede publicar, instalar y administrar paquetes. Así es como funciona:
-
Registro proxy de npm : Verdaccio le permite configurarlo para que actúe como proxy del registro oficial de npm o de cualquier otro registro de npm. Cuando intenta instalar, publicar o acceder a un paquete, Verdaccio primero verificará el caché local y, si encuentra el paquete requerido, lo entregará inmediatamente. Si no lo encuentra, enviará una solicitud al registro ascendente, obtendrá el paquete y lo almacenará en caché localmente para uso futuro.
-
Almacenamiento de paquetes local : Verdaccio proporciona la funcionalidad de almacenamiento de paquetes local, lo que significa que puede crear y publicar sus propios paquetes npm localmente sin publicarlos en el registro público de npm. Esto es útil para proyectos internos, bibliotecas privadas o situaciones en las que es necesario proteger la propiedad intelectual.
-
Seguridad : Verdaccio admite control de acceso, autenticación y administración de permisos, y puede configurarlo para restringir quién puede publicar, acceder o administrar paquetes en el almacén. Esto ayuda a proteger sus paquetes y código contra accesos y modificaciones no autorizados.
-
Altamente personalizable : Verdaccio es altamente personalizable según sus necesidades. Puede configurar sus complementos, temas, middleware y muchas otras opciones para adaptarse a los requisitos específicos de su proyecto u organización.
Usos del Verdaccio
Verdaccio es útil en muchas situaciones diferentes, estos son algunos de los usos principales:
-
Desarrollo local : durante el desarrollo, los desarrolladores pueden configurar un servidor Verdaccio localmente para una instalación y acceso más rápido a las dependencias. De esta manera, pueden usar un caché local en lugar de descargar dependencias del registro público de npm cada vez, lo que hace que el desarrollo sea más eficiente.
-
Proyectos internos : para proyectos dentro de una organización, especialmente aquellos que necesitan proteger la propiedad intelectual o no quieren que su código se haga público, Verdaccio proporciona una manera conveniente de crear y administrar repositorios npm locales. Esto garantiza que los paquetes no se filtren accidentalmente al registro público de npm.
-
Entornos sin conexión : en entornos sin conexión a Internet o ancho de banda limitado, Verdaccio le permite crear un caché npm local para garantizar que los miembros del equipo puedan continuar el desarrollo sin interrupciones debido a las limitaciones de la red.
-
Seguridad : las funciones de autenticación y control de permisos de Verdaccio mejoran la seguridad de los paquetes al permitirle administrar mejor quién puede acceder y publicar sus paquetes. Esto es importante para escenarios en los que protege proyectos internos o proporciona acceso limitado.
La configuración de Verdaccio
La configuración de Verdaccio es muy flexible, lo que le permite personalizarla según sus necesidades específicas. Aquí hay un ejemplo simple del archivo de configuración de Verdaccio:
# Verdaccio 配置文件
# 监听端口
listen: 4873
# 使用的存储插件，可以选择文件系统、云存储等
storage: ./storage
# 访问控制列表
access:
- $all
- publish: admin
# 身份验证插件
auth:
htpasswd:
file: ./htpasswd
max_users: 1000
# 插件配置
plugins:
some-plugin:
option1: value1
option2: value2
# 其他配置项...
En el ejemplo de configuración anterior, definimos algunas opciones de configuración clave, como puerto de escucha, método de almacenamiento, lista de control de acceso, autenticación y configuración de complementos. Puede modificar estas opciones de configuración según sea necesario para cumplir con sus requisitos.
Ejemplo de uso de Verdaccio
Veamos algunos usos de ejemplo para detallar cómo funciona y está configurado Verdaccio.
1. Configure un servidor Verdaccio local
Primero, crearemos un servidor Verdaccio local para acelerar nuestro proceso de desarrollo. Supongamos que nuestro archivo de configuración de Verdaccio se llama verdaccio-config.yamly tenemos Verdaccio instalado:
npm install -g verdaccio
Ahora podemos iniciar el servidor Verdaccio usando el siguiente comando:
verdaccio -c verdaccio-config.yaml
Esto iniciará el servidor Verdaccio y hará que escuche en el puerto especificado en el archivo de configuración (4873 en este ejemplo). Ahora podemos acceder a la interfaz de usuario de Verdaccio a través de http://localhost:4873.
2. Publicar el paquete en el repositorio local de Verdaccio.
Digamos que tenemos un paquete npm llamado "mi-paquete-awesome" y queremos publicarlo en nuestro repositorio local de Verdaccio. Primero, debemos iniciar sesión en el servidor Verdaccio,
Para asegurarnos de que tenemos permisos de publicación:
npm login --registry http://localhost:4873
Luego, siga las indicaciones para ingresar su nombre de usuario, contraseña y dirección de correo electrónico. Una vez que hayamos iniciado sesión correctamente, podemos publicar el paquete en el repositorio local de Verdaccio usando el siguiente comando:
npm publish --registry http://localhost:4873
Esto publicará el paquete en nuestro repositorio local de Verdaccio, donde se puede instalar con el siguiente comando:
npm install my-awesome-package --registry http://localhost:4873
Esto garantiza que durante el desarrollo estemos usando paquetes del repositorio local de Verdaccio en lugar de descargarlos del registro público npm.
3. Configurar el control de acceso
En Verdaccio podrás configurar el control de acceso según tus necesidades. Supongamos que queremos restringir que solo los administradores puedan publicar paquetes, podemos agregar la siguiente regla de control de acceso en el archivo de configuración:
# Verdaccio 配置文件
access:
- $all
- publish: admin
Esto solo permitirá a los usuarios con permisos de "administrador" publicar paquetes, otros usuarios tendrán acceso pero no podrán publicar. El control de acceso se puede configurar de forma más compleja según sus necesidades.
4. Utilice complementos
Verdaccio admite complementos para que puedas ampliar su funcionalidad según tus necesidades. Supongamos que queremos agregar un complemento personalizado para implementar autenticación adicional, podemos agregar la siguiente configuración de complemento en el archivo de configuración:
# Verdaccio 配置文件
auth:
custom-auth-plugin:
option1: value1
option2: value2
Luego necesitamos instalar y configurar los complementos adecuados para satisfacer nuestras necesidades.
Resumir
Verdaccio es una poderosa herramienta proxy de administrador de paquetes de Node.js que le permite crear y administrar repositorios de paquetes npm localmente o en una red privada. Funciona mediante proxy del registro npm, proporcionando almacenamiento de paquetes local, seguridad, control de acceso y un alto grado de personalización. Verdaccio se puede utilizar para acelerar el desarrollo local, gestionar proyectos internos, trabajar en entornos fuera de línea y mejorar la seguridad de los paquetes. A través de ejemplos de uso, explicamos en detalle cómo configurar un servidor Verdaccio local, publicar paquetes, configurar el control de acceso y usar complementos para ayudarlo a comprender y utilizar mejor las funciones de Verdaccio. Espero que este artículo haya sido útil y le haya permitido utilizar mejor Verdaccio para administrar las dependencias de su proyecto Node.js.