mirror of
https://github.com/zitadel/zitadel.git
synced 2025-01-07 11:48:03 +00:00
ea2aa27f15
* rename to overview * wip * wip * wip * wip * wip * wip * examples * ts example * wip with grafana * add grafana tutorial * screenshots and grafana * figure out oauth proxy * authz oauth proxy * move img * merge from master * reviewed documentation * reviewed documentation * wip * wip * wip * wip * wip * wip * examples * ts example * wip with grafana * screenshots and grafana * figure out oauth proxy * authz oauth proxy * move img * merge from master * cleaned up name for management roles * corrected small typo in code * Intro for orgs, spelling, ref to mgmt roles * removed inline comments * Update 00-quick-start.en.md * Update 02-organisations.en.md * Update site/docs/administrate/03-projects.en.md Co-authored-by: Florian Forster <florian@caos.ch> * Update 03-projects.en.md * Update 04-clients.en.md * Update site/docs/administrate/07-policies.en.md Co-authored-by: Florian Forster <florian@caos.ch> * Update 09-authorizations.en.md Co-authored-by: Florian Forster <florian@caos.ch>
55 lines
2.3 KiB
Markdown
55 lines
2.3 KiB
Markdown
---
|
|
title: Quick-Start
|
|
description: A quick-start reference for the impatient reader.
|
|
---
|
|
|
|
> All documentations are under active work and subject to change soon!
|
|
|
|
### Trying out ZITADEL
|
|
|
|
You can either use our cloud-instance [ZITADEL.ch](https://zitadel.ch) or deploy a dedicated **ZITADEL** instance. To get started, we recommend you try out our free tier on [ZITADEL.ch](https://zitadel.ch).
|
|
|
|
### Use ZITADEL.ch
|
|
|
|
To use ZITADEL in your project you need to:
|
|
1. Set up a new [client](administrate#What_are_clients) and [users](administrate#What_are_users) in our [Console](administrate#What_is_Console);
|
|
2. Configure your project to use ZITADEL.
|
|
|
|
To register your free [organisation](administrate#Organisations), visit this link [register organisation](https://accounts.zitadel.ch/register/org).
|
|
After accepting the TOS and filling out all the required fields you will receive an email with further instructions.
|
|
|
|
<div class="zitadel-gallery" itemscope itemtype="http://schema.org/ImageGallery">
|
|
<figure itemprop="associatedMedia" itemscope itemtype="http://schema.org/ImageObject">
|
|
<a href="img/accounts_org_register.png" itemprop="contentUrl" data-size="1472x1000">
|
|
<img src="img/accounts_org_register.png" itemprop="thumbnail" alt="Organisation Overview" />
|
|
</a>
|
|
<figcaption itemprop="caption description">Organisation Register</figcaption>
|
|
</figure>
|
|
</div>
|
|
|
|
#### Verify your domain name (optional)
|
|
|
|
When you verify your domain you get the benefit that your [organisations](administrate#Organisations) [users](administrate#Users) can use this domain as **preferred logonname**. You find a more detailed explanation [How ZITADEL handles usernames](administrate#How_ZITADEL_handles_usernames).
|
|
|
|
The verification process is documented [here](administrate#Verify_a_domain_name)
|
|
|
|
#### Add Users to your organisation
|
|
|
|
To add new user just follow [this guide](administrate#Create_Users)
|
|
|
|
#### Setup an application
|
|
|
|
First [create a project](administrate#Create_a_project)
|
|
|
|
Then create within this [project](administrate#Projects) a [new client](administrate#Create_a_client)
|
|
|
|
The wizard should provide some guidance what client is the proper for you. If you are still unsure consult our [Integration Guide](integrate#Overview)
|
|
|
|
### Use ORBOS to install ZITADEL
|
|
|
|
> This will be added later on
|
|
|
|
### Install ZITADEL with static manifest
|
|
|
|
> This will be added later on
|