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
⚠️ 只有在此文件 内的语言可用,你可以参与贡献添加更多语言。 默认版本是英文-美国
配置
属性 | 类型 | 必须的 | 范例 | 支持版本 | 描述 |
---|---|---|---|---|---|
enable | boolean | 否 | true/false | 全部 | 允许显示网页界面 |
title | string | 否 | Verdaccio | 全部 | HTML 头部标题描述(如果未定义则默认设置“Verdaccio”)。 |
gravatar | boolean | 否 | true | >v4 | 如果启用了这个属性,将在后台生成 Gravatars |
sort_packages | [asc,desc] | 否 | asc | >v4 | 默认情况下,私有包按升序排序 |
logo | string | 否 | /local/path/to/my/logo.png http://my.logo.domain/logo.png | 全部 | logo 所在的 URI 路径(顶部 logo) |
primary_color | string | 否 | "#4b5e40" | >v4 | 要在整个 UI (头部, 等其它) 中使用的主颜色 |
scope | string | 否 | @myscope | >v3.x | 如果要为特定模块作用域使用此registry,请指定该作用域,在webui指南页眉内设置它 |
darkMode | boolean | 否 | false | >=v4.6.0 | 这种模式对那些想沉浸在黑暗中的人来说是一个特殊的主题 |
favicon | string | 否 | false | >=v5.0.1 | 显示一个自定义的图标, 可以本地资源或者有效链接 |
rateLimit | object | 否 | 使用userRateLimit 配置 | >=v5.4.0 | 增加或减少速率限制,默认是5千请求每2分钟,只限制 web api 端点,CSS,JS,etcc 是内嵌的 |
pkgManagers | npm, pnpm 或 yarn | 否 | npm | >=v5.5.0 | 允许自定义哪些包管理器在侧栏和注册表信息对话框可见 |
login | boolean | 否 | true 或 false | >=v5.5.0 | 允许禁用用户界面登录(也包括web终端)。 |
scriptsBodyAfter | string[] | 否 | 任意字符串列表 | >=5.0.0 | 在 标签后注入脚本 |
metaScripts | string[] | 否 | 任意字符串列表 | >=5.0.0 | 注入脚本的内容 |
推荐的logo大小为
40x40
像素。
darkMode
可以通过UI启用,并持久化在浏览器的本地存储中。 如果将showThemeSwitch: false
与darkMode
结合使用,用户将被迫使用特定主题。 此外,无法定义primary_color
和 dark 也无法自定义。