Jenkins Handbook

  1. User Handbook Overview
  2. Installing Jenkins
    1. Docker
    2. Kubernetes
    3. Linux
    4. macOS
    5. Windows
    6. Other Systems
    7. WAR file
    8. Other Servlet Containers
    9. Offline Installations
    10. Initial Settings
  3. Platform Information
    1. Java Support Policy
    2. Linux Support Policy
    3. Windows Support Policy
    4. Browser compatibility
    5. Servlet Container Support Policy
    6. Upgrading to Java 11
    7. Upgrading to Java 17
  4. Using Jenkins
    1. Best Practices
    2. Working with projects
    3. Using credentials
    4. Search Box
    5. Referencing another project by name
    6. Aborting a build
    7. Fingerprints
    8. Using local language
    9. Change time zone
    10. Remote Access API
    11. Executor Starvation
    12. Using Jenkins agents
    13. Using JMeter with Jenkins
    14. Pluggable Storage

      Storage alternatives for artifacts, build logs, credentials, test results, and fingerprints

  5. Pipeline
    1. Getting started with Pipeline
    2. Using a Jenkinsfile
    3. Running Pipelines
    4. Branches and Pull Requests
    5. Using Docker with Pipeline
    6. Extending with Shared Libraries
    7. Pipeline Development Tools
    8. Pipeline Syntax
    9. Pipeline as Code
    10. Pipeline Best Practices
    11. Scaling Pipelines
    12. Pipeline CPS Method Mismatches
  6. Blue Ocean
    1. Getting started with Blue Ocean
    2. Creating a Pipeline
    3. Dashboard
    4. Activity View
    5. Pipeline Run Details View
    6. Pipeline Editor
  7. Managing Jenkins
    1. Configuring the System
    2. Configuration as Code
    3. Managing Tools
    4. Managing Plugins
    5. About Jenkins
    6. System Information
    7. Jenkins Features Controlled with System Properties
    8. Change System Time Zone
    9. Jenkins CLI
    10. Script Console
    11. Groovy Hook Scripts
    12. Managing Nodes
    13. In-process Script Approval
    14. Users
    15. Themes for user interface
    16. User Content
    17. Spawning Processes From Build
  8. Securing Jenkins
    1. Access Control
    2. Securing Jenkins
    3. Managing Security
    4. Controller Isolation
    5. Securing Builds
    6. CSRF Protection
    7. Rendering User Content
    8. Access Control for Builds
    9. Handling Environment Variables
    10. Markup Formatters
    11. Exposed Services and Ports
  9. System Administration
    1. Backing-up/Restoring Jenkins
    2. Monitoring Jenkins
    3. Administering Jenkins on Kubernetes
    4. Managing Jenkins with Chef
    5. Managing Jenkins with Puppet
    6. Viewing logs
    7. Authenticating scripted clients
    8. Reverse proxy configuration
    9. Reverse proxy - Issues
    10. Managing systemd services
    11. FIPS-140
    12. Reset the Jenkins administrator password
  10. Scaling Jenkins
    1. Architecting for Scale
    2. Hardware Recommendations
    3. Architecting for Manageability
    4. Scaling Jenkins on Kubernetes
  11. Troubleshooting Jenkins
    1. Diagnosing Errors
    2. Obtaining a thread dump
  12. Glossary