mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-17 21:37:35 +00:00
db6bfad536
* fix: added contribution link to build guide * Update README.md Co-authored-by: Florian Forster <florian@caos.ch>
65 lines
4.4 KiB
Markdown
65 lines
4.4 KiB
Markdown
<img src="./site/static/logos/zitadel-logo-dark@2x.png" alt="Zitadel Logo" height="100px" width="auto" />
|
|
|
|
[](https://github.com/semantic-release/semantic-release)
|
|
[](https://github.com/caos/zitadel/actions)
|
|
[](https://github.com/caos/zitadel/blob/master/LICENSE)
|
|
[](https://github.com/caos/zitadel/releases)
|
|
[](https://goreportcard.com/report/github.com/caos/zitadel)
|
|
[](https://codecov.io/gh/caos/zitadel)
|
|
|
|
> 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**](https://golang.org/) and the management interface, called **Console**, is written in [**Angular**](https://angular.io/).
|
|
|
|
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**](https://kubernetes.io/) for orchestration and [**CockroachDB**](https://www.cockroachlabs.com/) 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](https://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**](https://github.com/caos/orbos/).
|
|
With [**ORBOS**](https://github.com/caos/orbos/) you will be able to run [**Kubernetes**](https://kubernetes.io/) on **GCE** or **StaticProvider** within 20 minutes. To achieve this, [[**ORBOS**](https://github.com/caos/orbos/) will bootstrap and maintain a [**Kubernetes**](https://kubernetes.io/) cluster, essential platform components (logging, metrics, ingress, ...), a secure [**CockroachDB**](https://www.cockroachlabs.com/) cluster and **ZITADEL** itself.
|
|
|
|
The combination of the tools [**ORBOS**](https://github.com/caos/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](https://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](##License) you are fine.
|
|
|
|
We already have documentation specific [guidelines](./site/CONTRIBUTING.md).
|
|
|
|
Howto develop ZITADEL: [contribute](./CONTRIBUTING.md)
|
|
|
|
## Security
|
|
|
|
See the policy [here](./SECURITY.md)
|
|
|
|
## License
|
|
|
|
See the exact licensing terms [here](./LICENSE)
|
|
|
|
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.
|