Jenkins Install for Windows - johnttaylor/epc GitHub Wiki

Install instructions for Jenkins on a Windows machine. The most update instruction for installing Jenkins can be found here. The instructions on the Jenkins page are comprehensive and should get you up and running on Windows or other Operating systems. The steps below is what I followed to install Jenkins on the build VM server. Before installing Jenkins and I had previous installed the VIM Editor and the Git tools.

JAVA

  • Install JAVA 17.0.6 by downloading and running the Windows installer.
    • Accept the default install options when running the installer.

Download Jenkins installer

  • Download the Windows installer for Jenkins 2.401.1 LTS and then run the Windows Installer to launch the the Installation Setup Wizard. NOTE Jenkins will be installed as a Window Service.

Installation Setup Wizard

The steps below are copied from the Jenkins web site. Visit the Jenkins web site for latest up to date steps.

  1. Setup Wizard

    • On opening the Windows Installer, an Installation Setup Wizard appears, Click Next on the Setup Wizard to start your installation

  2. Select destination folder

    • Select the destination folder to store your Jenkins Installation and click Next to continue.

      • Note: For the GM6000 VM, the destination directory was set to C:\Jenkins

  3. Service login credentials

    • When Installing Jenkins, it is recommended to install and run Jenkins as an independent windows service using a local or domain user as it is much safer than running Jenkins using Local System (Windows equivalent of root) which will grant Jenkins full access to your machine and services.

    • To run Jenkins service using a local or domain user, specify the domain user name and password with which you want to run Jenkins, click on Test Credentials to test your domain credentials and click on Next.

  4. Port selection

    • Specify the port on which Jenkins will be running, Test Port button to validate whether the specified port if free on your machine or not. Consequently, if the port is free, it will show a green tick mark as shown below, then click on Next.

  5. Select Java home directory

    • The installation process checks for Java on your machine and prefills the dialog with the Java home directory. If the needed Java version is not installed on your machine, you will be prompted to install it. Once your Java home directory has been selected, click on Next to continue.

  6. Custom setup

    • Select other services that need to be installed with Jenkins and click on Next.

  7. Install Jenkins

    • Click on the Install button to start the installation of Jenkins.

    • Additionally, clicking on the Install button will show the progress bar of installation, as shown below.

  8. Finish Jenkins installation

    • Once the installation completes, click on Finish to complete the installation. Jenkins will be installed as a Windows Service. You can validate this by browsing the services section, as shown below.

Post-installation setup Wizard

After downloading, installing and running Jenkins, the post-installation setup wizard begins. This setup wizard takes you through a few quick "one-off" steps to unlock Jenkins, customize it with plugins and create the first administrator user through which you can continue accessing Jenkins.

Unlocking Jenkins

When you first access a new Jenkins instance, you are asked to unlock it using an automatically-generated password.

  1. Browse to http://localhost:8080 (or whichever port you configured for Jenkins when installing it) and wait until the Unlock Jenkins page appears.

  2. The initial Administrator password should be found under the Jenkins installation path (set at Step 2 in Jenkins Installation). For default installation location to C:\Program Files\Jenkins, a file called initialAdminPassword can be found under C:\Program Files\Jenkins\secrets. However, If a custom path for Jenkins installation was selected, then you should check that location for initialAdminPassword file.

  3. Open the highlighted file and copy the content of the initialAdminPassword file.

  4. On the Unlock Jenkins page, paste this password into the Administrator password field and click Continue.

    • You can also access Jenkins logs in the jenkins.err.log file in your Jenkins directory specified during the installation.

    • The Jenkins log file is another location (in the Jenkins home directory) where the initial password can also be obtained.

    This password must be entered in the setup wizard on new Jenkins installations before you can access Jenkins’s main UI. This password also serves as the default administrator account’s password (with username "admin") if you happen to skip the subsequent user-creation step in the setup wizard.

Customizing Jenkins with plugins

After unlocking Jenkins, the Customize Jenkins page appears. Here you can install any number of useful plugins as part of your initial setup. Click one of the two options shown:

  • Install suggested plugins - to install the recommended set of plugins, which are based on most common use cases.
  • Select plugins to install - to choose which set of plugins to initially install. When you first access the plugin selection page, the suggested plugins are selected by default.

NOTES:

  • If you are not sure what plugins you need, choose Install suggested plugins. You can install (or remove) additional Jenkins plugins at a later point in time via the Manage Jenkins > Plugins page in Jenkins.
  • On my install I selected recommended set of plugins and many of the plugins failed to install. That is okay, because any needed plugins can be installed later.

Creating the first administrator user

Finally, after customizing Jenkins with plugins, Jenkins asks you to create your first administrator user.

  1. When the Create First Admin User page appears, specify the details for your administrator user in the respective fields and click Save and Finish.
  2. When the Jenkins is ready page appears, click Start using Jenkins.
    • This page may indicate Jenkins is almost ready! instead and if so, click Restart.
    • If the page does not automatically refresh after a minute, use your web browser to refresh the page manually.
  3. If required, log in to Jenkins with the credentials of the user you just created and you are ready to start using Jenkins!