Installing the stand-alone WAR file

The stand-alone WAR file can be used on Linux, macOS, or Microsoft Windows, assuming the machine meets the system requirements, including having Java 8 installed. Other versions of Java will not work.

Native packages versus WAR file

Native packages install the distribution on the file system in standard locations for the operating system: log files, configuration files, service files, etc. Everything is properly configured and placed according to the target OS standards. The operating system starts services automatically at each boot using the same JENKINS_HOME. Native packages also integrate the distribution with tooling like process monitoring tools.

Unlike installed packages, the WAR file is an executable that is launched manually every time and is not integrated into the underlying OS. The user must take care to use the proper JENKINS_HOME or launch the WAR file with the same set of options. While the WAR file is portable across distributions and operating systems, achieving an integrated installation of the WAR file manually duplicates what a native package does.

Installing and configuring

  1. Download the WAR file for CloudBees Jenkins Distribution; for your operating system and copy it to where you wish to run CloudBees Jenkins Distribution.

  2. Copy the file to the directory where you wish to run CloudBees Jenkins Distribution.

  3. Open a terminal and run the command:

    java -jar cloudbees-jenkins-distribution.war
  4. The process output generates a password offset by three rows of asterisks above and below the text. Copy the password. The password is also saved in a directory like /users/<username>.jenkins/secrets/initialAdminPassword, where username is replaced with your username. The exact path may vary depending upon your operating system.

    *************************************************************
    *************************************************************
    *************************************************************
    
    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
    
    *************************************************************
    *************************************************************
    *************************************************************
  5. The terminal portion is complete when the output reads:

    INFO: Obtained the updated data file for hudson.tools.JDKInstaller
    Jan 24, 2019 4:38:57 PM com.cloudbees.jenkins.plugins.assurance.model.UpdateSiteDataProvider$Value get
    INFO: Beekeeper is parsing UpdateSite cloudbees-jenkins-distribution-offline
    Jan 24, 2019 4:38:57 PM com.cloudbees.jenkins.plugins.assurance.model.UpdateSiteDataProvider$Value get
    INFO: Beekeeper is parsing UpdateSite cap-cloudbees-jenkins-distribution
    Jan 24, 2019 4:42:42 PM hudson.model.AsyncPeriodicWork$1 run
    INFO: Started telemetry collection
    Jan 24, 2019 4:42:42 PM hudson.model.AsyncPeriodicWork$1 run
    INFO: Finished telemetry collection. 1 ms

After the process has completed, CloudBees Jenkins Distribution service should start automatically and be available in a web browser at localhost:8080 by default.

The setup process can be done using the Getting Started wizard.