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 provides a crucial solution for users needing a custom domain on servers without pre-assigned domains. The primary benefit of this feature is the quick and easy setup of a custom domain with HTTPS and SSL encryption. It automates SSL certificate management, enabling the secure activation of your domain in just a few clicks, without manually handling certificates.

Key Features

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

• Domain creation on a bare server: Setting up a domain on a server without any existing domains can be complicated, often requiring changes to DNS settings and other technical configurations. The Domain Manager simplifies this process, making it easy to set up a domain and improve accessibility and management without complex manual setup. CloudBeaver provides the domain .databases.team, which you can customize by choosing your own subdomain names. The full domain name will follow the format <deployment_subdomain>.<organization_subdomain>.databases.team.

• SSL certificate and HTTPS implementation: The Domain Manager automates SSL certificate generation through Let’s Encrypt, securing server connections and enabling HTTPS on all custom subdomains. This feature is useful for servers that need to integrate with identity providers like OAuth or SAML, as these providers require HTTPS for secure authentication. This automation helps your server support web-based authentication protocols securely. 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.team.

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 example development or test.
Server Address	Provide the IP 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.team.

Important notes

• The Domain Manager operates only if there is no existing domain configured for the server.
• 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, cloud-based Single Sign-On (SSO) might stop working. Make sure that the local access is set up.

SSL certification

CloudBeaver uses an automated system to secure your server connections with SSL certificates from Let's Encrypt, ensuring that your custom domain is also served over HTTPS. This setup is available during the initial server configuration as well as when making adjustments through the admin panel. The system utilizes a pre-configured nginx environment integrated with Certbot, which automatically handles the generation and renewal of SSL certificates.

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 already have your own SSL certificate and a specific domain you want to set up, you will need to configure it manually. This process requires editing the nginx configuration files to integrate your SSL certificate. For detailed instructions on manual setup, visit the deployment repositories for Team Edition or CloudBeaver Enterprise.