Orbit 项目设置

每个 Orbit 项目的所有配置都位于"设置"标签页上，按类别分组便于查找：通用信息、构建和部署、安全、通知、集成、使用限制、部署自动化、网络、可观测性、共享和底部的危险区域。

设置位置

打开 Orbit，点击项目，然后在项目标签栏中选择 Settings。该页面描述了如何配置项目名称、构建命令和 Git 集成，但实际功能远不止于此。

本指南是一个地图。如果某个主题有专门的文章，会提供链接而不是重复内容。

通用

项目信息 显示 URL slug、创建日期、关联的存储库和生产 URL，并允许您更改项目的 Name 和 Description。

Git 包含 Production branch。对该分支的推送会触发生产部署。

Status badge 提供实时部署状态 SVG，带有 URL、markdown 和 HTML 的复制按钮，可直接粘贴到 README 中。请参阅 在 Orbit 中查看您的项目 README。

Public status page 链接到状态页面配置。请参阅 Orbit 状态页面。

构建和部署

构建设置 是 Orbit 自动检测的五个字段，您可以覆盖：安装命令、构建命令、输出目录、根目录和 Node.js 版本。将字段留空以保持检测到的值。完整详情见 配置您的构建命令和输出目录。

运行时 包含四个值得理解的开关：

• Server mode 在每次部署后保持构建机器运行您的启动命令。对于任何在服务器上渲染而不是导出静态文件的内容都是必需的。
• Branch previews 为每个非生产或预演分支的推送自动创建一个环境，每个都位于 branch-*.kaps.run 下的自己的 URL 上。请参阅 分支预览。
• Auto-rollback on failure 在部署失败时恢复上一次健康的生产部署。
• Scheduled rebuild 按照间隔（从每小时到每周）重新构建生产，适合需要在没有 git 推送的情况下刷新的内容管理网站。

构建自动重试 重新排队因基础设施错误（例如网络问题或超时）失败的构建，最多三次。它不重试代码错误，因此无法掩盖损坏的构建。

