cloady文档
文档阅读约 18 分钟

控制台指南

按照你使用时依次遇到的顺序，介绍 Cloady 控制台中的每个面板和控件。

你在 Cloady 中的所有操作 — 登录、创建工作区、部署和管理应用 — 都在 cloady.com 上完成。下面每项任务都是一组带编号的操作步骤，你需要点击的每个按钮、标签页和选择器都用粗体标出。

第一次使用？先从快速入门开始，或者浏览一下核心概念，熟悉相关术语。

登录

  1. 在 cloady.com 上点击 Sign in，打开登录页。输入 Email 和 Password，然后点击 Sign in。已有的密码仍然有效。
  2. 如需使用社交账号登录，点击 Continue with GitHub 或 Continue with Google。
  3. 如果你的公司已配置单点登录（SSO），点击 Continue with SSO，输入 Work email，再点击 Continue with SSO。你会在公司的身份提供商处登录，并以 developer 角色加入公司的工作区。
  4. 如需创建账号或找回访问权限，选择 Create account or reset password。输入邮箱并获取验证码，然后输入该验证码和一个至少 12 个字符的新密码。验证码只能使用一次，15 分钟后失效；输错 5 次后，需要等待 15 分钟。以后用邮箱和密码登录即可。
  5. 如果你开启了两步验证，请输入我们通过短信发送的 6 位验证码，然后点击 Verify & continue。无论你用哪种方式登录，都需要这一步。
  6. 每个账号都必须验证手机号。如果你的手机号尚未验证，登录页接下来会要求你验证：输入手机号，点击 Text me a code，输入 6 位验证码，然后点击 Verify & continue。一个手机号只能对应一个账号；完成这一步之前，Cloady 的其他功能都无法使用。
  7. 随后你会进入自己的工作区。首次登录时，Cloady 会为你创建一个工作区。

你也可以在登录前，直接从 cloady.com 上的部署输入框开始：选择一个模板、仓库、镜像或文件夹，并在那里完成配置。点击 Deploy 后，卡片会直接变成登录表单，无需离开当前页面 — GitHub、Google 和 SSO 会在一个小窗口中打开，完成后窗口自动关闭；邮箱/密码登录则直接在卡片里完成。登录后，部署会按你的全部设置继续进行，应用会部署到一个新工作区中，工作区名称与应用地址里显示的一致。

创建工作区

工作区包含你的应用、你的团队和一份订阅，地址为 cloady.com/w/{slug}。

  1. 点击顶部栏左上角的 WORKSPACE 按钮，然后点击 + New workspace。
  2. 输入 Name（例如 Acme Inc）。输入框下方的 URL 预览会随之更新；如果这个名称已被占用，Cloady 会自动添加后缀并告诉你。
  3. （可选）在弹窗标题栏中上传一个 Icon。颜色无法手动选择 — 渐变色取自图标；如果没有上传图标，则根据名称生成。
  4. 点击 Create workspace。创建工作区不收取任何费用；弹窗中会显示每个工作区都享有的免费额度。

一份订阅覆盖整个工作区，你可以立即部署到任意区域。工作区支付的费用取决于其中应用声明的资源（参见容量与价格）；如果工作区中所有应用的资源合计不超过 0.5 vCPU、1 GB 内存和 5 GB SSD，就无需付费。

认识控制台

控制台只有一个屏幕：顶部栏、显示各项总计的工作区标题栏，以及下方的 Applications 网格。

