Skip to main content

Web User Interface

Uplinks

Verdaccio has a web user interface to display only the private packages and can be customised to your liking.

web:  enable: true  title: Verdaccio  logo: http://somedomain/somelogo.png  primary_color: "#4b5e40"  gravatar: true | false  scope: "@scope"  sort_packages: asc | desc  darkMode: false  favicon: http://somedomain/favicon.ico | /path/favicon.ico

All access restrictions defined to protect your packages will also apply to the Web Interface.

The primary_color and scope must be wrapped by quotes: eg: ('#000000' or "#000000")

The primary_color must be a valid hex representation.

Internationalization#

Since v4.5.0, there are translations available.

i18n:  web: en-US

⚠️ Only the languages in this list are available, feel free to contribute with more. The default one is en-US

Configuration#

PropertyTypeRequiredExampleSupportDescription
enablebooleanNotrue/falseallallow to display the web interface
titlestringNoVerdaccioallHTML head title description
gravatarbooleanNotrue>v4Gravatars will be generated under the hood if this property is enabled
sort_packages[asc,desc]Noasc>v4By default private packages are sorted by ascending
logostringNo/local/path/to/my/logo.png http://my.logo.domain/logo.pngalla URI where logo is located (header logo)
primary_colorstringNo"#4b5e40">4The primary color to use throughout the UI (header, etc)
scopestringNo@myscope>v3.xIf you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header
darkModebooleanNofalse>=v4.6.0This mode is an special theme for those want to live in the dark side
faviconstringNofalse>=v5.0.1Display a custom favicon, can be local resource or valid url

The recommended logo size is 40x40 pixels.

The darkMode can be enabled via UI and is persisted in the browser local storage. Furthermore, also void primary_color and dark cannot be customized.