zitadel/README.md
Livio Amstutz 3c790d996e
docs: update readme (#1460) (#1545)
* Update readme

* Apply suggestions from code review but features

Co-authored-by: Florian Forster <florian@caos.ch>

* Update README.md

Co-authored-by: Florian Forster <florian@caos.ch>

Co-authored-by: Maximilian Panne <maximilian.panne@gmail.com>
Co-authored-by: Florian Forster <florian@caos.ch>
(cherry picked from commit 5c5b13cf84)

Co-authored-by: mffap <mpa@caos.ch>
2021-04-07 14:26:21 +02:00

4.9 KiB

Zitadel Logo

semantic-release Release license release Go Report Card codecov

What Is ZITADEL

ZITADEL is a "Cloud Native Identity and Access Management" solution built for the cloud era. ZITADEL uses a modern software stack consisting of Golang, Angular and CockroachDB as sole storage and follows an event sourced pattern.

We built ZITADEL not only with the vision of becoming a great open source project but also as a superb platform to support developers building their applications, without need to handle secure user login and account management themselves.

How Does It Work

We built ZITADEL around the idea that the IAM should be easy to deploy and scale. That's why we tried to reduce external systems as much as possible. For example, ZITADEL is event sourced but it does not rely on a pub/sub system to function. Instead we built all the functionality right into one binary. ZITADEL only needs Kubernetes for orchestration and CockroachDB as storage.

Features of ZITADEL platform

  • Authentication
    • OpenID Connect 1.0 Protocol (OP)
    • Username / Password
    • Machine-to-machine (JWT profile)
    • Passwordless with FIDO2
  • Multifactor authentication with OTP, U2F
  • Federation with OpenID Connect 1.0 Protocol (RP), OAuth 2.0 Protocol (RP)
  • Authorization via Role Based Access Control (RBAC)
  • Identity Brokering
  • Delegation of roles to other organizations for self-management
  • Strong audit trail for all IAM resources
  • User interface for administration
  • APIs for Management, Administration, and Authentication
  • Policy configuration and enforcement

How To Use It

ZITADEL Cloud

We provide a cloud service ZITADEL.ch where people can register their own organization. There is a free tier including unlimited users and all the security features you need.

Run ZITADEL in the cloud or on-premise

ZITADEL is free open source software under Apache 2.0 managed by CAOS. We provide our community access to ZITADEL releases at no cost and welcome all contributions.

You can run ZITADEL in combination with ORBOS for easy and scalable operation on

Stay tuned, we will soon publish a more detailed guide on how you can deploy a hyperconverged system on your own.

Let us run ZITADEL for you

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!

Help and Documentation

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 you are fine.

We already have documentation specific guidelines.

How to develop ZITADEL: contribute

Security

See the policy here

Other CAOS Projects

  • ORBOS - GitOps everything
  • OIDC for GO - OpenID Connect SDK (client and server) for Go
  • ZITADEL Tools - Go tool to convert key file to privately signed JWT

License

See the exact licensing terms here

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.