docs: make Chinese README the default

2026-07-13 10:45:20 +00:00
parent 9e9dd9134f
commit 4f2b51664a
1 changed files with 117 additions and 111 deletions
@@ -1,18 +1,24 @@
+<!-- WEHUB_ZH_README -->
+> [!NOTE]
+> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。  
+> [English](./README.en.md) · [原始项目](https://github.com/casdoor/casdoor) · [上游 README](https://github.com/casdoor/casdoor/blob/HEAD/README.md)  
+> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
+
 <div align="center">
  <a href="https://casdoor.ai">
    <img src="https://cdn.casbin.org/img/casdoor-logo_1185x256.png" alt="Casdoor" width="500">
  </a>

-  <h3>Casdoor: AI-First Identity and Access Management (IAM) / AI MCP Gateway</h3>
+  <h3>Casdoor：AI 优先的身份与访问管理（IAM）/ AI MCP 网关</h3>

  <p align="center">
-    <strong>An open-source, AI-first IAM / MCP gateway and authentication server with a web UI.</strong><br>
-    Supporting MCP, A2A, OAuth&nbsp;2.0, OIDC (OAuth&nbsp;2.x), SAML, CAS, LDAP, SCIM, WebAuthn, TOTP, MFA, Face ID,<br>
-    Google Workspace, Azure AD, and more.
+    <strong>一款开源、AI 优先的 IAM / MCP 网关与认证服务器，配备 Web UI。</strong><br>
+    支持 MCP、A2A、OAuth&nbsp;2.0、OIDC（OAuth&nbsp;2.x）、SAML、CAS、LDAP、SCIM、WebAuthn、TOTP、MFA、Face ID、<br>
+    Google Workspace、Azure AD 等。
  </p>

  <p align="center">
-    <a href="https://casdoor.ai/"><strong>Documentation and guides: casdoor.ai</strong></a>
+    <a href="https://casdoor.ai/"><strong>文档与指南：casdoor.ai</strong></a>
  </p>

  <p>
@@ -55,68 +61,68 @@
  </p>

  <p align="center">
-    <a href="https://casdoor.ai"><strong>Website</strong></a> ·
-    <a href="https://casdoor.ai/docs/overview"><strong>Documentation</strong></a> ·
-    <a href="https://door.casdoor.com"><strong>Live demo</strong></a> ·
+    <a href="https://casdoor.ai"><strong>官网</strong></a> ·
+    <a href="https://casdoor.ai/docs/overview"><strong>文档</strong></a> ·
+    <a href="https://door.casdoor.com"><strong>在线演示</strong></a> ·
    <a href="https://discord.gg/5rPsrAzK7S"><strong>Discord</strong></a>
  </p>
 </div>

 ---

-## Table of contents
+## 目录

- [Why Casdoor](#why-casdoor)
- [Live demos](#live-demos)
- [Quick start](#quick-start)
- [Features](#features)
- [Technology stack](#technology-stack)
- [Documentation](#documentation)
- [Integrations](#integrations)
- [Security](#security)
- [Community and support](#community-and-support)
- [Contributing](#contributing)
- [Donate](#donate)
- [License](#license)
+- [为什么选择 Casdoor](#why-casdoor)
+- [在线演示](#live-demos)
+- [快速开始](#quick-start)
+- [功能特性](#features)
+- [技术栈](#technology-stack)
+- [文档](#documentation)
+- [集成](#integrations)
+- [安全](#security)
+- [社区与支持](#community-and-support)
+- [贡献](#contributing)
+- [捐赠](#donate)
+- [许可证](#license)

 ---

 <a id="why-casdoor"></a>
-## Why Casdoor
+## 为什么选择 Casdoor

-Casdoor is a **UI-first** identity provider and access management platform: one place to manage users, organizations, applications, and providers, with a modern web console. Authorization policies can be expressed with **[Casbin](https://casbin.org/)** (ACL, RBAC, ABAC, and more). Unlike reverse-proxy-centric auth companions, Casdoor is a dedicated auth server with broad protocol support, designed to be straightforward to self-host and integrate—see **[casdoor.ai](https://casdoor.ai)** for documentation.
+Casdoor 是一款 **UI 优先** 的身份提供方（IdP）与访问管理平台：在一个地方管理用户、组织、应用和提供方，并配备现代化的 Web 控制台。授权策略可通过 **[Casbin](https://casbin.org/)****（ACL、RBAC、ABAC 等）来表达。与以反向代理为中心的认证配套方案不同，Casdoor 是专用的认证服务器，支持广泛的协议，设计目标是便于自托管和集成——请参阅 **[casdoor.ai](https://casdoor.ai)**** 获取文档。

 ---

 <a id="live-demos"></a>
-## 🌐 Live demos
+## 🌐 在线演示

-| Environment | URL | Description |
+| 环境 | URL | 说明 |
 |-------------|-----|-------------|
-| **Read-only** | [door.casdoor.com](https://door.casdoor.com) | Global demo; **any modification or write operation will fail** (read-only). |
-| **Writable** | [demo.casdoor.com](https://demo.casdoor.com) | Full access for testing; **data is reset about every 5 minutes**. |
+| **只读** | [door.casdoor.com](https://door.casdoor.com) | 全球演示环境；**任何修改或写入操作都会失败**（只读）。 |
+| **可写** | [demo.casdoor.com](https://demo.casdoor.com) | 完整访问权限，用于测试；**数据大约每 5 分钟重置一次**。 |

-Default demo admin login (where applicable): `admin` / `123` — use only for demos; change credentials on your own deployment.
+默认演示管理员登录（如适用）：`admin` / `123` — 仅用于演示；在你自己的部署中请更改凭据。

 ---

 <a id="quick-start"></a>
-## 🚀 Quick start
+## 🚀 快速开始

-Pick one deployment method below. To keep behavior consistent with upstream, the steps are aligned with official docs.
+从下方选择一种部署方式。为与上游行为保持一致，步骤与官方文档对齐。

-### 🛠️ Source code (default)
+### 🛠️ 源代码（默认）

-1. Install dependencies: **Go 1.25** (follow `go.mod`), **Node.js LTS (20)**, **Yarn 1.x**, and a supported database.
-2. Clone the repository:
+1. 安装依赖：**Go 1.25**（遵循 `go.mod`）、**Node.js LTS (20)**、**Yarn 1.x**，以及受支持的数据库。
+2. 克隆仓库：

 ```bash
 git clone https://github.com/casdoor/casdoor.git
 cd casdoor
 ```

-3. Configure database in `conf/app.conf` (at minimum set `driverName`, `dataSourceName`, and `dbName`; for MySQL create database `casdoor` first).
-4. Build frontend and start backend:
+3. 在 `conf/app.conf` 中配置数据库（至少设置 `driverName`、`dataSourceName` 和 `dbName`；使用 MySQL 时需先创建数据库 `casdoor`）。
+4. 构建前端并启动后端：

 ```bash
 cd web
@@ -126,95 +132,95 @@ cd ..
 go run main.go
 ```

-5. Open [http://localhost:8000](http://localhost:8000) and sign in with `built-in/admin` / `123` on a fresh install (change password immediately in production).
+5. 打开 [http://localhost:8000](http://localhost:8000)，在全新安装上使用 `built-in/admin` / `123` 登录（生产环境请立即更改密码）。

-Official guide: [Server installation](https://casdoor.ai/docs/basic/server-installation)
+官方指南：[服务器安装](https://casdoor.ai/docs/basic/server-installation)

 ### 🐳 Docker

-Use one of the official Docker paths:
+使用以下任一官方 Docker 路径：

- **All-in-one (SQLite quick trial)**:
+- **一体化（SQLite 快速试用）**：

 ```bash
 docker run -p 8000:8000 casbin/casdoor-all-in-one
 ```

- **Docker Compose** (with your `conf/app.conf` next to `docker-compose.yml`):
+- **Docker Compose**（将 `conf/app.conf` 放在 `docker-compose.yml` 旁边）：

 ```bash
 docker compose up
 ```

-Then open [http://localhost:8000](http://localhost:8000) and sign in with `built-in/admin` / `123` on a fresh install.
+然后打开 [http://localhost:8000](http://localhost:8000)，在全新安装上使用 `built-in/admin` / `123` 登录。

-Official guide: [Try with Docker](https://casdoor.ai/docs/basic/try-with-docker)
+官方指南：[使用 Docker 试用](https://casdoor.ai/docs/basic/try-with-docker)

 ### ☸️ Kubernetes Helm

-With Helm v3 and a running Kubernetes cluster:
+使用 Helm v3 和运行中的 Kubernetes 集群：

 ```bash
 helm install casdoor oci://registry-1.docker.io/casbin/casdoor-helm-charts
 ```

-After installation, access Casdoor through your cluster service/ingress. The official guide covers chart versions (including optional `--version`) and cluster-specific settings.
+安装完成后，通过集群的 service/ingress 访问 Casdoor。官方指南涵盖 chart 版本（包括可选的 `--version`）及集群特定设置。

-Official guide: [Try with Helm](https://casdoor.ai/docs/basic/try-with-helm)
+官方指南：[使用 Helm 试用](https://casdoor.ai/docs/basic/try-with-helm)

 ---

 <a id="features"></a>
-## ✨ Features
+## ✨ 功能特性

 <table>
 <tr>
 <td width="50%">

-### 🔐 Authentication
+### 🔐 认证

- **OAuth 2.0 / OIDC** — OpenID Connect and OAuth 2.x authorization
- **SAML 2.0** — Enterprise SSO integration
- **CAS** — Central Authentication Service
- **LDAP** — Directory service integration
- **WebAuthn / Passkeys** — Passwordless authentication
- **TOTP / MFA** — Multi-factor authentication
- **Face ID** — Biometric authentication
+- **OAuth 2.0 / OIDC** — OpenID Connect 与 OAuth 2.x 授权
+- **SAML 2.0** — 企业 SSO 集成
+- **CAS** — 中央认证服务（Central Authentication Service）
+- **LDAP** — 目录服务集成
+- **WebAuthn / Passkeys** — 无密码认证
+- **TOTP / MFA** — 多因素认证
+- **Face ID** — 生物识别认证

 </td>
 <td width="50%">

-### 🏢 Enterprise
+### 🏢 企业级

- **SCIM 2.0** — User provisioning
- **RBAC** — Role-based access control
- **Social Login** — Google, GitHub, Azure AD, and more
- **Custom providers** — Extensible identity providers
- **User management** — Web UI for administration
- **Audit logs** — Comprehensive logging
- **Multi-tenancy** — Organization support
+- **SCIM 2.0** — 用户预配（provisioning）
+- **RBAC** — 基于角色的访问控制
+- **社交登录** — Google、GitHub、Azure AD 等
+- **自定义提供方** — 可扩展的身份提供方
+- **用户管理** — 用于管理的 Web UI
+- **审计日志** — 全面的日志记录
+- **多租户** — 组织支持

 </td>
 </tr>
 <tr>
 <td width="50%">

-### 🤖 AI & MCP
+### 🤖 AI 与 MCP

- **MCP Gateway** — Model Context Protocol support
- **A2A Protocol** — Agent-to-Agent communication
- **AI-First Design** — Built for AI applications
+- **MCP 网关** — 支持 Model Context Protocol
+- **A2A 协议** — Agent-to-Agent 通信
+- **AI 优先设计** — 为 AI 应用而构建

 </td>
 <td width="50%">

-### 🛠️ Developer Experience
+### 🛠️ 开发者体验

- **RESTful API** — Complete API coverage
- **SDKs** — Go, Java, Python, Node.js, and more
- **Swagger UI** — Interactive API documentation
- **Webhooks** — Event-driven integrations
- **Customizable UI** — Brand theming support
+- **RESTful API** — 完整的 API 覆盖
+- **SDK** — Go、Java、Python、Node.js 等
+- **Swagger UI** — 交互式 API 文档
+- **Webhooks** — 事件驱动集成
+- **可定制 UI** — 支持品牌主题

 </td>
 </tr>
@@ -223,43 +229,43 @@ Official guide: [Try with Helm](https://casdoor.ai/docs/basic/try-with-helm)
 ---

 <a id="technology-stack"></a>
-## Technology stack
+## 技术栈

-Casdoor is built as a **frontend–backend separated** project:
+Casdoor 采用 **前后端分离** 架构：

- **Web UI**: JavaScript and **React** ([`web/`](https://github.com/casdoor/casdoor/tree/master/web))
- **API server**: **Go** with **Beego**, RESTful APIs ([repository root](https://github.com/casdoor/casdoor))
- **Data**: mainstream databases including **MySQL**, **PostgreSQL**, and others ([overview](https://casdoor.ai/docs/overview))
- **Cache**: optional **Redis** for session/cache-style deployments (configure as needed)
+- **Web UI**：JavaScript 与 **React**（[`web/`](https://github.com/casdoor/casdoor/tree/master/web))
+- **API 服务器**：**Go** 与 **Beego**，RESTful API（[仓库根目录](https://github.com/casdoor/casdoor))
+- **数据**：主流数据库，包括 **MySQL**、**PostgreSQL** 等（[概览](https://casdoor.ai/docs/overview))
+- **缓存**：可选 **Redis**，用于会话/缓存类部署（按需配置）

 ---

 <a id="documentation"></a>
-## 📖 Documentation
+## 📖 文档

-**All product documentation, installation, and tutorials live at [casdoor.ai/docs/overview](https://casdoor.ai/docs/overview).** Start here, then use the sections below.
+**所有产品文档、安装说明和教程均位于 [casdoor.ai/docs/overview](https://casdoor.ai/docs/overview).** 请从这里开始，然后使用下方各章节。

-**Install**
+**安装**

- [Install from source](https://casdoor.ai/docs/basic/server-installation)
- [Install with Docker](https://casdoor.ai/docs/basic/try-with-docker)
- [Install with Kubernetes Helm](https://casdoor.ai/docs/basic/try-with-helm)
+- [从源码安装](https://casdoor.ai/docs/basic/server-installation)
+- [使用 Docker 安装](https://casdoor.ai/docs/basic/try-with-docker)
+- [使用 Kubernetes Helm 安装](https://casdoor.ai/docs/basic/try-with-helm)

-**Connect applications**
+**连接应用**

- [How to connect to Casdoor](https://casdoor.ai/docs/how-to-connect/overview)
+- [如何连接 Casdoor](https://casdoor.ai/docs/how-to-connect/overview)

-**APIs**
+**API**

- [Public API](https://casdoor.ai/docs/basic/public-api)
- [Swagger UI](https://door.casdoor.com/swagger) (live API explorer)
+- [公共 API](https://casdoor.ai/docs/basic/public-api)
+- [Swagger UI](https://door.casdoor.com/swagger)（实时 API 浏览器）

 ---

 <a id="integrations"></a>
-## 🔌 Integrations
+## 🔌 集成

-Casdoor integrates with common languages and frameworks:
+Casdoor 可与常见语言和框架集成：

 <p align="center">
  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/go/go-original.svg" width="40" alt="Go">
@@ -271,58 +277,58 @@ Casdoor integrates with common languages and frameworks:
  <img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/angularjs/angularjs-original.svg" width="40" alt="Angular">
 </p>

-Browse the full list: [Integrations](https://casdoor.ai/docs/category/integrations).
+浏览完整列表：[Integrations](https://casdoor.ai/docs/category/integrations).

 ---

 <a id="community-and-support"></a>
-## 🤝 Community and support
+## 🤝 社区与支持

- **Discord**: [Join our community](https://discord.gg/5rPsrAzK7S)
- **Contact**: [casdoor.ai/help](https://casdoor.ai/help)
- **Issues**: [GitHub Issues](https://github.com/casdoor/casdoor/issues)
- **Discussions**: [GitHub Discussions](https://github.com/casdoor/casdoor/discussions)
+- **Discord**：[加入我们的社区](https://discord.gg/5rPsrAzK7S)
+- **联系方式**：[casdoor.ai/help](https://casdoor.ai/help)
+- **Issues**：[GitHub Issues](https://github.com/casdoor/casdoor/issues)
+- **Discussions**：[GitHub Discussions](https://github.com/casdoor/casdoor/discussions)

 ---

 <a id="contributing"></a>
-## 🌍 Contributing
+## 🌍 贡献

-If you have questions about Casdoor, you can **[open an issue](https://github.com/casdoor/casdoor/issues)**. Pull requests are welcome; **we recommend opening an issue first** so you can align with maintainers and the community before larger changes.
+如果你对 Casdoor 有疑问，可以 **[提交 issue](https://github.com/casdoor/casdoor/issues)**. 欢迎提交 Pull request；**我们建议先提交 issue**，以便在进行较大改动前与维护者和社区达成一致。

-Please also read our [contribution guidelines](https://casdoor.ai/docs/contributing/) before contributing.
+请在贡献之前阅读我们的 [贡献指南](https://casdoor.ai/docs/contributing/)

-### Translation and i18n
+### 翻译与国际化（i18n）

- **Crowdin** is used for translation workflows: [casdoor-site on Crowdin](https://crowdin.com/project/casdoor-site).
- The web app uses **i18next**. When you add or change user-visible strings under [`web/`](https://github.com/casdoor/casdoor/tree/master/web), update the English catalog at [`web/src/locales/en/data.json`](web/src/locales/en/data.json) accordingly.
+- **Crowdin** 用于翻译工作流：[Crowdin 上的 casdoor-site](https://crowdin.com/project/casdoor-site).
+- Web 应用使用 **i18next**。当你在 [`web/`](https://github.com/casdoor/casdoor/tree/master/web), 下添加或修改用户可见字符串时，请相应更新 [`web/src/locales/en/data.json`](web/src/locales/en/data.json) 中的英文目录。

 ---

 <a id="donate"></a>
-## ❤️ Donate
+## ❤️ 捐赠

-If you find Casdoor useful, please consider supporting its development:
+如果你觉得 Casdoor 有用，请考虑支持其开发：

-<a href="https://opencollective.com/casdoor#sponsor"><img src="https://opencollective.com/casdoor/tiers/sponsor.svg?avatarHeight=74" alt="Sponsors on Open Collective"></a>
+<a href="https://opencollective.com/casdoor#sponsor"><img src="https://opencollective.com/casdoor/tiers/sponsor.svg?avatarHeight=74" alt="Open Collective 上的赞助者"></a>

-<a href="https://opencollective.com/casdoor#backer"><img src="https://opencollective.com/casdoor/tiers/backer.svg?avatarHeight=36" alt="Backers on Open Collective"></a>
+<a href="https://opencollective.com/casdoor#backer"><img src="https://opencollective.com/casdoor/tiers/backer.svg?avatarHeight=36" alt="Open Collective 上的支持者"></a>

 ---

 <a id="license"></a>
-## 📄 License
+## 📄 许可证

-Casdoor is licensed under the [Apache License 2.0](https://github.com/casdoor/casdoor/blob/master/LICENSE).
+Casdoor 采用 [Apache License 2.0](https://github.com/casdoor/casdoor/blob/master/LICENSE). 许可证。

 ---

 <div align="center">

-[![Made with ❤️](https://img.shields.io/badge/Made_with-%E2%9D%A4%EF%B8%8F-ff6b6b?style=flat-square&logoColor=white)](https://casdoor.ai) [![By Casdoor](https://img.shields.io/badge/by-Casdoor-4ecdc4?style=flat-square)](https://casdoor.ai)
+[![用 ❤️ 制作](https://img.shields.io/badge/Made_with-%E2%9D%A4%EF%B8%8F-ff6b6b?style=flat-square&logoColor=white)](https://casdoor.ai) [![来自 Casdoor](https://img.shields.io/badge/by-Casdoor-4ecdc4?style=flat-square)](https://casdoor.ai)

 <a href="https://github.com/casdoor/casdoor/stargazers"><img src="https://img.shields.io/github/stars/casdoor/casdoor?style=social&logo=github&label=Star" alt="GitHub Stars"></a>

-<sub>© 2026 <a href="https://casdoor.ai">Casdoor</a>. Licensed under <a href="https://github.com/casdoor/casdoor/blob/master/LICENSE">Apache License 2.0</a>.</sub>
+<sub>© 2026 <a href="https://casdoor.ai">Casdoor</a>. 采用 <a href="https://github.com/casdoor/casdoor/blob/master/LICENSE">Apache License 2.0</a> 许可证。</sub>

 </div>