Automation Platform Tasks

Running an Express Server Graphical User Interface Installation

4 minute read

The express server installation installs the CloudBees CD server, including the web server, built-in database, agent (for running jobs), and CloudBees CD tools. Review Before You Install CloudBees CD before performing this procedure.

The built-in database is not supported in a clustered CloudBees CD configuration.

  1. (Linux only) Enter the following command to make the installer file executable:

    chmod +x ./CloudBeesFlow-<version>
  2. Do one of the following to start the installation:

    • For Linux with root or sudo privileges or for Windows installations, double-click the installer file.

    • For Linux non-root/non- sudo installations, enter:

      ./CloudBeesFlow-<version> --nonRoot

      For this installation type, a warning about automatic server start-up with non-root/non- sudo installations.

  3. For non-root/non- sudo installations, click Yes to dismiss the warning.

    The screen examples in this procedure are from a Windows system. Different options will appear in some windows on a Linux system.
  4. Select the Express Server installation option, and then click Next to continue.

  5. Select the appropriate step for your platform and complete the information for the server service account.

    • Windows:

      • User Name —Enter the name of the user who will run the CloudBees CD server, web server, and repository server services.

      • Password —Enter the password of the user who will run the CloudBees CD server, web server, and repository server services.

      • Domain —Enter the domain name information for the user. For example, electric-cloud.com. Leave this field blank if this is a local user.

      • Use the local system account —Select this check box if you want the CloudBees CD 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 would otherwise require that you create a new account on each of those machines.
      • Use the same account for the agent service —Select this check box if you want the agent on the CloudBees CD server machine to run as the same account.

        For security reasons in production environments, you should use a separate account for the agent service because the server account has permission to read the key file ( include::ROOT:partial$install-trad/passkey-dir.adoc[] ). The key file is used to decrypt passwords stored in CloudBees CD. Using a different account for the agent service ensures that a process running on the agent cannot gain access to the key file.

    • Linux:

      • User Name —Enter the name of the user who owns the CloudBees CD server, repository server, and web server processes.

      • Group Name —Enter the name of the group who owns the CloudBees CD server, repository server, and web server processes.

      • Use the same account for the agent service —Select this check box if you want the same user and group to own the agent process on the CloudBees CD server machine.

        For security reasons in production environments, you should use a separate user and group for the agent service because the server service has permission to read the key file ( include::ROOT:partial$install-trad/passkey-dir.adoc[] ). The key file is used to decrypt passwords stored in CloudBees CD. Using a different user and group for the agent service ensures that a process running on the agent cannot gain access to the key file.

  6. Click Next to continue. The Agent Service Account screen appears.

    If you selected the Use the same account for the agent service check box on the previous screen, you will not see this screen.
  7. Select the appropriate step for your platform and complete the information for the agent service account.

    • Windows:

      • User Name —Enter the name of the user who will run the CloudBees CD agent service.

        The user that the agent runs as must have permission to write to the $INSTALL_DIRECTORY/log directory.

      • Password —Enter the password of the user who will run the CloudBees CD agent service.

      • Domain —Enter the domain name information for the user. For example, electric-cloud.com. Leave this field blank if this is a local user.

      • Use the local system account —Select this check box if you want the CloudBees CD agent service to run as the local Windows system account.

        The local system account does not have access to network shares.
    • Linux:

      • User Name —Use this field to enter the name of the user who owns the CloudBees CD agent process.

        The user/group that the agent runs as must have permission to write to the $INSTALL_DIRECTORY/log directory. If you specify root, click Yes when the following confirmation appears:

      • Group Name —Use this field to enter the name of the group that owns the CloudBees CD agent process.

  8. Click Next to continue. The Ready to Install screen appears.

  9. Review the default settings and your service account selections. Use the Back button to change your service account selections if necessary.

  10. Click Next to continue.

    The installer displays a status bar to show the progress of the installation, which can take fifteen minutes:

    When the install process is complete, the Install Wizard Complete screen appears:

    The CloudBees CD server will automatically start when the installation is complete.
  11. Select the Launch a web browser to login to CloudBees CD check box if you want CloudBees CD to open the login screen now.

  12. Click Finish to close the wizard.

  13. For non-root/non- sudo Linux installations, configure autostart for the CloudBees CD services.