Table of contents

CloudBees Jenkins Distribution installation guide


Completing post-install configuration

After installation, the Getting Started wizard will walk you through installing a curated set of plugins and creating the first admin account.

Security and unlocking the distribution

CloudBees Jenkins Distribution is initially configured to be secure on first launch. During installation, a password is generated and saved in a local file called initialAdminPassword. The file location depends upon the operating system you are using.

This password is required to unlock the instance on the Unlock Jenkins page.

To locate the password:

  1. Open a browser to http://localhost:8080.

  2. Open the initialAdminPassword file using the location displayed on the Unlock Jenkins page.

  3. Copy the password from the file.

Alternatively, the password may be displayed during installation. For example, the output below was from installing on macOS using a WAR file:

*************************************************************
*************************************************************
*************************************************************

Jenkins initial setup is required. An admin user has been created and a password generated.
Please use the following password to proceed to installation:

d661ea28c6b94406ad627601b6f4aa877

This may also be found at: /Users/<username>/.jenkins/secrets/initialAdminPassword

*************************************************************
*************************************************************
*************************************************************

Registration

During setup, you will be prompted to choose a registration type. You can register with a free product key online or contact CloudBees at support@cloudbees.com to obtain registration activation.

Using the Getting Started wizard

  1. Open a browser to http://localhost:8080.

  2. On the Unlock Jenkins page, paste in the Administrator password retrieved in the previous section in the field. Press Continue.

  3. Select the appropriate registration option on the License page.

    • Activate CloudBees Jenkins Distribution (requires online activation): Complete the form on Register CloudBees Jenkins Distribution page. Enter your name, email and company, check the box to accept the license agreement and click Submit. The Setup Wizard will contact CloudBees to create a license and apply the license to the product.

    • Use a license key (Apply a valid license key; useful for offline installations): Click Activate CloudBees Jenkins Distribution to obtain a free license (requires internet access). Email sales@cloudbees.com to obtain a register your product. Once you have the free license from CloudBees, select license key and paste the License Key and License Certificate from your registration in to their fields. Review the license and then accept the license by clicking the check box and click Submit.

  4. Select Install suggested plugins on the Customize Jenkins page to install the curated set of plugins recommended by CloudBees.

  5. The Getting Started page displays the setup progress. If any updates are available, you will also be given the option to upgrade. These upgrades may also be performed at a later time using the Beekeeper Upgrade Assistant.

  6. On the Create First Admin User page, enter a username, password (twice), full name, and email address for the first admin user. Press Save and Continue.

  7. Enter a new value for the Jenkins URL on the Instance Configuration page. You may choose to use the default value or to enter a new URL. Press Save and Finish.

    Important
    The Jenkins URL provides the root URL for absolute links to various Jenkins resources, including email notifications, PR status updates, and the BUILD_URL environment variable provided to build steps.
  8. You may be asked to reboot your system.

Finished

That’s it! Your copy of CloudBees Jenkins Distribution is installed and ready for you to use.