tryretool/backend

Retool Docker 镜像文档

1. 镜像概述与主要用途

Retool 是一款快速开发有效软件的工具，本 Docker 镜像用于部署 Retool，支持自托管（Self-hosted）模式。通过该镜像，用户可在自有云环境中部署 Retool，确保内部数据访问、基础设施配置及身份认证等关键环节均在企业可控范围内，满足对数据安全与架构自主性的需求。

2. 核心功能与特性

2.1 数据安全与访问控制

• 内部数据管理：所有内部数据访问均在企业自有云环境中进行，避免数据外泄风险。

2.2 基础设施灵活性

• 自定义配置：支持根据企业基础设施需求灵活配置 Retool 部署，适配不同架构环境。

2.3 日志与监控支持

• 日志配置：可自定义日志收集与管理策略，满足企业监控与审计需求。

2.4 身份认证集成

• SAML SSO 支持：支持通过 Okta、Active Directory 等身份提供商配置自定义 SAML SSO，简化用户认证流程。

2.5 版本自主控制

• 独立版本管理：自托管版本与 Retool 云版本独立，不会自动更新，用户可自主选择更新时机与版本。

3. 使用场景与适用范围

3.1 适用场景

• 企业级自托管部署：需在自有云环境（如私有云、AWS、Azure、GCP 等）中部署 Retool 的企业。
• 数据本地化需求：对内部数据访问有严格合规要求，需确保数据不离开企业基础设施的场景。
• 定制化基础设施：需要根据自身 IT 架构调整 Retool 部署配置的场景。
• SAML SSO 集成：需与企业现有身份认证系统（如 Okta、Active Directory）集成的场景。

3.2 适用范围

• 支持本地服务器、AWS、Azure、GCP 等主流云平台部署。
• 适用于需要自主控制 Retool 版本及更新节奏的团队或企业。

4. 使用方法与配置说明

4.1 前置要求

• 自托管 Retool 许可证（需注册自托管账号或联系 Retool 企业团队获取）。
• 兼容的 Docker 环境（支持 Docker Engine 及 Docker Compose）。
• 目标部署环境（本地服务器或云平台资源）。

4.2 自托管部署步骤

步骤 1：获取许可证

• 注册自托管 Retool 账号：访问 Retool 自托管注册页。
• 企业级需求：联系 Retool 企业团队获取许可证，详情见 Retool 企业演示申请。

步骤 2：选择版本

• 参考 Retool 版本列表 选择适配的自托管版本。

步骤 3：部署 Retool

• 部署选项：支持本地部署及 AWS、Azure、GCP 等云平台部署，完整部署选项与安装说明见 https://github.com/tryretool/retool-onpremise#table-of-contents%E3%80%82
• 部署流程：根据目标环境选择对应部署脚本或配置文件，执行部署命令（具体命令及配置需参考 GitHub 仓库说明）。

步骤 4：测试部署

• 部署完成后，通过访问 Retool 服务地址验证安装状态，确认登录、功能模块及数据连接正常。

步骤 5：版本更新

• 自托管版本不会自动更新，需手动执行更新操作，更新方法见 Retool 自托管更新文档。

4.3 部署配置参考

具体 Docker 部署配置（如 docker run 命令、docker-compose.yml 文件）需根据目标环境调整，建议参考 https://github.com/tryretool/retool-onpremise 获取针对不同场景的示例配置。

5. 注意事项

• 自托管 Retool 需定期手动更新以获取最新功能及安全补丁。
• 部署前需确保目标环境满足 Retool 的系统资源要求（如 CPU、内存、存储等）。
• SAML SSO 配置需与企业身份提供商的 metadata 同步，确保认证流程正常。