4.9 KiB
| id | title |
|---|---|
| configuration | Archivo de Configuración |
Este archivo es la piedra angular de verdaccio donde puedes modificar su comportamiento por defecto, activar plugins y características externas.
Cuando ejecutas por primera vez verdaccio se crea un archivo de configuración por defecto.
Configuración por Defecto
La configuración por defecto tiene soporte para paquetes con enfoque y permite a los usuarios acceder a todos los paquetes pero solo a los usuarios autentificados a publicarlos.
storage: ./storage
auth:
htpasswd:
file: ./htpasswd
uplinks:
npmjs:
url: https://registry.npmjs.org/
packages:
'@*/*':
access: $all
publish: $authenticated
proxy: npmjs
'**':
proxy: npmjs
logs:
- {type: stdout, format: pretty, level: http}
Secciones
Las siguientes secciones explican que significa cada propiedad y las diferentes configuraciones posibles.
Almacenamiento
Es la localización por defecto del almacenamiento. Verdaccio esta basado por defecto en archivos locales de sistema.
storage: ./storage
Autentificación
La configuración de autenticación es hecha aquí y esta basado en htpasswd y viene integrada por defecto. Puedes modificar el comportamiento por defecto vía extensiones. Para mas información sobre esta sección lea la página de autentificación.
auth:
htpasswd:
file: ./htpasswd
max_users: 1000
Web UI
Esta propiedad te permite modificar diseño del interfaz de usuario. Para mas información sobre esta sección lea la página de Web UI.
web:
enable: true
title: Verdaccio
logo: logo.png
Uplinks
Uplinks es la habilidad del sistema para traer paquetes de registros remotos cuando los paquetes no están disponibles localmente. Para mas información sobre esta sección lea página de uplinks.
uplinks:
npmjs:
url: https://registry.npmjs.org/
Paquetes
Paquetes permiten al usuario como los paquetes van a ser accedido. Para mas información sobre esta sección leer la página de paquetes.
packages:
'@*/*':
access: $all
publish: $authenticated
proxy: npmjs
Configuración Avanzada
Publicar modo sin conexión
Por defecto, verdaccio no permite publicar cuando el servidor esta en modo fuera de linea, este comportamiento puede ser sobrescrito cambiando el valor a true.
publish:
allow_offline: false
Desde: verdaccio@2.3.6 debido a #223
Prefijos URL
url_prefix: https://dev.company.local/verdaccio/
Desde: verdaccio@2.3.6 debido a #197
Tamaño Máximo del Cuerpo
Por defecto el tamaño máximo cuerpo para un documento JSON es 1mb, si un problema similar a "request entity too large" te podrá interesar aumentar este valor.
max_body_size: 1mb
Puertos
verdaccio se ejecuta por defecto en el puerto 4873. Cambiar el puerto se puede cambiar via cli o en el archivo de configuración, las siguientes opciones son válidas.
listen:
# - localhost:4873 # default value
# - http://localhost:4873 # same thing
# - 0.0.0.0:4873 # listen on all addresses (INADDR_ANY)
# - https://example.org:4873 # if you want to use https
# - "[::1]:4873" # ipv6
# - unix:/tmp/verdaccio.sock # unix socket
HTTPS
Para habilitarhttps en verdaccio es suficiente con definir en listen en su dominio el protocolo https://. Para mas información sobre esta sección leer página de Ssl.
https:
key: path/to/server.key
cert: path/to/server.crt
ca: path/to/server.pem
Proxy
Proxies are special-purpose HTTP servers designed to transfer data from remote servers to local clients.
http_proxy and https_proxy
If you have a proxy in your network you can set a X-Forwarded-For header using the following properties.
http_proxy: http://something.local/
https_proxy: https://something.local/
no_proxy
This variable should contain a comma-separated list of domain extensions proxy should not be used for.
http_proxy: http://something.local/
https_proxy: https://something.local/
Notifications
Enable notifications to three party tools is fairly easy via web hooks. For more information about this section read the notifications page.
notify:
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'
Para información detallada sobre configuración, por favor revise el código fuente.