diff --git a/README.md b/README.md index b8382393b..f248b9f4d 100644 --- a/README.md +++ b/README.md @@ -36,21 +36,30 @@ For example, **ZITADEL** is event sourced but it does not rely on a pub/sub syst * APIs for Management, Administration, and Authentication * Policy configuration and enforcement -## How To Use It +## Run ZITADEL anywhere -### ZITADEL Cloud +### Self-Managed -We provide a cloud service [**ZITADEL.ch**](https://zitadel.ch) where people can register their own organization. There is a **free tier** including unlimited users and all the security features you need. +You can run an automatically operated **ZITADEL** instance on a CNCF compliant Kubernetes cluster of your choice: +- [CRD Mode on an existing k8s cluster](https://docs.zitadel.ch/docs/guides/installation/crd) +- [GitOps Mode on an existing k8s cluster](https://docs.zitadel.ch/docs/guides/installation/gitops) +- [GitOps Mode on VM/bare-metal](https://docs.zitadel.ch/docs/guides/installation/managed-dedicated-instance) using [ORBOS](https://docs.zitadel.ch/docs/guides/installation/orbos) -### Run ZITADEL in the cloud or on-premise +### CAOS-Managed -**ZITADEL** is free open source software under [Apache 2.0](##License) managed by [CAOS](https://caos.ch). We provide our community access to ZITADEL releases at no cost and welcome all contributions. +- **ZITADEL Cloud:** [**ZITADEL.ch**](https://zitadel.ch) is our shared cloud service hosted in Switzerland. [Get started](https://docs.zitadel.ch/docs/guides/usage/get-started) and try the free tier, including already unlimited users and all necessary security features. +- **ZITADEL Enterprise:** We operate and support a private instance of **ZITADEL** for you. [Get in touch!](https://zitadel.ch/contact/) -You can run an automatically operated **ZITADEL** instance on a CNCF compliant Kubernetes cluster of your choice. You can do so by using [CRDs](https://docs.zitadel.ch/docs/guides/installation/crd), [GitOps](https://docs.zitadel.ch/docs/guides/installation/gitops) or on a [dedicated Kubernetes Cluster](https://docs.zitadel.ch/docs/guides/installation/managed-dedicated-instance) on various infrastructure providers using [ORBOS](https://docs.zitadel.ch/docs/guides/installation/orbos) +## Start using ZITADEL -### Let us run ZITADEL for you +### Quickstarts -If our cloud service or running **ZITADEL** on your own infrastructure does not work for you, we are happy to run a private instance of **ZITADEL** for you or provide you with our support services. [Get in touch!](https://zitadel.ch/contact/) +See our [Documentation](https://docs.zitadel.ch/docs/quickstarts/introduction) to get started with ZITADEL quickly. Let us know, if you are missing a language or framework in the [Q&A](https://github.com/caos/zitadel/discussions/1717). + +### Client libraries +* [Go](https://github.com/caos/zitadel-go) client library +* [.NET](https://github.com/caos/zitadel-net) client library +* [Dart](https://github.com/caos/zitadel-dart) client library ## Help and Documentation @@ -58,6 +67,27 @@ If our cloud service or running **ZITADEL** on your own infrastructure does not * [Ask a question or share ideas](https://github.com/caos/zitadel/discussions) * [Say hello](https://zitadel.ch/contact/) +## Showcase + +### Passwordless Login +Use our login widget to allow easy and sucure access to your applications and enjoy all the benefits of passwordless (FIDO 2 / WebAuthN): +- works on all modern platforms, devices, and browsers +- phishing resistant alternative +- requires only one gesture by the user +- easy [enrollment](https://docs.zitadel.ch/docs/manuals/user-factors) of the device during registration + +![passwordless-windows-hello](https://user-images.githubusercontent.com/1366906/118765435-5d419780-b87b-11eb-95bf-55140119c0d8.gif) +![passwordless-iphone](https://user-images.githubusercontent.com/1366906/118765439-5fa3f180-b87b-11eb-937b-b4acb7854086.gif) + +### Admin Console +Use [Console](https://docs.zitadel.ch/docs/manuals/introduction) or our [APIs](https://docs.zitadel.ch/docs/apis/introduction) to setup organizations, projects and applications. + +Register new applications +![OIDC-Client-Register](https://user-images.githubusercontent.com/1366906/118765446-62064b80-b87b-11eb-8b24-4f4c365b8c58.gif) + +Delegate the right to assign roles to another organization +![projects_create_org_grant](https://user-images.githubusercontent.com/1366906/118766069-39cb1c80-b87c-11eb-84cf-f5becce4e9b6.gif) + ## How To Contribute Details need to be announced, but feel free to contribute already. As long as you are okay with accepting to contribute under this projects OSS [License](./LICENSE) you are fine.