casdoor/README.md

89 lines
3.7 KiB
Markdown
Raw Normal View History

<h1 align="center" style="border-bottom: none;">📦⚡️ Casdoor</h1>
<h3 align="center">A UI-first centralized authentication / Single-Sign-On (SSO) platform based on OAuth 2.0 / OIDC.</h3>
<p align="center">
<a href="#badge">
<img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
</a>
<a href="https://hub.docker.com/r/casbin/casdoor">
<img alt="docker pull casbin/casdoor" src="https://img.shields.io/docker/pulls/casbin/casdoor.svg">
</a>
2022-01-20 14:11:46 +08:00
<a href="https://github.com/casdoor/casdoor/actions/workflows/build.yml">
2022-08-23 13:11:42 +08:00
<img alt="GitHub Workflow Status (branch)" src="https://github.com/casdoor/casdoor/workflows/Build/badge.svg?style=flat-square">
</a>
2022-01-20 14:11:46 +08:00
<a href="https://github.com/casdoor/casdoor/releases/latest">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/casbin/casdoor.svg">
</a>
<a href="https://hub.docker.com/repository/docker/casbin/casdoor">
<img alt="Docker Image Version (latest semver)" src="https://img.shields.io/badge/Docker%20Hub-latest-brightgreen">
</a>
</p>
<p align="center">
2022-01-20 14:11:46 +08:00
<a href="https://goreportcard.com/report/github.com/casdoor/casdoor">
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/casdoor/casdoor?style=flat-square">
</a>
2022-01-20 14:11:46 +08:00
<a href="https://github.com/casdoor/casdoor/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/casbin/casdoor?style=flat-square" alt="license">
</a>
2022-01-20 14:11:46 +08:00
<a href="https://github.com/casdoor/casdoor/issues">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/casbin/casdoor?style=flat-square">
</a>
<a href="#">
<img alt="GitHub stars" src="https://img.shields.io/github/stars/casbin/casdoor?style=flat-square">
</a>
2022-01-20 14:11:46 +08:00
<a href="https://github.com/casdoor/casdoor/network">
<img alt="GitHub forks" src="https://img.shields.io/github/forks/casbin/casdoor?style=flat-square">
</a>
2021-12-26 09:24:37 +08:00
<a href="https://crowdin.com/project/casdoor-site">
<img alt="Crowdin" src="https://badges.crowdin.net/casdoor-site/localized.svg">
</a>
<a href="https://discord.gg/5rPsrAzK7S">
<img alt="Discord" src="https://img.shields.io/discord/1022748306096537660?style=flat-square&logo=discord&label=discord&color=5865F2">
2022-01-02 23:34:24 +08:00
</a>
</p>
2021-02-16 17:58:51 +08:00
2022-05-23 21:45:31 +08:00
## Online demo
2022-12-18 01:40:58 +08:00
- Read-only site: https://door.casdoor.com (any modification operation will fail)
- Writable site: https://demo.casdoor.com (original data will be restored for every 5 minutes)
2022-05-23 21:45:31 +08:00
## Documentation
2021-02-16 17:58:51 +08:00
2022-12-18 01:40:58 +08:00
https://casdoor.org
2021-02-16 17:58:51 +08:00
2022-05-23 21:45:31 +08:00
## Install
2022-05-23 21:45:31 +08:00
- By source code: https://casdoor.org/docs/basic/server-installation
- By Docker: https://casdoor.org/docs/basic/try-with-docker
2022-05-23 21:45:31 +08:00
## How to connect to Casdoor?
2022-05-23 21:45:31 +08:00
https://casdoor.org/docs/how-to-connect/overview
2022-05-23 21:45:31 +08:00
## Casdoor Public API
2022-05-23 21:45:31 +08:00
- Docs: https://casdoor.org/docs/basic/public-api
- Swagger: https://door.casdoor.com/swagger
2021-02-16 17:58:51 +08:00
2022-05-23 21:45:31 +08:00
## Integrations
2022-10-08 16:00:08 +08:00
https://casdoor.org/docs/category/integrations
2021-02-16 17:58:51 +08:00
2022-05-23 21:45:31 +08:00
## How to contact?
2021-02-16 17:58:51 +08:00
- Discord: https://discord.gg/5rPsrAzK7S
2022-05-23 21:45:31 +08:00
- Forum: https://forum.casbin.com
- Contact: https://tawk.to/chat/623352fea34c2456412b8c51/1fuc7od6e
2021-08-07 22:02:56 +08:00
## Contribute
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).
2021-02-16 17:58:51 +08:00
2022-05-23 21:45:31 +08:00
### I18n translation
2021-02-16 17:58:51 +08:00
2022-08-23 13:11:42 +08:00
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.
2021-02-16 17:58:51 +08:00
2022-05-23 21:45:31 +08:00
## License
[Apache-2.0](https://github.com/casdoor/casdoor/blob/master/LICENSE)