# CircleCI Documentation

> Official technical documentation for CircleCI, a continuous integration and delivery platform

> Generated: 2026-03-19T20:35:16.616Z

## Site Information

- URL: https://circleci.com/docs
- Repository: https://github.com/circleci/circleci-docs
- Generator: Antora (static site generator for technical documentation)
- Markup: AsciiDoc

## Markdown Exports

All documentation pages are available in markdown format for easier parsing and processing.

### How to Access Markdown Versions

1. **Direct URL conversion**: Replace the HTML page URL with `/index.md`
   - HTML: https://circleci.com/docs/guides/getting-started/first-steps/
   - Markdown: https://circleci.com/docs/guides/getting-started/first-steps/index.md

2. **Inline links in this file**: Each page listing below includes a [md] link
   - Example: Page Title (https://circleci.com/docs/page/) [md](https://circleci.com/docs/page/index.md)

3. **HTML metadata**: Each page includes `<link rel="alternate" type="text/markdown" href="index.md">` in the HTML head

### About This File (llms.txt)

- **Location**: https://circleci.com/docs/llms.txt
- **Purpose**: Provides LLMs with complete site structure, navigation, and page descriptions
- **Updates**: Automatically regenerated on each deployment to main branch
- **Discovery**: Announced via `<link rel="alternate" type="text/plain" href="/docs/llms.txt">` in page headers
- **Format**: Plain text with markdown-style formatting for readability

## Documentation Structure

This documentation is organized into the following Antora components:

### Guides ()
- About CircleCI
  - CircleCI overview (https://circleci.com/docs/guides/about-circleci/about-circleci/) [md](https://circleci.com/docs/guides/about-circleci/about-circleci/index.md)
    An overview of CircleCI, continuous integration and continuous delivery
  - Benefits of CircleCI (https://circleci.com/docs/guides/about-circleci/benefits-of-circleci/) [md](https://circleci.com/docs/guides/about-circleci/benefits-of-circleci/index.md)
    Benefits of choosing CircleCI for CI/CD
  - Concepts (https://circleci.com/docs/guides/about-circleci/concepts/) [md](https://circleci.com/docs/guides/about-circleci/concepts/index.md)
    CircleCI concepts
  - Intro to the CircleCI web app (https://circleci.com/docs/guides/about-circleci/introduction-to-the-circleci-web-app/) [md](https://circleci.com/docs/guides/about-circleci/introduction-to-the-circleci-web-app/index.md)
    This document describes the basic features and settings available in the CircleCI web app.
  - Open source acknowledgements (https://circleci.com/docs/guides/about-circleci/open-source/) [md](https://circleci.com/docs/guides/about-circleci/open-source/index.md)
    List and acknowledgements for open-source projects and libraries that are used in CircleCI products and services.
- Getting started
  - First steps
    - Sign up and try CircleCI (https://circleci.com/docs/guides/getting-started/first-steps/) [md](https://circleci.com/docs/guides/getting-started/first-steps/index.md)
      First step for using CircleCI.
    - Join teammates on CircleCI (https://circleci.com/docs/guides/getting-started/invite-your-team/) [md](https://circleci.com/docs/guides/getting-started/invite-your-team/index.md)
      Add your team to your CircleCI organization
    - Create a project (https://circleci.com/docs/guides/getting-started/create-project/) [md](https://circleci.com/docs/guides/getting-started/create-project/index.md)
      "Learn how to create a project in CircleCI."
    - Quickstart guide (https://circleci.com/docs/guides/getting-started/getting-started/) [md](https://circleci.com/docs/guides/getting-started/getting-started/index.md)
      A quickstart guide for adding a project to CircleCI and exploring some features
  - How-to guides
    - Hello World (https://circleci.com/docs/guides/getting-started/hello-world/) [md](https://circleci.com/docs/guides/getting-started/hello-world/index.md)
      Get started with CircleCI by printing Hello World in any execution environment.
    - Intro to YAML configuration (https://circleci.com/docs/guides/getting-started/introduction-to-yaml-configurations/) [md](https://circleci.com/docs/guides/getting-started/introduction-to-yaml-configurations/index.md)
      "Overview of CircleCI configuration written in YAML"
    - In-app config editor (https://circleci.com/docs/guides/getting-started/config-editor/) [md](https://circleci.com/docs/guides/getting-started/config-editor/index.md)
      Docs page on In-app configuration editor use and features
    - Node.js quickstart (https://circleci.com/docs/guides/getting-started/language-javascript/) [md](https://circleci.com/docs/guides/getting-started/language-javascript/index.md)
      Building and Testing with JavaScript and Node.js on CircleCI
    - Python quickstart (https://circleci.com/docs/guides/getting-started/language-python/) [md](https://circleci.com/docs/guides/getting-started/language-python/index.md)
      Continuous integration with Python on CircleCI
    - Go quickstart (https://circleci.com/docs/guides/getting-started/language-go/) [md](https://circleci.com/docs/guides/getting-started/language-go/index.md)
      Learn how to set up a Go project with CircleCI.
    - Create an organization (https://circleci.com/docs/guides/getting-started/create-an-organization/) [md](https://circleci.com/docs/guides/getting-started/create-an-organization/index.md)
      Create a new organization in CircleCI.
  - Tutorials
    - Configuration intro (https://circleci.com/docs/guides/getting-started/config-intro/) [md](https://circleci.com/docs/guides/getting-started/config-intro/index.md)
      "Learn how to get started with the CircleCI config.yml file."
    - Use the Slack orb to set up notifications (https://circleci.com/docs/guides/getting-started/slack-orb-tutorial/) [md](https://circleci.com/docs/guides/getting-started/slack-orb-tutorial/index.md)
      "Learn how to get started with the CircleCI Slack orb"
- Migrate to CircleCI
  - Migration intro (https://circleci.com/docs/guides/migrate/migration-intro/) [md](https://circleci.com/docs/guides/migrate/migration-intro/index.md)
    This document provides an overview of the stages required to migrate your CI/CD pipelines to CircleCI.
  - Migrate from AWS (https://circleci.com/docs/guides/migrate/migrating-from-aws/) [md](https://circleci.com/docs/guides/migrate/migrating-from-aws/index.md)
    This overview provides instructions for installing CircleCI Server on Amazon Web Services (AWS) with Terraform.
  - Migrate from Azure DevOps (https://circleci.com/docs/guides/migrate/migrating-from-azuredevops/) [md](https://circleci.com/docs/guides/migrate/migrating-from-azuredevops/index.md)
    An overview of how to migrate from Azure DevOps to CircleCI.
  - Migrate from Buildkite (https://circleci.com/docs/guides/migrate/migrating-from-buildkite/) [md](https://circleci.com/docs/guides/migrate/migrating-from-buildkite/index.md)
    An overview of how to migrate from Buildkite to CircleCI.
  - Migrate from GitHub (https://circleci.com/docs/guides/migrate/migrating-from-github/) [md](https://circleci.com/docs/guides/migrate/migrating-from-github/index.md)
    An overview of how to migrate from GitHub Actions to CircleCI.
  - Migrate from GitLab (https://circleci.com/docs/guides/migrate/migrating-from-gitlab/) [md](https://circleci.com/docs/guides/migrate/migrating-from-gitlab/index.md)
    An overview of how to migrate from GitLab to CircleCI.
  - Migrate from Jenkins (https://circleci.com/docs/guides/migrate/migrating-from-jenkins/) [md](https://circleci.com/docs/guides/migrate/migrating-from-jenkins/index.md)
    Differences between CircleCI and Jenkins, with migration guide.
  - Migrate from TeamCity (https://circleci.com/docs/guides/migrate/migrating-from-teamcity/) [md](https://circleci.com/docs/guides/migrate/migrating-from-teamcity/index.md)
    An overview of how to migrate from TeamCity to CircleCI.
  - Migrate from Travis CI (https://circleci.com/docs/guides/migrate/migrating-from-travis/) [md](https://circleci.com/docs/guides/migrate/migrating-from-travis/index.md)
    An overview of how to migrate from Travis CI to CircleCI.
- Orchestrate
  - Pipelines
    - Pipeline overview and setup (https://circleci.com/docs/guides/orchestrate/pipelines/) [md](https://circleci.com/docs/guides/orchestrate/pipelines/index.md)
      This document introduces the concept of pipelines and shows how pipelines can be triggered and what they include.
    - Jobs and steps overview (https://circleci.com/docs/guides/orchestrate/jobs-steps/) [md](https://circleci.com/docs/guides/orchestrate/jobs-steps/index.md)
      Description of CircleCI jobs and steps.
    - Workflow orchestration (https://circleci.com/docs/guides/orchestrate/workflows/) [md](https://circleci.com/docs/guides/orchestrate/workflows/index.md)
      Learn about using CircleCI workflows to orchestrate jobs
    - Automatic reruns (https://circleci.com/docs/guides/orchestrate/automatic-reruns/) [md](https://circleci.com/docs/guides/orchestrate/automatic-reruns/index.md)
      Configure automatic reruns for failed workflows to reduce manual intervention and improve pipeline reliability
    - Use workspaces to share data between jobs (https://circleci.com/docs/guides/orchestrate/workspaces/) [md](https://circleci.com/docs/guides/orchestrate/workspaces/index.md)
      This document describes how to use workspaces to share data to downstream jobs in your workflows.
    - Use dynamic configuration (https://circleci.com/docs/guides/orchestrate/dynamic-config/) [md](https://circleci.com/docs/guides/orchestrate/dynamic-config/index.md)
      A guide to using CircleCI's dynamic configuration features
    - Skip CI, auto-cancel, and block new pipelines (https://circleci.com/docs/guides/orchestrate/skip-build/) [md](https://circleci.com/docs/guides/orchestrate/skip-build/index.md)
      Skip CI builds, auto-cancel redundant workflows, and block new work for your CircleCI organization or project.
    - Controlling serial execution across your organization (https://circleci.com/docs/guides/orchestrate/controlling-serial-execution-across-your-organization/) [md](https://circleci.com/docs/guides/orchestrate/controlling-serial-execution-across-your-organization/index.md)
      An overview of controlling serial execution across a CircleCI org.
    - Pipeline values and parameters (https://circleci.com/docs/guides/orchestrate/pipeline-variables/) [md](https://circleci.com/docs/guides/orchestrate/pipeline-variables/index.md)
      This document describes the Free Plan available to developers on CircleCI.
  - Triggers
    - Trigger options (https://circleci.com/docs/guides/orchestrate/triggers-overview/) [md](https://circleci.com/docs/guides/orchestrate/triggers-overview/index.md)
      "A guide to the various ways to manage pipeline triggering in CircleCI"
    - Set up triggers (https://circleci.com/docs/guides/orchestrate/set-up-triggers/) [md](https://circleci.com/docs/guides/orchestrate/set-up-triggers/index.md)
      A guide to setting up triggers for your pipelines.
    - GitHub trigger event options (https://circleci.com/docs/guides/orchestrate/github-trigger-event-options/) [md](https://circleci.com/docs/guides/orchestrate/github-trigger-event-options/index.md)
      A guide to the options available for triggering GitHub App pipelines. Trigger pipelines on non-push events.
    - GitLab trigger options (https://circleci.com/docs/guides/orchestrate/gitlab-trigger-options/) [md](https://circleci.com/docs/guides/orchestrate/gitlab-trigger-options/index.md)
      A guide to the options available for triggering GitLab pipelines
    - Custom webhooks (https://circleci.com/docs/guides/orchestrate/custom-webhooks/) [md](https://circleci.com/docs/guides/orchestrate/custom-webhooks/index.md)
      Use webhooks to integrate with third-party services and subscribe to CircleCI events
    - Schedule triggers (https://circleci.com/docs/guides/orchestrate/schedule-triggers/) [md](https://circleci.com/docs/guides/orchestrate/schedule-triggers/index.md)
      Learn about schedule triggers for your CircleCI projects.
  - How-to guides
    - Orchestration cookbook (https://circleci.com/docs/guides/orchestrate/orchestration-cookbook/) [md](https://circleci.com/docs/guides/orchestrate/orchestration-cookbook/index.md)
      A cookbook of common pipeline, workflow and job execution goals and patterns
    - How to override config (https://circleci.com/docs/guides/orchestrate/how-to-override-config/) [md](https://circleci.com/docs/guides/orchestrate/how-to-override-config/index.md)
      Learn how to use the override-with key in CircleCI to standardize pipelines across your organization while maintaining team flexibility.
    - Set up multiple configuration files for a project (https://circleci.com/docs/guides/orchestrate/set-up-multiple-configuration-files-for-a-project/) [md](https://circleci.com/docs/guides/orchestrate/set-up-multiple-configuration-files-for-a-project/index.md)
      A step by step guide for setting up multiple pipelines, each defined in a separate configuration file, in a CircleCI project.
    - Notify a Slack channel of a paused workflow (https://circleci.com/docs/guides/orchestrate/notify-a-slack-channel-of-a-paused-workflow/) [md](https://circleci.com/docs/guides/orchestrate/notify-a-slack-channel-of-a-paused-workflow/index.md)
      A how to guide for using the Slack orb to notify a Slack channel of a paused workflow.
    - Using branch filters (https://circleci.com/docs/guides/orchestrate/using-branch-filters/) [md](https://circleci.com/docs/guides/orchestrate/using-branch-filters/index.md)
      A how to guide for using branch fileters at the job level to simplify your CircleCI configuration.
    - Select a workflow to run using pipeline parameters (https://circleci.com/docs/guides/orchestrate/selecting-a-workflow-to-run-using-pipeline-parameters/) [md](https://circleci.com/docs/guides/orchestrate/selecting-a-workflow-to-run-using-pipeline-parameters/index.md)
      "A how-to guide for selecting a workflow to run using pipeline parameters."
    - Migrate scheduled workflows to schedule triggers (https://circleci.com/docs/guides/orchestrate/migrate-scheduled-workflows-to-schedule-triggers/) [md](https://circleci.com/docs/guides/orchestrate/migrate-scheduled-workflows-to-schedule-triggers/index.md)
      Migrate scheduled workflows to schedule triggers
    - Schedule triggers with multiple workflows (https://circleci.com/docs/guides/orchestrate/schedule-triggers-with-multiple-workflows/) [md](https://circleci.com/docs/guides/orchestrate/schedule-triggers-with-multiple-workflows/index.md)
      "Learn how to set conditionals for schedule triggers in multiple workflows."
    - Set a nightly schedule trigger (https://circleci.com/docs/guides/orchestrate/set-a-nightly-schedule-trigger/) [md](https://circleci.com/docs/guides/orchestrate/set-a-nightly-schedule-trigger/index.md)
      "Learn how to create schedule triggers on a specific timetable."
    - Using dynamic configuration (https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/) [md](https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/index.md)
      A how to guide for using CircleCI dynamic configuration.
    - Configure databases (https://circleci.com/docs/guides/orchestrate/databases/) [md](https://circleci.com/docs/guides/orchestrate/databases/index.md)
      This document describes how to use the official CircleCI pre-built Docker container images for a database service in CircleCI.
    - Migrate from deploy to run (https://circleci.com/docs/guides/orchestrate/migrate-from-deploy-to-run/) [md](https://circleci.com/docs/guides/orchestrate/migrate-from-deploy-to-run/index.md)
      A how-to guide on how to migrage from the deprecated deploy step to run.
    - Using shell scripts (https://circleci.com/docs/guides/orchestrate/using-shell-scripts/) [md](https://circleci.com/docs/guides/orchestrate/using-shell-scripts/index.md)
      Best practices for using shell scripts for use in CircleCI configuration
- Execute on managed compute
  - Execution environments overview (https://circleci.com/docs/guides/execution-managed/executor-intro/) [md](https://circleci.com/docs/guides/execution-managed/executor-intro/index.md)
    An overview of all CircleCI execution environments.
  - Resource class overview (https://circleci.com/docs/guides/execution-managed/resource-class-overview/) [md](https://circleci.com/docs/guides/execution-managed/resource-class-overview/index.md)
    An overview of resource classes in CircleCI
  - Resource class lifecycle (https://circleci.com/docs/guides/execution-managed/resource-class-lifecycle/) [md](https://circleci.com/docs/guides/execution-managed/resource-class-lifecycle/index.md)
  - Docker
    - Using Docker (https://circleci.com/docs/guides/execution-managed/using-docker/) [md](https://circleci.com/docs/guides/execution-managed/using-docker/index.md)
      Learn how to configure a your jobs to run in the Docker execution environment
    - Convenience images (https://circleci.com/docs/guides/execution-managed/circleci-images/) [md](https://circleci.com/docs/guides/execution-managed/circleci-images/index.md)
      Listing of available Docker images maintained by CircleCI
    - Migrating to next-gen images (https://circleci.com/docs/guides/execution-managed/next-gen-migration-guide/) [md](https://circleci.com/docs/guides/execution-managed/next-gen-migration-guide/index.md)
      A guide for migrating from using legacy images to next-gen images.
    - Using custom-built Docker images (https://circleci.com/docs/guides/execution-managed/custom-images/) [md](https://circleci.com/docs/guides/execution-managed/custom-images/index.md)
      Why and how to create custom Docker images
    - Docker authenticated pulls (https://circleci.com/docs/guides/execution-managed/private-images/) [md](https://circleci.com/docs/guides/execution-managed/private-images/index.md)
      This document describes how to authenticate with your Docker registry provider to pull images.
    - Running Docker commands (https://circleci.com/docs/guides/execution-managed/building-docker-images/) [md](https://circleci.com/docs/guides/execution-managed/building-docker-images/index.md)
      How to build Docker images using the Docker execution environment
  - Linux VM
    - Using the Linux VM execution environment (https://circleci.com/docs/guides/execution-managed/using-linuxvm/) [md](https://circleci.com/docs/guides/execution-managed/using-linuxvm/index.md)
      Learn how to configure a your jobs to run in the Linux VM execution environment using the machine executor.
    - Using Android images with the machine executor (https://circleci.com/docs/guides/execution-managed/android-machine-image/) [md](https://circleci.com/docs/guides/execution-managed/android-machine-image/index.md)
      Using the Android image on the machine executor
  - macOS
    - Using the macOS execution environment (https://circleci.com/docs/guides/execution-managed/using-macos/) [md](https://circleci.com/docs/guides/execution-managed/using-macos/index.md)
      "Learn how to configure a your jobs to run in the macOS execution environment."
    - Configuring a macOS app (https://circleci.com/docs/guides/execution-managed/hello-world-macos/) [md](https://circleci.com/docs/guides/execution-managed/hello-world-macos/index.md)
      First macOS project on CircleCI
    - iOS code signing (https://circleci.com/docs/guides/execution-managed/ios-codesigning/) [md](https://circleci.com/docs/guides/execution-managed/ios-codesigning/index.md)
      How to set up code signing for an iOS app
  - Windows
    - Using the Windows execution environment (https://circleci.com/docs/guides/execution-managed/using-windows/) [md](https://circleci.com/docs/guides/execution-managed/using-windows/index.md)
      Learn how to configure a your jobs to run in the Windows execution environment.
    - Hello world Windows (https://circleci.com/docs/guides/execution-managed/hello-world-windows/) [md](https://circleci.com/docs/guides/execution-managed/hello-world-windows/index.md)
      First Windows project on CircleCI
  - Arm
    - Using the Arm VM execution environment (https://circleci.com/docs/guides/execution-managed/using-arm/) [md](https://circleci.com/docs/guides/execution-managed/using-arm/index.md)
      Learn how to configure a your jobs to run in the Arm VM execution environment.
  - GPU
    - Using the GPU execution environment (https://circleci.com/docs/guides/execution-managed/using-gpu/) [md](https://circleci.com/docs/guides/execution-managed/using-gpu/index.md)
      Learn how to configure a your jobs to run in the GPU execution environment.
  - How-to guides
    - Pull an image from AWS ECR with OIDC (https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-aws-ecr-with-oidc/) [md](https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-aws-ecr-with-oidc/index.md)
      Learn how to pull an image from AWS ECR using OIDC authentication
    - Pull an image from GCP Artifact Registry with OIDC (https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-gcp-gar-with-oidc/) [md](https://circleci.com/docs/guides/permissions-authentication/pull-an-image-from-gcp-gar-with-oidc/index.md)
      Learn how to pull an image from GCP Artifact Registry using OIDC authentication
    - Run a job in a container on your machine with Docker (https://circleci.com/docs/guides/execution-managed/run-a-job-in-a-container/) [md](https://circleci.com/docs/guides/execution-managed/run-a-job-in-a-container/index.md)
      Learn how to run a job in a container on your machine with Docker.
    - Installing and using Docker Compose (https://circleci.com/docs/guides/execution-managed/docker-compose/) [md](https://circleci.com/docs/guides/execution-managed/docker-compose/index.md)
      How to enable Docker Compose in your primary container
    - Debugging container ID cannot be mapped to host ID error (https://circleci.com/docs/guides/execution-managed/high-uid-error/) [md](https://circleci.com/docs/guides/execution-managed/high-uid-error/index.md)
      Debugging 'Container ID XXX cannot be mapped to a host ID' error when starting a container
    - Migrating between the Docker machine executors (https://circleci.com/docs/guides/execution-managed/docker-to-machine/) [md](https://circleci.com/docs/guides/execution-managed/docker-to-machine/index.md)
      Best practices and considerations when migrating your executor from Docker to machine
  - Image support policies
    - Android images support policy (https://circleci.com/docs/guides/execution-managed/android-images-support-policy/) [md](https://circleci.com/docs/guides/execution-managed/android-images-support-policy/index.md)
      CircleCI Android images release, update, and deprecation policy
    - Convenience images support policy (https://circleci.com/docs/guides/execution-managed/convenience-images-support-policy/) [md](https://circleci.com/docs/guides/execution-managed/convenience-images-support-policy/index.md)
      CircleCI Convenience Images release, update, and deprecation policy
    - Linux VM images support policy (https://circleci.com/docs/guides/execution-managed/linux-vm-support-policy/) [md](https://circleci.com/docs/guides/execution-managed/linux-vm-support-policy/index.md)
      CircleCI Linux VM images release, update, and deprecation policy
    - Linux CUDA images support policy (https://circleci.com/docs/guides/execution-managed/linux-cuda-images-support-policy/) [md](https://circleci.com/docs/guides/execution-managed/linux-cuda-images-support-policy/index.md)
      CircleCI Linux CUDA images release, update, and deprecation policy
    - Remote Docker images support policy (https://circleci.com/docs/guides/execution-managed/remote-docker-images-support-policy/) [md](https://circleci.com/docs/guides/execution-managed/remote-docker-images-support-policy/index.md)
      CircleCI remote Docker images release, update, and deprecation policy
    - Windows images support policy (https://circleci.com/docs/guides/execution-managed/windows-images-support-policy/) [md](https://circleci.com/docs/guides/execution-managed/windows-images-support-policy/index.md)
      CircleCI Windows images release, update, and deprecation policy
    - Xcode image policy (https://circleci.com/docs/guides/execution-managed/xcode-policy/) [md](https://circleci.com/docs/guides/execution-managed/xcode-policy/index.md)
      CircleCI Xcode Image Release, Update and Deprecation Policy
    - CircleCI image lifecycle: A complete guide (https://circleci.com/docs/guides/execution-managed/machine-convenience-image-lifecycle/) [md](https://circleci.com/docs/guides/execution-managed/machine-convenience-image-lifecycle/index.md)
      CircleCI Machine/Convenience Image Lifecycle
- Execute jobs on self-hosted runners
  - Self-hosted runner overview (https://circleci.com/docs/guides/execution-runner/runner-overview/) [md](https://circleci.com/docs/guides/execution-runner/runner-overview/index.md)
    Learn how CircleCI's self-hosted runners enable you to use your own infrastructure for running jobs.
  - Self-hosted runner concepts (https://circleci.com/docs/guides/execution-runner/runner-concepts/) [md](https://circleci.com/docs/guides/execution-runner/runner-concepts/index.md)
    Conceptual Overview for CircleCI's self-hosted runner.
  - Runner feature comparison matrix (https://circleci.com/docs/guides/execution-runner/runner-feature-comparison-matrix/) [md](https://circleci.com/docs/guides/execution-runner/runner-feature-comparison-matrix/index.md)
    A comparison table of the features available for CircleCI runners.
  - Container runner
    - Container runner installation (https://circleci.com/docs/guides/execution-runner/container-runner-installation/) [md](https://circleci.com/docs/guides/execution-runner/container-runner-installation/index.md)
      Instructions on how to install CircleCI's container runner.
    - Container runner performance benchmarks (https://circleci.com/docs/guides/execution-runner/container-runner-performance-benchmarks/) [md](https://circleci.com/docs/guides/execution-runner/container-runner-performance-benchmarks/index.md)
      Performance benchmarks and tuning.
    - Container runner reference (https://circleci.com/docs/guides/execution-runner/container-runner/) [md](https://circleci.com/docs/guides/execution-runner/container-runner/index.md)
      Details of CircleCI's container runner
  - Machine runner 3
    - Install machine runner 3 on Linux (https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-linux/) [md](https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-linux/index.md)
      Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Linux.
    - Install machine runner 3 on macOS (https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-macos/) [md](https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-macos/index.md)
      Instructions on how to install CircleCI's self-hosted machine runner (3.0) on macOS.
    - Install machine runner 3 on Windows (https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-windows/) [md](https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-windows/index.md)
      Instructions on how to install CircleCI's machine runner 3  on Windows.
    - Install machine runner 3 on Docker (https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-docker/) [md](https://circleci.com/docs/guides/execution-runner/install-machine-runner-3-on-docker/index.md)
      Instructions on how to install CircleCI's self-hosted machine runner (3.0) on Docker.
    - Manual install on Linux and macOS (https://circleci.com/docs/guides/execution-runner/machine-runner-3-manual-installation/) [md](https://circleci.com/docs/guides/execution-runner/machine-runner-3-manual-installation/index.md)
      Instructions on how to manually start CircleCI's self-hosted machine runner 3 on macOS and Linux.
    - Manual install on Windows (https://circleci.com/docs/guides/execution-runner/machine-runner-3-manual-installation-on-windows/) [md](https://circleci.com/docs/guides/execution-runner/machine-runner-3-manual-installation-on-windows/index.md)
      Instructions on how to manually install CircleCI's self-hosted machine runner 3 on Windows.
    - Migrate from launch agent to machine runner 3 on Linux (https://circleci.com/docs/guides/execution-runner/migrate-from-launch-agent-to-machine-runner-3-on-linux/) [md](https://circleci.com/docs/guides/execution-runner/migrate-from-launch-agent-to-machine-runner-3-on-linux/index.md)
      Steps to migrate from using launch agent to machine runner 3
    - Migrate from launch agent to machine runner 3 on macOS (https://circleci.com/docs/guides/execution-runner/migrate-from-launch-agent-to-machine-runner-3-on-macos/) [md](https://circleci.com/docs/guides/execution-runner/migrate-from-launch-agent-to-machine-runner-3-on-macos/index.md)
      Steps to migrate from using launch agent to the machine runner 3 preview
    - Migrate from launch agent to machine runner 3 on Windows (https://circleci.com/docs/guides/execution-runner/migrate-from-launch-agent-to-machine-runner-3-on-windows/) [md](https://circleci.com/docs/guides/execution-runner/migrate-from-launch-agent-to-machine-runner-3-on-windows/index.md)
      Steps to migrate from using launch agent to the machine runner 3 preview on Windows
    - Machine runner 3 configuration reference (https://circleci.com/docs/guides/execution-runner/machine-runner-3-configuration-reference/) [md](https://circleci.com/docs/guides/execution-runner/machine-runner-3-configuration-reference/index.md)
  - Self-hosted runner reference
    - Self-hosted runner API (https://circleci.com/docs/guides/execution-runner/runner-api/) [md](https://circleci.com/docs/guides/execution-runner/runner-api/index.md)
      This document contains all the external facing endpoints for the CircleCI's self-hosted runner API.
    - Self-hosted runner FAQ (https://circleci.com/docs/guides/execution-runner/runner-faqs/) [md](https://circleci.com/docs/guides/execution-runner/runner-faqs/index.md)
      This page answers the most frequently asked questions for the CircleCI's self-hosted runner product.
    - Troubleshoot self-hosted runner (https://circleci.com/docs/guides/execution-runner/troubleshoot-self-hosted-runner/) [md](https://circleci.com/docs/guides/execution-runner/troubleshoot-self-hosted-runner/index.md)
      Errors and troubleshooting methods for container and machine runners.
    - Scaling self-hosted runner (https://circleci.com/docs/guides/execution-runner/runner-scaling/) [md](https://circleci.com/docs/guides/execution-runner/runner-scaling/index.md)
- Testing on CircleCI
  - Run tests on CircleCI
    - Automated testing (https://circleci.com/docs/guides/test/test/) [md](https://circleci.com/docs/guides/test/test/index.md)
      An overview of setting up testing automation, integration, and analytics.
    - Collecting test data (https://circleci.com/docs/guides/test/collect-test-data/) [md](https://circleci.com/docs/guides/test/collect-test-data/index.md)
      A guide to collecting test data in your CircleCI projects.
    - Test Insights (https://circleci.com/docs/guides/insights/insights-tests/) [md](https://circleci.com/docs/guides/insights/insights-tests/index.md)
      Analyze your test performance using test Insights.
  - Manage and optimize tests
    - Fix flaky tests (https://circleci.com/docs/guides/test/fix-flaky-tests/) [md](https://circleci.com/docs/guides/test/fix-flaky-tests/index.md)
      Learn about Chunk by CircleCI and how it can automatically identify and fix flaky tests in your CI/CD pipelines.
  - Testing strategies
    - Testing LLM-enabled applications through evaluations (https://circleci.com/docs/guides/test/testing-llm-enabled-applications-through-evaluations/) [md](https://circleci.com/docs/guides/test/testing-llm-enabled-applications-through-evaluations/index.md)
      Docs page on setting up LLM evaluations in your CI/CD pipeline
    - Browser testing (https://circleci.com/docs/guides/test/browser-testing/) [md](https://circleci.com/docs/guides/test/browser-testing/index.md)
      Browser Testing on CircleCI
    - Generate code coverage metrics (https://circleci.com/docs/guides/test/code-coverage/) [md](https://circleci.com/docs/guides/test/code-coverage/index.md)
      Generate code coverage metrics for different languages.
    - Re-run failed tests overview (https://circleci.com/docs/guides/test/rerun-failed-tests/) [md](https://circleci.com/docs/guides/test/rerun-failed-tests/index.md)
      How to rerun only failed tests in a job and optimize credit usage.
    - Test splitting and parallelism (https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/) [md](https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/index.md)
      A guide for test splitting and running tests across parallel compute environments to optimize your CircleCI pipelines.
  - Tutorials
    - Speed up pipelines with test splitting (https://circleci.com/docs/guides/test/test-splitting-tutorial/) [md](https://circleci.com/docs/guides/test/test-splitting-tutorial/index.md)
      Learn to split and run tests in parallel in CircleCI.
    - Testing iOS applications (https://circleci.com/docs/guides/test/testing-ios/) [md](https://circleci.com/docs/guides/test/testing-ios/index.md)
      Testing iOS applications on macOS.
    - Testing macOS applications (https://circleci.com/docs/guides/test/testing-macos/) [md](https://circleci.com/docs/guides/test/testing-macos/index.md)
      Testing macOS applications.
  - How-to guides
    - Use the environment CLI to split tests (https://circleci.com/docs/guides/optimize/use-the-circleci-cli-to-split-tests/) [md](https://circleci.com/docs/guides/optimize/use-the-circleci-cli-to-split-tests/index.md)
      How-to guide for using the environment CLI to split tests across parallel compute environments in a pipeline.
    - Automate LLM evaluation testing with the CircleCI Evals orb (https://circleci.com/docs/guides/test/automate-llm-evaluation-testing-with-the-circleci-evals-orb/) [md](https://circleci.com/docs/guides/test/automate-llm-evaluation-testing-with-the-circleci-evals-orb/index.md)
      How to use CircleCI Evals orb.
  - Reference
    - Troubleshoot test splitting (https://circleci.com/docs/guides/test/troubleshoot-test-splitting/) [md](https://circleci.com/docs/guides/test/troubleshoot-test-splitting/index.md)
      Tips and common errors to help troubleshoot your CircleCI test splitting implementation.
- Deploy with CircleCI
  - Deployment and deploy management (https://circleci.com/docs/guides/deploy/deployment-overview/) [md](https://circleci.com/docs/guides/deploy/deployment-overview/index.md)
    Learn the basics of deployment and deploys management with CircleCI.
  - Deploys and rollbacks
    - Set up a rollback pipeline (https://circleci.com/docs/guides/deploy/set-up-rollbacks/) [md](https://circleci.com/docs/guides/deploy/set-up-rollbacks/index.md)
    - Set up a deploy pipeline (https://circleci.com/docs/guides/deploy/set-up-deploys/) [md](https://circleci.com/docs/guides/deploy/set-up-deploys/index.md)
    - Deploy a component (https://circleci.com/docs/guides/deploy/deploy-a-component/) [md](https://circleci.com/docs/guides/deploy/deploy-a-component/index.md)
    - Rollback a deployment (https://circleci.com/docs/guides/deploy/rollback-a-deployment/) [md](https://circleci.com/docs/guides/deploy/rollback-a-deployment/index.md)
    - Configure deploy markers (https://circleci.com/docs/guides/deploy/configure-deploy-markers/) [md](https://circleci.com/docs/guides/deploy/configure-deploy-markers/index.md)
      Tutorial outlining how to configure deploy markers in your workflow.
    - Environment hierarchy and version promotion (https://circleci.com/docs/guides/deploy/environment-hierarchy-and-version-promotion/) [md](https://circleci.com/docs/guides/deploy/environment-hierarchy-and-version-promotion/index.md)
      Learn how to use environment hierarchy and version promotion to manage your deployments through multiple environments.
  - Release agent setup
    - Release agent overview (https://circleci.com/docs/guides/deploy/release-agent-overview/) [md](https://circleci.com/docs/guides/deploy/release-agent-overview/index.md)
      Learn the basics of release management for your Kubernetes deployments with CircleCI.
    - Set up the CircleCI release agent (https://circleci.com/docs/guides/deploy/set-up-the-circleci-release-agent/) [md](https://circleci.com/docs/guides/deploy/set-up-the-circleci-release-agent/index.md)
      Tutorial outlining how to set up the CircleCI release agent, covering creating an environment integration, installing the release agent and creating components.
    - Configure your Kubernetes components (https://circleci.com/docs/guides/deploy/configure-your-kubernetes-components/) [md](https://circleci.com/docs/guides/deploy/configure-your-kubernetes-components/index.md)
      Tutorial outlining how to configure your Kubernetes components for visibility and control on the deploys dashboard.
    - Update the Kubernetes release agent (https://circleci.com/docs/guides/deploy/update-the-kubernetes-release-agent/) [md](https://circleci.com/docs/guides/deploy/update-the-kubernetes-release-agent/index.md)
      How to update the Kubernetes release agent for integrations with CircleCI deploys.
    - Manage releases (https://circleci.com/docs/guides/deploy/manage-releases/) [md](https://circleci.com/docs/guides/deploy/manage-releases/index.md)
      How to guide for managing releases from the CircleCI web app.
  - How-to guides
    - Deploy Android applications (https://circleci.com/docs/guides/deploy/deploy-android-applications/) [md](https://circleci.com/docs/guides/deploy/deploy-android-applications/index.md)
      Learn to deploy Android apps through CircleCI.
    - Deploy to Artifactory (https://circleci.com/docs/guides/deploy/deploy-to-artifactory/) [md](https://circleci.com/docs/guides/deploy/deploy-to-artifactory/index.md)
      How to upload artifacts to Artifactory in CircleCI
    - Deploy to AWS (https://circleci.com/docs/guides/deploy/deploy-to-aws/) [md](https://circleci.com/docs/guides/deploy/deploy-to-aws/index.md)
      This is document provides examples of deploying to Amazon Web Services.
    - Push image to ECR and deploy to ECS (https://circleci.com/docs/guides/deploy/ecs-ecr/) [md](https://circleci.com/docs/guides/deploy/ecs-ecr/index.md)
      How to use CircleCI to deploy to AWS ECS from ECR
    - Deploy service update to AWS ECS (https://circleci.com/docs/guides/deploy/deploy-service-update-to-aws-ecs/) [md](https://circleci.com/docs/guides/deploy/deploy-service-update-to-aws-ecs/index.md)
      A how to guide for deploying changes to AWS ECS using CircleCI orbs.
    - Deploy to Azure Container Registry (https://circleci.com/docs/guides/deploy/deploy-to-azure-container-registry/) [md](https://circleci.com/docs/guides/deploy/deploy-to-azure-container-registry/index.md)
      This is document provides examples of deploying to Azure Container Registry.
    - Deploy to Capistrano (https://circleci.com/docs/guides/deploy/deploy-to-capistrano/) [md](https://circleci.com/docs/guides/deploy/deploy-to-capistrano/index.md)
      This is document provides examples of deploying to Capistrano.
    - Deploy to Cloud Foundry (https://circleci.com/docs/guides/deploy/deploy-to-cloud-foundry/) [md](https://circleci.com/docs/guides/deploy/deploy-to-cloud-foundry/index.md)
      This is document provides examples of deploying to Cloud Foundry.
    - Deploy to Firebase (https://circleci.com/docs/guides/deploy/deploy-to-firebase/) [md](https://circleci.com/docs/guides/deploy/deploy-to-firebase/index.md)
      This is document provides examples of deploying to Firebase.
    - Deploy to Google Cloud Platform (https://circleci.com/docs/guides/deploy/deploy-to-google-cloud-platform/) [md](https://circleci.com/docs/guides/deploy/deploy-to-google-cloud-platform/index.md)
      This is document provides examples of deploying to Google Cloud Platform.
    - Deploy to Heroku (https://circleci.com/docs/guides/deploy/deploy-to-heroku/) [md](https://circleci.com/docs/guides/deploy/deploy-to-heroku/index.md)
      This is document provides examples of deploying to Heroku.
    - Deploy iOS applications (https://circleci.com/docs/guides/deploy/deploy-ios-applications/) [md](https://circleci.com/docs/guides/deploy/deploy-ios-applications/index.md)
      Deploy iOS Applications
    - Deploy over SSH (https://circleci.com/docs/guides/deploy/deploy-over-ssh/) [md](https://circleci.com/docs/guides/deploy/deploy-over-ssh/index.md)
      Learn how to deploy your application over SSH using CircleCI.
    - Publish packages to Packagecloud (https://circleci.com/docs/guides/deploy/publish-packages-to-packagecloud/) [md](https://circleci.com/docs/guides/deploy/publish-packages-to-packagecloud/index.md)
      How to publish packages to Packagecloud using CircleCI.
    - Deploy to npm registry (https://circleci.com/docs/guides/deploy/deploy-to-npm-registry/) [md](https://circleci.com/docs/guides/deploy/deploy-to-npm-registry/index.md)
      Learn how to deploy packages to the npm registry using CircleCI.
- Optimize
  - Optimizations reference (https://circleci.com/docs/guides/optimize/optimizations/) [md](https://circleci.com/docs/guides/optimize/optimizations/index.md)
    Learn about ways to optimize your CircleCI pipelines
  - Data
    - Persisting data overview (https://circleci.com/docs/guides/optimize/persist-data/) [md](https://circleci.com/docs/guides/optimize/persist-data/index.md)
      A introductory guide to the various ways to persist data in CircleCI
    - Caching dependencies (https://circleci.com/docs/guides/optimize/caching/) [md](https://circleci.com/docs/guides/optimize/caching/index.md)
      This document is a guide to caching dependencies in CircleCI pipelines.
    - Caching strategies (https://circleci.com/docs/guides/optimize/caching-strategy/) [md](https://circleci.com/docs/guides/optimize/caching-strategy/index.md)
      A guide to the various caching strategies available for managing dependency caches in CircleCI.
    - Store build artifacts (https://circleci.com/docs/guides/optimize/artifacts/) [md](https://circleci.com/docs/guides/optimize/artifacts/index.md)
      Example of uploading artifacts created during a build
  - Speed
    - Concurrency (https://circleci.com/docs/guides/optimize/concurrency/) [md](https://circleci.com/docs/guides/optimize/concurrency/index.md)
      This page summarizes concurrency, and suggests ways to use concurrency to your advantage.
    - Test splitting and parallelism (https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/) [md](https://circleci.com/docs/guides/optimize/parallelism-faster-jobs/index.md)
      A guide for test splitting and running tests across parallel compute environments to optimize your CircleCI pipelines.
    - Docker layer caching overview (https://circleci.com/docs/guides/optimize/docker-layer-caching/) [md](https://circleci.com/docs/guides/optimize/docker-layer-caching/index.md)
      How to reuse unchanged cache layers in images you build to reduce overall run time
  - Config
    - Dynamic configuration (https://circleci.com/docs/guides/orchestrate/dynamic-config/) [md](https://circleci.com/docs/guides/orchestrate/dynamic-config/index.md)
      A guide to using CircleCI's dynamic configuration features
  - Tutorials
    - Speed up pipelines with test splitting (https://circleci.com/docs/guides/test/test-splitting-tutorial/) [md](https://circleci.com/docs/guides/test/test-splitting-tutorial/index.md)
      Learn to split and run tests in parallel in CircleCI.
  - How-to guides
    - Use matrix jobs (https://circleci.com/docs/guides/orchestrate/using-matrix-jobs/) [md](https://circleci.com/docs/guides/orchestrate/using-matrix-jobs/index.md)
      "A how to guide for using matrix jobs to simplify your CircleCI configuration."
    - Using dynamic configuration (https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/) [md](https://circleci.com/docs/guides/orchestrate/using-dynamic-configuration/index.md)
      A how to guide for using CircleCI dynamic configuration.
    - Avoid and debug Java memory errors (https://circleci.com/docs/guides/optimize/java-oom/) [md](https://circleci.com/docs/guides/optimize/java-oom/index.md)
      How to avoid and debug Java memory errors on CircleCI.
- Insights
  - Use Insights (https://circleci.com/docs/guides/insights/insights/) [md](https://circleci.com/docs/guides/insights/insights/index.md)
    Viewing the status of repos and test performance
  - Test Insights (https://circleci.com/docs/guides/insights/insights-tests/) [md](https://circleci.com/docs/guides/insights/insights-tests/index.md)
    Analyze your test performance using test Insights.
  - Generate an Insights snapshot badge (https://circleci.com/docs/guides/insights/insights-snapshot-badge/) [md](https://circleci.com/docs/guides/insights/insights-snapshot-badge/index.md)
    Generate a badge that displays Insights metrics for a project.
  - Insights glossary (https://circleci.com/docs/guides/insights/insights-glossary/) [md](https://circleci.com/docs/guides/insights/insights-glossary/index.md)
    Definitions for the metrics in CircleCI Insights, Insights dashboard as well as the Insights API.
- Manage roles, permissions, and authentication
  - Users, organizations, and integrations guide (https://circleci.com/docs/guides/permissions-authentication/users-organizations-and-integrations-guide/) [md](https://circleci.com/docs/guides/permissions-authentication/users-organizations-and-integrations-guide/index.md)
    A guide to understanding user accounts, organizations and integrations with version control systems in CircleCI.
  - Roles and permissions
    - Roles and permissions overview (https://circleci.com/docs/guides/permissions-authentication/roles-and-permissions-overview/) [md](https://circleci.com/docs/guides/permissions-authentication/roles-and-permissions-overview/index.md)
      An overview of the various project and orgnization roles in CircleCI and the permissions associated with each role.
    - Manage roles and permissions (https://circleci.com/docs/guides/permissions-authentication/manage-roles-and-permissions/) [md](https://circleci.com/docs/guides/permissions-authentication/manage-roles-and-permissions/index.md)
      How-to guides for managing roles and permissions in CircleCI.
    - Manage groups (https://circleci.com/docs/guides/permissions-authentication/manage-groups/) [md](https://circleci.com/docs/guides/permissions-authentication/manage-groups/index.md)
      How-to guides for setting up and assigning groups in CircleCI to manage roles and permissions across projects.
    - Prevent unregistered users from spending credits (https://circleci.com/docs/guides/plans-pricing/prevent-unregistered-users-from-spending-credits/) [md](https://circleci.com/docs/guides/plans-pricing/prevent-unregistered-users-from-spending-credits/index.md)
      A how to guide to configuring your org so that unregistered users will not be able to perform actions that spend credits
  - SSO authentication
    - SSO overview (https://circleci.com/docs/guides/permissions-authentication/sso-overview/) [md](https://circleci.com/docs/guides/permissions-authentication/sso-overview/index.md)
      Introduction to CircleCI SAML SSO
    - SSO setup (https://circleci.com/docs/guides/permissions-authentication/set-up-sso/) [md](https://circleci.com/docs/guides/permissions-authentication/set-up-sso/index.md)
      Tutorial outlining how to set up SSO for an organization
    - Set up SSO group mapping with Okta (https://circleci.com/docs/guides/permissions-authentication/sso-group-mapping/) [md](https://circleci.com/docs/guides/permissions-authentication/sso-group-mapping/index.md)
      Follow this guide to set up SSO (Single sign-on) group mapping with Okta and CircleCI.
    - Sign in to an SSO-enabled org (https://circleci.com/docs/guides/permissions-authentication/sign-in-to-an-sso-enabled-organization/) [md](https://circleci.com/docs/guides/permissions-authentication/sign-in-to-an-sso-enabled-organization/index.md)
      Instructions outlining how to sign in as an SSO user
  - Multi-factor authentication (MFA)
    - MFA overview (https://circleci.com/docs/guides/permissions-authentication/mfa/) [md](https://circleci.com/docs/guides/permissions-authentication/mfa/index.md)
      MFA Overview
  - OIDC tokens
    - Use OpenID Connect tokens in jobs (https://circleci.com/docs/guides/permissions-authentication/openid-connect-tokens/) [md](https://circleci.com/docs/guides/permissions-authentication/openid-connect-tokens/index.md)
      Learn how to use OpenID Connect ID tokens for access to compatible cloud services.
    - OIDC tokens with custom claims (https://circleci.com/docs/guides/permissions-authentication/oidc-tokens-with-custom-claims/) [md](https://circleci.com/docs/guides/permissions-authentication/oidc-tokens-with-custom-claims/index.md)
      Learn about the capabilities to customize claims in OIDC tokens.
- Manage security and secrets
  - Security features
    - How CircleCI handles security (https://circleci.com/docs/guides/security/security/) [md](https://circleci.com/docs/guides/security/security/index.md)
      An overview of security measures taken at CircleCI.
    - Intro to environment variables (https://circleci.com/docs/guides/security/env-vars/) [md](https://circleci.com/docs/guides/security/env-vars/index.md)
      Introduction to environment variables in CircleCI
    - Using contexts (https://circleci.com/docs/guides/security/contexts/) [md](https://circleci.com/docs/guides/security/contexts/index.md)
      Secured, cross-project resources
    - IP ranges (https://circleci.com/docs/guides/security/ip-ranges/) [md](https://circleci.com/docs/guides/security/ip-ranges/index.md)
      Enable CircleCI jobs to go through a set of well-defined IP address ranges
    - Audit logs (https://circleci.com/docs/guides/security/audit-logs/) [md](https://circleci.com/docs/guides/security/audit-logs/index.md)
      "This page describes the ways CircleCI customers can request and stream audit logs."
  - Security recommendations
    - Security overview (https://circleci.com/docs/guides/security/security-overview/) [md](https://circleci.com/docs/guides/security/security-overview/index.md)
      This document provides an introduction to security features at CircleCI.
    - Protecting against supply chain attacks (https://circleci.com/docs/guides/security/security-supply-chain/) [md](https://circleci.com/docs/guides/security/security-supply-chain/index.md)
      Protecting against supply chain attacks on CircleCI
    - Secure secrets handling (https://circleci.com/docs/guides/security/security-recommendations/) [md](https://circleci.com/docs/guides/security/security-recommendations/index.md)
      Learn how to handle secrets securely with CircleCI.
  - How-to guides
    - Set an environment variable (https://circleci.com/docs/guides/security/set-environment-variable/) [md](https://circleci.com/docs/guides/security/set-environment-variable/index.md)
      How to set environment variables for use in your CircleCI pipelines.
    - Inject environment variables with the API (https://circleci.com/docs/guides/security/inject-environment-variables-with-api/) [md](https://circleci.com/docs/guides/security/inject-environment-variables-with-api/index.md)
      How to inject env var values using the API.
    - Debug with SSH (https://circleci.com/docs/guides/execution-managed/ssh-access-jobs/) [md](https://circleci.com/docs/guides/execution-managed/ssh-access-jobs/index.md)
      How to access a build container using SSH on CircleCI
    - Rotate project SSH keys (https://circleci.com/docs/guides/security/rotate-project-ssh-keys/) [md](https://circleci.com/docs/guides/security/rotate-project-ssh-keys/index.md)
      How to rotate your project SSH keys.
    - Stop building a project on CircleCI (https://circleci.com/docs/guides/security/stop-building-a-project-on-circleci/) [md](https://circleci.com/docs/guides/security/stop-building-a-project-on-circleci/index.md)
      Learn how to remove a project from your CircleCI account
    - Rename organizations and repositories (https://circleci.com/docs/guides/security/rename-organizations-and-repositories/) [md](https://circleci.com/docs/guides/security/rename-organizations-and-repositories/index.md)
      Learn how to rename organizations and repositories in CircleCI.
    - Delete organizations and projects (https://circleci.com/docs/guides/security/delete-organizations-and-projects/) [md](https://circleci.com/docs/guides/security/delete-organizations-and-projects/index.md)
      Learn how to delete organizations and projects in CircleCI.
- Manage config policies
  - Config policy management overview (https://circleci.com/docs/guides/config-policies/config-policy-management-overview/) [md](https://circleci.com/docs/guides/config-policies/config-policy-management-overview/index.md)
    Config policies for CircleCI project configurations.
  - Config policy reference (https://circleci.com/docs/guides/config-policies/config-policy-reference/) [md](https://circleci.com/docs/guides/config-policies/config-policy-reference/index.md)
    Open preview of config policies for CircleCI. Reference page for function helpers.
  - How-to guides
    - Create and manage config policies (https://circleci.com/docs/guides/config-policies/create-and-manage-config-policies/) [md](https://circleci.com/docs/guides/config-policies/create-and-manage-config-policies/index.md)
      Learn how to write and manage config policies for CircleCI project configurations.
    - Test config policies (https://circleci.com/docs/guides/config-policies/test-config-policies/) [md](https://circleci.com/docs/guides/config-policies/test-config-policies/index.md)
      Open preview of config policies for CircleCI. Learn about testing your policies.
    - Use the CLI for config and policy development (https://circleci.com/docs/guides/config-policies/use-the-cli-for-config-and-policy-development/) [md](https://circleci.com/docs/guides/config-policies/use-the-cli-for-config-and-policy-development/index.md)
      Learn about developing your config policies using the CLI.
    - Config policies for self-hosted runner (https://circleci.com/docs/guides/config-policies/config-policies-for-self-hosted-runner/) [md](https://circleci.com/docs/guides/config-policies/config-policies-for-self-hosted-runner/index.md)
      Learn how to write a policy to restrict which projects can run jobs on a self-hosted runner.
    - Manage contexts with config policies (https://circleci.com/docs/guides/config-policies/manage-contexts-with-config-policies/) [md](https://circleci.com/docs/guides/config-policies/manage-contexts-with-config-policies/index.md)
      Learn how to manage the use of contexts with config policies.
- Integration
  - Integration features
    - Outbound webhooks (https://circleci.com/docs/guides/integration/outbound-webhooks/) [md](https://circleci.com/docs/guides/integration/outbound-webhooks/index.md)
      Use outbound webhooks to integrate with third-party services and subscribe to CircleCI events
    - Outbound webhooks reference (https://circleci.com/docs/reference/outbound-webhooks-reference/) [md](https://circleci.com/docs/reference/outbound-webhooks-reference/index.md)
    - Notifications (https://circleci.com/docs/guides/integration/notifications/) [md](https://circleci.com/docs/guides/integration/notifications/index.md)
      Learn how to get CircleCI notifications through Slack, IRC and email notifications.
  - VCS integration
    - VCS, pipeline types, and feature support (https://circleci.com/docs/guides/integration/version-control-system-integration-overview/) [md](https://circleci.com/docs/guides/integration/version-control-system-integration-overview/index.md)
      An overview guide to the version control systems you can integrate with CircleCI and the features available to each pipeline type and organization type.
    - Using the CircleCI GitHub App in an OAuth org (https://circleci.com/docs/guides/integration/using-the-circleci-github-app-in-an-oauth-org/) [md](https://circleci.com/docs/guides/integration/using-the-circleci-github-app-in-an-oauth-org/index.md)
      A guide to using the CircleCI GitHub app in an OAuth organization
    - Build open source projects (https://circleci.com/docs/guides/integration/oss/) [md](https://circleci.com/docs/guides/integration/oss/index.md)
      Best practices for building open source projects
  - Third-party integrations
    - Enable GitHub Checks (https://circleci.com/docs/guides/integration/enable-checks/) [md](https://circleci.com/docs/guides/integration/enable-checks/index.md)
      How to enable GitHub Checks for CircleCI
    - Connect with Jira (https://circleci.com/docs/guides/integration/jira-plugin/) [md](https://circleci.com/docs/guides/integration/jira-plugin/index.md)
      Connecting Jira with CircleCI
    - New Relic integration (https://circleci.com/docs/guides/integration/new-relic-integration/) [md](https://circleci.com/docs/guides/integration/new-relic-integration/index.md)
      This document describes how to track and visualize analytical data across all of your jobs on CircleCI with New Relic.
    - Datadog integration (https://circleci.com/docs/guides/integration/datadog-integration/) [md](https://circleci.com/docs/guides/integration/datadog-integration/index.md)
      Learn how to integrate CircleCI with Datadog for monitoring and observability.
    - Sumo Logic integration (https://circleci.com/docs/guides/integration/sumo-logic-integration/) [md](https://circleci.com/docs/guides/integration/sumo-logic-integration/index.md)
      This document describes how to track and visualize analytical data across all of your jobs on CircleCI with Sumo Logic.
  - How-to guides
    - Adding status badges (https://circleci.com/docs/guides/integration/status-badges/) [md](https://circleci.com/docs/guides/integration/status-badges/index.md)
      How to embed a CircleCI status badge in any web page or document
    - CircleCI webhooks with Airtable (https://circleci.com/docs/guides/integration/webhooks-airtable/) [md](https://circleci.com/docs/guides/integration/webhooks-airtable/index.md)
      How to guide for setting up webhooks with Airtable
    - Add additional SSH keys (https://circleci.com/docs/guides/integration/add-ssh-key/) [md](https://circleci.com/docs/guides/integration/add-ssh-key/index.md)
      How to add additional SSH keys to CircleCI
    - Authorize Google Cloud SDK (https://circleci.com/docs/guides/integration/authorize-google-cloud-sdk/) [md](https://circleci.com/docs/guides/integration/authorize-google-cloud-sdk/index.md)
      How to authorize the Google Cloud SDK
- Developer toolkit
  - How to find IDs (https://circleci.com/docs/guides/toolkit/how-to-find-ids/) [md](https://circleci.com/docs/guides/toolkit/how-to-find-ids/index.md)
    "This page describes how customers can find IDs of various CircleCI elements."
  - AI features
    - Chunk Setup and Overview (https://circleci.com/docs/guides/toolkit/chunk-setup-and-overview/) [md](https://circleci.com/docs/guides/toolkit/chunk-setup-and-overview/index.md)
      An overview of Chunk by CircleCI, an AI agent for CI/CD tasks, and a guide to setting it up with your chosen model provider.
    - Using the CircleCI MCP server (https://circleci.com/docs/guides/toolkit/using-the-circleci-mcp-server/) [md](https://circleci.com/docs/guides/toolkit/using-the-circleci-mcp-server/index.md)
      A guide to using the CircleCI MCP server to diagnose build failures, fix issues, and manage CI pipelines through natural language commands.
    - Intelligent summaries (https://circleci.com/docs/guides/toolkit/intelligent-summaries/) [md](https://circleci.com/docs/guides/toolkit/intelligent-summaries/index.md)
      An overview of the intelligent summaries feature, an AI enabled helper feature in CircleCI that provides help with build failures
  - CLI
    - CircleCI environment CLI usage guide (https://circleci.com/docs/guides/toolkit/environment-cli-usage-guide/) [md](https://circleci.com/docs/guides/toolkit/environment-cli-usage-guide/index.md)
      Using the CircleCI environment CLI in your CI/CD pipeline
    - Install and configure the CircleCI local CLI (https://circleci.com/docs/guides/toolkit/local-cli/) [md](https://circleci.com/docs/guides/toolkit/local-cli/index.md)
      How to install the CircleCI local CLI
    - How to use the CircleCI local CLI (https://circleci.com/docs/guides/toolkit/how-to-use-the-circleci-local-cli/) [md](https://circleci.com/docs/guides/toolkit/how-to-use-the-circleci-local-cli/index.md)
      How to use the CircleCI local CLI
  - APIs
    - API v2 intro (https://circleci.com/docs/guides/toolkit/api-intro/) [md](https://circleci.com/docs/guides/toolkit/api-intro/index.md)
      Introduction to the CircleCI API
    - API v2 developers guide (https://circleci.com/docs/guides/toolkit/api-developers-guide/) [md](https://circleci.com/docs/guides/toolkit/api-developers-guide/index.md)
      API guide for internal and external CircleCI developers
    - Managing API tokens (https://circleci.com/docs/guides/toolkit/managing-api-tokens/) [md](https://circleci.com/docs/guides/toolkit/managing-api-tokens/index.md)
      How to assign scoped tokens for using the CircleCI API
  - IDE tools
    - VS Code extension overview (https://circleci.com/docs/guides/toolkit/vs-code-extension-overview/) [md](https://circleci.com/docs/guides/toolkit/vs-code-extension-overview/index.md)
      Learn about how the CircleCI VS Code extension can help you manage your pipelines, workflows and jobs.
    - Get started with the VS Code extension (https://circleci.com/docs/guides/toolkit/get-started-with-the-vs-code-extension/) [md](https://circleci.com/docs/guides/toolkit/get-started-with-the-vs-code-extension/index.md)
      A quickstart tutorial for the CircleCI VS Code extension.
  - Config tools
    - Config SDK (https://circleci.com/docs/guides/toolkit/circleci-config-sdk/) [md](https://circleci.com/docs/guides/toolkit/circleci-config-sdk/index.md)
      The CircleCI Config SDK is a JavaScript package library for generating CircleCI config YAML.
    - Orb development kit (https://circleci.com/docs/orbs/author/orb-author/) [md](https://circleci.com/docs/orbs/author/orb-author/index.md)
      Starting point for authoring CircleCI orbs
    - Image Updater (https://circleci.com/docs/guides/toolkit/circleci-image-updater/) [md](https://circleci.com/docs/guides/toolkit/circleci-image-updater/index.md)
      The CircleCI tool to help customers update images in config.
  - Example projects and configs
    - Examples and guides overview (https://circleci.com/docs/guides/toolkit/examples-and-guides-overview/) [md](https://circleci.com/docs/guides/toolkit/examples-and-guides-overview/index.md)
      Resources for learning CircleCI using examples.
    - Sample config.yml files (https://circleci.com/docs/guides/toolkit/sample-config/) [md](https://circleci.com/docs/guides/toolkit/sample-config/index.md)
      Sample config.yml File
    - Database examples (https://circleci.com/docs/guides/toolkit/postgres-config/) [md](https://circleci.com/docs/guides/toolkit/postgres-config/index.md)
      See example database config.yml files using PostgreSQL/Rails and MySQL/Ruby for rails app with structure.sql, go app with postgresql, and mysql project.
- Plans and pricing
  - CircleCI plans overview (https://circleci.com/docs/guides/plans-pricing/plan-overview/) [md](https://circleci.com/docs/guides/plans-pricing/plan-overview/index.md)
    This document is an introduction to the plans CircleCI offers to developers.
  - Credits overview (https://circleci.com/docs/guides/plans-pricing/credits/) [md](https://circleci.com/docs/guides/plans-pricing/credits/index.md)
    Learn about the CircleCI credits-based plan system.
  - Manage budgets (https://circleci.com/docs/guides/plans-pricing/manage-budgets/) [md](https://circleci.com/docs/guides/plans-pricing/manage-budgets/index.md)
    Learn how to manage and monitor your CircleCI credit usage by setting spending limits at the organization and project level.
  - Free Plan overview (https://circleci.com/docs/guides/plans-pricing/plan-free/) [md](https://circleci.com/docs/guides/plans-pricing/plan-free/index.md)
    This document describes the Free Plan available to developers on CircleCI.
  - Performance Plan overview (https://circleci.com/docs/guides/plans-pricing/plan-performance/) [md](https://circleci.com/docs/guides/plans-pricing/plan-performance/index.md)
    This document describes the Performance Plan available to developers on CircleCI.
  - Scale Plan overview (https://circleci.com/docs/guides/plans-pricing/plan-scale/) [md](https://circleci.com/docs/guides/plans-pricing/plan-scale/index.md)
    This document describes the Scale Plan available to developers on CircleCI.
  - Server Plan overview (https://circleci.com/docs/guides/plans-pricing/plan-server/) [md](https://circleci.com/docs/guides/plans-pricing/plan-server/index.md)
    This document describes the Server Plan available to developers on CircleCI.

### Reference ()
- Configuration
  - Configuration reference (https://circleci.com/docs/reference/configuration-reference/) [md](https://circleci.com/docs/reference/configuration-reference/index.md)
    Reference for .circleci/config.yml
  - Reusable configuration reference (https://circleci.com/docs/reference/reusing-config/) [md](https://circleci.com/docs/reference/reusing-config/index.md)
    Reference guide for CircleCI 2.1 Configuration
  - Project values and variables (https://circleci.com/docs/reference/variables/) [md](https://circleci.com/docs/reference/variables/index.md)
    A list of all built-in variables for your CircleCI projects.
  - Config policy reference (https://circleci.com/docs/guides/config-policies/config-policy-reference/) [md](https://circleci.com/docs/guides/config-policies/config-policy-reference/index.md)
    Open preview of config policies for CircleCI. Reference page for function helpers.
  - Optimization reference (https://circleci.com/docs/guides/optimize/optimizations/) [md](https://circleci.com/docs/guides/optimize/optimizations/index.md)
    Learn about ways to optimize your CircleCI pipelines
  - Outbound webhooks reference (https://circleci.com/docs/reference/outbound-webhooks-reference/) [md](https://circleci.com/docs/reference/outbound-webhooks-reference/index.md)
- API
  - API v1 and v2 reference (https://circleci.com/docs/reference/api-homepage/) [md](https://circleci.com/docs/reference/api-homepage/index.md)
  - Runner API reference (https://circleci.com/docs/guides/execution-runner/runner-api/) [md](https://circleci.com/docs/guides/execution-runner/runner-api/index.md)
    This document contains all the external facing endpoints for the CircleCI's self-hosted runner API.
- General
  - Concepts (https://circleci.com/docs/guides/about-circleci/concepts/) [md](https://circleci.com/docs/guides/about-circleci/concepts/index.md)
    CircleCI concepts
  - Glossary (https://circleci.com/docs/reference/glossary/) [md](https://circleci.com/docs/reference/glossary/index.md)
    A glossary of terms used for the CircleCI product.
  - Environment CLI usage guide (https://circleci.com/docs/guides/toolkit/environment-cli-usage-guide/) [md](https://circleci.com/docs/guides/toolkit/environment-cli-usage-guide/index.md)
    Using the CircleCI environment CLI in your CI/CD pipeline
  - Insights metrics glossary (https://circleci.com/docs/guides/insights/insights-glossary/) [md](https://circleci.com/docs/guides/insights/insights-glossary/index.md)
    Definitions for the metrics in CircleCI Insights, Insights dashboard as well as the Insights API.
  - Troubleshoot (https://circleci.com/docs/reference/troubleshoot/) [md](https://circleci.com/docs/reference/troubleshoot/index.md)
    Troubleshoot CircleCI and various setups and integrations.
  - FAQ (https://circleci.com/docs/reference/faq/) [md](https://circleci.com/docs/reference/faq/index.md)
    Frequently asked questions about CircleCI

### Orbs ()
- Use orbs
  - Introduction to using orbs (https://circleci.com/docs/orbs/use/orb-intro/) [md](https://circleci.com/docs/orbs/use/orb-intro/index.md)
    Starting point for using CircleCI orbs
  - Orb concepts (https://circleci.com/docs/orbs/use/orb-concepts/) [md](https://circleci.com/docs/orbs/use/orb-concepts/index.md)
    Conceptual Overview for Orbs
  - Managing URL orbs allow lists (https://circleci.com/docs/orbs/use/managing-url-orbs-allow-lists/) [md](https://circleci.com/docs/orbs/use/managing-url-orbs-allow-lists/index.md)
    How to manage URL orbs allow-lists
  - FAQ (https://circleci.com/docs/orbs/use/orbs-faq/) [md](https://circleci.com/docs/orbs/use/orbs-faq/index.md)
    This page answers the most frequently asked questions about orbs.
- Author orbs
  - Introduction to authoring orbs (https://circleci.com/docs/orbs/author/orb-author/) [md](https://circleci.com/docs/orbs/author/orb-author/index.md)
    Starting point for authoring CircleCI orbs
  - Create a registry orb (https://circleci.com/docs/orbs/author/create-test-and-publish-a-registry-orb/) [md](https://circleci.com/docs/orbs/author/create-test-and-publish-a-registry-orb/index.md)
    Tutorial showing how to create an orb using the orb development kit.
  - Create a URL orb (https://circleci.com/docs/orbs/author/create-test-and-use-url-orbs/) [md](https://circleci.com/docs/orbs/author/create-test-and-use-url-orbs/index.md)
    How to author URL orbs for your organization
  - Create an inline orb (https://circleci.com/docs/orbs/author/create-an-inline-orb/) [md](https://circleci.com/docs/orbs/author/create-an-inline-orb/index.md)
    How to author inline orbs for your projects
  - Registry orb testing methodologies (https://circleci.com/docs/orbs/author/testing-orbs/) [md](https://circleci.com/docs/orbs/author/testing-orbs/index.md)
    Starting point for Testing CircleCI Orbs
  - Registry orb authoring process (manual) (https://circleci.com/docs/orbs/author/manual-orb-authoring-process/) [md](https://circleci.com/docs/orbs/author/manual-orb-authoring-process/index.md)
    Authoring simple orbs manually without the orb development kit.
  - Best practices (https://circleci.com/docs/orbs/author/orbs-best-practices/) [md](https://circleci.com/docs/orbs/author/orbs-best-practices/index.md)
    A reference guide to best practices for developing orbs.
  - FAQ (https://circleci.com/docs/orbs/author/orb-author-faq/) [md](https://circleci.com/docs/orbs/author/orb-author-faq/index.md)
    This page answers the most frequently asked questions by orb authors.

### Server
- Versions: server-4.9, server-4.8, server-4.7, server-4.6, server-4.5, server-4.4, server-4.3, server-4.2
- CircleCI Server Overview (https://circleci.com/docs/server-admin/latest/overview/circleci-server-overview/) [md](https://circleci.com/docs/server-admin/latest/overview/circleci-server-overview/index.md)
  CircleCI Server 4.9 is a continuous integration and continuous delivery (CI/CD) platform that you can install on your GCP or AWS Kubernetes cluster.
- Release notes (https://circleci.com/docs/server-admin/latest/overview/release-notes/) [md](https://circleci.com/docs/server-admin/latest/overview/release-notes/index.md)
  Details of the new features included in each CircleCI Server 4.9 release.
- Installing CircleCI Server
  - Install on AWS
    - Phase 1: AWS prerequisites (https://circleci.com/docs/server-admin/latest/installation/phase-1-aws-prerequisites/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-1-aws-prerequisites/index.md)
      Find the general and infrastructure-specific requirements that are needed in order to configure the CircleCI server 4.9 application.
    - Phase 2: AWS Core services installation (https://circleci.com/docs/server-admin/latest/installation/phase-2-aws-core-services/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-2-aws-core-services/index.md)
      Installation guide for CircleCI server 4.9 core services.
    - Phase 3: AWS execution environments installation (https://circleci.com/docs/server-admin/latest/installation/phase-3-aws-execution-environments/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-3-aws-execution-environments/index.md)
      Installation guide for CircleCI server 4.9 execution environments.
    - Phase 4: AWS post-installation (https://circleci.com/docs/server-admin/latest/installation/phase-4-aws-post-installation/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-4-aws-post-installation/index.md)
      CircleCI server 4.9 post installation steps.
  - Install on GCP
    - Phase 1: GCP prerequisites (https://circleci.com/docs/server-admin/latest/installation/phase-1-gcp-prerequisites/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-1-gcp-prerequisites/index.md)
      Find the general and infrastructure-specific requirements that are needed in order to configure the CircleCI server 4.9 application.
    - Phase 2: GCP Core services installation (https://circleci.com/docs/server-admin/latest/installation/phase-2-gcp-core-services/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-2-gcp-core-services/index.md)
      Installation guide for CircleCI server 4.9 core services.
    - Phase 3: GCP execution environments installation (https://circleci.com/docs/server-admin/latest/installation/phase-3-gcp-execution-environments/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-3-gcp-execution-environments/index.md)
      Installation guide for CircleCI server 4.9 execution environments.
    - Phase 4: GCP post-installation (https://circleci.com/docs/server-admin/latest/installation/phase-4-gcp-post-installation/) [md](https://circleci.com/docs/server-admin/latest/installation/phase-4-gcp-post-installation/index.md)
      CircleCI server 4.9 post installation steps.
  - Install in an air-gapped environment
    - Phase 1 - Prerequisites (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-1-prerequisites/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-1-prerequisites/index.md)
      A guide to installing CircleCI Server 4.9 in an air-gapped environment. Requirements, images and Helm charts.
    - Phase 2 - Configure object storage (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-2-configure-object-storage/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-2-configure-object-storage/index.md)
      How to configure object storage through MinIO to run CircleCI Server 4.9 in an air-gapped environment.
    - Phase 3 - Install CircleCI Server (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-3-install-circleci-server/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-3-install-circleci-server/index.md)
      How to install the CircleCI Server 4.9 Helm deployment to an air-gapped environment.
    - Phase 4 - Configure Nomad clients (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-4-configure-nomad-clients/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-4-configure-nomad-clients/index.md)
      How to configure Nomad clients to run with CircleCI Server 4.9 in an air-gapped environment.
    - Phase 5 - Test installation (https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-5-test-your-installation/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/phase-5-test-your-installation/index.md)
      How to test your CircleCI Server 4.9 installation in an air-gapped environment.
    - Additional considerations (https://circleci.com/docs/server-admin/latest/air-gapped-installation/additional-considerations/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/additional-considerations/index.md)
      This page presents some items that should be considered when starting an air-gapped installation of CircleCI Server 4.9.
    - Example values.yaml (https://circleci.com/docs/server-admin/latest/air-gapped-installation/example-values/) [md](https://circleci.com/docs/server-admin/latest/air-gapped-installation/example-values/index.md)
      This page presents an example values.yaml file to help with setting up an air-gapped installation of CircleCI Server 4.9.
  - Hardening your cluster (https://circleci.com/docs/server-admin/latest/installation/hardening-your-cluster/) [md](https://circleci.com/docs/server-admin/latest/installation/hardening-your-cluster/index.md)
    This section provides supplemental information on hardening your Kubernetes cluster for CircleCI Server 4.9.
  - Installing server behind a proxy (https://circleci.com/docs/server-admin/latest/installation/installing-server-behind-a-proxy/) [md](https://circleci.com/docs/server-admin/latest/installation/installing-server-behind-a-proxy/index.md)
    Learn how to install CircleCI Server 4.9 behind a proxy.
  - Upgrading server (https://circleci.com/docs/server-admin/latest/installation/upgrade-server/) [md](https://circleci.com/docs/server-admin/latest/installation/upgrade-server/index.md)
    "This document lists the steps required to upgrade a CircleCI Server 4.9 installation."
  - Installation reference (https://circleci.com/docs/server-admin/latest/installation/installation-reference/) [md](https://circleci.com/docs/server-admin/latest/installation/installation-reference/index.md)
    Reference documentation for installing CircleCI Server 4.9.
- CircleCI Server operator guide
  - Operator overview (https://circleci.com/docs/server-admin/latest/operator/operator-overview/) [md](https://circleci.com/docs/server-admin/latest/operator/operator-overview/index.md)
    Learn about the various tasks and tools involved in administering an installation of CircleCI Server 4.9.
  - Introduction to Nomad cluster operation (https://circleci.com/docs/server-admin/latest/operator/introduction-to-nomad-cluster-operation/) [md](https://circleci.com/docs/server-admin/latest/operator/introduction-to-nomad-cluster-operation/index.md)
    Learn how to operate the Nomad Cluster in your CircleCI Server 4.9 installation.
  - Resource consumption and cost management (https://circleci.com/docs/server-admin/latest/operator/resource-consumption-cost-management/) [md](https://circleci.com/docs/server-admin/latest/operator/resource-consumption-cost-management/index.md)
    Learn how CircleCI Server consumes cloud resources and how to monitor costs.
  - Managing user accounts (https://circleci.com/docs/server-admin/latest/operator/managing-user-accounts/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-user-accounts/index.md)
    This section provides information to help CircleCI Server 4.9 operators manage user accounts.
  - Managing orbs (https://circleci.com/docs/server-admin/latest/operator/managing-orbs/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-orbs/index.md)
    Use this page to learn about orbs and how to manage them within CircleCI Server 4.9.
  - Manage virtual machines with machine provisioner (https://circleci.com/docs/server-admin/latest/operator/manage-virtual-machines-with-machine-provisioner/) [md](https://circleci.com/docs/server-admin/latest/operator/manage-virtual-machines-with-machine-provisioner/index.md)
    CircleCI Server 4.9 machine provisioner service controls how machine executor (Linux and Windows images) and Remote Docker jobs are run.
  - Configuring external services (https://circleci.com/docs/server-admin/latest/operator/configuring-external-services/) [md](https://circleci.com/docs/server-admin/latest/operator/configuring-external-services/index.md)
    This document describes how to configure the following external services for use with a CircleCI Server 4.9 installation
  - Data retention in server (https://circleci.com/docs/server-admin/latest/operator/data-retention/) [md](https://circleci.com/docs/server-admin/latest/operator/data-retention/index.md)
    Learn how to configure data retention policies for MongoDB, PostgreSQL, and object storage buckets in your CircleCI Server installation.
  - Expanding internal database volumes (https://circleci.com/docs/server-admin/latest/operator/expanding-internal-database-volumes/) [md](https://circleci.com/docs/server-admin/latest/operator/expanding-internal-database-volumes/index.md)
    Expanding internal database volumes for CircleCI Server 4.9.
  - Managing load balancers (https://circleci.com/docs/server-admin/latest/operator/managing-load-balancers/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-load-balancers/index.md)
    Use this guide to make the frontend load balancer private for CircleCI Server 4.9.
  - User authentication (https://circleci.com/docs/server-admin/latest/operator/user-authentication/) [md](https://circleci.com/docs/server-admin/latest/operator/user-authentication/index.md)
    CircleCI Server 4.9 supports OAuth through GitHub or GitHub Enterprise.
  - Managing build artifacts (https://circleci.com/docs/server-admin/latest/operator/managing-build-artifacts/) [md](https://circleci.com/docs/server-admin/latest/operator/managing-build-artifacts/index.md)
    Learn how CircleCI Server 4.9 build artifacts persist data after a job is completed and how they can be used for longer-term storage of your build process outputs.
  - Usage data collection (https://circleci.com/docs/server-admin/latest/operator/usage-data-collection/) [md](https://circleci.com/docs/server-admin/latest/operator/usage-data-collection/index.md)
    Learn about CircleCI Server 4.9 usage data collection for the purpose of improving our product and services.
  - CircleCI Server security features (https://circleci.com/docs/server-admin/latest/operator/circleci-server-security-features/) [md](https://circleci.com/docs/server-admin/latest/operator/circleci-server-security-features/index.md)
    This document outlines security features built into CircleCI Server 4.9 and related integrations.
  - Application lifecycle (https://circleci.com/docs/server-admin/latest/operator/application-lifecycle/) [md](https://circleci.com/docs/server-admin/latest/operator/application-lifecycle/index.md)
    Learn about CircleCI Server 4.9 semantic versioning and release schedules.
  - Troubleshooting and support (https://circleci.com/docs/server-admin/latest/operator/troubleshooting-and-support/) [md](https://circleci.com/docs/server-admin/latest/operator/troubleshooting-and-support/index.md)
    Use this document to find troubleshooting steps if you are having problems with your CircleCI Server 4.9 installation.
  - Backup and restore (https://circleci.com/docs/server-admin/latest/operator/backup-and-restore/) [md](https://circleci.com/docs/server-admin/latest/operator/backup-and-restore/index.md)
    This document outlines recommendations for how to back up and restore your CircleCI Server 4.9 instance data and state.
  - Upgrade MongoDB (https://circleci.com/docs/server-admin/latest/operator/upgrade-mongo/) [md](https://circleci.com/docs/server-admin/latest/operator/upgrade-mongo/index.md)
    Learn how to upgrade MongoDB up to v7.0.15 in an installation of CircleCI Server 4.9.
  - Monitoring stack reference Helm chart (https://circleci.com/docs/server-admin/latest/operator/monitoring-stack-reference-helm-chart/) [md](https://circleci.com/docs/server-admin/latest/operator/monitoring-stack-reference-helm-chart/index.md)
    Learn how to deploy your own monitoring stack using our Helm chart as a reference.
  - FAQs (https://circleci.com/docs/server-admin/latest/operator/faq/) [md](https://circleci.com/docs/server-admin/latest/operator/faq/index.md)
    Find answers about the CircleCI Server 4.9 data retention policy, what control is granted over Nomad certificates.

### Services ()
- Field engineering services overview (https://circleci.com/docs/services/services-overview/) [md](https://circleci.com/docs/services/services-overview/index.md)
  Field engineering services overview
- Services
  - Optimization assistance (https://circleci.com/docs/services/services/optimization-assistance/) [md](https://circleci.com/docs/services/services/optimization-assistance/index.md)
    Optimization assistance service
  - Onboarding assistance (https://circleci.com/docs/services/services/onboarding-assistance/) [md](https://circleci.com/docs/services/services/onboarding-assistance/index.md)
    Onboarding assistance service
  - Migration assistance (https://circleci.com/docs/services/services/migration-assistance/) [md](https://circleci.com/docs/services/services/migration-assistance/index.md)
    Migration assistance service
  - Configuration review (https://circleci.com/docs/services/services/config-review/) [md](https://circleci.com/docs/services/services/config-review/index.md)
    Configuration review service
  - Configuration translation (https://circleci.com/docs/services/services/config-translation/) [md](https://circleci.com/docs/services/services/config-translation/index.md)
    Configuration translation service
  - Cost optimization (https://circleci.com/docs/services/services/cost-optimization/) [md](https://circleci.com/docs/services/services/cost-optimization/index.md)
    Cost optimization service
  - Technical consultation (https://circleci.com/docs/services/services/technical-consultation/) [md](https://circleci.com/docs/services/services/technical-consultation/index.md)
    Technical consultation service
  - Custom service (https://circleci.com/docs/services/services/custom-service/) [md](https://circleci.com/docs/services/services/custom-service/index.md)
    Custom service
  - Server assistance
    - Server installation (https://circleci.com/docs/services/services/server-installation/) [md](https://circleci.com/docs/services/services/server-installation/index.md)
      Server installation service
    - Server migration (https://circleci.com/docs/services/services/server-migration/) [md](https://circleci.com/docs/services/services/server-migration/index.md)
      Server migration service
    - Server operator training (https://circleci.com/docs/services/services/server-operator-training/) [md](https://circleci.com/docs/services/services/server-operator-training/index.md)
      Server operator training
- Training
  - General developer training (https://circleci.com/docs/services/services/general-developer-training/) [md](https://circleci.com/docs/services/services/general-developer-training/index.md)
    General developer training service
  - Reusable configuration training (https://circleci.com/docs/services/services/reusable-config-training/) [md](https://circleci.com/docs/services/services/reusable-config-training/index.md)
    Reusable configuration training
  - Usage API training (https://circleci.com/docs/services/services/usage-api-training/) [md](https://circleci.com/docs/services/services/usage-api-training/index.md)
    Usage API training

### Contributors ()
- Docs style guide
  - Overview (https://circleci.com/docs/contributors/docs-style/) [md](https://circleci.com/docs/contributors/docs-style/index.md)
    An overview of contributing to CircleCI docs including page templates and our style guide.
  - Formatting (https://circleci.com/docs/contributors/docs-style/formatting/) [md](https://circleci.com/docs/contributors/docs-style/formatting/index.md)
  - Style and voice (https://circleci.com/docs/contributors/docs-style/style-and-voice/) [md](https://circleci.com/docs/contributors/docs-style/style-and-voice/index.md)
  - Headings (https://circleci.com/docs/contributors/docs-style/headings/) [md](https://circleci.com/docs/contributors/docs-style/headings/index.md)
  - Using lists (https://circleci.com/docs/contributors/docs-style/using-lists/) [md](https://circleci.com/docs/contributors/docs-style/using-lists/index.md)
  - Cross references and links (https://circleci.com/docs/contributors/docs-style/links/) [md](https://circleci.com/docs/contributors/docs-style/links/index.md)
  - Using images (https://circleci.com/docs/contributors/docs-style/using-images/) [md](https://circleci.com/docs/contributors/docs-style/using-images/index.md)
    Guidelines for using images in CircleCI documentation.
  - Using tables (https://circleci.com/docs/contributors/docs-style/using-tables/) [md](https://circleci.com/docs/contributors/docs-style/using-tables/index.md)
  - Using code samples (https://circleci.com/docs/contributors/docs-style/using-code-samples/) [md](https://circleci.com/docs/contributors/docs-style/using-code-samples/index.md)
  - Page title badges (https://circleci.com/docs/contributors/docs-style/title-badges/) [md](https://circleci.com/docs/contributors/docs-style/title-badges/index.md)
- Content templates
  - Template for a conceptual page (https://circleci.com/docs/contributors/templates/template-conceptual/) [md](https://circleci.com/docs/contributors/templates/template-conceptual/index.md)
    A short page description goes here max 155 characters.
  - Template for a how-to page (https://circleci.com/docs/contributors/templates/template-how-to/) [md](https://circleci.com/docs/contributors/templates/template-how-to/index.md)
    A short page description goes here max 155 characters.
  - Template for a tutorial page (https://circleci.com/docs/contributors/templates/template-tutorial/) [md](https://circleci.com/docs/contributors/templates/template-tutorial/index.md)
    A short page description goes here
  - A test page to show all assets and styles (https://circleci.com/docs/contributors/templates/test-page-one/) [md](https://circleci.com/docs/contributors/templates/test-page-one/index.md)
    A page with all components for testing the new docs site.

### Home ()

## Content Statistics

- Total components: 7
- Total pages: 580

Pages by component:
  - Guides: 239
  - server-admin (server-4.9): 41
  - server-admin (server-4.8): 41
  - server-admin (server-4.7): 39
  - server-admin (server-4.6): 34
  - server-admin (server-4.5): 34
  - server-admin (server-4.4): 34
  - server-admin (server-4.3): 34
  - server-admin (server-4.2): 34
  - Services: 15
  - Contributors: 14
  - Orbs: 12
  - Reference: 8
  - Home: 1

## Technical Stack

- Static Site Generator: Antora 3.1.14
- Markup Language: AsciiDoc
- API Docs: Redocly CLI 2.0.0
- Search: Algolia
- Build Tool: npm scripts with Gulp

## Common URL Patterns

- Guides: https://circleci.com/docs/guides/<topic>/
- Reference: https://circleci.com/docs/reference/<topic>/
- Orbs: https://circleci.com/docs/orbs/<topic>/
- Server Admin: https://circleci.com/docs/server-admin-<version>/<topic>/
- API: https://circleci.com/docs/api/<version>/

## Server Versions

- Server 4.9: 4.9.1
- Server 4.8: 4.8.8
- Server 4.7: 4.7.15
- Server 4.6: 4.6.6
- Server 4.5: 4.5.5
- Server 4.4: 4.4.7
- Server 4.3: 4.3.9
- Server 4.2: 4.2.7
- Server 4.1: 4.1.10
- Server 4.0: 4.0.6