mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-02 04:12:16 +00:00
docs: proposal restructure (#5318)
* docs: docs structure * docs: remove sdk from main nav * docs: fix broken links * docs: texts * docs: texts * docs: react example * docs: proposal restructure * remove manual, move troubleshooting * revmove duplicate item * identity providers * broken links and rel paths * examples wip * examples * navigation * support * solution scenarios * concepts * overview * Actions caution to info * suggestions from code review * remove start command again * proposed start command (with and without api) * wip startpage * startpage * broken link integrate * remove get started from nav * Apply suggestions from code review Co-authored-by: Elio Bischof <[email protected]> --------- Co-authored-by: Fabienne <[email protected]> Co-authored-by: Florian Forster <[email protected]> Co-authored-by: Elio Bischof <[email protected]>
This commit is contained in:
mffap
co-authored by
Elio Bischof
Fabienne
Florian Forster
Elio Bischof
Fabienne
Florian Forster
parent
23c14d9bd1
commit
8d4d182c20
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Application Support Trainings
|
||||
---
|
||||
|
||||
## ZITADEL DevOps
|
||||
|
||||
In this session your second level support and operations team will gain an understanding on how to extract relevant information for technical support questions and root cause analysis. We will also present our DevOps best practices and answer your questions.
|
||||
|
||||
**Audience**: 2nd Level Support Staff, Operations
|
||||
**Duration**: 0.5 day
|
||||
|
||||
**Topics covered**:
|
||||
|
||||
- Event types
|
||||
- Database schemas and compute models
|
||||
- Accessing database
|
||||
- Observability (Logs, Errors, Metrics, Tracing)
|
||||
- Operations best practices (Deployment, Backup, Networking etc.)
|
||||
- Q&A
|
||||
|
||||
## ZITADEL Administrator
|
||||
|
||||
In this hands-on training your employees will get a complete overview of the system and learn how to configure and use ZITADEL. Your support staff will gain the required knowledge to provide user-support, while your solution owners gain an understanding about integration of clients.
|
||||
|
||||
**Audience**: 1st / 2nd Level Support Staff, Solution Owner, QA Manager (optional)
|
||||
**Duration**: 0.5 days
|
||||
|
||||
**Topics covered**:
|
||||
|
||||
- IAM Configuration
|
||||
- Walk-though all features
|
||||
- Users / Manuals
|
||||
- APIs
|
||||
- Validation of tokens
|
||||
- Client integration best-practices
|
||||
- Q&A
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
The following pages describe the the trainings provided by ZITADEL. These trainings are intended for onboarding and during the course of a Support Program.
|
||||
|
||||
Training should be held as block-sessions with the relevant staff from your organization.
|
||||
|
||||
## Onboarding Project
|
||||
|
||||
You receive professional onboarding support from our engineers, who help you to setup and configure ZITADEL on your infrastructure.
|
||||
|
||||
[More information](project)
|
||||
|
||||
## Application Support Trainings
|
||||
|
||||
With the application support trainings we provide the initial knowledge transfer to manage and support ZITADEL. The trainings are held as block-sessions with relevant staff from your organization. Prices are flat-fee, excl. expenses.
|
||||
|
||||
* [ZITADEL DevOps](application#zitadel-devops)
|
||||
* [ZITADEL Administrator](application#zitadel-administrator)
|
||||
|
||||
## Recurring Trainings
|
||||
|
||||
While you can benefit from a technical account manager during your term, these trainings are designed to onboard new staff or update staff about larger changes to the platform. Prices are flat-fee, excl. expenses.
|
||||
|
||||
* [ZITADEL Support Refresher](recurring#zitadel-support-refresher)
|
||||
* [ZITADEL Support Onboarding](recurring#zitadel-support-onboarding)
|
||||
|
||||
In case you have any questions please [get in touch](https://zitadel.com/contact).
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Onboarding Project
|
||||
---
|
||||
|
||||
Effort required during depends on the complexity of your infrastructure and the overall setup. With a Multi-Zone Setup (excl. Multi-Region), support during this phase requires around 10-25h over 2 weeks. Actual effort is based on time and material.
|
||||
|
||||
Scope of the project is agreed on individual basis.
|
||||
|
||||
## In Scope
|
||||
|
||||
- Check prerequisites and architecture
|
||||
- Troubleshoot installation and configuration of ZITADEL
|
||||
- Troubleshoot and configuration connectivity to the database
|
||||
- Functional testing of the ZITADEL instance
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- Running multiple ZITADEL instances on the same cluster
|
||||
- Integration into internal monitoring and alerting
|
||||
- Multi-cluster architecture deployments
|
||||
- DNS, Network and Firewall configuration
|
||||
- Customer-specific Kubernetes configuration needs
|
||||
- Changes for specific environments
|
||||
- Performance testing
|
||||
- Production deployment
|
||||
- Application-side coding, configuration, or tuning
|
||||
- Changes or configuration on assets used in ZITADEL
|
||||
- Setting up or maintaining backup storage
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Running Kubernetes with possibility to deploy to namespaces
|
||||
- Inbound and outbound HTTP/2 traffic possible
|
||||
- For being able to send SMS, we need a Twilio sender name, SID and an auth token
|
||||
- ZITADEL also needs to connect to an email relay of your choice. We need the SMTP host, user and app key as well as the ZITADEL emails sender address and name.
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: Recurring Trainings
|
||||
---
|
||||
|
||||
## ZITADEL Support Refresher
|
||||
|
||||
In this session you can refresh knowledge about existing and gain experience with new features of ZITADEL to keep the quality of your support high. We recommend an half day training per support staff.
|
||||
|
||||
**Audience**: 1st / 2nd Level Support Staff, Solution Owner, QA Manager (optional)
|
||||
**Duration**: 0.5 day / support staff
|
||||
|
||||
**Topics covered**:
|
||||
|
||||
* Walk-through new features
|
||||
* Review of difficult support issues
|
||||
* Review of customer feedback
|
||||
* Q&A
|
||||
|
||||
## ZITADEL Support Onboarding
|
||||
|
||||
In this hands-on training new support staff will get an overview of the system and learn how to configure and use ZITADEL to provide support for users.
|
||||
|
||||
**Audience**: 1st / 2nd Level Support Staff, Solution Owner, QA Manager (optional)
|
||||
**Duration**: 0.5 days / support staff
|
||||
|
||||
**Topics covered**:
|
||||
|
||||
* Event types
|
||||
* Accessing database
|
||||
* Logs and Errors
|
||||
* Validation of tokens
|
||||
* Walk-through key features
|
||||
* Q&A
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Troubleshoot
|
||||
---
|
||||
|
||||
You will find some possible error messages here, what the problem is and what some possible solutions can be.
|
||||
|
||||
:::tip Didn't find an answer?
|
||||
Join or [Chat](https://zitadel.com/chat) or open a [Discussion](https://github.com/zitadel/zitadel/discussions).
|
||||
:::
|
||||
|
||||
|
||||
## User Agent does not correspond
|
||||
|
||||
This error appeared for some users as soon as they were redirected to the login page of ZITADEL.
|
||||
ZITADEL uses some cookies to identify the browser/user agent of the user, so it is able to store the active user sessions. By blocking the cookies the functions of ZITADEL will be affected.
|
||||
|
||||
We only found this issue with iPhone users, and it was dependent on the settings of the device.
|
||||
|
||||
Go to the settings of the app Safari and check in the "Experimental WebKit Features" if SameSite strict enforcement (ITP) is disabled
|
||||
Also check if "block all cookies" is active. If so please disable this setting.
|
||||
|
||||
To make sure, that your new settings will trigger, please restart your mobile phone and try it again.
|
||||
|
||||
**Settings > Safari > Advanced > Experimental Features > disable: „SameSite strict enforcement (ITP)“**
|
||||
|
||||
|
||||
|
||||
**Settings > Safari > disable: "Block All cookies"**
|
||||
|
||||
|
||||
Do you still face this issue? Please contact us, and we will help you find out what the problem is.
|
||||
|
||||
## Instance not found
|
||||
|
||||
`ID=QUERY-n0wng Message=Instance not found`
|
||||
|
||||
If you're in an self-hosting scenario with a custom domain, you need to instruct ZITADEL to use the `ExternalDomain`.
|
||||
You can find more instruction in our guide about [custom domains](https://zitadel.com/docs/self-hosting/manage/custom-domain).
|
||||
We also provide a guide on how to [configure](https://zitadel.com/docs/self-hosting/manage/configure) ZITADEL with variables from files or environment variables.
|
||||
Reference in New Issue
Block a user