控制台结构：顶部栏、工作区标题栏和 Applications 网格；区域和环境选择器会同步到 URL 中，并用于筛选网格cloady.com/w/acme/usw1/productioncloadyAcme Incusw1PRODSearch…ToolsSettings+ New applicationAcme Inccost $15/mo · usw1cpu 4.0 vCPUram 8.0 GBdisk 200 GB5 apps · 4 runningApplicationsusw1 · productionwordpressrunningpostgresrunningapideploying+ Add application区域和环境是 URL 的最后两段 — 切换其中任意一个，都会重新筛选网格，并改变下一次安装的目标位置。
  1. 顶部栏从左到右依次是：cloady 标志（返回首页）、显示当前工作区名称的 WORKSPACE 切换器、区域选择器（地球图标 + 区域代码），以及环境选择器（彩色圆点 + PRODUCTION / PREVIEW / DEVELOPMENT）。
  2. 点击区域选择器即可切换区域：Deployed 分组列出你已经在运行应用的区域，Available 列出其余区域。列出的每个区域都可以部署。
  3. 点击环境选择器即可切换环境。它会筛选网格，并决定下一次安装所在的环境。这两个选择器都体现在 URL 中，所以控制台链接可以直接分享：/w/{slug}/{region}/{env}。
  4. 使用 Search applications… 搜索框（或按 ⌘K）按名称筛选网格。
  5. 右侧还有：Terminal、Files、Database、Monitor 和 Git 工具按钮、Settings 齿轮、New application，以及你的账号头像菜单。
  6. 在工作区标题栏中，可以看到 apps / running 数量、每月的 cost，以及 cpu、ram 和 disk：即你的应用所声明资源的总和。
  7. 下方的 Applications 列出所选区域和环境中的所有应用。可以用 All / Running / Stopped 筛选，按 Name、Status、CPU 或 Memory 排序，还可以打开 Expand，显示带实时详情的卡片。虚线框的 Add application 卡片是另一个入口。

安装应用

  1. 确认环境选择器指向你要部署的环境。每个应用只运行在一个区域和一个环境中；应用创建后，环境就固定不变，只有 Transfer 能把它迁移到另一个区域。
  2. 点击顶部栏中的 New application，或网格中的 Add application 卡片。
  3. 使用弹窗顶部的输入框：粘贴 GitHub 仓库 URL；输入镜像名称，例如 nginx 或 ghcr.io/acme/api:1.4；输入镜像仓库地址（例如 docker.io/）浏览热门镜像；或者输入关键词，搜索下方列出的模板（WordPress、Postgres 等）。你也可以把文件夹或 docker-compose.yml 拖到输入框上。点击某一行，或按 Enter 选择高亮的那一行。
  4. 输入框会变成该应用的卡片。顶部依次是你选择的内容、它的每月价格和部署按钮。下方的 Services 显示 Cloady 从你的来源中读取到的内容，Settings 列出部署前可以修改的设置。点击某一行即可打开，按 Esc 或点击 Done 返回：
    • Resources — 在模板默认值的基础上调高或调低 CPU 和内存。
    • Payment method — 当这个应用会让工作区超出免费额度时显示，并注明将被扣款的银行卡。工作区所有者可以直接在这里添加银行卡：新卡会成为所有者账号的默认卡；如果工作区有自己的专用卡，则会替换那张卡。如果还没有绑定银行卡，Deploy 会多出一步要求你添加，保存后部署会自动继续。
    • Region — 应用运行的位置。所有区域价格相同。
    • Domains — 在这里修改应用名称；应用的 cloady.io 地址会随名称变化，并且始终启用。添加自有域名的方式与应用设置中完全相同；Check DNS 会告诉你它的记录是否已经指向 Cloady。
    • Managed backups — 每日快照，保留 7 个还原点，费用为该应用自身价格的 20%。仅当应用有存储卷时显示。
    • Environment — 应用的变量。模板会列出所需的变量，并为你生成密码。
    • Build — 适用于仓库和上传的代码：分支、根目录、推送时重新部署，以及构建和启动命令（留空则由 Cloady 自动检测）。
  5. 按 Enter 或点击 Deploy。Cloady 会构建应用，为它分配一个已配好 HTTPS 的主机名，然后启动它。
  6. 卡片会实时显示部署进度；生成的密码或密钥之后也可以随时在应用的 Settings → Environment 中找到。

应用的地址由应用名称、一段短代码和工作区名称组成：

my-blog-k7q2v9ze-acme.cloady.io

所有区域和环境都使用同样的格式；短代码保证每个应用的地址唯一。

