Skip to content

Commit a68b4d4

Browse files
JasonBuildAIhsluoyz
JasonBuildAI
authored and
hsluoyz
committed
feat: improve README (#5410)
1 parent 7a6b2cb commit a68b4d4

1 file changed

Lines changed: 293 additions & 65 deletions

File tree

‎README.md‎

Lines changed: 293 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,316 @@
1-
<h1 align="center" style="border-bottom: none;">📦⚡️ Casdoor</h1>
2-
<h3 align="center">An open-source AI-first Identity and Access Management (IAM) /AI MCP gateway and auth server with web UI supporting MCP, A2A, OAuth 2.1, OIDC, SAML, CAS, LDAP, SCIM, WebAuthn, TOTP, MFA, Face ID, Google Workspace, Azure AD</h3>
3-
<p align="center">
4-
<a href="#badge">
5-
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
6-
</a>
7-
<a href="https://hub.docker.com/r/casbin/casdoor">
8-
<img alt="docker pull casbin/casdoor" src="https://img.shields.io/docker/pulls/casbin/casdoor.svg">
9-
</a>
10-
<a href="https://github.com/casdoor/casdoor/actions/workflows/build.yml">
11-
<img alt="GitHub Workflow Status (branch)" src="https://github.com/casdoor/casdoor/workflows/Build/badge.svg?style=flat-square">
1+
<div align="center">
2+
<a href="https://casdoor.ai">
3+
<img src="https://cdn.casbin.org/img/casdoor-logo_1185x256.png" alt="Casdoor" width="500">
124
</a>
13-
<a href="https://github.com/casdoor/casdoor/releases/latest">
14-
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/casdoor/casdoor.svg">
15-
</a>
16-
<a href="https://hub.docker.com/r/casbin/casdoor">
17-
<img alt="Docker Image Version (latest semver)" src="https://img.shields.io/badge/Docker%20Hub-latest-brightgreen">
18-
</a>
19-
</p>
5+
6+
<h3>Casdoor: AI-First Identity and Access Management (IAM) / AI MCP Gateway</h3>
7+
8+
<p align="center">
9+
<strong>An open-source, AI-first IAM / MCP gateway and authentication server with a web UI.</strong><br>
10+
Supporting MCP, A2A, OAuth&nbsp;2.0, OIDC (OAuth&nbsp;2.x), SAML, CAS, LDAP, SCIM, WebAuthn, TOTP, MFA, Face ID,<br>
11+
Google Workspace, Azure AD, and more.
12+
</p>
13+
14+
<p align="center">
15+
<a href="https://casdoor.ai/"><strong>Documentation and guides: casdoor.ai</strong></a>
16+
</p>
17+
18+
<p>
19+
<a href="https://casdoor.ai/docs/overview">
20+
<img src="https://img.shields.io/badge/documentation-casdoor.ai%2Fdocs-1890ff?style=flat-square&logo=readthedocs&logoColor=white" alt="Documentation">
21+
</a>
22+
<a href="https://github.com/casdoor/casdoor/releases/latest">
23+
<img src="https://img.shields.io/github/v/release/casdoor/casdoor?style=flat-square&color=blue" alt="GitHub Release">
24+
</a>
25+
<a href="https://hub.docker.com/r/casbin/casdoor">
26+
<img src="https://img.shields.io/docker/pulls/casbin/casdoor?style=flat-square&color=brightgreen" alt="Docker Pulls">
27+
</a>
28+
<a href="https://github.com/casdoor/casdoor/actions/workflows/build.yml">
29+
<img src="https://img.shields.io/github/actions/workflow/status/casdoor/casdoor/build.yml?style=flat-square&label=build" alt="Build Status">
30+
</a>
31+
<a href="https://goreportcard.com/report/github.com/casdoor/casdoor">
32+
<img src="https://goreportcard.com/badge/github.com/casdoor/casdoor?style=flat-square" alt="Go Report Card">
33+
</a>
34+
<a href="https://github.com/casdoor/casdoor/blob/master/LICENSE">
35+
<img src="https://img.shields.io/github/license/casdoor/casdoor?style=flat-square&color=orange" alt="License">
36+
</a>
37+
</p>
38+
39+
<p>
40+
<a href="https://github.com/casdoor/casdoor/stargazers">
41+
<img src="https://img.shields.io/github/stars/casdoor/casdoor?style=flat-square&color=yellow" alt="GitHub Stars">
42+
</a>
43+
<a href="https://github.com/casdoor/casdoor/network/members">
44+
<img src="https://img.shields.io/github/forks/casdoor/casdoor?style=flat-square" alt="GitHub Forks">
45+
</a>
46+
<a href="https://github.com/casdoor/casdoor/issues">
47+
<img src="https://img.shields.io/github/issues/casdoor/casdoor?style=flat-square&color=red" alt="GitHub Issues">
48+
</a>
49+
<a href="https://discord.gg/5rPsrAzK7S">
50+
<img src="https://img.shields.io/discord/1022748306096537660?style=flat-square&logo=discord&label=Discord&color=5865F2" alt="Discord">
51+
</a>
52+
<a href="https://crowdin.com/project/casdoor-site">
53+
<img src="https://badges.crowdin.net/casdoor-site/localized.svg" alt="Crowdin">
54+
</a>
55+
</p>
56+
57+
<p align="center">
58+
<a href="https://casdoor.ai"><strong>Website</strong></a> ·
59+
<a href="https://casdoor.ai/docs/overview"><strong>Documentation</strong></a> ·
60+
<a href="https://door.casdoor.com"><strong>Live demo</strong></a> ·
61+
<a href="https://discord.gg/5rPsrAzK7S"><strong>Discord</strong></a>
62+
</p>
63+
</div>
64+
65+
---
66+
67+
## Table of contents
68+
69+
- [Why Casdoor](#why-casdoor)
70+
- [Live demos](#live-demos)
71+
- [Quick start](#quick-start)
72+
- [Features](#features)
73+
- [Technology stack](#technology-stack)
74+
- [Documentation](#documentation)
75+
- [Integrations](#integrations)
76+
- [Security](#security)
77+
- [Community and support](#community-and-support)
78+
- [Contributing](#contributing)
79+
- [License](#license)
80+
81+
---
82+
83+
<a id="why-casdoor"></a>
84+
## Why Casdoor
85+
86+
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.
87+
88+
---
89+
90+
<a id="live-demos"></a>
91+
## 🌐 Live demos
92+
93+
| Environment | URL | Description |
94+
|-------------|-----|-------------|
95+
| **Read-only** | [door.casdoor.com](https://door.casdoor.com) | Global demo; **any modification or write operation will fail** (read-only). |
96+
| **Writable** | [demo.casdoor.com](https://demo.casdoor.com) | Full access for testing; **data is reset about every 5 minutes**. |
97+
98+
Default demo admin login (where applicable): `admin` / `123` — use only for demos; change credentials on your own deployment.
99+
100+
---
101+
102+
<a id="quick-start"></a>
103+
## 🚀 Quick start
104+
105+
Pick one deployment method below. To keep behavior consistent with upstream, the steps are aligned with official docs.
106+
107+
### 🛠️ Source code (default)
108+
109+
1. Install dependencies: **Go 1.25** (follow `go.mod`), **Node.js LTS (20)**, **Yarn 1.x**, and a supported database.
110+
2. Clone the repository:
111+
112+
```bash
113+
git clone https://github.com/casdoor/casdoor.git
114+
cd casdoor
115+
```
116+
117+
3. Configure database in `conf/app.conf` (at minimum set `driverName`, `dataSourceName`, and `dbName`; for MySQL create database `casdoor` first).
118+
4. Build frontend and start backend:
119+
120+
```bash
121+
cd web
122+
yarn install
123+
yarn build
124+
cd ..
125+
go run main.go
126+
```
127+
128+
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).
129+
130+
Official guide: [Server installation](https://casdoor.ai/docs/basic/server-installation)
131+
132+
### 🐳 Docker
133+
134+
Use one of the official Docker paths:
135+
136+
- **All-in-one (SQLite quick trial)**:
137+
138+
```bash
139+
docker run -p 8000:8000 casbin/casdoor-all-in-one
140+
```
141+
142+
- **Docker Compose** (with your `conf/app.conf` next to `docker-compose.yml`):
143+
144+
```bash
145+
docker compose up
146+
```
147+
148+
Then open [http://localhost:8000](http://localhost:8000) and sign in with `built-in/admin` / `123` on a fresh install.
149+
150+
Official guide: [Try with Docker](https://casdoor.ai/docs/basic/try-with-docker)
151+
152+
### ☸️ Kubernetes Helm
153+
154+
With Helm v3 and a running Kubernetes cluster:
155+
156+
```bash
157+
helm install casdoor oci://registry-1.docker.io/casbin/casdoor-helm-charts
158+
```
159+
160+
After installation, access Casdoor through your cluster service/ingress. The official guide covers chart versions (including optional `--version`) and cluster-specific settings.
161+
162+
Official guide: [Try with Helm](https://casdoor.ai/docs/basic/try-with-helm)
163+
164+
---
165+
166+
<a id="features"></a>
167+
## ✨ Features
168+
169+
<table>
170+
<tr>
171+
<td width="50%">
172+
173+
### 🔐 Authentication
174+
175+
- **OAuth 2.0 / OIDC** — OpenID Connect and OAuth 2.x authorization
176+
- **SAML 2.0** — Enterprise SSO integration
177+
- **CAS** — Central Authentication Service
178+
- **LDAP** — Directory service integration
179+
- **WebAuthn / Passkeys** — Passwordless authentication
180+
- **TOTP / MFA** — Multi-factor authentication
181+
- **Face ID** — Biometric authentication
182+
183+
</td>
184+
<td width="50%">
185+
186+
### 🏢 Enterprise
187+
188+
- **SCIM 2.0** — User provisioning
189+
- **RBAC** — Role-based access control
190+
- **Social Login** — Google, GitHub, Azure AD, and more
191+
- **Custom providers** — Extensible identity providers
192+
- **User management** — Web UI for administration
193+
- **Audit logs** — Comprehensive logging
194+
- **Multi-tenancy** — Organization support
195+
196+
</td>
197+
</tr>
198+
<tr>
199+
<td width="50%">
200+
201+
### 🤖 AI & MCP
202+
203+
- **MCP Gateway** — Model Context Protocol support
204+
- **A2A Protocol** — Agent-to-Agent communication
205+
- **AI-First Design** — Built for AI applications
206+
207+
</td>
208+
<td width="50%">
209+
210+
### 🛠️ Developer Experience
211+
212+
- **RESTful API** — Complete API coverage
213+
- **SDKs** — Go, Java, Python, Node.js, and more
214+
- **Swagger UI** — Interactive API documentation
215+
- **Webhooks** — Event-driven integrations
216+
- **Customizable UI** — Brand theming support
217+
218+
</td>
219+
</tr>
220+
</table>
221+
222+
---
223+
224+
<a id="technology-stack"></a>
225+
## Technology stack
226+
227+
Casdoor is built as a **frontend–backend separated** project:
228+
229+
- **Web UI**: JavaScript and **React** ([`web/`](https://github.com/casdoor/casdoor/tree/master/web))
230+
- **API server**: **Go** with **Beego**, RESTful APIs ([repository root](https://github.com/casdoor/casdoor))
231+
- **Data**: mainstream databases including **MySQL**, **PostgreSQL**, and others ([overview](https://casdoor.ai/docs/overview))
232+
- **Cache**: optional **Redis** for session/cache-style deployments (configure as needed)
233+
234+
---
235+
236+
<a id="documentation"></a>
237+
## 📖 Documentation
238+
239+
**All product documentation, installation, and tutorials live at [casdoor.ai/docs/overview](https://casdoor.ai/docs/overview).** Start here, then use the sections below.
240+
241+
**Install**
242+
243+
- [Install from source](https://casdoor.ai/docs/basic/server-installation)
244+
- [Install with Docker](https://casdoor.ai/docs/basic/try-with-docker)
245+
- [Install with Kubernetes Helm](https://casdoor.ai/docs/basic/try-with-helm)
246+
247+
**Connect applications**
248+
249+
- [How to connect to Casdoor](https://casdoor.ai/docs/how-to-connect/overview)
250+
251+
**APIs**
252+
253+
- [Public API](https://casdoor.ai/docs/basic/public-api)
254+
- [Swagger UI](https://door.casdoor.com/swagger) (live API explorer)
255+
256+
---
257+
258+
<a id="integrations"></a>
259+
## 🔌 Integrations
260+
261+
Casdoor integrates with common languages and frameworks:
20262

21263
<p align="center">
22-
<a href="https://goreportcard.com/report/github.com/casdoor/casdoor">
23-
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/casdoor/casdoor?style=flat-square">
24-
</a>
25-
<a href="https://github.com/casdoor/casdoor/blob/master/LICENSE">
26-
<img src="https://img.shields.io/github/license/casdoor/casdoor?style=flat-square" alt="license">
27-
</a>
28-
<a href="https://github.com/casdoor/casdoor/issues">
29-
<img alt="GitHub issues" src="https://img.shields.io/github/issues/casdoor/casdoor?style=flat-square">
30-
</a>
31-
<a href="#">
32-
<img alt="GitHub stars" src="https://img.shields.io/github/stars/casdoor/casdoor?style=flat-square">
33-
</a>
34-
<a href="https://github.com/casdoor/casdoor/network">
35-
<img alt="GitHub forks" src="https://img.shields.io/github/forks/casdoor/casdoor?style=flat-square">
36-
</a>
37-
<a href="https://crowdin.com/project/casdoor-site">
38-
<img alt="Crowdin" src="https://badges.crowdin.net/casdoor-site/localized.svg">
39-
</a>
40-
<a href="https://discord.gg/5rPsrAzK7S">
41-
<img alt="Discord" src="https://img.shields.io/discord/1022748306096537660?style=flat-square&logo=discord&label=discord&color=5865F2">
42-
</a>
264+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/go/go-original.svg" width="40" alt="Go">
265+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/java/java-original.svg" width="40" alt="Java">
266+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/python/python-original.svg" width="40" alt="Python">
267+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/nodejs/nodejs-original.svg" width="40" alt="Node.js">
268+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/react/react-original.svg" width="40" alt="React">
269+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/vuejs/vuejs-original.svg" width="40" alt="Vue">
270+
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/angularjs/angularjs-original.svg" width="40" alt="Angular">
43271
</p>
44272

45-
## Online demo
46-
47-
- Read-only site: https://door.casdoor.com (any modification operation will fail)
48-
- Writable site: https://demo.casdoor.com (original data will be restored for every 5 minutes)
273+
Browse the full list: [Integrations](https://casdoor.ai/docs/category/integrations).
49274

50-
## Documentation
275+
---
51276

52-
https://casdoor.org
277+
<a id="community-and-support"></a>
278+
## 🤝 Community and support
53279

54-
## Install
280+
- **Discord**: [Join our community](https://discord.gg/5rPsrAzK7S)
281+
- **Contact**: [casdoor.ai/help](https://casdoor.ai/help)
282+
- **Issues**: [GitHub Issues](https://github.com/casdoor/casdoor/issues)
283+
- **Discussions**: [GitHub Discussions](https://github.com/casdoor/casdoor/discussions)
55284

56-
- By source code: https://casdoor.org/docs/basic/server-installation
57-
- By Docker: https://casdoor.org/docs/basic/try-with-docker
58-
- By Kubernetes Helm: https://casdoor.org/docs/basic/try-with-helm
285+
---
59286

60-
## How to connect to Casdoor?
287+
<a id="contributing"></a>
288+
## 🌍 Contributing
61289

62-
https://casdoor.org/docs/how-to-connect/overview
290+
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.
63291

64-
## Casdoor Public API
292+
Please also read our [contribution guidelines](https://casdoor.ai/docs/contributing/) before contributing.
65293

66-
- Docs: https://casdoor.org/docs/basic/public-api
67-
- Swagger: https://door.casdoor.com/swagger
294+
### Translation and i18n
68295

69-
## Integrations
296+
- **Crowdin** is used for translation workflows: [casdoor-site on Crowdin](https://crowdin.com/project/casdoor-site).
297+
- 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.
70298

71-
https://casdoor.org/docs/category/integrations
299+
---
72300

73-
## How to contact?
301+
<a id="license"></a>
302+
## 📄 License
74303

75-
- Discord: https://discord.gg/5rPsrAzK7S
76-
- Contact: https://casdoor.org/help
304+
Casdoor is licensed under the [Apache License 2.0](https://github.com/casdoor/casdoor/blob/master/LICENSE).
77305

78-
## Contribute
306+
---
79307

80-
For casdoor, if you have any questions, you can give Issues, or you can also directly start Pull Requests(but we recommend giving issues first to communicate with the community).
308+
<div align="center">
81309

82-
### I18n translation
310+
[![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)
83311

84-
If you are contributing to casdoor, please note that we use [Crowdin](https://crowdin.com/project/casdoor-site) as translating platform and i18next as translating tool. When you add some words using i18next in the `web/` directory, please remember to add what you have added to the `web/src/locales/en/data.json` file.
312+
<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>
85313

86-
## License
314+
<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>
87315

88-
[Apache-2.0](https://github.com/casdoor/casdoor/blob/master/LICENSE)
316+
</div>

0 commit comments

Comments
 (0)