跳到主要内容
版本号:Next

Web 配置

上行链路

Verdaccio 有可定制的 Web 界面用于管理私有包

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

所有访问限制设置可以参考保护你的软件包页面,这些规则也将应用于 Web 界面。

建议 logo 尺寸为 40x40 像素。

primary_ color 必须是一个有效的十六进制表示

国际化

自v4.5.0, 有翻译版本可用。

i18n:
web: en-US

⚠️ 只有在此文件 内的语言可用,你可以参与贡献添加更多语言。 默认版本是英文-美国

配置

属性类型必须的范例支持版本描述
enablebooleantrue/false全部允许显示网页界面
titlestringVerdaccio全部HTML 头部标题描述(如果未定义则默认设置“Verdaccio”)。
gravatarbooleantrue>v4如果启用了这个属性,将在后台生成 Gravatars
sort_packages[asc,desc]asc>v4默认情况下,私有包按升序排序
logostring/local/path/to/my/logo.png http://my.logo.domain/logo.png全部logo 所在的 URI 路径(顶部 logo)
primary_colorstring"#4b5e40">v4要在整个 UI (头部, 等其它) 中使用的主颜色
scopestring@myscope>v3.x如果要为特定模块作用域使用此registry,请指定该作用域,在webui指南页眉内设置它
darkModebooleanfalse>=v4.6.0这种模式对那些想沉浸在黑暗中的人来说是一个特殊的主题
faviconstringfalse>=v5.0.1显示一个自定义的图标, 可以本地资源或者有效链接
rateLimitobject使用userRateLimit配置>=v5.4.0增加或减少速率限制,默认是5千请求每2分钟,只限制 web api 端点,CSS,JS,etcc 是内嵌的
pkgManagersnpm, pnpm 或 yarnnpm>=v5.5.0允许自定义哪些包管理器在侧栏和注册表信息对话框可见
loginbooleantrue 或 false>=v5.5.0允许禁用用户界面登录(也包括web终端)。
scriptsBodyAfterstring[]任意字符串列表>=5.0.0在 标签后注入脚本
metaScriptsstring[]任意字符串列表>=5.0.0注入脚本的内容
| | scriptsbodyBefore | string[] | 否 | 任意字符串列表 | `>=5.0.0` | 在之前注入脚本 | | html_cache | boolean | 否 | true | `>=v5.9.0` | 是否开启 html 缓存,默认 true | | showInfo | boolean | 否 | true | `>=v5.10.0` | 在标题栏上显示信息按钮 | | showSettings | boolean | 否 | true | `>=v5.10.0` | 在标题栏上显示设置按钮 | | showThemeSwitch | boolean | 否 | true | `>=v5.10.0` | 在标题栏上显示主题切换按钮 | | showFooter | boolean | 否 | true | `>=v5.10.0` | 允许隐藏页脚 | | showSearch | boolean | 否 | true | `>=v5.10.0` | 允许隐藏搜索组件 | | showDownloadTarball | boolean | 否 | true | `>=v5.10.0` | 允许隐藏侧边栏上的下载按钮 | | showRaw | boolean | 否 | true | `>=v5.10.0` | 允许隐藏侧边栏上的清单按钮(实验功能) |

推荐的logo大小为 40x40 像素。

darkMode 可以通过UI启用,并持久化在浏览器的本地存储中。 如果将 showThemeSwitch: falsedarkMode 结合使用,用户将被迫使用特定主题。 此外,无法定义 primary_color 和 dark 也无法自定义。