跳转到内容

You're viewing the prerelease documentation siteContent here is for testing and may differ from the live docs.

Go to live docs

自托管概述

运行您自己的实例,每一条机密内容、每一个账户和每一行日志都会留在您控制的基础设施上。由您决定账户如何进行身份验证、实例是否可以从公共互联网访问,以及界面采用何种品牌。

模式决定了还需要运行哪些组件,因此请在安装之前确定下来。

simple 是默认配置,只需要 Valkey/Redis 数据存储。full 会为账户增加一个 SQL 数据库,默认使用位于 sqlite://data/auth.db 的 SQLite。PostgreSQL 是受支持的选项,而非必需项。在容器中,该文件需要挂载卷才能在重启后保留。

Simple 还是 Full 介绍了每种模式解锁的功能、该数据库必须放在哪里,以及之后切换模式的难度。

时间紧迫,而且已经有正在运行的 Valkey 或 Redis?使用 Docker 安装中的单条 docker run 命令会在 3000 端口启动一个实例,并生成一个 SECRET 值。实例启动后,本页的其他内容仍然适用。

  • 镜像与变体 — 应该运行哪个已发布的镜像,以及发布标签的工作方式。
  • 使用 Docker 安装 — 项目提供的两套 Compose 栈。
  • 在 Linux 上安装 — 在 Debian 或 Ubuntu 上进行裸机安装。项目的安装测试不覆盖其他发行版系列。
  • 作为服务运行 — 仓库提供的 systemd 单元,以及面向没有 systemd 的主机的 Procfile 运行器。
  • 反向代理与 TLS — 应用程序从不终止 TLS,因此需要在其前面部署一个代理。在对外暴露实例之前,请先阅读此页。
  • 验证您的安装 — 在把实例交给任何人之前,先证明它确实在正常提供服务,并创建第一个账户:站点运营者角色只能通过 CLI 授予。

升级现有安装?升级指南按从新到旧的顺序列出了可用的指南。请从您当前运行版本之后的第一份指南开始,依次向前推进,并阅读中间每个版本的发布说明。

运行 simple 身份验证模式的实例的推荐配置:

  • 2 个以上 CPU 核心
  • 2GB 以上内存
  • 10GB 以上磁盘空间

同时运行 PostgreSQL、后台工作进程和调度器的 full 模式部署大约需要两倍于此的资源。

有些管理工作在应用程序中没有对应界面,需要在实例的命令行中完成。

将组织转移给新所有者是其中最主要的一项。组织所有者没有相应的界面或端点,因此转移需要由您来执行。请使用下面的命令。如需自动化,Colonel API 在 POST /api/colonel/organizations/:org_id/transfer-ownership 提供了相同的操作。它需要 colonel 角色,以组织名称作为确认,并且立即生效,没有预览。

终端窗口
bin/ots org transfer-ownership ORG NEW_OWNER

ORG 是组织的公开 ID(extid,即 CLI 输出的 ID)或内部 ID(objid)。NEW_OWNER 是邮箱地址、客户 extid 或 Rodauth 账户 ID,并且对方必须已经是活跃成员——该命令从不创建客户,因此如果对方还不是成员,请先运行 bin/ots memberships add ORG CUSTOMER。

不带 --yes 运行时,它会先规划转移,在改动任何内容之前打印谁将失去所有权、有多少所有者成员关系会被降级以及降级为什么角色,然后请您确认。回答 n 即可仅预览转移。可用选项有 --demote-to ROLE(除 owner 以外的任何成员角色,默认 admin)、--yes(也可写作 -y 和 -f)和 --json。

原所有者会被降级,而不是被移除。该操作会先提升新所有者,再降级旧所有者——唯一所有者保护机制会拒绝任何其他顺序——因此在这两次写入期间,组织会同时拥有两个所有者成员关系,bin/ots org doctor 会将检查项 4(membership_role_sync)报告为警告。如果转移在此窗口内被中断,请重新运行转移命令,而不是 org doctor。转移操作是幂等的,会降级其他所有的所有者。org doctor 将该检查项标记为 repairable: false,不会修复它。

面向最终用户的说明是所有权与转移,您的用户在向您提问之前会先读到它。