0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-30 22:34:10 -05:00

docs: Upgrade main config file documentation

This commit is contained in:
Juan Picado @jotadeveloper 2017-08-26 11:35:04 +02:00
parent 7c88cb4392
commit ec0746fc8f
No known key found for this signature in database
GPG key ID: 18AC54485952D158

View file

@ -8,7 +8,7 @@ A default configuration file is created the very first time you run `verdaccio`.
The default configuration has support for **scoped** packages and allow any user to access all packages but only **authenticated users to publish**.
```
```yaml
storage: ./storage
auth:
htpasswd:
@ -35,7 +35,7 @@ The following sections explain what means each property and the different otpion
Is the location of the default storage. **Verdaccio is by default based on local file system**.
```
```yaml
storage: ./storage
```
@ -43,7 +43,7 @@ storage: ./storage
The authentification set up is done here, the default auth is based on `htpasswd` and is build-in. You can modify this behaviour via [plugins](plugins.md). For more information about this section read the [auth page](auth.md).
```
```yaml
auth:
htpasswd:
file: ./htpasswd
@ -54,7 +54,7 @@ auth:
This properties allow you to modify the look and feel of the web UI. For more information about this section read the [web ui page](web.md).
```
```yaml
web:
enable: true
title: Verdaccio
@ -63,18 +63,95 @@ web:
### Upkinks
Uplinks is the avility of the system to proxy package from remote registries when those package are not available locally. For more information about this section read the [uplinks page](uplinks.md).
Uplinks is the ability of the system to fetch packages from remote registries when those packages are not available locally. For more information about this section read the [uplinks page](uplinks.md).
```
```yaml
uplinks:
npmjs:
url: https://registry.npmjs.org/
```
### Packages
Packages allow the user how the packages are gonna be accessed. For more information about this section read the [packages page](packages.md).
```yaml
packages:
'@*/*':
access: $all
publish: $authenticated
proxy: npmjs
```
## Advanced Settings
### Offline Publish
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
```
Since: *v2.3.6* due [#223](https://github.com/verdaccio/verdaccio/pull/223)
### URL Prefix
```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
```
### Listen Port
`verdaccio` runs by default in the port `4873`. Change the port can be done via [cli](cli.md) or in the configuration file, the following options are valid.
```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
# - [::1]:4873 # ipv6
# - unix:/tmp/verdaccio.sock # unix socket
```
### HTTPS
To enable `https` in `verdaccio` enough with set your `listen` domain with the protocol *https://*. For more information about this section read the [ssl page](ssl.md).
```yaml
https:
key: path/to/server.key
cert: path/to/server.crt
ca: path/to/server.pem
```
### Notifications
Enable notifications to three party tools is fairly easy via web hooks. For more information about this section read the [notifications page](notifications.md).
```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"}'
```