Install a default configuration

This page covers how to install CloudBees CD/RO using the GUI-based Express Server option of Windows and Linux full installers.

To perform a GUI-based installation for Linux, you must have a graphical environment installed. If your Linux environment does not have a graphical environment installed, refer to the corresponding interactive Linux command-line option to continue installation.

The Express Server option installs the following CloudBees CD/RO components on the host machine using their default configurations:

Server
Web server
Repository server
Built-in database
Agent
CloudBees CD/RO tools

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:

The Express Server option should only be used for evaluation and local development and testing purposes. This option does not support 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.

Perform an Express Server installation

To perform an Express Server installation:

If you have not already done so, download the full installer file. To download this version, select your required installer:
- Windows full installer: 2024.12.0.177508
- 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.
Start the installer:
- Windows:
  Windows installers
  On Windows, an Administrator user is required to install CloudBees CD/RO. For more information about required user privileges, refer to Windows services user permissions.
  
  Navigate to the directory where you downloaded the CloudBees CD/RO installer.
  
  Double-click the installer. This starts the installer in the GUI-based installation mode.
- Linux:
  Linux installers
  Navigate to the directory where you downloaded the CloudBees CD/RO installer.
  
  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
  ▼
  
  Start the installation:
  
  For more information about required user privileges, refer to Linux services user permissions.
  
  For root or sudo installations:
  
  Root or sudo procedures
  
  Navigate to the directory where you downloaded CloudBees CD/RO.
  
  Double-click the installer. This starts the installer in the GUI-based installation mode.
  
  For non-root/non-sudo installations, from the terminal, run:
  
  Non-root/non-sudo procedures
  
  Command
  Current version
  
  ./CloudBeesFlow-x64-<version> --nonRoot
  ▼
  
  ./CloudBeesFlow-x64-2024.12.0.177508 --nonRoot
  ▼
  
  A warning about automatic server start-up with non-root/non- sudo installations appears. Select Yes to dismiss the warning.
Select the Express Server: Install CloudBees CD/RO with built-in database and default configuration installation option, and then select Next to continue.

On the Service account screen, follow the platform-specific instructions below:

Windows:

Configure Windows server service account:

Username: Enter the username of a host user to run the CloudBees CD/RO server, web server, and repository server services.
Password: Enter the password of the user entered in Username.
Domain: Enter the domain name information for the user. For example, electric-cloud.com.

Leave this field blank to run the agent as a local user.

Use the local system account: Select this checkbox if you want the CloudBees CD/RO server, repository server, and web server services to run as the local Windows system account.

The Windows local system account cannot access network resources, such as shared file systems used for plugins or workspaces. Therefore, do not use this option for a clustered server deployment, which requires a shared file system for plugins.

This option is typically used only for installing agents on numerous machines, which normally requires creating a new account on each machine.

Use the same account for the agent service: Select this checkbox to use the same account entered for the server to run agent services.

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.

Select Next to continue:

If you selected Use the same account for the agent service, the Ready to install screen appears.
If you did not select Use the same account for the agent service, the Agent service account screen appears.

Linux:

Configure Linux server service account:

Username: Enter the username of a host user to run the CloudBees CD/RO server, web server, and repository server services.
Group name: Enter the system group name for the user entered in Username.

Use the same account for the agent service: Select this checkbox to use the same account entered for the server to run agent services.

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

Select Next to continue:

If you selected Use the same account for the agent service, the Ready to install screen appears.
If you did not select Use the same account for the agent service, the Agent service account screen appears.

On the Agent service account screen, follow the platform-specific instructions below:

Windows:

Configure Windows agent service account:

Username: Enter the username of a host user to run the CloudBees CD/RO server, web server, and repository server services.

The user the agent runs as must have permission to write to the $INSTALL_DIRECTORY\log directory.
Password: Enter the password of the user entered in Username.
Domain: Enter the user’s domain name, such as electric-cloud.com. Leave this field blank if this is a local user.

Use the local system account: Select this checkbox if you want the CloudBees CD/RO agent service to run as the local Windows system account.

This option is typically used only for installing agents on numerous machines, which normally requires creating a new account on each machine.

Select Next to continue. The Ready to install screen appears.

Linux:
Configure Linux agent service account:
- Username: Enter the username of a host user to run CloudBees CD/RO agent processes.
  
  The user/group the agent runs as must have permission to write to the $INSTALL_DIRECTORY/log directory.
  
  If you specify root, select Yes when confirmation appears.
- Group name: Enter the system group name for the user entered in Username.
Select Next to continue. The Ready to install screen appears.

On the Ready to install screen, review the settings and your service account configurations.
- If any information is incorrect, use the Back button to navigate back through the configurations.

Select whether to send usage data. If you do not wish to participate, clear the Help improve CloudBees CD/RO? checkbox.

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.

Select Next to install CloudBees CD/RO.

The installer displays a status bar to show the progress of the installation. When the installation finishes, the Installation complete screen appears:

Select the Launch a web browser to log in to CloudBees CD/RO checkbox if you want CloudBees CD/RO to open when you exit the wizard.
Select Finish to close the wizard.

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.