2017-12-16 07:29:26 -05:00
---
id: configuration
New Crowdin translations (#461)
* New translations ansible.md (Chinese Traditional)
* New translations uplinks.md (Chinese Traditional, Hong Kong)
* New translations ssl.md (Urdu (Pakistan))
* New translations test.md (Chinese Traditional)
* New translations test.md (Chinese Traditional, Hong Kong)
* New translations test.md (Portuguese, Brazilian)
* New translations test.md (Spanish)
* New translations test.md (Urdu (Pakistan))
* New translations uplinks.md (Chinese Traditional)
* New translations uplinks.md (Portuguese, Brazilian)
* New translations ssl.md (Portuguese, Brazilian)
* New translations uplinks.md (Spanish)
* New translations uplinks.md (Urdu (Pakistan))
* New translations use-cases.md (Chinese Traditional)
* New translations use-cases.md (Chinese Traditional, Hong Kong)
* New translations use-cases.md (Portuguese, Brazilian)
* New translations use-cases.md (Spanish)
* New translations use-cases.md (Urdu (Pakistan))
* New translations ssl.md (Spanish)
* New translations ssl.md (Chinese Traditional, Hong Kong)
* New translations web.md (Chinese Traditional, Hong Kong)
* New translations reverse-proxy.md (Chinese Traditional, Hong Kong)
* New translations protect-your-dependencies.md (Urdu (Pakistan))
* New translations repositories.md (Chinese Traditional)
* New translations repositories.md (Chinese Traditional, Hong Kong)
* New translations repositories.md (Portuguese, Brazilian)
* New translations repositories.md (Spanish)
* New translations repositories.md (Urdu (Pakistan))
* New translations reverse-proxy.md (Chinese Traditional)
* New translations reverse-proxy.md (Portuguese, Brazilian)
* New translations ssl.md (Chinese Traditional)
* New translations reverse-proxy.md (Spanish)
* New translations reverse-proxy.md (Urdu (Pakistan))
* New translations server.md (Chinese Traditional)
* New translations server.md (Chinese Traditional, Hong Kong)
* New translations server.md (Portuguese, Brazilian)
* New translations server.md (Spanish)
* New translations server.md (Urdu (Pakistan))
* New translations web.md (Chinese Traditional)
* New translations web.md (Portuguese, Brazilian)
* New translations protect-your-dependencies.md (Portuguese, Brazilian)
* New translations repositories.md (Chinese Simplified)
* New translations install.md (Chinese Simplified)
* New translations kubernetes.md (Chinese Simplified)
* New translations logger.md (Chinese Simplified)
* New translations notifications.md (Chinese Simplified)
* New translations packages.md (Chinese Simplified)
* New translations plugins.md (Chinese Simplified)
* New translations protect-your-dependencies.md (Chinese Simplified)
* New translations reverse-proxy.md (Chinese Simplified)
* New translations home.md (Chinese Simplified)
* New translations server.md (Chinese Simplified)
* New translations ssl.md (Chinese Simplified)
* New translations test.md (Chinese Simplified)
* New translations uplinks.md (Chinese Simplified)
* New translations use-cases.md (Chinese Simplified)
* New translations web.md (Chinese Simplified)
* New translations windows.md (Chinese Simplified)
* New translations iis-server.md (Chinese Simplified)
* New translations docker.md (Chinese Simplified)
* New translations web.md (Spanish)
* New translations web.md (Urdu (Pakistan))
* New translations windows.md (Chinese Traditional)
* New translations windows.md (Chinese Traditional, Hong Kong)
* New translations windows.md (Portuguese, Brazilian)
* New translations windows.md (Spanish)
* New translations windows.md (Urdu (Pakistan))
* New translations dev-plugins.md (Chinese Simplified)
* New translations ansible.md (Chinese Simplified)
* New translations auth.md (Chinese Simplified)
* New translations cli.md (Chinese Simplified)
* New translations config.md (Chinese Simplified)
* New translations contributing.md (Chinese Simplified)
* New translations protect-your-dependencies.md (Spanish)
* New translations protect-your-dependencies.md (Chinese Traditional, Hong Kong)
* New translations ansible.md (Chinese Traditional, Hong Kong)
* New translations dev-plugins.md (Chinese Traditional)
* New translations config.md (Spanish)
* New translations config.md (Urdu (Pakistan))
* 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 dev-plugins.md (Chinese Traditional, Hong Kong)
* New translations config.md (Chinese Traditional, Hong Kong)
* New translations dev-plugins.md (Portuguese, Brazilian)
* New translations dev-plugins.md (Spanish)
* New translations dev-plugins.md (Urdu (Pakistan))
* 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 config.md (Portuguese, Brazilian)
* New translations config.md (Chinese Traditional)
* New translations home.md (Chinese Traditional)
* New translations auth.md (Urdu (Pakistan))
* New translations ansible.md (Portuguese, Brazilian)
* New translations ansible.md (Spanish)
* New translations ansible.md (Urdu (Pakistan))
* New translations auth.md (Chinese Traditional)
* New translations auth.md (Chinese Traditional, Hong Kong)
* New translations auth.md (Portuguese, Brazilian)
* New translations auth.md (Spanish)
* New translations cli.md (Urdu (Pakistan))
* New translations cli.md (Chinese Traditional)
* New translations cli.md (Chinese Traditional, Hong Kong)
* New translations cli.md (Portuguese, Brazilian)
* New translations cli.md (Spanish)
* New translations docker.md (Urdu (Pakistan))
* New translations home.md (Chinese Traditional, Hong Kong)
* New translations protect-your-dependencies.md (Chinese Traditional)
* New translations packages.md (Chinese Traditional, Hong Kong)
* New translations logger.md (Urdu (Pakistan))
* New translations notifications.md (Chinese Traditional)
* New translations notifications.md (Chinese Traditional, Hong Kong)
* New translations notifications.md (Portuguese, Brazilian)
* New translations notifications.md (Spanish)
* New translations notifications.md (Urdu (Pakistan))
* New translations packages.md (Chinese Traditional)
* New translations packages.md (Portuguese, Brazilian)
* New translations logger.md (Portuguese, Brazilian)
* New translations packages.md (Spanish)
* New translations packages.md (Urdu (Pakistan))
* New translations plugins.md (Chinese Traditional)
* New translations plugins.md (Chinese Traditional, Hong Kong)
* New translations plugins.md (Portuguese, Brazilian)
* New translations plugins.md (Spanish)
* New translations plugins.md (Urdu (Pakistan))
* New translations logger.md (Spanish)
* New translations logger.md (Chinese Traditional, Hong Kong)
* New translations home.md (Portuguese, Brazilian)
* New translations install.md (Chinese Traditional)
* New translations home.md (Spanish)
* New translations home.md (Urdu (Pakistan))
* New translations iis-server.md (Chinese Traditional)
* New translations iis-server.md (Chinese Traditional, Hong Kong)
* New translations iis-server.md (Portuguese, Brazilian)
* New translations iis-server.md (Spanish)
* New translations iis-server.md (Urdu (Pakistan))
* New translations install.md (Chinese Traditional, Hong Kong)
* New translations logger.md (Chinese Traditional)
* New translations install.md (Portuguese, Brazilian)
* New translations install.md (Spanish)
* New translations install.md (Urdu (Pakistan))
* New translations kubernetes.md (Chinese Traditional)
* New translations kubernetes.md (Chinese Traditional, Hong Kong)
* New translations kubernetes.md (Portuguese, Brazilian)
* New translations kubernetes.md (Spanish)
* New translations kubernetes.md (Urdu (Pakistan))
2018-01-09 12:52:17 -05:00
title: Configuration File
2017-12-16 07:29:26 -05:00
---
2018-01-08 01:46:09 -05: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 07:29:26 -05:00
2018-01-08 01:46:09 -05:00
Cuando ejecutas por primera vez ` verdaccio` se crea un archivo de configuración por defecto.
2017-12-16 07:29:26 -05:00
2018-01-08 01:46:09 -05:00
## Configuración por Defecto
2017-12-16 07:29:26 -05:00
2018-01-08 01:46:09 -05: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 07:29:26 -05: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 01:46:09 -05:00
## Secciones
2017-12-16 07:29:26 -05:00
2018-01-08 01:46:09 -05:00
Las siguientes secciones explican que significa cada propiedad y las diferentes configuraciones posibles.
2017-12-16 07:29:26 -05:00
2018-01-08 14:45:03 -05:00
### Almacenamiento
2017-12-16 07:29:26 -05:00
2018-01-08 14:45:03 -05:00
Es la localización por defecto del almacenamiento. **Verdaccio esta basado por defecto en archivos locales de sistema** .
2017-12-16 07:29:26 -05:00
```yaml
storage: ./storage
```
2018-01-08 14:45:03 -05:00
### Autentificación
2017-12-16 07:29:26 -05:00
2018-01-08 16:14:06 -05: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 07:29:26 -05:00
```yaml
auth:
htpasswd:
file: ./htpasswd
max_users: 1000
```
### Web UI
2018-01-08 16:14:06 -05: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 07:29:26 -05:00
```yaml
web:
enable: true
title: Verdaccio
logo: logo.png
```
### Uplinks
2018-01-08 16:14:06 -05: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 07:29:26 -05:00
```yaml
uplinks:
npmjs:
url: https://registry.npmjs.org/
```
2018-01-08 16:14:06 -05:00
### Paquetes
2017-12-16 07:29:26 -05:00
2018-01-08 16:14:06 -05: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 07:29:26 -05:00
```yaml
packages:
'@*/*':
access: $all
publish: $authenticated
proxy: npmjs
```
2018-01-08 16:14:06 -05:00
## Configuración Avanzada
2017-12-16 07:29:26 -05:00
2018-01-08 16:14:06 -05:00
### Publicar modo sin conexión
2017-12-16 07:29:26 -05:00
By default `verdaccio` does not allow to publish when the client is offline, that behavior can be overridden set it in to *true* .
```yaml
publish:
allow_offline: false
```
2018-01-06 17:12:54 -05:00
< small > Since: < em > v2.3.6< / em > due < a href = "https://github.com/verdaccio/verdaccio/pull/223" > #223< / a > < / small >
2017-12-16 07:29:26 -05:00
2018-01-08 16:14:06 -05:00
### Prefijos URL
2017-12-16 07:29:26 -05:00
```yaml
url_prefix: https://dev.company.local/verdaccio/
```
Since: *v2.3.6* due [#197 ](https://github.com/verdaccio/verdaccio/pull/197 )
### Max Body Size
By default the maximum body size for a JSON document is `1mb` , if you run in errors as `"request entity too large"` you may increase this value.
```yaml
max_body_size: 1mb
```
2018-01-08 16:14:06 -05:00
### Puertos
2017-12-16 07:29:26 -05:00
2018-01-08 16:14:06 -05: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 07:29:26 -05: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 03:09:16 -05:00
# - "[::1]:4873" # ipv6
2017-12-16 07:29:26 -05:00
# - unix:/tmp/verdaccio.sock # unix socket
```
### HTTPS
2018-01-08 16:14:06 -05: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 07:29:26 -05:00
```yaml
https:
key: path/to/server.key
cert: path/to/server.crt
ca: path/to/server.pem
```
2018-01-08 16:14:06 -05:00
### Notificaciones
2017-12-16 07:29:26 -05:00
2018-01-08 16:14:06 -05:00
Habilitar notificaciones de herramientas a terceros es bastante fácil vía web hooks. Para mas información sobre esta sección lea [página de notificaciones ](notifications.md ).
2017-12-16 07:29:26 -05: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"}'
```