忽略路径 和 分支忽略模式 停止不需要的构建：用于文件更改不应部署的 glob 模式，以及对于诸如 dependabot/* 这样永远不应触发构建的分支。

Git tag 部署 设置标签模式，将标签推送转换为生产部署。请参阅 Orbit 发布。

部署自动化和保护

部署保护 有两个门控：Require approval for production，它暂停由推送触发的生产部署，直到有人批准，以及 Require staging success before production，它保持生产部署，直到预演已成功部署相同的提交。

CI 必需的检查 在您自己的 CI 上进行部署门控。在 GitHub 上，您列出作业名称，所有这些都必须通过；在 GitLab 上，任何非空值都会等待整个管道。CI 失败会取消部署。

部署冻结计划 在批准的时间窗口外（周末或 UTC 小时范围）阻止由推送触发的部署。手动部署和部署钩子不受影响。

分支保护 添加 glob 模式规则，阻止匹配分支上的部署，直到所需的外部检查通过，并且可选地获得人工批准。

Auto-promote staging 在预演运行指定小时数而无健康失败并且烟雾测试通过后，自动将预演提升为生产。

所有这些都在 Orbit 部署管道 标签页的一个视图中汇总。

健康和质量门控

健康检查 在每次生产部署后获取您选择的路径。在 15 秒内的非 2xx 响应会恢复上一次健康的部署。

烟雾测试 在每次成功部署后对最多十个逗号分隔的路径运行 GET 请求，并记录通过或失败。与自动回滚结合，失败的烟雾测试会回滚部署。

性能预算 警告或失败超过阈值的构建：MB 中的总工件大小、kB 中由 glob 匹配的单个文件大小，或秒中的构建时间。每个预算设置为警告或构建失败。

预演

预演有自己的一组卡片：预演分支、带有密码的 访问保护、IP 允许列表（接受 IPv4 地址和 CIDR 范围，每行一个）、失败时自动回滚、预演是否 继承生产环境变量（优先级较低），以及安装、构建、输出和根目录的 构建覆盖。

密码和 IP 允许列表是应该在任何不打算公开的预演环境上设置的两个。将两者留空，预演 URL 将可由拥有它的任何人访问。

网络

自定义域 为生产环境添加和验证域，包括证书配置。请参阅 向 Orbit 添加自定义域。

重定向和重写 是在提供服务前应用的基于路径的规则，按顺序测试，第一次匹配获胜。重定向以 301 或 302 将浏览器发送到新 URL；重写静默地提供不同的路径而无 URL 更改。模式支持精确匹配、通配符、命名参数和 splat。请参阅 Orbit 中的重定向和重写。

响应头 将自定义 HTTP 头应用于匹配的路径，具有 HSTS、CSP、no-embed、no-sniff、引用者政策和 CORS 的预设。所有匹配规则都适用，稍后的条目会覆盖同一键的早期条目。

倾斜保护 在新部署上线后的保留窗口内，在存储中保留旧构建工件，以便加载先前版本的访问者仍可以获取其资源，而不是获得 404。

配置存储 保存部署在运行时读取的键/值设置，用于特性标志和不需要重新部署而更改的设置。它在存储下管理，而不是在这里，并且它是免费的：没有读取费用，也没有写入费用。值以纯文本形式存储，因此永远不要在其中放入密钥。每个项目最多 100 个条目，键最多 200 个字符，值最多 4096 个。每晚对每个条目进行快照，每个计划保留三十晚，因此可以恢复您删除的条目：请参阅 快照和恢复。

使用和限制

构建使用 显示此项目已运行的构建。

支出上限 设置最大月度超额支出，涵盖超出您的计划分配的构建分钟和带宽超额。最小值为 US$6.32，最大值为 US$6,315.79。警报在 50% 和 80% 处触发，在 100% 处暂停服务，直到您提高上限。请参阅 Orbit 支出上限。

构建支出上限 是单独的、更粗糙的限制：每月总构建分钟数的上限，之后新构建停止排队，直到下个月或您提高它。

工件保留 设置每个环境要保留多少个成功的构建工件。较旧的工件每天删除，当前实时部署始终保留，无论限制如何。

预览过期 在 7、14、30 或 60 天后或永不暂停预览环境。暂停的预览在 24 小时内回收其存储。

工件大小警报 在构建工件超过您设置的大小时向您发送电子邮件。

通知、集成和可观测性

部署电子邮件通知 有三个设置：所有部署、仅失败或关闭。通知 webhook URL 可以与它一起设置，在每次成功或失败时发布。

通知频道 是更丰富的版本，具有按事件选择、传输历史和测试按钮。完整的 webhook 控制在其自己的标签页上：请参阅 Orbit Webhooks。

部署钩子 创建密钥 URL，当某些东西向它们 POST 时触发部署。请参阅 通过部署钩子触发部署。

日志排水 在每次部署后将构建日志发送到您的可观测性平台，对 Datadog、Logtail、Axiom 和 New Relic 提供内置支持，或自定义 webhook，可选择筛选为一个环境。

Web Analytics 为您提供核心网络生命周期收集片段。请参阅 Orbit Web Vitals。

Cron 触发器 计划 HTTP 请求到所选环境，每个项目最多十个。更大的、仅生产版本位于其自己的标签页上：请参阅 Orbit Cron 作业。

共享和团队

团队 使用三个角色管理协作者：管理员、开发者和查看者。

共享链接 生成临时无密码链接，以便外部审阅者可以查看环境而无需密码或帐户。每个链接可在 1 小时、24 小时或 7 天后或永不过期，并显示其访问计数。可随时撤销一个。

部署组 将此项目加入一个组，以便相关项目一起部署，可选择按分支筛选。

克隆环境 和 克隆项目 复制配置。克隆项目会复制构建设置、环境配置和非密钥环境变量；密钥不会被复制。

危险区域

清除构建缓存 删除每个环境的缓存依赖项，因此下一次部署从头运行完整安装。它无法撤销，但缓存会在下一次构建时自动重建。

转移项目 将项目移到另一个 Kapsule 帐户。请参阅 转移 Orbit 项目。

存档项目 立即停止提供流量。它可在从 Orbit 列表中的 30 天内恢复，之后将被永久删除。

接下来去哪里

• Orbit 部署管道 在一个视图中查看每个设置的效果。
• 共享环境变量组 适用于跨项目使用的值。
• Orbit 计划限制 了解您的计划允许的内容。