verdaccio/docs/web.md

---
id: webui
title: "Web User Interface"
---

<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 packages 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 \\@)
chore: first version of website using docusaurus 2017-12-16 13:25:59 +01:00			`---`
			`id: webui`
Update web.md 2018-09-26 14:31:17 +02:00			`title: "Web User Interface"`
chore: first version of website using docusaurus 2017-12-16 13:25:59 +01:00			`---`
docs: Add web ui documentation 2017-08-28 19:55:46 +02:00
docs: small improvements 2018-07-22 20:23:53 +02:00			`<p align="center"><img src="https://github.com/verdaccio/verdaccio/blob/master/assets/gif/verdaccio_big_30.gif?raw=true"></p>`
fix: Update website and move it to the root 2018-01-20 23:00:45 +01:00
docs: fixes typo (#945) 2018-08-24 14:35:54 +02:00			`Verdaccio has a web user interface to display only the private packages and can be customisable.`
docs: Add web ui documentation 2017-08-28 19:55:46 +02:00
			```yaml
			`web:`
			`enable: true`
			`title: Verdaccio`
			`logo: logo.png`
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. Removed changes to website/translated_docs and website/versioned_docs And update docs/web.md and config.md 2018-07-30 21:11:36 +02:00			`scope:`
docs: Add web ui documentation 2017-08-28 19:55:46 +02:00			```
chore: first version of website using docusaurus 2017-12-16 13:25:59 +01:00
Mention access restrictions Indicate that access restrictions apply to web UI as well as npm access (to avoid #804) 2018-07-06 08:41:46 +02:00			`All access restrictions defined to [protect your packages](protect-your-dependencies.md) will also apply to the Web Interface.`
docs: Add web ui documentation 2017-08-28 19:55:46 +02:00
			`### Configuration`

chore: first version of website using docusaurus 2017-12-16 13:25:59 +01:00			`Property \| Type \| Required \| Example \| Support \| Description`
			`--- \| --- \| --- \| --- \| --- \| ---`
docs: Add web ui documentation 2017-08-28 19:55:46 +02:00			`enable \| boolean \| No \| true/false \| all \| allow to display the web interface`
Mention access restrictions Indicate that access restrictions apply to web UI as well as npm access (to avoid #804) 2018-07-06 08:41:46 +02:00			`title \| string \| No \| Verdaccio \| all \| HTML head title description`
docs: Add web ui documentation 2017-08-28 19:55:46 +02:00			`logo \| string \| No \| http://my.logo.domain/logo.png \| all \| a URI where logo is located`
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			`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 \\@)`