github.com/verdaccio
1
0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-13 03:35:52 +01:00
Code Releases Wiki Activity
3ad519f0c2
verdaccio/website/docs/web.md
Juan Picado 3ad519f0c2 chore: website scaffolding (#1843) 
* chore: upload gatsby website

* chore: update header

* chore: add background header

* chore: add ci for website

* Update ci-website.yml

* chore: update patch mach ci

* chore: update ci settings

* chore: update docker version
2021-04-09 17:54:10 +02:00

2.2 KiB
Raw Blame History

id title
webui Web User Interface

Uplinks

''

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

web:
  enable: true
  title: Verdaccio
  logo: logo.png
  primary_color: "#4b5e40"
  gravatar: true | false
  scope: "@scope"
  sort_packages: asc | desc
  darkMode: false

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 es-US

Configuration

Property Type Required Example Support Description
enable boolean No true/false all allow to display the web interface
title string No Verdaccio all HTML head title description
gravatar boolean No true >v4 Gravatars will be generated under the hood if this property is enabled
sort_packages [asc,desc] No asc >v4 By default private packages are sorted by ascending
logo string No /local/path/to/my/logo.png http://my.logo.domain/logo.png all a URI where logo is located (header logo)
primary_color string No "#4b5e40" >4 The primary color to use throughout the UI (header, etc)
scope string No @myscope >v3.x If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header
darkMode boolean No false >=v4.6.0 This mode is an special theme for those want to live in the dark side

It is recommended the logo size has the following size 40x40 pixels.

The darMode can be enbled via UI and is persisted in the local storage, furthermore, also void primary_color and dark cannot be customized.