andwati/zitadel
1
0
Fork 0
mirror of https://github.com/andwati/zitadel.git synced 2026-11-05 13:52:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve documentation for v2 release (#4046)

Browse Source 
* WIP: docs(proxy): describe proxy settings

* fix nginx

* refactor (docs): deploy and operate sections

* chore: ignore package-lock since we use yarn

* chore: update to rc1

* chore: broken links

* chore: update yarn

* docs: move disclaimer to bottom

* chore: fix broken links

* Update docs/docs/guides/operate/tls_modes.mdx

Co-authored-by: Fabi <[email protected]>

* test caddy files

* syntax highlight

* traefik example

* refactor: docs

* refactor

* working state

* got a working state

* remove bar

* mark rate limits for update

* remove zitadel.ch

* fix cases

* docs: zitadel quickstart

* docs: zitadel quickstart

* docs: create app and project

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: move customer portal docs to guides manage cloud

* docs: add help me choose in the quickstart

* docs: broken links

* fix broken links

* Update knative guide

* styling

* docs: support customer portal

* update to main instead v2-alpha

* use version 2 tag

* docs: images

* docs: move authentication and authorization guides to integrate

* docs: quickstart use examples

* docs: lb example

* fix broken link

* docs: update userinfo endpoints

* docs: update userinfo endpoints

* fix oidc endpoint

* docs: remove unused endpoints in app.module

Co-authored-by: Fabi <[email protected]>
Co-authored-by: Fabienne <[email protected]>
Co-authored-by: Livio Amstutz <[email protected]>
This commit is contained in:
Florian Forster
2022-07-29 10:13:45 +02:00
committed by GitHub
co-authored by Fabi Fabienne Livio Amstutz
parent fb52575f79
commit 3c3bce1a6b
123 changed files with 3212 additions and 25673 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/guides/start/_local_instance.mdx
+1
View File
@@ -0,0 +1 @@
If you choose to run a local instance have a look at our [deploy](../deploy/overview) section, where we show you different possibilities on how to run ZITADEL.
docs/docs/guides/start/_zitadel_cloud.mdx
+55
View File
@@ -0,0 +1,55 @@
This guide provides a quick start on how to onboard to the ZITADEL Cloud Customer Portal, where you can manage your ZITADEL instances.
Follow all the guides in the get to know section, to create your first instance, upgrade to a paid tier and connect your first client.
## Try out ZITADEL Cloud
1. Visit [zitadel.cloud](https://zitadel.cloud/) to create your account. If you already have a ZITADEL instance sign in with your Customer Portal user.
2. Enter the data to create your organization (First name, Last name, Email, Username and Organization Name)
3. By clicking "Let's go" we will create a user for you.
4. You will receive an verification Email to verify the user for the Customer Portal
5. Use the newly create user to login to the Custom Portal
![Customer Portal Landing Page](/img/manuals/portal/customer_portal_landing_page.png)
## Login to Customer Portal
Use your Customer Portal user to login to the ZITADEL Customer Portal.
Here you can manage all your different instances, subscriptions and billing data.
1. Go to [zitadel.cloud](https://zitadel.cloud)
2. Click sign in
3. Use your ZITADEL Cloud user
Find out more about the Customer Portal [here](/docs/guides/manage/cloud/overview).
## Create a new instance
:::note
This takes place in the [ZITADEL Cloud Customer Portal](https://zitadel.cloud)
:::
The creation and management of an instance takes place in the Customer Portal.
To manage your existing instances you need login with your Customer Portal user. Be aware that this is not the same user as in the instance itself.
1. Click
![New Instance](/img/manuals/portal/customer_portal_new_instance.gif)
## Login to your instance
:::note
This takes place in the your ZITADEL Cloud Instances Console
:::
After you have initialized your first admin user of the newly created ZITADEL instance. You can access the instance's Console, to manage all of your resources.
To login with the user you have initialized. You will find the link to access your instance in the initialization email of your user or in the detail page of your instance in the [ZITADEL Cloud](https://zitadel.cloud).
We generated a unique domain for each ZITADEL Cloud Instance that looks like this: {InstanceName}-{RandomString}.zitadel.cloud
**Customer Portal - Find Instance Domain:**
![Customer Portal - Instance Domain](/img/manuals/portal/portal_instance_detail_domain.png)
**Console - Landing Page**
![Console Landing Page](/img/console_dashboard.png)
## Manage Instance and Billing
docs/docs/guides/start/quickstart.mdx
+81
View File
@@ -0,0 +1,81 @@
---
title: Quickstart
---
import Column from "../../../src/components/column";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Zcloud from './_zitadel_cloud.mdx'
import LocalInstance from './_local_instance.mdx'
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.
ZITADEL currently support two ways of using it:
- Use the ZITADEL Cloud free tier to get started in minutes
- Deploy a self-hosted ZITADEL, where ever you like
## Help me choose
If you are unsure you should opt for the gracious free-tier of [ZITADEL Cloud](../manage/cloud/overview).
Chose [ZITADEL Cloud](../manage/cloud/overview) if you want:
- A turnkey solution that just works
- Gracious Free tier with a great pay-as-you-go option
- Global scalability without the headache of running
- Data residency compliance for your customers
Chose [ZITADEL Self-Hosted](../deploy/overview) if you want:
- Total control over all components and your data
- Run ZITADEL in air gapped or regulated environemnts
- Flexibilty when you deploy updates
:::info
Support is available either through the opensource community or a support contract
:::
<Tabs
groupId="proxy-vendor"
default="zcloud"
values={[
{'label': 'ZITADEL Cloud', 'value': 'zcloud'},
{'label': 'Local Instance', 'value': 'local'},
]}
>
<TabItem value="zcloud">
<Zcloud/>
<More/>
</TabItem>
<TabItem value="local">
<LocalInstance/>
<More/>
</TabItem>
</Tabs>
## Create first project and application
To be able to connect your first application you have to create a project and an application in the ZITADEL Console.application
1. Click on the projects menu point
2. Add new project by clicking the "+" Button and give a name
3. Click the "+" Button in the project detail in the application section
4. The wizard will help you through the creation process with the recommended values when choosing the application type [More about applications](../manage/console/applications)
Now you are ready to integrate ZITADEL into your application.
Check out our [Examples](../../examples/introduction) to start with your app.
## Elect New Managers
:::note
This takes place in the ZITADEL Console
:::
ZITADEL allows you to give other users control over the ZITADEL Console. The manager role can be restricted to some kind of write and/or read.
This is especially useful for direct administration over several users. You can have managers able to edit project settings and others able to create/add users only.
> Note: ZITADEL Managers are located on the right side panel of the ZITADEL Console.