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. Using Jenkins
    1. Working with projects
    2. Using credentials
    3. Search Box
    4. Referencing another project by name
    5. Aborting a build
    6. Fingerprints
    7. Using local language
    8. Change time zone
    9. Remote Access API
    10. Executor Starvation
    11. Using Jenkins agents
    12. Using JMeter with Jenkins
    13. Pluggable Storage

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

  4. 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
  5. 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
  6. Managing Jenkins
    1. Configuring the System
    2. Configuration as Code
    3. Global Tool Configuration
    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
  7. 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
  8. 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
  9. Scaling Jenkins
    1. Architecting for Scale
    2. Hardware Recommendations
    3. Architecting for Manageability
    4. Scaling Jenkins on Kubernetes
  10. Troubleshooting Jenkins
    1. Diagnosing Errors
    2. Obtaining a thread dump
  11. Glossary