Domain Manager

Note: This feature is available in Enterprise and Team editions only. For Team Edition, the configuration is accessible exclusively through the web interface.

Overview

The Domain Manager in CloudBeaver enables you to configure custom subdomains for your server. This feature is essential for organizations that manage multiple environments, such as development, testing, and production, or different projects within the same main domain. The ability to create distinct subdomains makes it easier to organize, access, and manage different project stages, thereby enhancing efficiency and clarity in operations.

Key features

• Automatic configuration: When deploying using the Team Edition or CloudBeaver Enterprise deployment repositories, everything works seamlessly out of the box.

• Subdomain customization: Administrators have the ability to set up a specific subdomain within the organization’s domain.

• SSL certificate integration: During the Domain Manager setup, an SSL certificate is automatically generated via Let’s Encrypt, ensuring that the connection to the server remains secure. Learn more

Domain manager configuration

You can access the Domain Manager during the initial server configuration or modify settings after CloudBeaver has been fully set up.

• Initial setup: You can specify the subdomain during the initial server configuration. Learn more

• Modifying domain settings: You can adjust the subdomain at any time after the application has been launched. Learn more

Initial setup

To configure a custom subdomain during the initial setup, follow these steps:

1. Navigate to the Domain Manager tab during the initial server configuration.
2. Fill in the necessary fields as detailed in the table below.
3. Submit your settings and wait for the domain registration to complete. There may be a waiting period for domain registration.
4. Once the domain is active, you will be redirected to your server at the newly constructed domain, e.g., development.example-corp.databases.com.

Configuration fields

Field/Button	Description
Organization Subdomain	Specify the Organizational subdomain. Automatically assigned during initial setup based on your licence.
Deployment Subdomain (Optional)	Specify the Deployment subdomain for managing multiple environments, such as development or test.
Server Address	Provide the address where your CloudBeaver server is hosted.
Delete	Delete the Organizational subdomain.

Modifying domain settings

Once CloudBeaver is operational, you can modify the domain settings to better suit evolving needs or correct initial configurations.

To modify your domain settings, follow these steps:

1. Log in as an administrator.
2. Navigate to Settings -> Administration -> Domain Manager.
3. Fill in the necessary fields.
4. Submit your settings and wait for the domain registration to complete. There may be a waiting period.
5. Once the domain is active, you will be redirected to your server at the newly constructed domain, e.g., development.example-corp.databases.com.

Important notes

• The Organization subdomain can be changed once. If it is already set, you must delete it before assigning a new one.
• After deleting a subdomain, the service will be accessible via the Server's Address.
• Changes to the Deployment Subdomain only affect the specified Server Address.
• You can change the Deployment Subdomain up to three times per calendar month.
• The subdomain name can have up to 32 characters and must comply with standard website domain validity criteria.
• After removing or modifying the subdomain, you may lose access to the server, and cloud-based Single Sign-On (SSO) functionality may cease to work. Ensure that one of the following authentication methods is configured and operational: IAM, NTLM, LDAP, or local access.

SSL certification

CloudBeaver uses an automated system to secure your server connections with SSL certificates from Let's Encrypt. This setup is available both during the initial server configuration and when making adjustments via the admin panel. The system utilizes a pre-configured nginx environment integrated with Certbot, which automatically handles the generation and renewal of SSL certificates. Specify your subdomain during setup, and the system will manage the SSL configuration on your behalf.

Each generated SSL certificate for the subdomain is valid for three months. To ensure continuous security and functionality, the server automatically initiates the certificate renewal process one month before the certificate's expiration.

Manual configuration

If you have specific SSL certificate needs or require a custom configuration, you have to set up it manually. This option involves editing the nginx configuration files yourself to integrate your SSL certificate. It is suitable for users with unique security needs or those who prefer to handle their SSL configurations on their own.