Install a custom configuration

This page covers how to install CloudBees CD/RO using the CLI-based Advanced option of the Linux full installer.

The Advanced option allows you to install any combination of the following CloudBees CD/RO components on the host machine with the option to configure custom settings:

Server
Web server
Repository server
Built-in database or custom database
Agent
CloudBees CD/RO tools (Required)

The built-in database does not support production or clustered environments.

Before you start

The following are important knowledge prerequisites to review before starting this procedure:

CloudBees recommends reviewing the following resources before installation:

CloudBees strongly suggests using the Advanced option when configuring production environments. For more information, refer to Installation types.

For production environments, CloudBees recommends installing each CloudBees CD/RO component on separate machines using the Advanced installation option.

Additionally, there are specific agent security recommendations available at Agent security recommendations.

If you have not already done so, download the full installer file. To download this version, select:

Linux full installer: 2024.12.0.177508
For more details on installers, refer to Install CloudBees CD/RO on traditional platforms.

For legacy installer downloads, navigate to CloudBees CD/RO downloads.
1. Start the installer:
  1. Enter the following command to make the installer file executable:
    
    Command
    Current version
    
    chmod +x CloudBeesFlow-x64-<version>
    ▼
    
    chmod +x CloudBeesFlow-x64-2024.12.0.177508
    ▼
  2. Start the installation:
    
    For more information about required user privileges, refer to Linux services user permissions.
    
    For root or sudo installations, run:
    
    Root or sudo procedures
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version>
    ▼
    
    ./CloudBeesFlow-x64-2024.12.0.177508
    ▼
    
    For root or sudo installations on Linux systems with a graphical interface systems, run:
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version> --mode console
    ▼
    
    ./CloudBeesFlow-x64-2024.12.0.177508 --mode console
    ▼
    
    For non-root/non-sudo installations, run:
    
    Non-root/non-sudo procedure
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version> --nonRoot
    ▼
    
    ./CloudBeesFlow-x64-2024.12.0.177508 --nonRoot
    ▼
    
    For non-root/non-sudo installations on Linux systems with a graphical interface systems, run:
    
    Command
    Current version
    
    ./CloudBeesFlow-x64-<version> \ --nonRoot \ --mode console
    ▼
    
    ./CloudBeesFlow-x64-2024.12.0.177508 \ --nonRoot \ --mode console
    ▼
    
    A warning about automatic server start-up with non-root/non- sudo installations appears. Enter Yes to dismiss the warning.

Perform an Advanced installation

The installer launch prompt appears. Enter Y to continue.
A prompt appears that describes the available installation types.
1. Enter advanced.

Prompts guide you through selecting which CloudBees CD/RO components to install.

For production environments, CloudBees recommends installing each CloudBees CD/RO component on separate machines using the Advanced installation option.

Additionally, there are specific agent security recommendations available at Agent security recommendations.

Specify which components to install by entering Y for the component:

Install a CloudBees CD/RO server? [n/Y]
# Built-in database prompt appears only if installing a CloudBees CD/RO server.
Install CloudBees CD/RO with the built-in database? [n/Y]
Install the CloudBees CD/RO web server (Apache-based)? [n/Y]
Install a CloudBees CD/RO repository server? [n/Y]▼

If you select to install any CloudBees CD/RO server, a CloudBees CD/RO agent and CloudBees Tools installation are also installed.

A prompt appears for sending telemetry data. Review the information and either:

Enter Y to to participate.

Enter n if you do not wish to participate.

If you select to send usage data, you can disable sending data at anytime by setting Server settings System setttings Send Usage Data to Disabled. This can be updated without reinstalling or upgrading CloudBees CD/RO.

A prompt appears to specify the installation directory. Either press Enter to accept the default, or provide a path to another directory.
A prompt appears to specify the data directory for data files, configurations, and logs. Either press Enter to accept the default, or provide a path to another directory.
Depending on the components you are installing, a series of prompts appear to specify the ports to use:
1. For each, press Enter to accept the port, or provide a custom port.
  Ports description
  If installing a CloudBees CD/RO server, prompts appear to specify the following:
  
  HTTP port.
  
  HTTPS port.
  
  File transfers.
  
  Database connection.
  
  If installing a CloudBees CD/RO web server, prompts appear to specify the following:
  
  HTTP port.
  
  HTTPS port.
  
  Additionally, if installing either a CloudBees CD/RO server or web server, prompts appear to specify the following:
  
  Agent port.
  
  Local port for the agent.
  
  If installing a CloudBees CD/RO repository server, a prompt appears to specify its port.
