Skip to main content
Version: 5.x

Configuration File

This file is the cornerstone of Verdaccio where you can modify the default behaviour, enable plugins and extend features.

A default configuration file config.yaml is created the very first time you run verdaccio.

Default Configuration

The default configuration has support for scoped packages and allows any user to access all packages, but only authenticated users to publish.

storage: ./storage
file: ./htpasswd
access: $all
publish: $authenticated
proxy: npmjs
proxy: npmjs
log: { type: stdout, format: pretty, level: http }


The following sections explain what each property means and their different options.


Is the location of the default storage. Verdaccio is by default based on local file system.

storage: ./storage

Released at v5.6.0: The environment variable VERDACCIO_STORAGE_PATH could be used to replace the location of the storage (only for the default storage, does not apply to plugins unless it is implemented independently).

The .verdaccio-db database


Only available if user does not use a custom storage

By default verdaccio uses a little database to store private packages the storage property is defined in the config.yaml file.

The location might change based in your operative system, see here more details about location of files.

The structure of the database is based in JSON file, for instance:

"list": ["package1", "@scope/pkg2"],
"secret": "secret_token"
  • list: Is an array with the list of the private packages published, any item on this list is considered being published by the user.
  • secret: The secret field is used for verify the token signature, either for JWT or legacy token signature.


Is the location of the plugin directory. Useful for Docker/Kubernetes-based deployments.

plugins: ./plugins


The authentication setup is done here. The default auth is based on htpasswd and is built in. You can modify this behaviour via plugins. For more information about this section read the auth page.

file: ./htpasswd
max_users: 1000


The security block allows you to customise the token signature. To enable a new JWT (JSON Web Tokens) signature you need to add the block jwt to the api section; web uses jwt by default.

The configuration is separated in two sections, api and web. To use JWT on api it has to be defined, otherwise the legacy token signature (aes192) will be used. For JWT you might want to customize the signature and the token verification with your own properties.

legacy: true
expiresIn: 29d
someProp: [value]
expiresIn: 1h # 1 hour by default
someProp: [value]

In 5.x versions, you will see the warning [DEP0106] DeprecationWarning: crypto.createDecipher is deprecated. in your terminal. This warning indicates that Node.js has deprecated a function utilized by the legacy signature. To address thi please upgrade to the newest 6.x version (to check the release status read here available).


A set of properties to modify the behavior of the server application, specifically the API (Express.js).

You can specify HTTP/1.1 server keep alive timeout in seconds for incomming connections. A value of 0 makes the http server behave similarly to Node.js versions prior to 8.0.0, which did not have a keep-alive timeout. WORKAROUND: Through given configuration you can workaround following issue Set to 0 in case 60 is not enough.

keepAliveTimeout: 60

Web UI

This property allow you to modify the look and feel of the web UI. For more information about this section read the web UI page.

enable: true
title: Verdaccio
logo: logo.png

Uplinks add the ability to fetch packages from remote registries when those packages are not available locally. For more information about this section read the uplinks page.



This section allows you to control how packages are accessed. For more information about this section read the packages page.

access: $all
publish: $authenticated
proxy: npmjs

Advanced Settings

Offline Publish

By default verdaccio does not allow you to publish packages when the client is offline. This can be can be overridden by setting this value to true.

allow_offline: false
Since: `verdaccio@2.3.6` due [#223](

URL Prefix

The prefix is intended to be used when the server runs behinds the proxy and won't work properly if is used without a reverse proxy, check the reverse proxy setup page for more details.

The internal logic builds correctly the public url, validates the host header and and bad shaped url_prefix.

eg: url_prefix: /verdaccio, url_prefix: verdaccio/, url_prefix: verdaccio would be /verdaccio/

url_prefix: /verdaccio/

The new VERDACCIO_PUBLIC_URL is intended to be used behind proxies, this variable will be used for:

  • Used as base path to serve UI resources as (js, favicon, etc)
  • Used on return metadata dist base path
  • Ignores host and X-Forwarded-Proto headers
  • If url_prefix is defined would be appended to the env variable.

Read more about VERDACCIO_PUBLIC_URL at the environment variables page.

User Agent

Since: `verdaccio@5.4.0`

The user agent is disabled by default, in exchange the user agent client (package manager, browser, etc ...) is being bypassed to the remote. To enable the previous behaviour use boolean values.

user_agent: true
user_agent: false
user_agent: 'custom user agent'

User Rate Limit

Since: [verdaccio@5.4.0](

Add default rate limit to user endpoints, npm token, npm profile, npm loding/adduser and login website to 100 request peer 15 min, customizable via:

windowMs: 50000
max: 1000

Additonal configuration (only feature flags) is also possible via the middleware docs.

Max Body Size

By default the maximum body size for a JSON document is 10mb, if you run into errors that state "request entity too large" you may increase this value.

max_body_size: 10mb

Listen Port

verdaccio runs by default on the port 4873. Changing the port can be done via CLI or in the configuration file. The following options are valid:

# - localhost:4873 # default value
# - http://localhost:4873 # same thing
# - # listen on all addresses (INADDR_ANY)
# - # if you want to use https
# - "[::1]:4873" # ipv6
# - unix:/tmp/verdaccio.sock # unix socket


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.

key: ./path/verdaccio-key.pem
cert: ./path/verdaccio-cert.pem
ca: ./path/verdaccio-csr.pem


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/


This variable should contain a comma-separated list of domain extensions that the proxy should not be used for.

no_proxy: localhost,


Enabling notifications to third-party tools is fairly easy via webhooks. For more information about this section read the notifications page.

method: POST
headers: [{ 'Content-Type': 'application/json' }]
content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'

For more detailed configuration settings, please check the source code.



Since v5.22.0 the logger property is renamed to logs but log still compatible but displaying a warning

Two logger types are supported, you may chose only one of them:

console output (the default)

log: { type: stdout, format: pretty, level: http }

file output

log: { type: file, path: verdaccio.log, level: info }

For full information - see here: Features/logger


Since: `verdaccio@3.0.0`

npm audit is a new command released with npm 6.x. 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

enabled: true


This release includes a new property named experiments that can be placed in the config.yaml and is completely optional.

We want to be able to ship new things without affecting production environments. This flag allows us to add new features and get feedback from the community who decides to use them.

The features under this flag might not be stable or might be removed in future releases.

Here is one example:

changePassword: false

To disable the experiments warning in the console, you must comment out the whole experiments section.

Config Builder API

After version v5.23.1 the new advanced configuration builder API is available. The API is a flexible way to generate programmatically configuration outputs either in JSON or YAML using the builder pattern, for example:

import { ConfigBuilder } from 'verdaccio';

const config =;
.addUplink('upstream', { url: 'https://registry.upstream.local' })
.addUplink('upstream2', { url: 'https://registry.upstream2.local' })
.addPackageAccess('upstream/*', {
access: 'public',
publish: 'foo, bar',
unpublish: 'foo, bar',
proxy: 'some',
.addLogger({ level: 'info', type: 'stdout', format: 'json' })
.addSecurity({ api: { legacy: true } });

// generate JSON object as output

// generate output as yaml