0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00
verdaccio/docs/web.md
Peter Cools f9e9383688 feat: adds option to set scope in webui instructions header
If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header e.g. npm set @coolsp:registry http://localhost:4873.
Added as webui.scope option in .yaml.
> Note: in .yaml, escape @ with \\@.

See also feature request #593.

Corrected typo myscopy --> myscope
2018-07-31 10:58:43 +02:00

1,014 B

id title
webui Web User Interface2

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

web:
  enable: true
  title: Verdaccio
  logo: logo.png
  scope:

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

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
logo string No http://my.logo.domain/logo.png all a URI where logo is located
scope string No \@myscope all If you're using this registry for a specific module scope, specify that scope to set it in the webui instructions header (note: escape @ with \@)