0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00
verdaccio/docs/env.variables.md
osher 681dc821aa
feat: new environment variable (storage path) (#2993)
* WIP: port PR#2199 to master into 5.x

* port PR#2199 to master to 5.x - env.variables.md

* port PR#2199 to master to 5.x - config.spec

* Update config.spec.ts

* Update config.spec.ts

* fix format

Co-authored-by: Juan Picado <juanpicado19@gmail.com>
2022-02-14 21:05:59 +01:00

1.4 KiB

Environment variables

A full list of available environment variables that allow override internal features.

VERDACCIO_HANDLE_KILL_SIGNALS

Enables gracefully shutdown, more info here.

This will be enable by default on Verdaccio 5.

VERDACCIO_PUBLIC_URL

Define a specific public url for your server, it overrules the Host and X-Forwarded-Proto header if a reverse proxy is being used, it takes in account the url_prefix if is defined.

This is handy in such situations where a dynamic url is required.

eg:

VERDACCIO_PUBLIC_URL='https://somedomain.org';
url_prefix: '/my_prefix'

// url -> https://somedomain.org/my_prefix/

VERDACCIO_PUBLIC_URL='https://somedomain.org';
url_prefix: '/'

// url -> https://somedomain.org/

VERDACCIO_PUBLIC_URL='https://somedomain.org/first_prefix';
url_prefix: '/second_prefix'

// url -> https://somedomain.org/second_prefix/'

VERDACCIO_FORWARDED_PROTO

The default header to identify the protocol is X-Forwarded-Proto, but there are some environments which uses something different, to change it use the variable VERDACCIO_FORWARDED_PROTO

$ VERDACCIO_FORWARDED_PROTO=CloudFront-Forwarded-Proto verdaccio --listen 5000

VERDACCIO_STORAGE_PATH

By default, the storage is taken from config file, but using this variable allows to set it from environment variable.