mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-06 01:42:13 +00:00
feat: docs rehaul, fix missing context in console, quickstarts (#1212)
* onboarding components, routing, steps * onboarding component, toc * fix onboarding mixin * header * refactor docs * fix layout * cleanup routing * docs routing * fix conventions * de en routing * docs, guide contents, nav * rem i18n support * fix routing from docs * rollup onwarn changes, preload * update svelte plugin, update rollup config * move docs * revert img style, remove code table * rem de completely * rollup optim, template * angular quickstart, quickstart overview page, update deps * fix link * pack, slug * prefetch binding, hidden links * export log * guards route ch * fix homepage * angular docs * docs * resolve fsh * overview * docs * docs * packages fix race condition * nav, home link * add vue, aspnet * doc optimizations * embed status pal * angular guide * angular guide * dotnet, angular guide * viewbox * typo * block onboarding route for non iam writers * set links from component data * fix: fetch org context in guard, more main cnt (#1192) * change get started guide, fix code blockquotes, typos * flutter guide * h2 spacing * highlight strong * plus * rm start sublinks * add proxy quickstart * regex * prevent outside click, fix project grant write Co-authored-by: Florian Forster <florian@caos.ch> Co-authored-by: Livio Amstutz <livio.a@gmail.com>
This commit is contained in:
Max Peintner
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Schnellstart
|
||||
description: ...
|
||||
---
|
||||
|
||||
> This Language is not yet translated. Please consult the English version.
|
||||
@@ -1,54 +0,0 @@
|
||||
---
|
||||
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
|
||||
19
site/docs/start/00-quick-start.md
Normal file
19
site/docs/start/00-quick-start.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Welcome to ZITADEL
|
||||
description: A quick-start reference for the impatient reader.
|
||||
---
|
||||
|
||||
Most applications need to know the identity of a user allowing to securely store user data in the cloud and provide the same personalised experience across all of the user's devices.
|
||||
|
||||
ZITADEL's authentication provides backend services, easy-to-use SDKs, and ready-made UI libraries to authenticate users in your application. It supports authentication using passwords and applies additional security with the help of a second factor, for example OTP, to ensure a safe and secure access.
|
||||
It additionally leverages industry standards like OAuth 2.0 and OpenID Connect such that it can be easily integrated in your custom backend.
|
||||
|
||||
This documentation demonstrates the different installation methods of ZITADEL and provides a quick start guide on how to register your organization as well as creating your first project.
|
||||
|
||||
> All documentations are under active work and subject to change soon!
|
||||
|
||||
## Trying out ZITADEL
|
||||
|
||||
### Installation Types
|
||||
|
||||
You can either use our cloud-instance [zitadel.ch](https://zitadel.ch) or deploy a dedicated **ZITADEL** instance. To get started, we recommend you to try out our free tier first.
|
||||
39
site/docs/start/01-zitadel-ch.md
Normal file
39
site/docs/start/01-zitadel-ch.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: ZITADEL.ch
|
||||
description: A quick-start reference to use our cloud instance zitadel.ch
|
||||
---
|
||||
|
||||
### Use cloud instance zitadel.ch
|
||||
|
||||
To create a ZITADEL project, you have to register as an organization first. Click [here](https://accounts.zitadel.ch/register/org) to register.
|
||||
You will receive an email prompting you to verify your mail.
|
||||
Then go to your [Console Projects](https://console.zitadel.ch/projects) view and create a new project.
|
||||
|
||||
<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_light.png" itemprop="contentUrl" data-size="840x1398">
|
||||
<img src="img/accounts_org_register_light.png" itemprop="thumbnail" alt="Organisation Overview" />
|
||||
</a>
|
||||
<figcaption itemprop="caption description">Organisation Register</figcaption>
|
||||
</figure>
|
||||
</div>
|
||||
|
||||
Now you can proceed adding [users](administrate#What_are_users) to your organization as well as integrating your applications. We refer to our administration [documentation](administrate#What_are_clients) as well as our [quickstarts](quickstarts) to do so.
|
||||
|
||||
#### Verify your domain name (optional)
|
||||
|
||||
If you verify a domain you get the benefit that your organisations users can use this domain as the **preferred logonname**. You find a more detailed explanation on [how ZITADEL handles usernames](administrate#How_ZITADEL_handles_usernames) here.
|
||||
The verification process is documented [here](administrate#Verify_a_domain_name)
|
||||
|
||||
#### Elect Managers
|
||||
|
||||
ZITADEL allows you to give other users control over ZITADEL Console itself. This can be restricted to some kind of write and/or read. This can be especially useful for directing administration over several users. You can have managers able to edit project settings and others able to create/add users only.
|
||||
Read the [administration](administrate#ZITADEL_Roles) guide for more information.
|
||||
|
||||
> Note: ZITADEL Managers are always located on the right sidepanel of console.
|
||||
|
||||
#### Integrating an application
|
||||
|
||||
After creating your project you can start integrating your applications.
|
||||
After choosing your [project](https://console.zitadel.ch/projects) add a client application on the top of the page.
|
||||
The wizard should provide some guidance what client is the proper for you. If you are still unsure consult our [Quickstart Guides](quickstarts).
|
||||
7
site/docs/start/02-orbos.md
Normal file
7
site/docs/start/02-orbos.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: ORBOS
|
||||
---
|
||||
|
||||
### Use ORBOS to install ZITADEL
|
||||
|
||||
> This will be added later on
|
||||
7
site/docs/start/03-static-manifest.md
Normal file
7
site/docs/start/03-static-manifest.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Static Manifest
|
||||
---
|
||||
|
||||
### Install ZITADEL with static manifest
|
||||
|
||||
> This will be added later on
|
||||
Reference in New Issue
Block a user