应用介绍
OVERVIEW安装说明
V4
- 确认服务器使用 Docker Engine 24 或更高版本、Docker Compose v2,并至少有 2 GB 内存;选择 PostgreSQL 14–18 数据库服务,再填写计划用于 ZITADEL 的公网 HTTPS 域名。
- 在网站配置中删除默认生成的
location /,并按 ZITADEL 官方 NGINX 示例添加以下配置。普通 HTTP/1.1proxy_pass不支持 ZITADEL 的原生 gRPC API。
location / {
grpc_pass grpc://127.0.0.1:<应用 HTTP 端口>;
grpc_set_header Host $host;
grpc_set_header X-Forwarded-Proto https;
}
- 使用安装时创建的初始组织管理员登录。默认用户名填写
zitadel-admin时,完整登录名为zitadel-admin@zitadel.<公网域名>。初始管理员配置只在首次初始化时生效。
V4 包使用 ZITADEL 主程序内置且官方仍支持的 Login V1,因此仅运行一个 ZITADEL 容器。需要 Login V2 或依赖它的功能时,应按官方 Login V2 迁移指南单独规划部署。其他要求请参阅 ZITADEL 官方的 NGINX 反向代理文档和系统要求。
注意事项
- V4 安装项按
https://<公网域名>:443初始化。安装表单中的域名必须与用户实际访问的域名完全一致,否则会出现Instance not found。请勿使用应用端口直接访问。 - 主密钥必须恰好为 32 个字符,安装脚本会在首次启动前安全生成并保存到
data/masterkey.env;该文件会随应用备份保存,首次初始化后不得修改或丢失。 - V4 包显式关闭实例级 Login V2,并继续使用 V4 主程序内置且官方支持的 Login V1;该设置仅在首次初始化时生效。
- V4 是独立版本,不支持从应用商店现有 V3.3.2 直接一键升级。迁移已有实例前必须备份数据库,先升级至最新 V3.4.x(最低 V3.4.1),等待旧 Token 和会话过期或安排用户重新登录,再按官方流程先运行 V4
setup完成迁移,然后启动 V4。请参阅官方 V3 升级 V4 指南。 - V2 与 V3 同样需要使用与安装配置一致的域名,并通过 HTTPS 反向代理访问。
产品介绍
ZITADEL 是开源身份基础设施,提供身份认证、授权、多租户和审计能力,适用于 B2B 与 B2C 场景。
主要功能
- 支持 OpenID Connect、OAuth 2.x 和 SAML 2.0。
- 支持 Passkeys、多因素认证和无密码登录。
- 支持多租户组织、项目、角色和权限管理。
- 提供管理控制台、自助登录界面、API 和审计事件。
版本与部署参数
VERSIONS以下信息来自开源应用包模板,仅用于技术参考;尚未转换成可直接使用的 Cockpit 安装配置。
版本 4.19.4↓ 下载 docker-compose.yaml
配置字段
参数说明属性
PANEL_APP_PORT_HTTPHTTP 端口必填PANEL_DB_TYPE数据库服务必填PANEL_DB_NAME数据库名称必填PANEL_DB_USER数据库用户必填PANEL_DB_USER_PASSWORD数据库密码敏感信息ZITADEL_DOMAIN公网 HTTPS 域名必填ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME初始组织管理员必填ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD初始组织管理员密码敏感信息原始模板存在特定平台的网络或环境变量依赖,不能直接作为 Cockpit 安装文件使用。
版本 3.4.15↓ 下载 docker-compose.yaml
配置字段
参数说明属性
PANEL_APP_PORT_HTTP端口必填PANEL_DB_TYPE数据库服务必填PANEL_DB_NAME数据库名称必填PANEL_DB_USER数据库用户必填PANEL_DB_USER_PASSWORD数据库密码敏感信息ZITADEL_MASTER_KEY管理密钥(32位长度)敏感信息ZITADEL_EXTERNALDOMAIN外部域名必填ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME组织管理员必填ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD组织管理员密码敏感信息原始模板存在特定平台的网络或环境变量依赖,不能直接作为 Cockpit 安装文件使用。
版本 2.71.19↓ 下载 docker-compose.yaml
配置字段
参数说明属性
PANEL_APP_PORT_HTTP端口必填PANEL_DB_TYPE数据库服务必填PANEL_DB_NAME数据库名称必填PANEL_DB_USER数据库用户必填PANEL_DB_USER_PASSWORD数据库密码敏感信息ZITADEL_MASTER_KEY管理密钥(32位长度)敏感信息ZITADEL_EXTERNALDOMAIN外部域名必填ZITADEL_FIRSTINSTANCE_ORG_HUMAN_USERNAME组织管理员必填ZITADEL_FIRSTINSTANCE_ORG_HUMAN_PASSWORD组织管理员密码敏感信息原始模板存在特定平台的网络或环境变量依赖,不能直接作为 Cockpit 安装文件使用。