zitadel

module
v0.104.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 17, 2020 License: Apache-2.0

README

Zitadel Logo

semantic-release Release license release Go Report Card codecov

This project is in a beta state and API might still change a bit

What Is It

ZITADEL is a "Cloud Native Identity and Access Management" solution. All server side components are written in Go and the management interface, called Console, is written in Angular.

We optimized ZITADEL for the usage as "service provider" IAM. By "service provider" we think of companies who build services for e.g SaaS cases. Often these companies would like to use an IAM where they can register their application and grant other people or companies the right to self manage a set of roles within that application.

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.

Why Another IAM

In the past we already built a closed sourced IAM and tested multiple others. With most of them we had some issues, either technology, feature, pricing or transparency related in nature. For example we find the idea that security related features like MFA should not be hidden behind a paywall or a feature price. One feature that we often missed, was a solid audit trail of all IAM resources. Most systems we saw so far either rely on simple log files or use a short retention for this.

How To Use It

Use our free tier

We provide a shared-cloud ZITADEL system where people can register there own organisation. Until end of 2020 we operator under a early access model where everything is free. Go check it out under zitadel.ch

Run your own IAM

Stay tuned, we will soon publish a guide how you can deploy a hyperconverged system with our automation tooling called ORBOS. With ORBOS you will be able to run Kubernetes on GCE or StaticProvider within 20 minutes. To achieve this, [ORBOS will bootstrap and maintain a Kubernetes cluster, essential platform components (logging, metrics, ingress, ...), a secure CockroachDB cluster and ZITADEL itself.

The combination of the tools ORBOS and ZITADEL is what makes the operation easy and scalable.

Give me some docs

Have a look at our constantly evolving docs page docs.zitadel.ch.

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.

Security

See the policy here

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.

Directories

Path Synopsis
cmd
internal
api
auth_request/repository/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
cache/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
crypto
Package crypto is a generated GoMock package.
Package crypto is a generated GoMock package.
errors/generate
go generate
go generate
eventstore/internal/repository/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
eventstore/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
eventstore/spooler/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
id
id/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
notification/providers/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
tracing/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
ui
pkg
grpc/admin/mock
Package api is a generated GoMock package.
Package api is a generated GoMock package.
grpc/auth/mock
Package api is a generated GoMock package.
Package api is a generated GoMock package.
grpc/management/mock
Package api is a generated GoMock package.
Package api is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL