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-08-25 12:18:46 +02:00
Las siguientes seciones explican que significa cada propiedad y todas sus diferentes opciones.
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-08-25 12:18:46 +02:00
### Extensiones
2017-12-16 13:29:26 +01:00
2018-08-25 12:18:46 +02:00
Es la localización del directorio de extensiones. Muy útil para despliegues basados en Docker/Kubernetes.
2018-07-21 16:34:10 +02:00
```yaml
plugins: ./plugins
```
2018-08-25 12:18:46 +02:00
### Autentificación
2018-07-21 16:34:10 +02:00
2018-08-25 12:18:46 +02:00
La configuración de autentificación es definida aquí, por defecto la autentificación esta basada en `htpasswd` y es por defecto. Puedes modificar el comportamiento via [extensiones ](plugins.md ). Para mas información sobre esta sección lee [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-08-25 12:18:46 +02:00
Estas propiedades te permiten modificar el aspecto del interfaz web. Para mas información sobre esta sección lea [la página de interfaz web ](web.md ).
2017-12-16 13:29:26 +01:00
```yaml
web:
enable: true
title: Verdaccio
logo: logo.png
2018-08-01 22:25:11 +02:00
scope:
2017-12-16 13:29:26 +01:00
```
### Uplinks
2018-08-25 12:18:46 +02:00
Uplinks es la habilidad del sistema para descargar paquetes de registros remotos cuando dichos paquetes no estan disponibles localmente. Para mas información sobre esta sección lea [la página de uplinks ](uplinks.md ).
2017-12-16 13:29:26 +01:00
```yaml
uplinks:
npmjs:
url: https://registry.npmjs.org/
```
2018-07-21 16:34:10 +02:00
### Packages
2017-12-16 13:29:26 +01:00
2018-08-25 12:18:46 +02:00
Paquetes te permite controlar como los paquetes van a ser accedidos. Para mas información sobre esta sección lea [la páginas 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-08-25 12:18:46 +02:00
### Publicar fuera de línea
2017-12-16 13:29:26 +01:00
2018-08-25 12:18:46 +02:00
Por defecto `verdaccio` no permite publicar cuando el cliente esta fuera de línea, este comportamiento puede ser anulado ajustando esta propiedad a *true* .
2017-12-16 13:29:26 +01:00
```yaml
publish:
allow_offline: false
```
2018-08-25 12:18:46 +02:00
< small > Desde: < code > verdaccio@2.3.6< / code > due < a href = "https://github.com/verdaccio/verdaccio/pull/223" > #223< / a > < / small >
2017-12-16 13:29:26 +01:00
2018-08-25 12:18:46 +02:00
### Prefijo URL
2017-12-16 13:29:26 +01:00
```yaml
url_prefix: https://dev.company.local/verdaccio/
```
2018-07-21 16:34:10 +02:00
Since: `verdaccio@2.3.6` due [#197 ](https://github.com/verdaccio/verdaccio/pull/197 )
2017-12-16 13:29:26 +01:00
2018-07-21 16:34:10 +02:00
### Max Body Size
2017-12-16 13:29:26 +01:00
2018-07-21 16:34:10 +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-07-21 16:34:10 +02:00
### Listen Port
2017-12-16 13:29:26 +01:00
2018-07-21 16:34:10 +02:00
`verdaccio` runs by default in the port `4873` . Changing the port can be done via [cli ](cli.md ) or in the configuration file, the following options are valid.
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-07-21 16:34:10 +02:00
To enable `https` in `verdaccio` it's enough to set the `listen` flag with the protocol *https://* . For more information about this section read the [ssl page ](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-07-21 16:34:10 +02:00
Proxies are special-purpose HTTP servers designed to transfer data from remote servers to local clients.
2018-02-11 09:58:10 +01:00
#### http_proxy and https_proxy
2018-07-21 16:34:10 +02:00
If you have a proxy in your network you can set a `X-Forwarded-For` header using the following properties.
2018-02-11 09:58:10 +01:00
```yaml
http_proxy: http://something.local/
https_proxy: https://something.local/
```
#### no_proxy
2018-07-21 16:34:10 +02:00
This variable should contain a comma-separated list of domain extensions proxy should not be used for.
2018-02-11 09:58:10 +01:00
```yaml
2018-07-21 16:34:10 +02:00
no_proxy: localhost,127.0.0.1
2018-02-11 09:58:10 +01:00
```
2018-07-21 16:34:10 +02:00
### Notifications
2018-02-11 09:58:10 +01:00
2018-07-21 16:34:10 +02:00
Enabling notifications to third-party tools is fairly easy via web hooks. For more information about this section read the [notifications page ](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).
2018-07-21 16:34:10 +02:00
### Audit
2018-05-31 10:55:20 +02:00
2018-07-21 16:34:10 +02:00
< small > Since: < code > verdaccio@3.0.0< / code > < / small >
2018-06-07 17:19:13 +02:00
2018-07-21 16:34:10 +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.
2018-05-31 10:55:20 +02:00
2018-06-19 19:18:49 +02:00
> Si tienes una nueva instalación va incluida por defecto, de otro modo necesitarás añadir las siguientes propiedades a tu archivo config
2018-05-31 10:55:20 +02:00
```yaml
middlewares:
audit:
enabled: true
```