2017-12-16 13:29:26 +01:00
---
id: configuration
2018-02-16 19:32:53 +01:00
title: "Archivo de Configuración"
2017-12-16 13:29:26 +01:00
---
2018-01-08 07:46:09 +01:00
Este archivo es la piedra angular de verdaccio donde puedes modificar su comportamiento por defecto, activar plugins y características externas.
2017-12-16 13:29:26 +01:00
2018-01-08 07:46:09 +01:00
Cuando ejecutas por primera vez ` verdaccio` se crea un archivo de configuración por defecto.
2017-12-16 13:29:26 +01:00
2018-01-08 07:46:09 +01:00
## Configuración por Defecto
2017-12-16 13:29:26 +01:00
2018-01-08 07:46:09 +01:00
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** .
2017-12-16 13:29:26 +01:00
```yaml
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}
```
2018-01-08 07:46:09 +01:00
## Secciones
2017-12-16 13:29:26 +01:00
2018-01-08 07:46:09 +01:00
Las siguientes secciones explican que significa cada propiedad y las diferentes configuraciones posibles.
2017-12-16 13:29:26 +01:00
2018-01-08 20:45:03 +01:00
### Almacenamiento
2017-12-16 13:29:26 +01:00
2018-01-08 20:45:03 +01:00
Es la localización por defecto del almacenamiento. **Verdaccio esta basado por defecto en archivos locales de sistema** .
2017-12-16 13:29:26 +01:00
```yaml
storage: ./storage
```
2018-01-08 20:45:03 +01:00
### Autentificación
2017-12-16 13:29:26 +01:00
2018-01-08 22:14:06 +01:00
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 ](plugins.md ). Para mas información sobre esta sección lea [la página de autentificación ](auth.md ).
2017-12-16 13:29:26 +01:00
```yaml
auth:
htpasswd:
file: ./htpasswd
max_users: 1000
```
### Web UI
2018-01-08 22:14:06 +01:00
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.md ).
2017-12-16 13:29:26 +01:00
```yaml
web:
enable: true
title: Verdaccio
logo: logo.png
```
### Uplinks
2018-01-08 22:14:06 +01:00
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.md ).
2017-12-16 13:29:26 +01:00
```yaml
uplinks:
npmjs:
url: https://registry.npmjs.org/
```
2018-01-08 22:14:06 +01:00
### Paquetes
2017-12-16 13:29:26 +01:00
2018-01-08 22:14:06 +01:00
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.md ).
2017-12-16 13:29:26 +01:00
```yaml
packages:
'@*/*':
access: $all
publish: $authenticated
proxy: npmjs
```
2018-01-08 22:14:06 +01:00
## Configuración Avanzada
2017-12-16 13:29:26 +01:00
2018-01-08 22:14:06 +01:00
### Publicar modo sin conexión
2017-12-16 13:29:26 +01:00
2018-01-23 08:59:05 +01:00
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* .
2017-12-16 13:29:26 +01:00
```yaml
publish:
allow_offline: false
```
2018-01-23 08:59:05 +01:00
< small > Desde: < code > verdaccio@2.3.6< / code > debido a < a href = "https://github.com/verdaccio/verdaccio/pull/223" > #223< / a > < / small >
2017-12-16 13:29:26 +01:00
2018-01-08 22:14:06 +01:00
### Prefijos URL
2017-12-16 13:29:26 +01:00
```yaml
url_prefix: https://dev.company.local/verdaccio/
```
2018-01-23 08:59:05 +01:00
Desde: `verdaccio@2.3.6` debido a [#197 ](https://github.com/verdaccio/verdaccio/pull/197 )
2017-12-16 13:29:26 +01:00
2018-01-23 08:59:05 +01:00
### Tamaño Máximo del Cuerpo
2017-12-16 13:29:26 +01:00
2018-05-30 15:46:53 +02:00
By default the maximum body size for a JSON document is `10mb` , if you run in errors as `"request entity too large"` you may increase this value.
2017-12-16 13:29:26 +01:00
```yaml
2018-05-30 15:46:53 +02:00
max_body_size: 10mb
2017-12-16 13:29:26 +01:00
```
2018-01-08 22:14:06 +01:00
### Puertos
2017-12-16 13:29:26 +01:00
2018-01-08 22:14:06 +01:00
`verdaccio` se ejecuta por defecto en el puerto `4873` . Cambiar el puerto se puede cambiar via [cli ](cli.md ) o en el archivo de configuración, las siguientes opciones son válidas.
2017-12-16 13:29:26 +01:00
```yaml
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
New Crowdin translations (#479)
* New translations contributing.md (Chinese Simplified)
* New translations contributing.md (Chinese Traditional)
* New translations contributing.md (Chinese Traditional, Hong Kong)
* New translations contributing.md (Portuguese, Brazilian)
* New translations contributing.md (Spanish)
* New translations contributing.md (Urdu (Pakistan))
* New translations docker.md (Chinese Simplified)
* New translations docker.md (Chinese Traditional)
* New translations docker.md (Chinese Traditional, Hong Kong)
* New translations docker.md (Portuguese, Brazilian)
* New translations docker.md (Spanish)
* New translations docker.md (Urdu (Pakistan))
* New translations node-api.md (Chinese Simplified)
* New translations node-api.md (Chinese Traditional)
* New translations node-api.md (Chinese Traditional, Hong Kong)
* New translations node-api.md (Portuguese, Brazilian)
* New translations node-api.md (Spanish)
* New translations node-api.md (Urdu (Pakistan))
* New translations uplinks.md (Chinese Traditional)
* New translations uplinks.md (Chinese Traditional, Hong Kong)
* New translations uplinks.md (Portuguese, Brazilian)
* New translations uplinks.md (Spanish)
* New translations uplinks.md (Urdu (Pakistan))
* New translations uplinks.md (Chinese Simplified)
* New translations config.md (Chinese Simplified)
* New translations config.md (Spanish)
* New translations config.md (Urdu (Pakistan))
* New translations config.md (Chinese Traditional, Hong Kong)
* New translations config.md (Portuguese, Brazilian)
* New translations config.md (Chinese Traditional)
2018-01-20 09:09:16 +01:00
# - "[::1]:4873" # ipv6
2017-12-16 13:29:26 +01:00
# - unix:/tmp/verdaccio.sock # unix socket
```
### HTTPS
2018-01-08 22:14:06 +01:00
Para habilitar`https` 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 ](ssl.md ).
2017-12-16 13:29:26 +01:00
```yaml
https:
2018-02-16 19:32:53 +01:00
key: ./path/verdaccio-key.pem
cert: ./path/verdaccio-cert.pem
ca: ./path/verdaccio-csr.pem
2017-12-16 13:29:26 +01:00
```
2018-02-11 09:58:10 +01:00
### Proxy
2017-12-16 13:29:26 +01:00
2018-03-16 07:08:06 +01:00
Proxies tienen propósitos especiales en servidores HTTP diseñados para transferir datos desde servidores remotos a clientes locales.
2018-02-11 09:58:10 +01:00
#### http_proxy and https_proxy
2018-03-16 07:08:06 +01:00
Si ya tienes un proxy en tu red, puedes definir el encabezado `X-Forwarded-For` usando las siguientes propiedades.
2018-02-11 09:58:10 +01:00
```yaml
http_proxy: http://something.local/
https_proxy: https://something.local/
```
#### no_proxy
2018-03-16 07:08:06 +01:00
Esta variable debería contentener una lista de extensiones domínios separados por comas donde el proxy no debería ser usado.
2018-02-11 09:58:10 +01:00
```yaml
http_proxy: http://something.local/
https_proxy: https://something.local/
```
2018-03-16 07:08:06 +01:00
### Notificaciones
2018-02-11 09:58:10 +01:00
2018-03-16 07:08:06 +01:00
Habilita notificaciones en aplicaciones a terceros es muy sencillo via web hooks. Para más información sobre esta sección lea [la página de notificaciones ](notifications.md ).
2017-12-16 13:29:26 +01:00
```yaml
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"}'
2018-01-21 00:04:36 +01:00
```
2018-05-31 10:55:20 +02:00
> Para información detallada sobre configuración, por favor [revise el código fuente](https://github.com/verdaccio/verdaccio/tree/master/conf).
### Audit
2018-06-07 17:19:13 +02:00
< small > Since: < code > verdaccio@3.0.0< / code > < / small >
2018-05-31 10:55:20 +02:00
`npm audit` is a new command released with [npm 6.x ](https://github.com/npm/npm/releases/tag/v6.1.0 ). Verdaccio includes a built-in middleware plugin to handle this command.
> If you have a new installation it comes by default, otherwise you need to add the following props to your config file
```yaml
middlewares:
audit:
enabled: true
```