Managing Jenkins URL and security - Commands & Configuration

Introduction

Jenkins is a tool that helps automate tasks like building and testing software. Managing its URL and security settings ensures only the right people can access it safely and that the web address is correct for users.

When you want to change the web address Jenkins uses to be easier to remember or fit your company domain

When you need to secure Jenkins so only authorized users can access it

When you want to enable HTTPS to encrypt data between users and Jenkins

When you want to disable anonymous access to protect your build jobs

When you want to configure security settings after installing Jenkins for the first time

Commands

Open the Jenkins default configuration file to change the Jenkins URL and port settings.

Terminal

sudo vi /etc/default/jenkins

Expected Output

No output (command runs silently)

Restart Jenkins to apply the changes made to the configuration file.

Terminal

sudo systemctl restart jenkins

Expected Output

● jenkins.service - Jenkins Continuous Integration Server

   Loaded: loaded (/lib/systemd/system/jenkins.service; enabled; vendor preset: enabled)

   Active: active (running) since Fri 2024-06-14 10:00:00 UTC; 5s ago

 Main PID: 1234 (java)

    Tasks: 30 (limit: 4915)

   Memory: 200.0M

   CGroup: /system.slice/jenkins.service

           └─1234 /usr/bin/java -jar /usr/share/jenkins/jenkins.war

Allow traffic on port 8080, which is the default Jenkins port, so users can access Jenkins through the firewall.

Terminal

sudo ufw allow 8080

Expected Output

Rule added

Rule added (v6)

Edit Jenkins main configuration file to enable security settings like disabling anonymous access and enabling user authentication.

Terminal

sudo vi /var/lib/jenkins/config.xml

Expected Output

No output (command runs silently)

Restart Jenkins again to apply the security configuration changes.

Terminal

sudo systemctl restart jenkins

Expected Output

● jenkins.service - Jenkins Continuous Integration Server

   Loaded: loaded (/lib/systemd/system/jenkins.service; enabled; vendor preset: enabled)

   Active: active (running) since Fri 2024-06-14 10:05:00 UTC; 5s ago

 Main PID: 1234 (java)

    Tasks: 30 (limit: 4915)

   Memory: 200.0M

   CGroup: /system.slice/jenkins.service

           └─1234 /usr/bin/java -jar /usr/share/jenkins/jenkins.war

Key Concept

If you remember nothing else, remember: changing Jenkins URL and security settings requires editing config files and restarting Jenkins to apply changes safely.

Common Mistakes

Changing Jenkins URL without restarting the Jenkins service

Jenkins will continue running with old settings until restarted, so changes won't take effect.

Always restart Jenkins after changing URL or port settings.

Not allowing Jenkins port through the firewall

Users cannot access Jenkins even if it is running because the firewall blocks the traffic.

Open the Jenkins port (default 8080) in the firewall to allow user access.

Disabling security without setting up user authentication

This leaves Jenkins open to anyone, risking unauthorized access and changes.

Enable security and configure user authentication before disabling anonymous access.

Summary

Edit /etc/default/jenkins to change Jenkins URL and port.

Restart Jenkins service to apply URL and port changes.

Open Jenkins port in firewall to allow access.

Edit /var/lib/jenkins/config.xml to enable security settings.

Restart Jenkins again to apply security changes.

Practice

1. What is the main purpose of setting the Jenkins URL in the Configure System page?

easy

A. To configure user permissions automatically

B. To ensure Jenkins generates correct links in notifications and UI

C. To enable Jenkins security features

D. To change the Jenkins server's IP address

Solution

1. Step 1: Understand Jenkins URL role

   The Jenkins URL is used to create links in emails and UI that point back to the Jenkins server.

2. Step 2: Identify correct purpose

   Setting this URL ensures users receive valid clickable links, improving usability and notifications.

3. Final Answer:

   To ensure Jenkins generates correct links in notifications and UI -> Option B

4. Quick Check:

   Jenkins URL = Correct links [OK]

Hint: Jenkins URL sets links, not IP or security [OK]

Common Mistakes:

• Confusing URL setting with IP address change
• Thinking it enables security features
• Assuming it manages user permissions

2. Which Jenkins configuration step is required to enable user login security?

easy

A. Enable the 'Enable security' checkbox and configure an authorization strategy

B. Disable the 'Enable security' checkbox

C. Set the Jenkins URL to HTTPS

D. Install a plugin for user management

Solution

1. Step 1: Locate security settings

   In Jenkins, enabling security requires checking the 'Enable security' box in Configure Global Security.

2. Step 2: Configure authorization

   After enabling security, you must select an authorization strategy to control user access and permissions.

3. Final Answer:

   Enable the 'Enable security' checkbox and configure an authorization strategy -> Option A

4. Quick Check:

   Enable security + authorization = login control [OK]

Hint: Enable security checkbox and set authorization [OK]

Common Mistakes:

• Disabling security instead of enabling
• Confusing URL setting with security
• Assuming plugins are mandatory for login

3. Given this Jenkins Groovy script snippet to print the Jenkins URL:

println(jenkins.model.Jenkins.instance.getRootUrl())

What will be the output if the Jenkins URL is set to http://jenkins.example.com/?

medium

A. null

B. http://localhost:8080/

C. http://jenkins.example.com/

D. Error: getRootUrl() not found

Solution

1. Step 1: Understand getRootUrl() method

   This method returns the Jenkins URL set in the Configure System page.

2. Step 2: Match configured URL

   If the URL is set to 'http://jenkins.example.com/', the method returns exactly this string.

3. Final Answer:

   http://jenkins.example.com/ -> Option C

4. Quick Check:

   Configured URL = getRootUrl() output [OK]

Hint: getRootUrl() returns configured Jenkins URL [OK]

Common Mistakes:

• Assuming default localhost URL is returned
• Expecting null if URL is set
• Thinking method does not exist

4. You enabled Jenkins security but users report they cannot log in. Which is the most likely cause?

medium

A. Security is enabled but no authentication method is configured

B. Authorization strategy is set to 'Logged-in users can do anything' but no users exist

C. Jenkins URL is not set correctly

D. Jenkins server is offline

Solution

1. Step 1: Check security enablement

   Enabling security requires configuring an authentication method (like Jenkins own user database).

2. Step 2: Identify missing authentication

   If no authentication method is set, Jenkins cannot verify users, blocking login.

3. Final Answer:

   Security is enabled but no authentication method is configured -> Option A

4. Quick Check:

   Security enabled + no auth = login failure [OK]

Hint: Enable auth method when security is on [OK]

Common Mistakes:

• Blaming Jenkins URL for login issues
• Assuming authorization fixes login without auth
• Ignoring server status

5. You want to restrict Jenkins access so only specific users can configure jobs, but all authenticated users can view jobs. Which authorization strategy should you choose?

hard

A. Anyone can do anything

B. Logged-in users can do anything

C. Disable security to allow open access

D. Matrix-based security with fine-grained permissions

Solution

1. Step 1: Understand access requirements

   Need to allow all authenticated users to view but restrict configuration to some users.

2. Step 2: Choose authorization strategy

   Matrix-based security lets you assign specific permissions per user or group, fitting this need.

3. Final Answer:

   Matrix-based security with fine-grained permissions -> Option D

4. Quick Check:

   Fine-grained control = Matrix security [OK]

Hint: Use matrix security for detailed user permissions [OK]

Common Mistakes:

• Choosing open access strategies ignoring restrictions
• Assuming 'logged-in users can do anything' restricts config
• Disabling security to solve access control