mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-12-23 22:27:34 -05:00
28 lines
1.8 KiB
Markdown
28 lines
1.8 KiB
Markdown
|
---
|
||
|
|
id: webui
|
||
|
|
title: "Web User Interface2"
|
||
|
|
---
|
||
|
|
|
||
|
|
|
||
|
|
<p align="center"><img src="https://github.com/verdaccio/verdaccio/blob/master/assets/gif/verdaccio_big_30.gif?raw=true"></p>
|
||
|
|
|
||
|
|
Verdaccio has a web user interface to display only the private packges and can be customisable.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
web:
|
||
|
|
enable: true
|
||
|
|
title: Verdaccio
|
||
|
|
logo: logo.png
|
||
|
|
scope:
|
||
|
|
```
|
||
|
|
|
||
|
|
All access restrictions defined to [protect your packages](protect-your-dependencies.md) 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 \\@) |
|