mirror of
https://github.com/zitadel/zitadel.git
synced 2026-08-17 16:35:14 -05:00
chore: update the readme (#11694)
Just a little spring cleaning of the readme.
This commit is contained in:
Florian Forster
@@ -1,14 +1,15 @@
|
||||
<p align="center">
|
||||
<img src="./apps/docs/public/img/logos/zitadel-logo-dark@2x.png#gh-light-mode-only" alt="Zitadel Logo" max-height="200px" width="auto" />
|
||||
<img src="./apps/docs/public/img/logos/zitadel-logo-light@2x.png#gh-dark-mode-only" alt="Zitadel Logo" max-height="200px" width="auto" />
|
||||
<img src="./apps/docs/public/img/logos/zitadel-logo-dark@2x.png#gh-light-mode-only" alt="ZITADEL Logo" max-height="200px" width="auto" />
|
||||
<img src="./apps/docs/public/img/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://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/zitadel/zitadel" alt="Open in Dev Container">
|
||||
<img src="https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue" /> </a>
|
||||
<img src="https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue" /></a>
|
||||
<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://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">
|
||||
@@ -19,7 +20,7 @@
|
||||
<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">
|
||||
<a href="https://github.com/zitadel/zitadel/graphs/contributors" alt="Contributors">
|
||||
<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>
|
||||
@@ -30,138 +31,150 @@
|
||||
<img src="./apps/docs/public/img/logos/oidc-cert.png" /></a>
|
||||
</p>
|
||||
|
||||
Are you searching for a user management tool that is quickly set up like Auth0 and open source like Keycloak?
|
||||
## The Identity Infrastructure for Developers
|
||||
|
||||
Do you have a project that requires multi-tenant user management with self-service for your customers?
|
||||
**ZITADEL** is an open-source identity and access management platform built for teams that need more than basic auth. Whether you're securing a SaaS product, building a B2B platform, or self-hosting a production IAM stack — ZITADEL gives you everything out of the box: SSO, MFA, Passkeys, OIDC, SAML, SCIM, and a battle-tested multi-tenancy model.
|
||||
|
||||
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
|
||||
:white_check_mark: SCIM 2.0 Server
|
||||
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.
|
||||
No vendor lock-in. No compromise on control. Just a robust, API-first identity platform you can own.
|
||||
|
||||
---
|
||||
|
||||
**[🏡 Website](https://zitadel.com) [💬 Chat](https://zitadel.com/chat) [📋 Docs](https://zitadel.com/docs/) [🧑💻 Blog](https://zitadel.com/blog) [📞 Contact](https://zitadel.com/contact/)**
|
||||
**[🏡 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
|
||||
---
|
||||
|
||||
## Why ZITADEL
|
||||
|
||||
We built ZITADEL to handle the hardest IAM challenges at scale — starting with multi-tenancy.
|
||||
|
||||
| | ZITADEL | FusionAuth | Keycloak | Auth0/Okta |
|
||||
|---|---|---|---|---|
|
||||
| Open-source | ✅ | ❌ | ✅ | ❌ |
|
||||
| Self-hostable | ✅ | ✅ | ✅ | ❌ |
|
||||
| Infrastructure-level tenants | ✅ Instances (High scale) | ✅ Tenants | 🟡 Realms (Scaling limits) | ❌ (Multi-tenant = multi-account) |
|
||||
| B2B Organizations | ✅ Native & Unlimited | 🟡 via Entity Management | ✅ (Recent addition) | 🟡 (Plan/Account dependent) |
|
||||
| Full audit trail | ✅ Comprehensive Event Stream* | 🟡 Audit logs | 🟡 Audit logs | 🟡 Audit logs |
|
||||
| Passkeys (FIDO2) | ✅ | ✅ | ✅ | ✅ |
|
||||
| [Actions / webhooks](https://zitadel.com/docs/concepts/features/actions_v2) | ✅ | ✅ | 🟡 via SPI | ✅ |
|
||||
| API-first (gRPC + REST) | ✅ | 🟡 REST only | 🟡 REST only | 🟡 REST only |
|
||||
| SaaS + self-host parity | ✅ | ✅ | ➖ N/A | ➖ N/A |
|
||||
|
||||
ZITADEL Cloud and self-hosted ZITADEL run the same codebase.
|
||||
|
||||
**Key differentiators for architects:**
|
||||
- **Relational core, event-driven soul** — every mutation is written as an immutable event for a complete, API-accessible [audit trail](https://zitadel.com/docs/concepts/features/audit-trail). Unlike systems that log only select activities, ZITADEL provides a comprehensive event stream that can be audited or streamed to external systems via Webhooks.
|
||||
- **Strict multi-tenant hierarchy** — Identity System → Organizations → Projects, with isolated data and policy scoping at multiple levels
|
||||
- **API-first design** — every resource and action is available via [connectRPC, gRPC, and HTTP/JSON APIs](https://zitadel.com/docs/apis/introduction)
|
||||
- **[Zero-downtime updates](https://zitadel.com/docs/concepts/architecture/solution#zero-downtime-updates)** and [horizontal scalability](https://zitadel.com/docs/self-hosting/manage/updating_scaling) without external session stores
|
||||
|
||||
---
|
||||
|
||||
## Get Started in 3 Minutes
|
||||
|
||||
👉 [Quick Start Guide](https://zitadel.com/docs/guides/start/quickstart)
|
||||
|
||||
### Deploy ZITADEL (Self-Hosted)
|
||||
### ZITADEL Self-Hosted
|
||||
|
||||
Deploying ZITADEL locally takes less than 3 minutes. Go ahead and give it a try!
|
||||
```bash
|
||||
# Docker Compose — up and running in under 3 minutes
|
||||
curl -LO https://raw.githubusercontent.com/zitadel/zitadel/main/deploy/compose/docker-compose.yml \
|
||||
&& curl -LO https://raw.githubusercontent.com/zitadel/zitadel/main/deploy/compose/.env.example \
|
||||
&& cp .env.example .env \
|
||||
&& docker compose up -d --wait
|
||||
```
|
||||
|
||||
* [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)
|
||||
* [Kubernetes](https://zitadel.com/docs/self-hosting/deploy/kubernetes)
|
||||
Full deployment guides:
|
||||
- [Docker Compose](https://zitadel.com/docs/self-hosting/deploy/compose)
|
||||
- [Kubernetes](https://zitadel.com/docs/self-hosting/deploy/kubernetes)
|
||||
|
||||
See all guides [here](https://zitadel.com/docs/self-hosting/deploy/overview)
|
||||
> Need professional support for your self-hosted deployment? [Contact us](https://zitadel.com/contact).
|
||||
|
||||
> If you are interested to get professional support for your self-hosted ZITADEL [please reach out to us](https://zitadel.com/contact)!
|
||||
### ZITADEL Cloud (SaaS)
|
||||
|
||||
### Setup ZITADEL Cloud (SaaS)
|
||||
Start for free at [zitadel.com](https://zitadel.com) — no credit card required. Available in US · EU · AU · CH. [Pay-as-you-go pricing](https://zitadel.com/pricing).
|
||||
|
||||
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).
|
||||
## Integrate with the V2 API
|
||||
|
||||
## Adopters
|
||||
ZITADEL exposes every capability over a typed API. Here's how to create a user with the V2 REST API:
|
||||
|
||||
We are grateful to the organizations and individuals who are using ZITADEL. If you are using ZITADEL, please consider adding your name to our [Adopters list](./ADOPTERS.md) by submitting a pull request.
|
||||
```bash
|
||||
curl -X POST https://$ZITADEL_DOMAIN/v2/users/human \
|
||||
-H "Authorization: Bearer $ACCESS_TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"username": "alice@example.com",
|
||||
"profile": { "givenName": "Alice", "familyName": "Smith" },
|
||||
"email": { "email": "alice@example.com", "sendCode": {} }
|
||||
}'
|
||||
```
|
||||
|
||||
### Example applications
|
||||
Explore the full [API reference](https://zitadel.com/docs/apis/introduction) — including connectRPC and gRPC transports — or jump straight to [quickstart examples](https://zitadel.com/docs/guides/start/quickstart).
|
||||
|
||||
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/guides/manage/console/actions-overview) 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
|
||||
- [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, OTP Email, OTP SMS
|
||||
- [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-accounts/authenticate-service-accounts) with JWT profile, Personal Access Tokens (PAT), and Client Credentials
|
||||
**Authentication**
|
||||
- Single Sign On (SSO) · Username/Password · [Passkeys (FIDO2 / WebAuthn)](https://zitadel.com/docs/concepts/features/passkeys)
|
||||
- MFA: OTP, U2F, OTP Email, OTP SMS
|
||||
- [LDAP](https://zitadel.com/docs/guides/integrate/identity-providers/ldap) · [Enterprise IdPs and social logins](https://zitadel.com/docs/guides/integrate/identity-providers/introduction)
|
||||
- [OpenID Connect certified](https://openid.net/certification/#OPs) · [SAML 2.0](https://zitadel.com/docs/apis/saml/endpoints) · [Device authorization](https://zitadel.com/docs/guides/integrate/login/oidc/device-authorization)
|
||||
- [Machine-to-machine](https://zitadel.com/docs/guides/integrate/service-accounts/authenticate-service-accounts): JWT Profile, PAT, Client Credentials
|
||||
- [Token exchange and impersonation](https://zitadel.com/docs/guides/integrate/token-exchange)
|
||||
- [Beta: Hosted Login V2](https://zitadel.com/docs/guides/integrate/login/hosted-login#hosted-login-version-2-beta) our new Login version 2.0
|
||||
- [Custom sessions](https://zitadel.com/docs/guides/integrate/login-ui/username-password) for flows beyond OIDC/SAML
|
||||
- [Hosted Login V2](https://zitadel.com/docs/guides/integrate/login/hosted-login)
|
||||
|
||||
Multi-Tenancy
|
||||
|
||||
- [Identity Brokering](https://zitadel.com/docs/guides/integrate/identity-brokering) with templates for popular identity providers
|
||||
- [Customizable onboarding](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-overview)
|
||||
**Multi-Tenancy**
|
||||
- [Identity brokering](https://zitadel.com/docs/concepts/features/identity-brokering) with pre-built IdP templates
|
||||
- [Customizable B2B onboarding](https://zitadel.com/docs/guides/integrate/onboarding/b2b) with self-service for customers
|
||||
- [Delegated role management](https://zitadel.com/docs/guides/manage/console/projects-overview) to third parties
|
||||
- [Domain discovery](https://zitadel.com/docs/guides/solution-scenarios/domain-discovery)
|
||||
|
||||
Integration
|
||||
**Integration**
|
||||
- [gRPC, connectRPC, and REST APIs](https://zitadel.com/docs/apis/introduction) for every resource
|
||||
- [Actions](https://zitadel.com/docs/concepts/features/actions_v2): webhooks, custom code, token enrichment
|
||||
- [RBAC](https://zitadel.com/docs/guides/integrate/retrieve-user-roles) · [SCIM 2.0 Server](https://zitadel.com/docs/apis/scim2)
|
||||
- [Audit log and SOC/SIEM integration](https://zitadel.com/docs/guides/integrate/external-audit-log)
|
||||
- [SDKs and example apps](https://zitadel.com/docs/sdk-examples/introduction)
|
||||
|
||||
- [GRPC and REST APIs](https://zitadel.com/docs/apis/introduction) for every functionality and resource
|
||||
- [Actions](https://zitadel.com/docs/guides/manage/console/actions-overview) 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)
|
||||
- [SCIM 2.0 Server](https://zitadel.com/docs/apis/scim2)
|
||||
- [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/login-users)
|
||||
**Self-Service & Admin**
|
||||
- [Self-registration](https://zitadel.com/docs/concepts/features/selfservice#registration) with email/phone verification
|
||||
- [Administration Console](https://zitadel.com/docs/guides/manage/console/console-overview) for orgs and projects
|
||||
- [Custom branding](https://zitadel.com/docs/guides/manage/customize/branding) per organization
|
||||
|
||||
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/console-overview)
|
||||
|
||||
Deployment
|
||||
- [Postgres](https://zitadel.com/docs/self-hosting/manage/database#postgres) (version >= 14)
|
||||
- [Zero Downtime Updates](https://zitadel.com/docs/concepts/architecture/solution#zero-downtime-updates)
|
||||
- [High scalability](https://zitadel.com/docs/self-hosting/manage/production)
|
||||
**Deployment**
|
||||
- [PostgreSQL](https://zitadel.com/docs/self-hosting/manage/database#postgres) (≥ 14) · [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.
|
||||
|
||||
---
|
||||
|
||||
## Showcase
|
||||
|
||||
### Login V2
|
||||
|
||||
Our new, fully customizable login experience — [documentation](https://zitadel.com/docs/guides/integrate/login/hosted-login)
|
||||
|
||||
---
|
||||
|
||||
## Adopters & Ecosystem
|
||||
|
||||
Used in production by organizations worldwide. See the full [Adopters list](./ADOPTERS.md) — and add yours by submitting a pull request.
|
||||
|
||||
- **SDKs**: [All supported languages and frameworks](https://zitadel.com/docs/sdk-examples/introduction)
|
||||
- **Examples**: [Clone and use our examples](https://zitadel.com/docs/sdk-examples/introduction)
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
ZITADEL is built in the open and welcoming to contributions of all kinds.
|
||||
|
||||
- 📖 Read the [Contribution Guide](./CONTRIBUTING.md) to get started
|
||||
- 💬 Join the conversation on [Discord](https://zitadel.com/chat)
|
||||
- 🐛 Report bugs or request features via [GitHub Issues](https://github.com/zitadel/zitadel/issues)
|
||||
|
||||
## Contributors
|
||||
|
||||
@@ -171,40 +184,16 @@ Join our [Discord Chat](https://zitadel.com/chat) to get help.
|
||||
|
||||
Made with [contrib.rocks](https://contrib.rocks/preview?repo=zitadel/zitadel).
|
||||
|
||||
## 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")
|
||||
|
||||
### Management Console
|
||||
|
||||
Use [Console](https://zitadel.com/docs/guides/manage/console/console-overview) or our [APIs](https://zitadel.com/docs/apis/introduction) to set up organizations, projects and applications.
|
||||
|
||||
[](http://www.youtube.com/watch?v=RPpHktAcCtk "Console Showcase")
|
||||
|
||||
### Login V2
|
||||
|
||||
Check out our new Login V2 version in our [documentation](https://zitadel.com/docs/guides/integrate/login/hosted-login#hosted-login-version-2-beta)
|
||||
|
||||
---
|
||||
|
||||
## Security
|
||||
|
||||
You can find our security policy [here](./SECURITY.md).
|
||||
Security policy: [SECURITY.md](./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.
|
||||
[Vulnerability Disclosure Policy](https://zitadel.com/docs/legal/policies/vulnerability-disclosure-policy) — how to responsibly report security issues.
|
||||
|
||||
[Technical Advisories](https://zitadel.com/docs/support/technical_advisory) are published for major issues that could impact security or stability in production.
|
||||
|
||||
## 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.
|
||||
[AGPL-3.0](./LICENSE) — see [LICENSING.md](./LICENSING.md) for the full licensing policy, including Apache 2.0 and MIT exceptions for specific directories.
|
||||
|
||||
Reference in New Issue
Block a user