十年匠心定制 · 商业建站与技术教学双线并行 咨询热线:400-886-1026 service@lmnt.cn
ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

Huly 自托管功能禁用配置指南:使用 DISABLED_FEATURES 环境变量精简你的部署

Huly 自托管功能禁用配置指南:使用 DISABLED_FEATURES 环境变量精简你的部署 Huly 自托管功能禁用配置指南使用 DISABLED_FEATURES 环境变量精简你的部署【免费下载链接】platformHuly — All-in-One Project Management Platform (alternative to Linear, Jira, Slack, Notion, Motion)项目地址: https://gitcode.com/GitHub_Trending/platform80/platform导读本篇技术指南面向 Huly 自托管部署的运维与开发人员系统讲解如何通过DISABLED_FEATURES环境变量为所有工作区统一禁用不需要的模块如自动翻译、Github 集成、邮件、招聘模块等。读完本文你将掌握该配置项的完整取值清单、docker-compose 与服务容器中的具体配置方法以及从环境变量解析、前端元数据注入到 UI 入口过滤的底层实现原理从而按需裁剪部署体积与界面复杂度。功能禁用的设计动机Huly 是一个 All-in-One 的项目管理平台默认集成了大量业务模块跟踪器、招聘、文档、日历、库存、培训、流程等。但对某些自托管场景而言并非每个部署方都需要全部功能——例如一个专注于软件研发追踪的团队可能完全用不到 Recruit 招聘模块或 Inventory 库存模块。为此Huly 提供了一种全局、强制的功能禁用机制安装部署时可以一次性禁用一个或多个未使用的功能且该禁用对所有工作区生效而不是某个单独工作区的局部设置。正如 docs/disableFeatures.md 所述配置方式非常简单——为 front 服务容器设置DISABLED_FEATURES环境变量并支持逗号分隔的多个取值。支持的禁用项完整清单DISABLED_FEATURES是一个逗号分隔的字符串可包含下列取值来自 docs/disableFeatures.md取值禁用效果auto-translate禁用自动翻译github禁用 Github 集成mailboxes禁用 Huly Mail邮箱export禁用导出功能integration禁用所有集成backup禁用备份 UIinvites禁用邀请 UIdocuments禁用受控文档Control Documentscalendar禁用日历 UIinventory禁用库存模块survey禁用问卷调查lead禁用线索Leads模块products禁用产品模块telegram禁用 Telegram 集成recruit禁用招聘Recruit模块training禁用培训Trainings模块testManagement禁用测试管理模块process禁用流程模块cards禁用卡片可以组合使用例如DISABLED_FEATURESauto-translate,mailboxes会同时禁用自动翻译和 Huly Mail 两项功能。配置方法方式一docker-compose 环境变量官方自托管编排文件 dev/docker-compose.yaml 中front 服务容器默认就演示了该变量的用法# dev/docker-compose.yaml services: front: image: hardcoreeng/front environment: - DISABLED_FEATURESauto-translate,mailboxes # 其他环境变量...将DISABLED_FEATURES的值改为你的目标组合即可例如- DISABLED_FEATURESgithub,integration,telegram,lead,products,inventory,survey修改后需要重新创建 front 容器使配置生效。方式二直接为 front 容器设置环境变量不依赖 docker-compose 时可直接在 front 服务进程或容器启动时注入该变量。front 服务的入口 pods/front/src/__start.ts 会从进程环境读取并透传// pods/front/src/__start.ts startFront(metricsContext, { // ... DISABLED_FEATURES: process.env.DISABLED_FEATURES ?? , // ... })注意默认值为空字符串即未设置时不禁用任何功能行为符合预期。桌面端Desktop同样支持该机制不仅作用于 Web 前端桌面应用也会读取DISABLED_FEATURES。桌面端 UI 启动逻辑位于 desktop/src/ui/platform.ts与 Web 端采用完全相同的解析与注入方式// desktop/src/ui/platform.ts const disabledFeatures (config.DISABLED_FEATURES ?? ).split(,).map(it it.trim()).filter(it it.length 0) setMetadata(presentation.metadata.DisabledFeatures, new Set(disabledFeatures))桌面端的环境变量类型声明可参见 desktop/src/ui/types.ts。底层实现原理理解配置项如何在代码中生效有助于排查为什么禁用了却没有消失之类的问题。整个链路分为三步第一步字符串解析与规范化Web 端在 dev/prod/src/platform.ts 中对配置值做了解析const disabledFeatures (config.DISABLED_FEATURES ?? ).split(,) .map(it it.trim()) .filter(it it.length 0) setMetadata(presentation.metadata.DisabledFeatures, new Set(disabledFeatures))解析逻辑具有三个要点按逗号分割split(,)支持多个取值同时配置自动去空格it.trim()使github, mailboxes这类带空格的写法也能正常工作过滤空串filter(it it.length 0)忽略多余的空项例如github,,mailboxes不会产生空条目。解析结果被转换成Setstring并通过setMetadata注入到全局元数据presentation.metadata.DisabledFeatures定义于 packages/presentation/src/plugin.ts。使用Set意味着判断某个功能是否被禁用是 O(1) 的哈希查找性能开销可忽略。第二步统一的禁用判断入口前端各模块判断功能是否被禁用时统一调用 packages/presentation/src/utils.ts 中的isDisabled函数export function isDisabled (feature?: string): boolean { if (feature undefined) { return false } return getMetadata(plugin.metadata.DisabledFeatures)?.has(feature) ?? false }该函数有两个值得注意的细节传入undefined时返回false保证未标注 feature 的组件始终可见未设置元数据时getMetadata返回undefined同样回退为false即默认不禁用任何功能。第三步UI 层按禁用状态过滤入口isDisabled被大量用于设置页、工作区设置与用户菜单等场景从源码结构看其典型用法是渲染时条件过滤设置主页面 plugins/setting-resources/src/components/Settings.svelte 中设置分类按角色与禁用状态双重过滤res.filter((p) hasAccountRole(account, p.role) !isDisabled(p.feature))工作区设置页 plugins/setting-resources/src/components/WorkspaceSettings.svelte 同样按!isDisabled(p.feature ?? )过滤分类应用/模块配置页 plugins/setting-resources/src/components/Configure.svelte 中被禁用的插件直接不渲染配置卡片config.hidden ! true config.system ! true !isDisabled(config.pluginId)邀请功能在 plugins/setting-resources/src/components/Settings.svelte 与 plugins/workbench-resources/src/components/AccountPopup.svelte 中均通过!isDisabled(invites)控制显隐集成相关组件如 plugins/setting-resources/src/components/integrations/IntegrationCard.svelte、IntegrationLabel.svelte也会根据禁用状态调整展示。可以推断被禁用的功能不仅在设置入口消失其对应的应用导航入口、相关按钮与集成卡片等 UI 元素也会随之隐藏从而实现整个功能对用户不可见的全局裁剪效果。需要注意该机制主要作用于前端 UI 展示层对于已经通过 API 或直接数据访问的调用应结合服务端权限与网络层如不暴露对应服务端口共同收敛这与文档定位configuration guide, for self-hosted users面向自托管用户的配置指南是一致的。注意事项与常见问题Q1DISABLED_FEATURES与桌面端的disable-features是一回事吗不是。桌面端主进程 desktop/src/main/start.ts 中的disabledFeatures数组用于app.commandLine.appendSwitch(disable-features, ...)那是 Chromium/Electron 渲染内核层面的功能开关与 Huly 业务功能的DISABLED_FEATURES完全无关切勿混淆。Q2禁用某功能后已存在的数据会被删除吗从实现看禁用机制只是在元数据中登记禁用项、并在 UI 层过滤入口并不会触发数据清理。功能被禁用期间历史数据仍保留在数据库中后续移除禁用项即可恢复可见。Q3禁用是否只影响某个工作区不是。该配置是全局的对所有工作区统一生效文档明确说明 for all workspaces。如需按工作区差异化启用应另寻其他配置手段。Q4值的大小写敏感吗从源码解析逻辑看取值会原样保留并作为Set的 key未做大小写归一化。因此请严格按上表的小写命名填写例如github而非Github、testManagement保持驼峰大小写。结语DISABLED_FEATURES是 Huly 自托管部署中一项轻量而有效的功能裁剪手段只需一行环境变量即可为全部工作区统一禁用最多 19 类业务模块从 UI 层彻底隐藏无关入口让部署更聚焦于实际业务。其实现链路环境变量读取 → 解析与元数据注入 → isDisabled 统一判断 → UI 条件过滤清晰可查便于二次开发与问题排查。配置时只需注意取值大小写、逗号分隔格式以及它对所有工作区全局生效这两个关键特性即可。【免费下载链接】platformHuly — All-in-One Project Management Platform (alternative to Linear, Jira, Slack, Notion, Motion)项目地址: https://gitcode.com/GitHub_Trending/platform80/platform创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表