Hybrid Data Pipeline supports branding or white labeling the Web UI. Branding information is persisted in the CSS and properties files. The CSS file determines branding information such as colors, background, name, and logo. The properties file may be used to specify the browser window title and icon path. By modifying the CSS and properties files, you may brand the Web UI during or after the deployment of the Hybrid Data Pipeline server. Branding updates are persisted across upgrades.

Branding during installation or upgrade

  1. Download the sample CSS file from the following GitHub location: https://github.com/progress/Hybrid-Data-Pipeline/blob/main/Branding/hdp-branding.css.
  2. Download the sample properties file from the following GitHub location: https://github.com/progress/Hybrid-Data-Pipeline/blob/main/Branding/hdp-branding.properties.
  3. Update the sample files according to your specifications.
  4. Create a user-specified, external key location. See Shared files and the key location for details.
  5. Copy the hdp-branding.css and hdp-branding.properties files to the user-specified key location.
  6. Run the installation program. When you run the installer, you should select the Custom installation type. This will allow you to specify the external key location you created. See Installing and upgrading the Hybrid Data Pipeline server for more information.
  7. Run the installation program on each node that will be running the service.
Note: To brand the Web UI, you must select the Custom installation type and specify an external key location. You cannot brand the Web UI using the Typical installation type or the default key location.

Branding after installation or upgrade

  1. Update the hdp-branding.css file in the user-specified, external key location. The sample CSS file can be found in the install folder .../ddcloud/samples/branding/hdp-branding.css.
  2. Update the hdp-branding.properties file in the user-specified, external key location. The sample properties file can be found in the install folder .../ddcloud/samples/branding/hdp-branding.properties.
  3. Restart the Hybrid Data Pipeline server. For cluster deployments, restart the server on each node in the cluster.
    1. Run the stop service script.
      ./install_dir/ddcloud/stop.sh
      Note: Shutting down Hybrid Data Pipeline can take a few minutes. Wait until you see the Shutdown complete message displayed on the console before taking any additional actions.
    2. Run the start service script.
      ./install_dir/ddcloud/start.sh

Branding a Docker deployment

  1. Download the sample CSS file from the following GitHub location: https://github.com/progress/Hybrid-Data-Pipeline/blob/main/Branding/hdp-branding.css.
  2. Download the sample properties file from the following GitHub location: https://github.com/progress/Hybrid-Data-Pipeline/blob/main/Branding/hdp-branding.properties.
  3. Update the sample files according to your specifications.
  4. Create a shared file location. The shared file location is an external file location where keys and other information is persisted for one or more Docker containers. See Shared files and the key location for details.
  5. Copy the hdp-branding.css and hdp-branding.properties files to the shared file location.
  6. Execute the Docker run command to deploy Hybrid Data Pipeline. The command must specify the shared location to which you copied the CSS and properties files. See Deploying Hybrid Data Pipeline using Docker for details.