2022-05-20 14:20:31 +00:00
< p align = "center" >
2022-05-20 18:11:59 +00:00
< 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" / >
2022-05-20 14:20:31 +00:00
< / p >
2020-03-19 13:39:06 +00:00
2022-05-20 14:20:31 +00:00
< p align = "center" >
2022-11-10 14:16:09 +00:00
< a href = "https://bestpractices.coreinfrastructure.org/projects/6662" > < img src = "https://bestpractices.coreinfrastructure.org/projects/6662/badge" > < / a >
2022-05-20 14:20:31 +00:00
< a href = "https://github.com/zitadel/zitadel/graphs/contributors" alt = "Release" >
< img src = "https://badgen.net/github/contributors/zitadel/zitadel" / > < / 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 src = "https://github.com/zitadel/zitadel/actions/workflows/zitadel.yml/badge.svg" / > < / 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://github.com/zitadel/zitadel/releases" alt = "Release" >
< img src = "https://badgen.net/github/release/zitadel/zitadel/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://discord.gg/erh5Brh7jE" alt = "Discord Chat" >
< img src = "https://badgen.net/discord/online-members/erh5Brh7jE" / > < / a >
< / p >
2021-11-18 18:15:09 +00:00
2022-05-20 14:20:31 +00:00
< p align = "center" >
< a href = "https://openid.net/certification/#OPs" alt = "OpenID Connect Certified" >
< img src = "./docs/static/logos/oidc-cert.png" / > < / a >
< / p >
2020-03-19 14:19:18 +00:00
2022-10-27 16:16:04 +00:00
Do you look for a user management that's quickly set up like Auth0 and open source like Keycloak?
2020-03-19 14:19:18 +00:00
2022-10-27 16:16:04 +00:00
Do you have project that requires a multi-tenant user management with self-service for your customers?
2020-03-19 14:19:18 +00:00
2022-10-27 16:16:04 +00:00
Look no further — ZITADEL combines the ease of Auth0 with the versatility of Keycloak.
2020-07-28 06:24:09 +00:00
2022-10-27 16:16:04 +00:00
We provide you with a wide range of out of the box features to accelerate your project.
2023-04-13 08:34:01 +00:00
Multi-tenancy with branding customization, secure login, self-service, OpenID Connect, OAuth2.x, SAML2, LDAP, Passwordless with FIDO2 (including Passkeys), OTP, U2F, and an unlimited audit trail is there for you, ready to use.
2022-10-27 16:16:04 +00:00
With ZITADEL you can rely on a hardened and extensible turnkey solution to solve all of your authentication and authorization needs.
2020-03-19 14:19:18 +00:00
2022-05-20 14:20:31 +00:00
---
2021-04-07 12:26:21 +00:00
2022-12-06 23:09:50 +00:00
**[🏡 Website](https://zitadel.com) [💬 Chat ](https://zitadel.com/chat ) [📋 Docs ](https://zitadel.com/docs/ ) [🧑💻 Blog ](https://zitadel.com/blog ) [📞 Contact ](https://zitadel.com/contact/ )**
2021-07-06 11:55:57 +00:00
2022-05-20 14:20:31 +00:00
## Get started
2021-04-07 12:26:21 +00:00
2023-03-07 14:31:05 +00:00
👉 [Quick Start Guide ](https://zitadel.com/docs/guides/start/quickstart )
2022-10-27 16:16:04 +00:00
### Deploy ZITADEL (Self-Hosted)
2020-07-28 06:24:09 +00:00
2022-10-27 16:16:04 +00:00
Deploying ZITADEL locally takes less than 3 minutes. So go ahead and give it a try!
2020-07-28 06:24:09 +00:00
2022-12-20 10:17:27 +00:00
* [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 )
2020-07-28 06:24:09 +00:00
2022-12-20 10:17:27 +00:00
See all guides [here ](https://zitadel.com/docs/self-hosting/deploy/overview )
2020-07-28 06:24:09 +00:00
2022-10-27 16:16:04 +00:00
> If you are interested to get professional support for your self-hosted ZITADEL [please reach out to us](https://zitadel.com/contact)!
2021-05-19 07:47:16 +00:00
2022-10-27 16:16:04 +00:00
### Setup ZITADEL Cloud (SaaS)
2021-07-06 11:55:57 +00:00
2022-10-27 16:16:04 +00:00
If you want to experience a hands-free ZITADEL, you should use [ZITADEL Cloud ](https://zitadel.cloud ).
2020-07-28 06:24:09 +00:00
2022-10-27 16:16:04 +00:00
It is free for up to 25'000 authenticated requests and provides you all the features that make ZITADEL great.
Learn more about the [pay-as-you-go pricing ](https://zitadel.com/pricing ).
2021-04-07 12:26:21 +00:00
2023-03-07 14:31:05 +00:00
### Example applications
Clone one of our [example applications ](https://zitadel.com/docs/examples/introduction#clone-a-sample-project ) or deploy them directly to Vercel.
### SDKs
Use our [SDKs ](https://zitadel.com/docs/examples/sdks ) for your favorite language and framework.
2022-10-27 16:16:04 +00:00
## Why choose ZITADEL
2022-01-05 22:08:49 +00:00
2023-03-07 14:31:05 +00:00
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.
2022-10-27 16:16:04 +00:00
2022-12-06 23:09:50 +00:00
- [API-first approach ](https://zitadel.com/docs/apis/introduction )
- Strong audit trail thanks to [event sourcing ](https://zitadel.com/docs/concepts/eventstore/overview ) as storage pattern
2023-03-07 14:31:05 +00:00
- [Actions ](https://zitadel.com/docs/apis/actions/introduction ) to react on events with custom code and extended ZITADEL for you needs
2022-12-06 23:09:50 +00:00
- [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
2022-10-27 16:16:04 +00:00
- [CockroachDB ](https://www.cockroachlabs.com/ ) or a [Postgres ](https://www.postgresql.org/ ) database as reliable and widespread storage option
2022-01-05 22:08:49 +00:00
2022-05-20 14:20:31 +00:00
## Features
2022-01-05 22:08:49 +00:00
2023-04-13 08:34:01 +00:00
Authentication
2022-05-20 14:20:31 +00:00
- Single Sign On (SSO)
2022-10-27 16:16:04 +00:00
- Passwordless with FIDO2 support (Including Passkeys)
2022-05-20 14:20:31 +00:00
- Username / Password
2023-05-24 12:09:01 +00:00
- Multifactor authentication with OTP, U2F
2023-04-13 08:34:01 +00:00
- LDAP
- [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 )
- [Machine-to-machine ](https://zitadel.com/docs/guides/integrate/serviceusers ) with JWT profile, Personal Access Tokens (PAT), and Client Credentials
Multi-Tenancy
- [Identity Brokering ](https://zitadel.com/docs/guides/integrate/identity-brokering ) with templates for popular identity providers
2022-12-06 23:09:50 +00:00
- [Delegate role management to third-parties ](https://zitadel.com/docs/guides/manage/console/projects )
2023-04-13 08:34:01 +00:00
- Domain discovery
Integration
- [GRPC and REST APIs ](https://zitadel.com/docs/apis/introduction )
- [Actions ](https://zitadel.com/docs/apis/actions/introduction ) to call any API, send webhooks, adjust workflows, or customize tokens
- Role Based Access Control (RBAC)
Self-Service
2022-12-06 23:09:50 +00:00
- [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
2023-04-13 08:34:01 +00:00
- [Administration UI (Console) ](https://zitadel.com/docs/guides/manage/console/overview )
Deployment
2022-12-20 10:17:27 +00:00
- [Postgres ](https://zitadel.com/docs/self-hosting/manage/database#postgres ) (version >= 14) or [CockroachDB ](https://zitadel.com/docs/self-hosting/manage/database#cockroach ) (version >= 22.0)
2023-04-13 08:34:01 +00:00
- [Zero Downtime Updates ](https://zitadel.com/docs/concepts/architecture/solution#zero-downtime-updates )
2022-01-05 22:08:49 +00:00
2022-08-24 22:03:14 +00:00
Track upcoming features on our [roadmap ](https://zitadel.com/roadmap ).
2022-05-20 14:20:31 +00:00
## How To Contribute
2022-01-05 22:08:49 +00:00
2022-05-20 14:20:31 +00:00
Details about how to contribute you can find in the [Contribution Guide ](./CONTRIBUTING.md )
2020-07-28 06:24:09 +00:00
2022-05-21 10:35:45 +00:00
## 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 ).
2021-05-19 07:47:16 +00:00
## Showcase
2023-03-08 08:52:28 +00:00
### Quick Start Guide
2021-07-06 11:55:57 +00:00
2023-03-08 08:52:28 +00:00
Secure a React Application using OpenID Connect Authorization Code with PKCE
2021-07-06 11:55:57 +00:00
2023-03-08 08:52:28 +00:00
[](http://www.youtube.com/watch?v=5THbQljoPKg "Quick Start Guide")
2021-05-19 07:47:16 +00:00
2023-03-08 08:52:28 +00:00
### 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")
2021-05-19 07:47:16 +00:00
### Admin Console
2021-07-06 11:55:57 +00:00
2023-03-07 14:31:05 +00:00
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.
2021-05-19 07:47:16 +00:00
2023-03-08 08:52:28 +00:00
[](http://www.youtube.com/watch?v=RPpHktAcCtk "Console Showcase")
2021-06-25 12:25:27 +00:00
2022-05-20 14:20:31 +00:00
## Security
2023-06-01 08:30:30 +00:00
See the 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.
2022-05-20 14:20:31 +00:00
2020-03-19 14:19:18 +00:00
## License
See the exact licensing terms [here ](./LICENSE )
2022-10-27 16:16:04 +00:00
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 the License for the specific language governing permissions and limitations under the License.
