docs: Updated outdated information and screenshots for customer portal docs (#7326)
* docs: updating customer portal docs * docs: portal instance page docs updated * docs: portal in docs updated * Update docs/docs/guides/manage/cloud/billing.md --------- Co-authored-by: Max Peintner <max@caos.ch>
@ -1,12 +1,21 @@
|
||||
---
|
||||
title: Billing
|
||||
title: Settings / Billing
|
||||
---
|
||||
|
||||
## General
|
||||
|
||||
In the general settings you can change your team name, notification settings and delete your team.
|
||||
|
||||

|
||||
|
||||
|
||||
## Billing
|
||||
|
||||
In the billing page shows your configured payment methods and the invoice
|
||||
|
||||

|
||||
|
||||
## Payment Method
|
||||
### 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
|
||||
@ -38,11 +47,14 @@ Depending on your billing address we will mark the invoice as reverse charge.
|
||||
|
||||
## Update Billing Information
|
||||
|
||||
You will only need to add billing information if your instance is in the paid tier. There are two options on how to add your billing info.
|
||||
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.
|
||||
|
||||
2. Go to the billing menu and add a new payment method. You will be able to choose the added method, when upgrading the instance to the paid tier.
|
||||
3. Add the billing information directly during the upgrade process.
|
||||
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.
|
||||
We show all you invoices, and you are able to download them directly in the Customer Portal.
|
||||
|
||||
|
||||

|
||||
|
@ -4,30 +4,34 @@ sidebar_label: Instances
|
||||
---
|
||||
|
||||
The ZITADEL Customer Portal is used to manage all your different ZITADEL instances.
|
||||
You can also manage your subscriptions, billing, newsletters and support requests.
|
||||
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 a specific customer.
|
||||
You can directly see what kind of subscription the instance has and in which data region it is stored.
|
||||
With a click on a instance row you get to the detail of the chosen instance.
|
||||
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. Choose if you like to start with the free or the pay as you go tier
|
||||
3. Choose your options (pay as you go)
|
||||
1. Data Region: The region where your data is stored
|
||||
2. Custom Domain: We generate a default domain ({instance-name}-{random-string}.zitadel.cloud), but you can choose you custom domain
|
||||
3. If our basic SLA and Support is not enough, you can extend it
|
||||
4. Check the summary
|
||||
5. Add you payment method (pay as you go)
|
||||
6. Return to Customer Portal
|
||||
7. Instance created!
|
||||
|
||||
You will get an email to initialize your first user of the instance and to access the new created ZITADEL 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.
|
||||
|
||||
:::info
|
||||
Every new instance gets a generated domain of the form [instancename][randomnumber].zitadel.cloud
|
||||
@ -37,77 +41,54 @@ Every new instance gets a generated domain of the form [instancename][randomnumb
|
||||
|
||||
## Detail
|
||||
|
||||
The detail shows you general information about your instance, which options you have and your usage.
|
||||
The detail shows you general information about your instance, the region and your usage.
|
||||
|
||||

|
||||
|
||||
### Upgrade Instance
|
||||
### Upgrade to Pro
|
||||
|
||||
A free instance can be upgraded to a "pay as you go" instance. By upgrading your authenticated request will no longer be capped and you will be able to choose more options. To upgrade you must enter your billing information.
|
||||
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.
|
||||
|
||||
1. Go to the detail of your instance
|
||||
2. Click "Upgrade to paid tier!" in the General Information
|
||||
3. Choose the options you need (can be changed later)
|
||||
1. Data Region
|
||||
2. Custom Domain
|
||||
3. Extended SLA
|
||||
4. Add a payment method or choose an existing one
|
||||
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. Go to the settings tab
|
||||
2. You can now see your Plan: "FREE"
|
||||
3. Click "Upgrade"
|
||||
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 your instance
|
||||
2. Click **Add custom domain**
|
||||
3. To start the domain verification click the domain name and a dialog will appear, where you can choose between DNS or HTTP challenge methods.
|
||||
4. For example, create a TXT record with your DNS provider for the used domain and click verify. ZITADEL will then proceed an check your DNS.
|
||||
5. When the verification is successful you have the option to activate the domain by clicking **Set as primary**
|
||||
1. Browse to the "Custom Domains" Tab
|
||||
2. Click **Add**
|
||||
3. Enter the domain you want and select the instance where the domain should belong to
|
||||
4. In the next screen you will get all the information you will have to add to your DNS provider to verify your domain
|
||||
|
||||
> **_Please note:_** Do not delete the verification code, as ZITADEL Customer Portal will re-check the ownership of your domain from time to time
|
||||
|
||||
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. Passwordless authentication is based on the domain, if you change it, your users will not be able to login with the registered passwordless authentication
|
||||
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
|
||||
|
||||
If you need a custom domain for your ZITADEL instance, you need to verify the 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)
|
||||
|
||||
You will now be able to use the added custom domain to access your ZITADEL instance
|
||||
|
||||
### Change Options
|
||||
|
||||
You can change your selected options in the detail of your instance.
|
||||
This can have an impact on your instance cost.
|
||||
|
||||
1. Go to the detail of your instance
|
||||
2. Click the edit button on the Options section
|
||||
3. Choose your options
|
||||
1. Extended SLA
|
||||
2. Data Region
|
||||
4. Save
|
||||
|
||||

|
||||
|
||||
### Downgrade Instance
|
||||
|
||||
If you are in the "Pay as you go tier" with your instance, you can downgrade it to the free tier.
|
||||
|
||||
:::caution
|
||||
Be aware that this might have an impact for your users and application.
|
||||
If you have registered a custom domain, it will be deleted.
|
||||
The data region will be set to "Global", if you have selected something else.
|
||||
:::
|
||||
|
||||
1. Go to the detail of your instance
|
||||
2. Click "Change to free tier" in the General Information
|
||||
3. You will see an overview of what happens when downgrading, click "Downgrade anyway"
|
||||
4. In the popup you need to confirm by clicking "I am sure"
|
||||
|
@ -1,22 +0,0 @@
|
||||
---
|
||||
title: ZITADEL Notifications
|
||||
sidebar_label: Notifications
|
||||
---
|
||||
|
||||
You can subscribe to different newsletters and notifications.
|
||||
|
||||
## Change Notification/Newsletter settings
|
||||
|
||||
1. Click on your user avatar in the top right
|
||||
2. In the menu that has opend you can see click on "Edit Notifications"
|
||||
3. You can see all the different newsletters and notifications and can now enable or disable them
|
||||
|
||||
|
||||

|
||||
|
||||
## Notifications
|
||||
|
||||
Onboarding: The onboarding list will provide you with some information when you first created your account
|
||||
Newsletter: The newsletter will contain any news about the company, the product and what happens around. (e.g Blogs, Funding, etc)
|
||||
Product News: You will get some news about the product, changes and new features
|
||||
Security: Security should possibly not be disabled, we will send some security relevant information and critical issues here.
|
@ -8,19 +8,18 @@ If you are new to ZITADEL your first action is to create your first ZITADEL inst
|
||||
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.cloud) and enter all the detail information.
|
||||
As soon as you click "Let's go" you will get two initialization mails to finish your registration.
|
||||
One is for your Customer Portal account and the other for your new created ZITADEL instance, verify both to be able to login to the systems.
|
||||
|
||||
To get started, enter the following data:
|
||||
|
||||
- Firstname
|
||||
- Lastname
|
||||
- Email
|
||||
- Username
|
||||
- Organization Name
|
||||
Go to [ZITADEL Customer Portal](https://zitadel.com) and start by entering you email or use an existing account like Google.
|
||||
|
||||

|
||||
|
||||
The instance you have created will automatically be in the free subscription, which already allows you to use all the features.
|
||||
Sign in to [ZITADEL Customer Portal](https://zitadel.cloud), to manage all you instances.
|
||||
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.
|
||||
|
@ -6,7 +6,14 @@ sidebar_label: Support
|
||||
:::note
|
||||
We describe our [support services](/docs/legal/service-description/support-services) and information required in more detail in our legal section. Beware that not all features may be supported by your subscription and consult the [support states](/docs/support/software-release-cycles-support#support-states).
|
||||
:::
|
||||
In the header you can find a button for the support.
|
||||
|
||||
## General
|
||||
|
||||
We always recommend first having a look at our [documentation](/docs), [discord chat](https://zitadel.com/chat) and [GitHub repository](https://github.com/zitadel/zitadel)
|
||||
|
||||

|
||||
|
||||
## Support Request
|
||||
|
||||
Create a new support request with the following information:
|
||||
- Subject
|
||||
|
@ -1,32 +1,32 @@
|
||||
---
|
||||
title: Customer Portal Users in ZITADEL
|
||||
sidebar_label: Customer Portal Users
|
||||
title: Customer Portal Administrators
|
||||
sidebar_label: Customer Portal Administrators
|
||||
---
|
||||
|
||||
Manage all your users who are allowed to access the Customer Portal.
|
||||
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 user
|
||||
## Add new administrator
|
||||
|
||||
1. Go to the Users tab in the ZITADEL Customer Portal
|
||||
2. Click the button "Create user"
|
||||
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 get a verification email, by clicking the button in the mail, he will get to the user activation screen and has to enter a password.
|
||||
|
||||

|
||||

|
||||
|
||||
## Delete user
|
||||
## Delete administrator
|
||||
|
||||
1. Go to the Users tab in the ZITADEL Customer Portal
|
||||
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
|
||||
|
||||

|
||||

|
||||
|
@ -1,55 +0,0 @@
|
||||
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
|
||||
|
||||

|
||||
|
||||
## 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](/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
|
||||

|
||||
|
||||
## 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:**
|
||||

|
||||
|
||||
**Console - Landing Page**
|
||||

|
||||
|
||||
## Manage Instance and Billing
|
||||
|
BIN
docs/static/img/manuals/portal/customer_portal_add_admin.png
vendored
Normal file
After Width: | Height: | Size: 279 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_add_domain.png
vendored
Normal file
After Width: | Height: | Size: 218 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_administrator_list.png
vendored
Normal file
After Width: | Height: | Size: 214 KiB |
Before Width: | Height: | Size: 203 KiB After Width: | Height: | Size: 318 KiB |
Before Width: | Height: | Size: 223 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_delete_admin.png
vendored
Normal file
After Width: | Height: | Size: 278 KiB |
Before Width: | Height: | Size: 245 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_general_support.png
vendored
Normal file
After Width: | Height: | Size: 201 KiB |
Before Width: | Height: | Size: 326 KiB After Width: | Height: | Size: 353 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_instance_overview.png
vendored
Normal file
After Width: | Height: | Size: 217 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_invoices.png
vendored
Normal file
After Width: | Height: | Size: 458 KiB |
Before Width: | Height: | Size: 1.1 MiB After Width: | Height: | Size: 220 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_landing_page_2.png
vendored
Normal file
After Width: | Height: | Size: 257 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_landing_page_3.png
vendored
Normal file
After Width: | Height: | Size: 340 KiB |
Before Width: | Height: | Size: 4.4 MiB After Width: | Height: | Size: 713 KiB |
Before Width: | Height: | Size: 195 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_settings_general.png
vendored
Normal file
After Width: | Height: | Size: 283 KiB |
Before Width: | Height: | Size: 223 KiB After Width: | Height: | Size: 303 KiB |
BIN
docs/static/img/manuals/portal/customer_portal_upgrade_tier.png
vendored
Normal file
After Width: | Height: | Size: 186 KiB |
Before Width: | Height: | Size: 166 KiB |
BIN
docs/static/img/manuals/portal/portal_add_domain.png
vendored
Before Width: | Height: | Size: 266 KiB |
Before Width: | Height: | Size: 295 KiB |