Configuring the Jenkins build management software

Configuring Jenkins allows you to:

  • Define a welcome message for your Jenkins dashboard.
  • Define the number of executors that Jenkins can use to perform simultaneous builds.

To configure Jenkins

  1. If you haven't already opened the Jenkins dashboard, then in a browser, navigate to the URL http://localhost:8080, and then sign in as the administrator user you created during installation.
  1. Click Manage Jenkins.
  2. Click Configure System.
  3. In the System Message box, enter a welcome message that appears at the top of the dashboard for users who connect to the build machine.

Tip   The welcome message supports standard HTML code and is a great place to provide guidelines or recommendations you want to share with writers for manually starting or stopping builds. You can also share your contact information for anyone who might have build-related questions.

  1. In the # of executors box, enter the number of builds that you want to allow Jenkins to run simultaneously.

Note   The number of builds you can run simultaneously might be limited by your authoring tool. In most cases, two executors is sufficient for automating documentation builds created by small teams.

  1. In the Jenkins URL box, replace the localhost keyword in the URL with the name of your build computer.

Tip   On Windows-based servers, you can find the name of the computer in the System control panel.

Note   Jenkins supports many optional system configuration settings, such as the ability to set up individual user accounts with custom permissions and the ability to define email account settings that use Jenkins' built-in support for sending email notifications. Neither of these is required. In later procedures, you will configure individual jobs that use a custom validation script to send email notifications only when build warnings or errors occur; this does not require defining any email account information in Jenkins.

Now you're ready to configure the credentials that Jenkins uses to access your GitHub repository.