zitadel/site/docs/start/00-quick-start.en.md
mffap ea2aa27f15
docs: improvement to semantics (#944)
* 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>
2020-12-01 16:56:33 +01:00

2.3 KiB

title description
Quick-Start 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 or deploy a dedicated ZITADEL instance. To get started, we recommend you try out our free tier on ZITADEL.ch.

Use ZITADEL.ch

To use ZITADEL in your project you need to:

  1. Set up a new client and users in our Console;
  2. Configure your project to use ZITADEL.

To register your free organisation, visit this link register organisation. After accepting the TOS and filling out all the required fields you will receive an email with further instructions.

Organisation Overview
Organisation Register

Verify your domain name (optional)

When you verify your domain you get the benefit that your organisations users can use this domain as preferred logonname. You find a more detailed explanation How ZITADEL handles usernames.

The verification process is documented here

Add Users to your organisation

To add new user just follow this guide

Setup an application

First create a project

Then create within this project a new client

The wizard should provide some guidance what client is the proper for you. If you are still unsure consult our Integration Guide

Use ORBOS to install ZITADEL

This will be added later on

Install ZITADEL with static manifest

This will be added later on