如果工作区仍在免费额度之内，应用启动时不收取费用。超出额度后，会从已绑定的银行卡中扣除本月剩余时间的费用。如果没有绑定银行卡，Deploy 会先在 Payment method 中要求你添加；如果银行卡扣款被拒，启动会以 payment_required 失败，点击 Use another card 即可回到那里。你也可以调小应用的规格。

管理应用

  1. 点击网格中的应用卡片打开详情视图，或者直接使用卡片上的内联控件。
  2. 使用标题栏中的生命周期按钮：Start 启动已停止的应用，Stop 关闭它的容器并保留数据，Restart 重启容器，Open 在新标签页中打开公开 URL。
  3. 点击 Settings，打开 App settings 弹窗：
    • General — Name、Slug（小写字母、数字和连字符，最多 24 个字符）、Region（可通过 Danger zone 下的 Transfer 更改）；对于基于仓库的应用，还有分支选择器、Auto-deploy 开关和预览分支跟踪。
    • Services — 该应用运行的容器，每个容器都带有终端按钮。
    • Volumes — 持久化存储。重启、重新部署和停止都不会影响它；只有删除应用才会将其移除。
    • Resources — 当前的 CPU / 内存 / 磁盘用量、CPU 和 MEMORY 缩放滑块（0.5× 到 4×），以及逐个存储卷的扩容。存储卷只能扩大，不能缩小。在你点击 Save changes 之前，这里会显示此次更改会让月账单增加或节省多少；增加的部分在保存时扣费，减少的部分从下次续费时生效。
    • Environment — 应用的变量。机密值在你选择显示之前始终隐藏；你也可以把 .env 文件拖到面板上，一次导入多个变量。更改会在下一次部署时生效。
    • Deployments — 每一次部署及其构建日志、一个部署按钮，并可回滚到之前成功的部署。
    • Domains — 内置主机名和所有自定义域名（见下一节）。
    • Backups — 每个应用都有的自动应急快照，以及 Managed backups 开关：每日快照，保留 7 个还原点，费用为该应用自身价格的 20%。每个快照都有 Restore 按钮；还原会用快照替换当前数据。
    • Logs — 实时查看容器的输出。
    • Danger zone — Stop application；Transfer application，即把应用转移到另一个工作区、另一个区域，或者两者同时更换（数据会保留；迁移到其他区域时，应用会在存储卷复制期间停止运行）；以及 Delete application。

重命名是安全的，删除则不然。你可以随时在 General 中修改 Name — 地址会随名称变化，自定义域名也会继续正常工作。如果你手动编辑了 Slug，从那以后它就不再随名称变化。删除应用会永久销毁它的服务、存储、变量、域名和部署历史 — 千万不要为了重命名而删除应用。删除时需要输入应用的 slug 进行确认。

添加自定义域名

  1. 打开应用，点击 Settings，然后切换到 Domains 标签页。
  2. 顶部的 BUILT-IN 主机名就是应用已经在使用的 cloady.io 地址，并已启用 HTTPS。
  3. 在添加行中输入你的主机名（例如 app.yourdomain.com），然后点击 Add domain。如果想把访问者转到其他地方，请先勾选 Redirect to another host (permanent)，并填写目标地址。
  4. 在 DNS configuration 下，用切换按钮选择一种方式：
    • CNAME — 子域名的默认方式。在你的 DNS 服务商处添加页面上显示的那一条 CNAME 记录。
    • A / AAAA — 用于根域名（apex），根域名不能使用 CNAME。添加页面上显示的 A（IPv4）和 AAAA（IPv6）记录。
  5. 用复制按钮获取准确的值，然后在你的域名注册商处创建这些记录。
  6. DNS 解析生效后，Cloady 会为你申请证书；每个域名的状态会依次变为 queued → pending → issued。如果几分钟后仍未变为 issued，说明记录没有指向 Cloady — 请到域名注册商处重新检查。

工作区设置与容量调整

