mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-23 07:52:15 +00:00
docs: quickstart, guides overview (#2524)
* fix: components, styles * col component * list components, change contents * fix link
This commit is contained in:
Max Peintner
@@ -2,6 +2,8 @@
|
||||
title: Get started
|
||||
---
|
||||
|
||||
import Column from '../../../src/components/column';
|
||||
|
||||
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.
|
||||
@@ -11,27 +13,33 @@ This provides a quick start guide on how to register your organization as well a
|
||||
|
||||
## Trying out ZITADEL on zitadel.ch
|
||||
|
||||
<Column>
|
||||
<div>
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
Now you can proceed adding users to your organization as well as integrating your applications. We refer to our guides as well as our [Quickstarts](../../quickstarts/introduction) to do so.
|
||||
|
||||
#### Verify your domain name (optional)
|
||||
</div>
|
||||
<img width="400px" src="/img/accounts_org_register_light.png" alt="register view"/>
|
||||
</Column>
|
||||
|
||||
### 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**.
|
||||
|
||||
#### Elect Managers
|
||||
### 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 [guides](../introduction) for more information.
|
||||
Read the [guides](../overview) for more information.
|
||||
|
||||
> Note: ZITADEL Managers are always located on the right sidepanel of console.
|
||||
|
||||
#### Integrating an application
|
||||
### 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 [Guide Project](projects).
|
||||
|
||||
+7
-2
@@ -12,6 +12,7 @@ title: Organizations
|
||||
## What is an organization?
|
||||
|
||||
import OrgDescription from '../../concepts/zitadel/objects/_org_description.mdx';
|
||||
import Column from '../../../src/components/column';
|
||||
|
||||
<OrgDescription name="OrgDescription" />
|
||||
|
||||
@@ -23,9 +24,13 @@ To register your organization and create a user for ZITADEL, visit zitadel.ch or
|
||||
|
||||
|
||||
|
||||
If you already have an existing login for zitadel.ch, you need to visit the console, then click on your organization’s name in the upper left corner, and then select “New organization”.
|
||||
<Column>
|
||||
<div>
|
||||
If you already have an existing login for zitadel.ch, you need to visit the console, then click on your organization’s name in the upper left corner, and then select “New organization”.
|
||||
</div>
|
||||
|
||||
|
||||
<img src="/img/console_org_select.png" alt="Select Organization"/>
|
||||
</Column>
|
||||
|
||||
## How ZITADEL handles usernames
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
---
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
With our guides you will learn everything you need to know about specific topics. You get step-by-step instructions for certain tasks and have a knowledge check at the end.
|
||||
|
||||
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. Jump directly to the [get started](./basics/get-started) docs.
|
||||
|
||||
When you are familiar with the ZITADEL usage, you can choose to stay on [zitadel.ch](./installation/shared-cloud), order your own [dedicated instance](./installation/shared-cloud) which is also availabe on premise, or install ZITADEL easily on your own using [Custom Kubernetes Resources](./installation/crd), [GitOps](./installation/gitops) or [ORBOS](./installation/orbos).
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Overview
|
||||
---
|
||||
|
||||
import {ListElement, ListWrapper, ICONTYPE} from '../../src/components/list';
|
||||
import Column from '../../src/components/column';
|
||||
|
||||
With our guides you will learn everything you need to know about specific topics. You get step-by-step instructions for certain tasks and have a knowledge check at the end.
|
||||
|
||||
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. Jump directly to the [get started](./basics/get-started) docs.
|
||||
|
||||
When you are familiar with the ZITADEL usage, you can choose to stay on [zitadel.ch](./installation/shared-cloud), order your own [dedicated instance](./installation/shared-cloud) which is also availabe on premise, or install ZITADEL easily on your own using [Custom Kubernetes Resources](./installation/crd), [GitOps](./installation/gitops) or [ORBOS](./installation/orbos).
|
||||
|
||||
<Column>
|
||||
<ListWrapper title="Get to know ZITADEL">
|
||||
<ListElement link="/docs/guides/basics/get-started" type={ICONTYPE.START} title="Get started" description="Try out zitadel.ch" />
|
||||
<ListElement link="/docs/guides/basics/organizations" type={ICONTYPE.START} title="Organizations" description="Learn how ZITADEL ist organized" />
|
||||
<ListElement link="/docs/guides/basics/projects" type={ICONTYPE.START} title="Projects" description="Understand projects and grants" />
|
||||
</ListWrapper>
|
||||
<ListWrapper title="Authentication">
|
||||
<ListElement link="/docs/guides/authentication/login-users" type={ICONTYPE.LOGIN} title="Login users" description="Authenticate users in ZITADEL" />
|
||||
<ListElement link="/docs/guides/authentication/identity-brokering" type={ICONTYPE.LOGIN} title="Identity Brokering" description="Identity Brokering and Federated Identities" />
|
||||
</ListWrapper>
|
||||
<ListWrapper title="APIs">
|
||||
<ListElement link="/docs/guides/api/access-zitadel-apis" type={ICONTYPE.APIS} title="APIs" description="Authorize Service Users to access ZITADEL APIs" />
|
||||
</ListWrapper>
|
||||
<ListWrapper title="Customization">
|
||||
<ListElement link="/docs/guides/customization/branding" type={ICONTYPE.PRIVATELABELING} title="Private Labeling" description="Customize your organization to your brand" />
|
||||
<ListElement link="/docs/guides/customization/texts" type={ICONTYPE.TEXTS} title="Texts" description="Login interface texts and notification texts" />
|
||||
</ListWrapper>
|
||||
<ListWrapper title="Installation">
|
||||
<ListElement link="/docs/guides/installation/shared-cloud" type={ICONTYPE.SYSTEM} title="Managed" description="Shared ZITADEL Cloud or Dedicated Instance" />
|
||||
</ListWrapper>
|
||||
</Column>
|
||||
@@ -1,7 +0,0 @@
|
||||
---
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
Start with ZITADEL quickly by choosing your language.
|
||||
|
||||
You can find some example applications [here](https://github.com/caos/zitadel-examples)
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: Overview
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import {Card, CardWrapper} from '../../src/components/card';
|
||||
|
||||
Get started with ZITADEL quickly by reading a quickstart or by cloning an example from our [ZITADEL examples](https://github.com/caos/zitadel-examples) repo.
|
||||
|
||||
<Tabs>
|
||||
<TabItem value="app" label="Web · Native applications" default>
|
||||
<CardWrapper>
|
||||
<Card link="/docs/quickstarts/login/angular" imageSource="/img/tech/angular.svg" title="Angular" description="Add the user login to your application and query some data from the userinfo endpoint" />
|
||||
<Card link="/docs/quickstarts/login/react" imageSource="/img/tech/react.png" title="React" description="Logs into your application and queries some data from the userinfo endpoint" />
|
||||
<Card link="/docs/quickstarts/login/flutter" imageSource="/img/tech/flutter.svg" title="Flutter" description="Mobile Application working for iOS and Android that authenticates your user." />
|
||||
<Card link="/docs/quickstarts/login/nextjs" imageSource="/img/tech/nextjs.svg" title="NextJS" description="A simple application to log into your user account and query some data from User endpoint." />
|
||||
</CardWrapper>
|
||||
</TabItem>
|
||||
<TabItem value="backend" label="Backend · API">
|
||||
<CardWrapper>
|
||||
<Card link="/docs/quickstarts/call-zitadel-api/go" imageSource="/img/tech/golang.svg" title="GO" description="Demonstrates how to fetch some data from the ZITADEL management API." />
|
||||
<Card link="/docs/quickstarts/call-zitadel-api/dot-net" imageSource="/img/tech/dotnet.svg" title=".NET" description="This integration guide shows you how to integrate ZITADEL into your .NET application. It demonstrates how to fetch some data from the ZITADEL management API." />
|
||||
</CardWrapper>
|
||||
</TabItem>
|
||||
<TabItem value="proxy" label="Proxy">
|
||||
<CardWrapper>
|
||||
<Card link="/docs/quickstarts/identity-proxy/oauth2-proxy" imageSource="/img/tech/oauth2-proxy.svg" title="OAuth 2.0 Proxy" description="Allows services to delegate the authentication flow to a IDP, for example ZITADEL" />
|
||||
</CardWrapper>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Clone a sample project
|
||||
|
||||
<CardWrapper>
|
||||
<Card githubLink="https://github.com/caos/zitadel-examples/tree/main/python3" title="Python" label="Python" />
|
||||
<Card githubLink="https://github.com/caos/zitadel-examples/tree/main/angular" title="Angular" label="Web · Mobile Web" />
|
||||
<Card githubLink="https://github.com/caos/zitadel-examples/tree/main/nextjs" title="NextJS" label="Web · Mobile Web" />
|
||||
</CardWrapper>
|
||||
|
||||
## Libraries
|
||||
|
||||
|
||||
| Language | Description | Link |
|
||||
| ------------ | ---------------------|-------------|
|
||||
| Go | Go client library for ZITADEL. | [https://github.com/caos/zitadel-go](https://github.com/caos/zitadel-go)
|
||||
| .Net | Authentication / Authorization library written in dotnet for the asp.net web application package. | [https://github.com/caos/zitadel-net](https://github.com/caos/zitadel-net)
|
||||
| Dart | Dart library for ZITADEL, contains gRPC and API access elements. | [https://github.com/caos/zitadel-dart](https://github.com/caos/zitadel-dart) |
|
||||
| Elixir | API Client for the ZITADEL API. | [https://github.com/jshmrtn/zitadel_api](https://github.com/jshmrtn/zitadel_api) |
|
||||
Reference in New Issue
Block a user