If installing a CloudBees CD/RO web server, a prompt appears to specify its host name URL.
1. Press Enter to accept the default, or provide a custom web server URL.
If installing a CloudBees CD/RO server, web server, or repository server, a prompt appears to specify the system user to run these services as.
If installing a CloudBees CD/RO server, web server, or repository server, a prompt appears to specify the group of the system user.

If installing a CloudBees CD/RO agent, the following prompt appears:

For security reasons, CloudBees strongly recommends NOT using the same user for the CloudBees CD/RO server and agents in production environments.
For more information, refer to:

https://docs.cloudbees.com/docs/cloudbees-cd/latest/install-trad/agent-config-recommendations

Do you want to use the same system account for CloudBees CD/RO server and the agent? [y/N]▼

For security, CloudBees recommends not installing agents on the server host or giving any agents access to the server file system. Doing so may give an agent access to sensitive files such as the server passkey, database configuration, and other system resources allotted to CloudBees CD/RO.

If the agent is installed on the server host or given access to the server file system (such as for short-lived development and testing), CloudBees strongly recommends using separate users for server and agent services. This helps prevent the agent from accessing sensitive files. Using the same user for both services gives an agent the same access permissions as the server user.

Additionally, CloudBees strongly recommends not running agents as sudo or ROOT users in production, or long-lived development and testing environments. Running agents with these privileges poses significant security risks, as they have unlimited ability to execute operations which can be used to access any file on the agent host, or modify the configuration of that host.

Assign CloudBees CD/RO agent users only the necessary privileges to perform their functions, following the Principle of Least Privilege (PoLP). This helps to prevent permission escalation and data exposure should an agent become compromised.

For more information on how to mitigate agent security risks, refer to Agent security recommendations.

If you enter Y, the installation begins.

If you enter N, you are prompted to configure the agent service account:

Configure agent service account

The following prompt appears:

Specify the system user the agent will run as []▼

Provide the system user to use when running agent services.

If you specify root as the agent service user, the following prompt appears:

For security reasons, CloudBees strongly recommends NOT using the 'root' user to run agent processes in production environments. For more
information, refer to:

https://docs.cloudbees.com/docs/cloudbees-cd/latest/install-trad/agent-config-recommendations

Do you still want to continue using the 'root' user to run agent processes? [y/N]▼

CloudBees strongly recommends not running the agent services as a root user. This can pose significant security concerns if the agent becomes compromised.

To accept this security risks, and run the agent as root, enter Y.

The following prompt appears:
```
Specify the system group the agent will run as []▼
```
1. Provide the system group of the user being used to run the agent services.

Once you have provided this information, the installation begins.

The installer displays a status bar to show the progress of the installation, which may take fifteen minutes or longer. Once the following message appears:

Copied log file(s) to "/opt/cloudbees/sda/logs"
CloudBees CD/RO <VERSION> was successfully installed!
Installer log file: /opt/cloudbees/sda/logs/installer.log.▼

You can navigate to the URL of the web server, and the status of the server start up is displayed. Once it is complete, the log in window appears.

The default sign in credentials are:

Username: admin
Password: changeme

On your first sign in, CloudBees strongly suggests to immediately change the default password. To do so:

Log into CloudBees CD/RO using the default credentials.
Navigate to Administration Users.
From the Users list, select admin. The Edit User window opens.
In the Current Password field, enter the default password.
In the New Password field, enter a new password.
Confirm your new password by entering it again in the Retype Password field.
Select OK.
Log out of CloudBees CD/RO, and then log back in using your new password.

For more information on sign in options, refer to Sign in to CloudBees CD/RO.

Configure autostart for non-root environments

For installations performed as a Windows Administrator or with Linux root or sudo privileges, CloudBees CD/RO components start automatically upon completing the installation and during system boot. However, for non-root/non-sudo Linux installations CloudBees CD/RO components do not have the permissions to start automatically.

To configure autostart for non-root or non-sudo Linux installations of CloudBees CD/RO components, refer to Configure autostart for non-root/non-sudo Linux installations.