mirror of
https://github.com/zitadel/zitadel
synced 2024-11-21 16:30:53 +00:00
204 lines
12 KiB
Markdown
204 lines
12 KiB
Markdown
<p align="center">
|
|
<img src="./docs/static/logos/zitadel-logo-dark@2x.png#gh-light-mode-only" alt="Zitadel Logo" max-height="200px" width="auto" />
|
|
<img src="./docs/static/logos/zitadel-logo-light@2x.png#gh-dark-mode-only" alt="Zitadel Logo" max-height="200px" width="auto" />
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/zitadel/zitadel/blob/main/LICENSE" alt="License">
|
|
<img src="https://badgen.net/github/license/zitadel/zitadel/" /></a>
|
|
<a href="https://bestpractices.coreinfrastructure.org/projects/6662"><img src="https://bestpractices.coreinfrastructure.org/projects/6662/badge"></a>
|
|
<a href="https://github.com/semantic-release/semantic-release" alt="semantic-release">
|
|
<img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" /></a>
|
|
<a href="https://github.com/zitadel/zitadel/actions" alt="ZITADEL Release">
|
|
<img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/zitadel/zitadel/build.yml?event=pull_request"></a>
|
|
<a href="https://zitadel.com/docs/support/software-release-cycles-support" alt="Release">
|
|
<img src="https://badgen.net/github/release/zitadel/zitadel/stable" /></a>
|
|
<a href="https://github.com/zitadel/zitadel/releases" alt="Release">
|
|
<img alt="Dynamic YAML Badge" src="https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fzitadel%2Fzitadel%2Fmain%2Frelease-channels.yaml&query=%24.stable&label=stable"></a>
|
|
<a href="https://goreportcard.com/report/github.com/zitadel/zitadel" alt="Go Report Card">
|
|
<img src="https://goreportcard.com/badge/github.com/zitadel/zitadel" /></a>
|
|
<a href="https://codecov.io/gh/zitadel/zitadel" alt="Code Coverage">
|
|
<img src="https://codecov.io/gh/zitadel/zitadel/branch/main/graph/badge.svg" /></a>
|
|
<a href="https://github.com/zitadel/zitadel/graphs/contributors" alt="Release">
|
|
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/zitadel/zitadel"></a>
|
|
<a href="https://discord.gg/YgjEuJzZ3x" alt="Discord Chat">
|
|
<img src="https://badgen.net/discord/online-members/YgjEuJzZ3x" /></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://openid.net/certification/#OPs" alt="OpenID Connect Certified">
|
|
<img src="./docs/static/logos/oidc-cert.png" /></a>
|
|
</p>
|
|
|
|
|Community Meeting|
|
|
|------------------|
|
|
|ZITADEL holds bi-weekly community calls. To join the community calls or to watch previous meeting notes and recordings, please visit the [meeting schedule](https://github.com/zitadel/zitadel/blob/main/MEETING_SCHEDULE.md).|
|
|
|
|
Are you searching for a user management tool that is quickly set up like Auth0 and open source like Keycloak?
|
|
|
|
Do you have a project that requires multi-tenant user management with self-service for your customers?
|
|
|
|
Look no further — ZITADEL is the identity infrastructure, simplified for you.
|
|
|
|
We provide you with a wide range of out-of-the-box features to accelerate your project, including:
|
|
|
|
:white_check_mark: Multi-tenancy with team management
|
|
:white_check_mark: Secure login
|
|
:white_check_mark: Self-service
|
|
:white_check_mark: OpenID Connect
|
|
:white_check_mark: OAuth2.x
|
|
:white_check_mark: SAML2
|
|
:white_check_mark: LDAP
|
|
:white_check_mark: Passkeys / FIDO2
|
|
:white_check_mark: OTP
|
|
and an unlimited audit trail is there for you, ready to use.
|
|
|
|
With ZITADEL, you are assured of a robust and customizable turnkey solution for all your authentication and authorization needs.
|
|
|
|
---
|
|
|
|
**[🏡 Website](https://zitadel.com) [💬 Chat](https://zitadel.com/chat) [📋 Docs](https://zitadel.com/docs/) [🧑💻 Blog](https://zitadel.com/blog) [📞 Contact](https://zitadel.com/contact/)**
|
|
|
|
## Get started
|
|
|
|
👉 [Quick Start Guide](https://zitadel.com/docs/guides/start/quickstart)
|
|
|
|
### Deploy ZITADEL (Self-Hosted)
|
|
|
|
Deploying ZITADEL locally takes less than 3 minutes. Go ahead and give it a try!
|
|
|
|
* [Linux](https://zitadel.com/docs/self-hosting/deploy/linux)
|
|
* [MacOS](https://zitadel.com/docs/self-hosting/deploy/macos)
|
|
* [Docker compose](https://zitadel.com/docs/self-hosting/deploy/compose)
|
|
* [Knative](https://zitadel.com/docs/self-hosting/deploy/knative)
|
|
* [Kubernetes](https://zitadel.com/docs/self-hosting/deploy/kubernetes)
|
|
|
|
See all guides [here](https://zitadel.com/docs/self-hosting/deploy/overview)
|
|
|
|
> If you are interested to get professional support for your self-hosted ZITADEL [please reach out to us](https://zitadel.com/contact)!
|
|
|
|
### Setup ZITADEL Cloud (SaaS)
|
|
|
|
If you want to experience a hands-free ZITADEL, you should use [ZITADEL Cloud](https://zitadel.com).
|
|
Available data regions are:
|
|
* 🇺🇸 United States
|
|
* 🇪🇺 European Union
|
|
* 🇦🇺 Australia
|
|
* 🇨🇭 Switzerland
|
|
|
|
ZITADEL Cloud comes with a free tier, providing you with all the same features as the open-source version.
|
|
Learn more about the [pay-as-you-go pricing](https://zitadel.com/pricing).
|
|
|
|
### Example applications
|
|
|
|
Clone one of our [example applications](https://zitadel.com/docs/sdk-examples/introduction) or deploy them directly to Vercel.
|
|
|
|
### SDKs
|
|
|
|
Use our [SDKs](https://zitadel.com/docs/sdk-examples/introduction) for your favorite language and framework.
|
|
|
|
## Why choose ZITADEL
|
|
|
|
We built ZITADEL with a complex multi-tenancy architecture in mind and provide the best solution to handle [B2B customers and partners](https://zitadel.com/docs/guides/solution-scenarios/b2b).
|
|
Yet it offers everything you need for a customer identity ([CIAM](https://zitadel.com/docs/guides/solution-scenarios/b2c)) use case.
|
|
|
|
- [API-first approach](https://zitadel.com/docs/apis/introduction)
|
|
- [Multi-tenancy](https://zitadel.com/docs/guides/solution-scenarios/b2b) authentication and access management
|
|
- [Strong audit trail](https://zitadel.com/docs/concepts/features/audit-trail) thanks to [event sourcing](https://zitadel.com/docs/concepts/eventstore/overview) as storage pattern
|
|
- [Actions](https://zitadel.com/docs/apis/actions/introduction) to react on events with custom code and extended ZITADEL for you needs
|
|
- [Branding](https://zitadel.com/docs/guides/manage/customize/branding) for a uniform user experience across multiple organizations
|
|
- [Self-service](https://zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators
|
|
- [CockroachDB](https://www.cockroachlabs.com/) or a [Postgres](https://www.postgresql.org/) database as reliable and widespread storage option
|
|
|
|
## Features
|
|
|
|
Authentication
|
|
|
|
- Single Sign On (SSO)
|
|
- [Passkeys support (FIDO2 / WebAuthN)](https://zitadel.com/docs/concepts/features/passkeys)
|
|
- Username / Password
|
|
- Multifactor authentication with OTP, U2F, Email OTP, SMS OTP
|
|
- [LDAP](https://zitadel.com/docs/guides/integrate/identity-providers/ldap)
|
|
- [External enterprise identity providers and social logins](https://zitadel.com/docs/guides/integrate/identity-providers/introduction)
|
|
- [Device authorization](https://zitadel.com/docs/guides/solution-scenarios/device-authorization)
|
|
- [OpenID Connect certified](https://openid.net/certification/#OPs) => [OIDC Endpoints](https://zitadel.com/docs/apis/openidoauth/endpoints)
|
|
- [SAML 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) => [SAML Endpoints](https://zitadel.com/docs/apis/saml/endpoints)
|
|
- [Custom sessions](https://zitadel.com/docs/guides/integrate/login-ui/username-password) if you need to go beyond OIDC or SAML
|
|
- [Machine-to-machine](https://zitadel.com/docs/guides/integrate/service-users/authenticate-service-users) with JWT profile, Personal Access Tokens (PAT), and Client Credentials
|
|
- [Token exchange and impersonation](https://zitadel.com/docs/guides/integrate/token-exchange)
|
|
|
|
Multi-Tenancy
|
|
|
|
- [Identity Brokering](https://zitadel.com/docs/guides/integrate/identity-brokering) with templates for popular identity providers
|
|
- [Customizable onboaring](https://zitadel.com/docs/guides/solution-scenarios/onboarding) for B2B and their users
|
|
- [Delegate role management to third-parties](https://zitadel.com/docs/guides/manage/console/projects)
|
|
- [Domain discovery](https://zitadel.com/docs/guides/solution-scenarios/domain-discovery)
|
|
|
|
Integration
|
|
|
|
- [GRPC and REST APIs](https://zitadel.com/docs/apis/introduction) for every functionality and resource
|
|
- [Actions](https://zitadel.com/docs/apis/actions/introduction) to call any API, send webhooks, adjust workflows, or customize tokens
|
|
- [Role Based Access Control (RBAC)](https://zitadel.com/docs/guides/integrate/retrieve-user-roles)
|
|
- [Examples and SDKs](https://zitadel.com/docs/sdk-examples/introduction)
|
|
- [Audit Log and SOC/SIEM](https://zitadel.com/docs/guides/integrate/external-audit-log)
|
|
- [User registration and onboarding](https://zitadel.com/docs/guides/integrate/onboarding)
|
|
- [Hosted and custom login user interface](https://zitadel.com/docs/guides/integrate/login-ui)
|
|
|
|
Self-Service
|
|
- [Self-registration](https://zitadel.com/docs/concepts/features/selfservice#registration) including verification
|
|
- [Self-service](https://zitadel.com/docs/concepts/features/selfservice) for end-users, business customers, and administrators
|
|
- [Administration UI (Console)](https://zitadel.com/docs/guides/manage/console/overview)
|
|
|
|
Deployment
|
|
- [Postgres](https://zitadel.com/docs/self-hosting/manage/database#postgres) (version >= 14) or [CockroachDB](https://zitadel.com/docs/self-hosting/manage/database#cockroach) (version latest stable)
|
|
- [Zero Downtime Updates](https://zitadel.com/docs/concepts/architecture/solution#zero-downtime-updates)
|
|
- [High scalability](https://zitadel.com/docs/self-hosting/manage/production)
|
|
|
|
Track upcoming features on our [roadmap](https://zitadel.com/roadmap) and follow our [changelog](https://zitadel.com/changelog) for recent updates.
|
|
|
|
## How To Contribute
|
|
|
|
Find details about how you can contribute in our [Contribution Guide](./CONTRIBUTING.md).
|
|
Join our [Discord Chat](https://zitadel.com/chat) to get help.
|
|
|
|
## Contributors
|
|
|
|
<a href="https://github.com/zitadel/zitadel/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=zitadel/zitadel" />
|
|
</a>
|
|
|
|
Made with [contrib.rocks](https://contrib.rocks).
|
|
|
|
## Showcase
|
|
|
|
### Quick Start Guide
|
|
|
|
Secure a React Application using OpenID Connect Authorization Code with PKCE
|
|
|
|
[](http://www.youtube.com/watch?v=5THbQljoPKg "Quick Start Guide")
|
|
|
|
### Login with Passkeys
|
|
|
|
Use our login widget to allow easy and secure access to your applications and enjoy all the benefits of Passkeys (FIDO 2 / WebAuthN):
|
|
|
|
[](https://www.youtube.com/watch?v=cZjHQYurSjw&list=PLTDa7jTlOyRLdABgD2zL0LGM7rx5GZ1IR&index=2 "Passkeys")
|
|
|
|
### Admin Console
|
|
|
|
Use [Console](https://zitadel.com/docs/guides/manage/console/overview) or our [APIs](https://zitadel.com/docs/apis/introduction) to setup organizations, projects and applications.
|
|
|
|
[](http://www.youtube.com/watch?v=RPpHktAcCtk "Console Showcase")
|
|
|
|
## Security
|
|
|
|
You can find our security policy [here](./SECURITY.md).
|
|
|
|
[Technical Advisories](https://zitadel.com/docs/support/technical_advisory) are published regarding major issues with the ZITADEL platform that could potentially impact security or stability in production environments.
|
|
|
|
## License
|
|
|
|
[here](./LICENSE) are our exact licensing terms.
|
|
|
|
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See our [license](./LICENSE) for detailed information governing permissions and limitations on use.
|