mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-12-16 21:56:25 -05:00
96 lines
8.9 KiB
Markdown
96 lines
8.9 KiB
Markdown
---
|
|
id: webui
|
|
title: 'Web User Interface'
|
|
---
|
|
|
|
|
|
|
|
Verdaccio has a web user interface to display only the private packages and can be customised to your liking.
|
|
|
|
```yaml
|
|
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
|
|
rateLimit:
|
|
windowMs: 50000
|
|
max: 1000
|
|
pkgManagers:
|
|
- npm
|
|
- yarn
|
|
- pnpm
|
|
login: true
|
|
scriptsBodyAfter:
|
|
- '<script type="text/javascript" src="https://my.company.com/customJS.min.js"></script>'
|
|
metaScripts:
|
|
- '<script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.slim.min.js"></script>'
|
|
- '<script type="text/javascript" src="https://browser.sentry-cdn.com/5.15.5/bundle.min.js"></script>'
|
|
- '<meta name="robots" content="noindex" />'
|
|
scriptsbodyBefore:
|
|
- '<div id="myId">html before webpack scripts</div>'
|
|
html_cache: true
|
|
showInfo: true
|
|
showSettings: true
|
|
# In combination with darkMode you can force specific theme
|
|
showThemeSwitch: true
|
|
showFooter: true
|
|
showSearch: true
|
|
showDownloadTarball: true
|
|
showRaw: true
|
|
```
|
|
|
|
All access restrictions defined to [protect your packages](protect-your-dependencies.md) 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 {#internationalization}
|
|
|
|
_Since v4.5.0_, there are translations available.
|
|
|
|
```yaml
|
|
i18n:
|
|
web: en-US
|
|
```
|
|
|
|
> ⚠️ Only the enabled languages on this [file](https://github.com/verdaccio/verdaccio/blob/master/packages/plugins/ui-theme/src/i18n/enabledLanguages.ts) are available, you can contribute by adding new more languages. The default
|
|
> one is en-US
|
|
|
|
### Configuration {#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 (if is not define set "Verdaccio" by default). |
|
|
| 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 |
|
|
| favicon | string | No | false | `>=v5.0.1` | Display a custom favicon, can be local resource or valid url |
|
|
| rateLimit | object | No | use `userRateLimit` configuration | `>=v5.4.0` | Increase or decrease rate limit, by default is 5k request every 2 minutes, only limit web api endpoints, the CSS, JS, etcc are ingnored |
|
|
| pkgManagers | npm, pnpm or yarn | No | npm | `>=v5.5.0` | Allow customise which package managers on the side bar and registry information dialog are visible |
|
|
| login | boolean | No | true or false | `>=v5.5.0` | Allow disable login on the UI (also include web endpoints). |
|
|
| scriptsBodyAfter | string[] | No | any list of strings | `>=5.0.0` | inject scripts after the <body/> tag |
|
|
| metaScripts | string[] | No | any list of strings | `>=5.0.0` | inject scripts inside <head/> |
|
|
| scriptsbodyBefore | string[] | No | any list of strings | `>=5.0.0` | inject scripts before the <body/> |
|
|
| html_cache | boolean | No | true | `>=v5.9.0` | whether the html cache is enabled, default true |
|
|
| showInfo | boolean | No | true | `>=v5.10.0` | display the info button on the header |
|
|
| showSettings | boolean | No | true | `>=v5.10.0` | display the settings button on the header |
|
|
| showThemeSwitch | boolean | No | true | `>=v5.10.0` | display the theme switch button on the header |
|
|
| showFooter | boolean | No | true | `>=v5.10.0` | allow hide footer |
|
|
| showSearch | boolean | No | true | `>=v5.10.0` | allow hide search component |
|
|
| showDownloadTarball | boolean | No | true | `>=v5.10.0` | allow hide download button on the sidebar |
|
|
| showRaw | boolean | No | true | `>=v5.10.0` | allow hide manifest button on the sidebar (experimental feature) |
|
|
|
|
> The recommended logo size is `40x40` pixels.
|
|
|
|
> The `darkMode` can be enabled via UI and is persisted in the browser local storage. If you combine `showThemeSwitch: false` with `darkMode` users will be forced to use an specific theme. Furthermore, also void `primary_color` and dark cannot be customized.
|