按作用范围依次排列的三个设置弹窗（账号、工作区、应用），标出了打开每个弹窗的控件及其标签页，并高亮显示在多个层级中都出现的标签名账号›工作区›应用头像菜单Account settings你本人，在所有工作区中ProfileSecurityNotificationsAPI tokensBillingDanger zone顶部栏齿轮Workspace settings单个工作区及其容量GeneralMembersSingle sign-onDomainsBillingIntegrationsDanger zone应用 · SettingsApp settings一个区域 + 环境中的单个应用GeneralServicesVolumesResourcesEnvironmentDeploymentsDomainsLogsDanger zone绿色名称会出现在多个弹窗中 — 但每一个都只作用于自己所在的范围。
  1. 点击 Settings（顶部栏中的齿轮图标），打开工作区的 Settings 弹窗。标签页包括：General、Members、Single sign-on、Domains、Billing、Integrations、Import、Danger zone。
  2. 打开 Billing。顶部的卡片分别显示 THIS MONTH（本计费周期已出账的金额）、DUE TODAY（尚未支付的款项）和 NEXT MONTH（续费时的费用）。一份订阅覆盖整个工作区 — 不按区域分别计费。
  3. Subscribed capacity 显示你的应用声明的资源总量：它所处的套餐档位，CPU、RAM 和 SSD 及其各自在价格中的占比，以及每月总价。这里没有需要购买的东西；它会跟随你的应用变化。
  4. 要调整容量，可以在应用的 Settings → Resources 标签页中缩放应用，或者部署、删除应用。在你点击 Save changes 之前，该标签页会显示此次更改会让月账单增加或节省多少。增加资源会立即扣费，并且只有付款成功后才会生效；减少资源则从下次续费时开始生效，所以你已经付费的部分在本周期内仍然保留。
  5. 工作区有了订阅之后，Workspace card 会仅在这个工作区内覆盖你账号的默认卡。留空则使用账号默认卡，它显示在下方。
  6. 要邀请团队成员，打开 Members，通过邮箱添加。
  7. 要让公司成员通过公司的身份提供商登录，打开 Single sign-on（仅限工作区 admin）。在你的身份提供商（Okta、Microsoft Entra ID、Google Workspace、Auth0、Keycloak 等）处创建一个 OpenID Connect 应用，并填入页面上显示的 Redirect URI；然后填写 Email domain、Issuer URL、Client ID 和 Client secret，再点击 Save。把页面显示的 DNS record 作为 TXT 记录添加到你的 DNS 服务商处，然后点击 Check DNS。状态显示为 ACTIVE 后，凡是通过你的身份提供商登录、且邮箱属于该域名的人，都会以 developer 角色加入这个工作区。
  8. Integrations 用于连接 GitHub，这样你就能部署私有仓库。Danger zone 中有 Delete workspace：你需要输入工作区 slug 进行确认，随后工作区中的每个应用、它们的全部数据和全部域名都会被永久销毁。

账号与 API 令牌

个人访问令牌用于 CLI、API、Terraform Provider 和 MCP 服务器的身份验证，让它们以你的身份访问你的所有工作区。

  1. 点击顶部栏右上角的账号头像，然后点击 Account settings。标签页包括：Profile、Security、Preferences、Notifications、API tokens、Billing、Danger zone。
  2. 打开 API tokens 标签页，点击 + New token。
  3. 填写 Name（例如 CLI · macbook），选择 Scope（Full access、Deploy only 或 Read only）和 Expiry（No expiry、30 days、90 days 或 1 year），然后点击 Create token。
  4. 以 cldy_ 开头的密钥只显示一次 — 点击复制按钮保存它，然后点击 Done。之后无法再次获取。
  5. 在 CLI / API / MCP 中将该令牌用作 Bearer 凭据。要吊销某个令牌，点击它所在行的 Revoke。

在 Cloady 上托管应用与数据库

选择部署来源，确定应用和数据库的资源规格，了解资源定价，并规划如何迁移到 Cloady。

从 Railway、Render 或 Vercel 导入

把现有服务迁移过来，仓库、变量、磁盘和域名都会预先填好。

本页内容

1登录2创建工作区3认识控制台4安装应用5管理应用6添加自定义域名7工作区设置与容量调整8账号与 API 令牌