mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
docs: move customer portal docs to knowledge base (#12147)
Moved the Customer Portal Documentation to the knowledge base (help.zitadel.com)
This commit is contained in:
Federico Coppede
@@ -11,4 +11,4 @@ By configuring a Custom Domain within ZITADEL, organizations can replace the def
|
||||
|
||||
This not only enhances the overall user experience but also reinforces the organization's brand presence. Additionally, Custom Domains can contribute to trust and credibility, as users are more likely to recognize and trust URLs associated with the organization rather than generic domains. Overall, ZITADEL's Custom Domain feature empowers organizations to tailor the authentication process to align with their brand identity and user expectations.
|
||||
|
||||
Learn how to [configure a Custom Domain in ZITADEL Cloud](/guides/manage/cloud/instances#add-custom-domain) or how to configure [Custom Domain when self-hosting](/self-hosting/manage/custom-domain).
|
||||
Learn how to [configure a Custom Domain in ZITADEL Cloud](https://help.zitadel.com/customer-portal-instances#add-custom-domain) or how to configure [Custom Domain when self-hosting](/self-hosting/manage/custom-domain).
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
---
|
||||
title: Billing
|
||||
description: "Manage billing, payment methods, and customer details in ZITADEL Cloud."
|
||||
---
|
||||
|
||||
## Billing
|
||||
|
||||
In the billing page shows your configured payment methods and the invoice
|
||||
|
||||
|
||||
|
||||
### Payment Method
|
||||
|
||||
If you click on the "+" Button a popup will be shown with the needed fields to add a new payment method.
|
||||
At the moment we provide only "Credit Card" payment
|
||||
|
||||
Once a payment method is configured, it can be selected directly in the instance creation process.
|
||||
|
||||
## Customer
|
||||
|
||||
To be able to create correct billings we will need some customer information from you.
|
||||
This includes the following fields:
|
||||
|
||||
- Name
|
||||
- Country
|
||||
- Email address
|
||||
- Address line 1
|
||||
- Address line 2
|
||||
- Postal Code
|
||||
- City
|
||||
|
||||
## Tax ID
|
||||
|
||||
If available, enter your tax ID type and VAT number.
|
||||
The tax ID will be shown on the invoice.
|
||||
|
||||
<Callout title="Reverse Charge">
|
||||
When you enter the tax ID we will automatically calculate taxability.
|
||||
Depending on your billing address we will mark the invoice as reverse charge.
|
||||
</Callout>
|
||||
|
||||
## Update Billing Information
|
||||
|
||||
You will only need to add billing information if your want to get the pro tier. There are two options on how to add your billing info.
|
||||
|
||||
1. Go to the billing menu and add a new payment method.
|
||||
2. Add the billing information directly during the upgrade process.
|
||||
|
||||
## Invoices
|
||||
|
||||
We show all you invoices, and you are able to download them directly in the Customer Portal.
|
||||
|
||||
|
||||
@@ -1,98 +0,0 @@
|
||||
---
|
||||
title: ZITADEL Instances
|
||||
description: "Create and manage multiple ZITADEL instances for dev, test, and production environments in the Customer Portal."
|
||||
sidebar_label: Instances
|
||||
---
|
||||
|
||||
The ZITADEL Customer Portal is used to manage all your different ZITADEL instances.
|
||||
Instances are containers for your organizations, users and projects.
|
||||
A recommended setup could look like the following:
|
||||
1. Instance: "Dev Environment"
|
||||
2. Instance: "Test Environment"
|
||||
3. Instance: "Prod Environment"
|
||||
|
||||
In the free subscription model you have one instance included.
|
||||
To be able to add more instances please upgrade to "ZITADEL Pro".
|
||||
|
||||
## Overview
|
||||
|
||||
The overview shows all the instances that are registered for your customer.
|
||||
You can directly see the Custom Domain and data region.
|
||||
With a click on an instance you get to the detail of the chosen instance.
|
||||
|
||||
|
||||
|
||||
## New instance
|
||||
|
||||
Click on the new button above the instance table to create a new instance.
|
||||
|
||||
1. Enter the name of your new instance
|
||||
2. Add the credentials for your first administrator
|
||||
- Username (prefilled)
|
||||
- Password
|
||||
3. Instance created! You can now see the details of your first instance.
|
||||
|
||||
<Callout type="info">
|
||||
Every new instance gets a generated domain of the form [instancename][randomnumber].zitadel.cloud
|
||||
</Callout>
|
||||
|
||||
|
||||
|
||||
## Detail
|
||||
|
||||
The detail shows you general information about your instance, the region and your usage.
|
||||
|
||||
|
||||
|
||||
### Upgrade to Pro
|
||||
|
||||
Your first instance is included in the free subscription.
|
||||
As soon as you want to create your second instance or use a "pro" feature like choosing the region, you will have to upgrade to the Pro subscription.
|
||||
To upgrade you must enter your billing information.
|
||||
|
||||
If you hit a limit from the free tier you will automatically be asked to add your credit card information and to subscribe to the pro tier.
|
||||
You can also upgrade manually at any time.
|
||||
|
||||
1. Click the "Upgrade to PRO" button in the menu or go to the billing menu
|
||||
2. If you choose the billing menu, you can now see your Free plan, click "Upgrade to Pro"
|
||||
4. Add the missing data
|
||||
- Payment method: Credit Card Information
|
||||
- Customer: At least you have to fill the country
|
||||
5. Save the information
|
||||
|
||||
|
||||
|
||||
### Add Custom Domain
|
||||
|
||||
We recommend register a Custom Domain to access your ZITADEL instance.
|
||||
The primary Custom Domain of your ZITADEL instance will be the issuer of the instance. All other Custom Domains can be used to access the instance itself
|
||||
|
||||
1. Browse to the "Instances" Tab
|
||||
2. Click on the instance box to open the instance detailed view
|
||||
3. Scroll down to the **Custom Domains** section
|
||||
4. Click on **+ Add Custom Domain**
|
||||
5. Enter the domain you want
|
||||
6. In the next screen you will get all the information you will have to add to your DNS provider to verify your domain
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Be aware that it has some impacts if you change the primary domain of your instance.
|
||||
|
||||
1. The urls and issuer have to change in your app
|
||||
2. Passkey authentication is based on the domain, if you change it, your users will not be able to login with the registered passkey authentication
|
||||
|
||||
#### Verify Custom Domain
|
||||
|
||||
As soon as you have added your Custom Domain you will have to verify it, by adding a CNAME record to your DNS provider.
|
||||
|
||||
|
||||
|
||||
1. Go to your DNS provider
|
||||
2. Add a new CNAME record (You can find the target on the detail page of your instance)
|
||||
3. After adding the CNAME you need to wait till the domain is verified (this can take some time)
|
||||
|
||||
> **_Please note:_** Do not delete the verification code, as ZITADEL Customer Portal will re-check the ownership of your domain periodically.
|
||||
|
||||
You will now be able to use the added Custom Domain to access your ZITADEL instance
|
||||
@@ -11,9 +11,9 @@ import { Card, Cards } from 'fumadocs-ui/components/card';
|
||||
import { FileText, Folder, Link as LinkIcon } from 'lucide-react';
|
||||
|
||||
<Cards>
|
||||
<Card title="Start" href="/guides/manage/cloud/start" icon={<FileText />} />
|
||||
<Card title="Instances" href="/guides/manage/cloud/instances" icon={<FileText />} />
|
||||
<Card title="Settings" href="/guides/manage/cloud/settings" icon={<FileText />} />
|
||||
<Card title="Billing" href="/guides/manage/cloud/billing" icon={<FileText />} />
|
||||
<Card title="Users" href="/guides/manage/cloud/users" icon={<FileText />} />
|
||||
<Card title="Start" href="https://help.zitadel.com/customer-portal-getting-started" icon={<FileText />} external />
|
||||
<Card title="Instances" href="https://help.zitadel.com/customer-portal-instances" icon={<FileText />} external />
|
||||
<Card title="Settings" href="https://help.zitadel.com/customer-portal-settings" icon={<FileText />} external />
|
||||
<Card title="Billing" href="https://help.zitadel.com/customer-portal-billing" icon={<FileText />} external />
|
||||
<Card title="Users" href="https://help.zitadel.com/customer-portal-administrators" icon={<FileText />} external />
|
||||
</Cards>
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: Settings
|
||||
description: "Configure your ZITADEL Cloud team settings, including notification preferences and subscriptions."
|
||||
---
|
||||
|
||||
In the settings you can change your team name, notification settings and delete your team.
|
||||
|
||||
|
||||
|
||||
## Team name
|
||||
|
||||
Change your ZITADEL Cloud team name by entering a new name.
|
||||
Confirm the changes by clicking the Change button.
|
||||
|
||||
## Notifications and newsletters
|
||||
|
||||
You can subscribe and unsubscribe to notifications and newsletters:
|
||||
|
||||
- Onboarding: Welcome information for new users
|
||||
- Newsletter: Regular newsletter on ZITADEL
|
||||
- Product News: Receive product updates
|
||||
- Security: Receive notifications related to security issues
|
||||
|
||||
<Callout title="Technical Advisories">
|
||||
If you want to stay up to date on our technical advisories, we recommend [subscribing here to the mailing list](/support/technical_advisory#subscribe-to-our-mailing-list).
|
||||
|
||||
Technical advisories are notices that report major issues with ZITADEL Self-Hosted or the ZITADEL Cloud platform that could potentially impact security or stability in production environments.
|
||||
</Callout>
|
||||
|
||||
You can also manage your subscriptions by clicking the unsubscribe link in the emails.
|
||||
|
||||
<Callout title="Mandatory Information">
|
||||
We are required to inform you about changes to the terms of service or based on regulatory requirements. You can't unsubscribe to these notifications.
|
||||
</Callout>
|
||||
|
||||
## Delete team
|
||||
|
||||
Permanently delete your ZITADEL Cloud account.
|
||||
This will delete your team and delete all associated information.
|
||||
|
||||
Click **Delete Account** and confirm the next step.
|
||||
|
||||
## Update billing information
|
||||
|
||||
Refer to the [billing guide](./billing).
|
||||
@@ -1,26 +0,0 @@
|
||||
---
|
||||
title: Getting Started with ZITADEL
|
||||
description: "Create your ZITADEL Cloud account and first instance."
|
||||
sidebar_label: Getting Started
|
||||
---
|
||||
|
||||
If you are new to ZITADEL your first action is to create your first ZITADEL instance and an account to access the ZITADEL Customer Portal.
|
||||
|
||||
The ZITADEL customer Portal is used to manage all your different ZITADEL instances.
|
||||
You can also manage your subscriptions, billing, newsletters and support requests.
|
||||
|
||||
Go to [ZITADEL Customer Portal](https://zitadel.com) and start by entering you email or use an existing account like Google.
|
||||
|
||||
|
||||
|
||||
In a second step fill out your user data like First-, Last- and Team-name.
|
||||
|
||||
|
||||
|
||||
If you did start with your email instead of a social login (e.g. Google) you have to fill a password for your authentication.
|
||||
In that case you will get an initialization mail to verify your account.
|
||||
|
||||
|
||||
|
||||
You are now registered with a free account and ready to try all the features of ZITADEL.
|
||||
Sign in to [ZITADEL Customer Portal](https://zitadel.com), to manage all you instances.
|
||||
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: Customer Portal Administrators
|
||||
description: "Manage administrators who have access to the ZITADEL Customer Portal."
|
||||
sidebar_label: Customer Portal Administrators
|
||||
---
|
||||
|
||||
Manage all your administrators who are allowed to access the Customer Portal.
|
||||
For the moment all users with access to the Customer Portal will have the role "Admin".
|
||||
|
||||
|
||||
|
||||
## Add new administrator
|
||||
|
||||
1. Go to the Administrators tab in the ZITADEL Customer Portal
|
||||
2. Click the button "Create"
|
||||
3. Fill in the Firstname, Lastname, Email and the username
|
||||
4. Click create
|
||||
|
||||
The user will receive a verification email. Clicking the button in the email will lead to the user activation screen where password creation is required.
|
||||
|
||||
|
||||
|
||||
## Delete administrator
|
||||
|
||||
1. Go to the Administrators tab in the ZITADEL Customer Portal
|
||||
2. Click the bin icon in the users table for the user you like to delete
|
||||
3. You will get a popup, where you have to enter the login name of the user to confirm that you like to delete the user
|
||||
4. Click the "delete" button
|
||||
|
||||
The user will be deleted and has no access to the Customer Portal anymore
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ Domain discovery is typically used in [B2B](./b2b) or [SaaS](./saas) scenarios w
|
||||
|
||||
|
||||
|
||||
In the example there is a service provider with a ZITADEL instance running on a [Custom Domain](/guides/manage/cloud/instances#add-custom-domain) on `login.mycompany.com`.
|
||||
In the example there is a service provider with a ZITADEL instance running on a [Custom Domain](https://help.zitadel.com/customer-portal-instances#add-custom-domain) on `login.mycompany.com`.
|
||||
By default, all users login on the organization **CIAM** with their preferred social login provider.
|
||||
|
||||
Users of the two business customers **Alpha** and **Beta** should log in, according to their organization login and access policy settings.
|
||||
|
||||
@@ -53,10 +53,10 @@ You can use ZITADEL in two ways:
|
||||
- **ZITADEL Cloud**: This is our public cloud service. Use the free tier to start in minutes.
|
||||
- **Self-hosted ZITADEL**: For full control, deploy ZITADEL wherever you prefer.
|
||||
|
||||
If you're unsure, consider the generous free tier of [ZITADEL Cloud](/guides/manage/cloud/start).
|
||||
If you're unsure, consider the generous free tier of [ZITADEL Cloud](https://help.zitadel.com/customer-portal-getting-started).
|
||||
|
||||
<Cards>
|
||||
<Card title="ZITADEL Cloud" href="/guides/manage/cloud/start" icon={<Server />}>
|
||||
<Card title="ZITADEL Cloud" href="https://help.zitadel.com/customer-portal-getting-started" icon={<Server />} external >
|
||||
Choose if you want:
|
||||
- A turnkey solution that's ready to go
|
||||
- Global scalability without the hassle
|
||||
|
||||
@@ -181,7 +181,7 @@ Caches:
|
||||
All HTTP and gRPC requests sent to ZITADEL receive an instance context. The instance is usually resolved by the domain from the request. In some cases, like the [system service](/reference/api/system), the instance can be resolved by its ID. An instance object contains many of the [default settings](/reference/api/system), the instance can be resolved by its ID. An instance object contains many of the [default settings](/guides/manage/console/default-settings):
|
||||
|
||||
- Instance [features](/guides/manage/console/default-settings#features)
|
||||
- Custom Domains: generated and [custom](/guides/manage/cloud/instances#add-custom-domain)
|
||||
- Custom Domains: generated and [custom](https://help.zitadel.com/customer-portal-instances#add-custom-domain)
|
||||
- [Trusted domains](/apis/resources/admin/admin-service-add-instance-trusted-domain)
|
||||
- Security settings ([IFrame policy](/guides/solution-scenarios/configurations#embedding-zitadel-in-an-iframe))
|
||||
- Limits[^2]
|
||||
|
||||
@@ -690,25 +690,6 @@ export const guidesSidebar: readonly SidebarItem[] = [
|
||||
items: [
|
||||
"guides/manage/console/console-overview",
|
||||
"guides/manage/cloud/egress",
|
||||
{
|
||||
type: "category",
|
||||
label: "Customer Portal",
|
||||
collapsed: true,
|
||||
link: {
|
||||
type: "generated-index",
|
||||
title: "Overview",
|
||||
slug: "guides/manage/cloud/overview",
|
||||
description:
|
||||
"Our customer portal is used to manage all your ZITADEL instances. You can also manage your subscriptions, billing, newsletters and support requests.",
|
||||
},
|
||||
items: [
|
||||
"guides/manage/cloud/start",
|
||||
"guides/manage/cloud/instances",
|
||||
"guides/manage/cloud/settings",
|
||||
"guides/manage/cloud/billing",
|
||||
"guides/manage/cloud/users",
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Self-Hosted",
|
||||
|
||||
Reference in New Issue
Block a user