hugo.yaml

title: Docker Docs
baseURL: https://docs.docker.com
refLinksErrorLevel: WARNING
enableGitInfo: true
disablePathToLower: true
enableInlineShortcodes: true
disableKinds:
  - taxonomy
  - term

markup:
  tableOfContents:
    startLevel: 2
    endLevel: 3
  goldmark:
    extensions:
      typographer: false
    parser:
      wrapStandAloneImageWithinParagraph: false
      attribute:
        block: true
    renderer:
      unsafe: true
  highlight:
    noClasses: false

related:
  includeNewer: true
  indices:
  - name: keywords
    weight: 80
  - name: fragmentrefs
    applyFilter: false
    type: fragments
    weight: 80
  threshold: 20
  toLower: false

build:
  writeStats: true
  cachebusters:
    - source: "assets/watching/hugo_stats\\.json"
      target: "styles\\.css"
    - source: "(postcss|tailwind)\\.config\\.js"
      target: "css"
    - source: "assets/.*\\.(js|ts|jsx|tsx)"
      target: "js"
    - source: "(assets|layouts)/.*\\.(.*)$"
      target: "$1"

outputFormats:
  redirects:
    baseName: redirects
    isPlainText: true
    mediaType: "application/json"
    notAlternative: true
  robots:
    baseName: robots
    isPlainText: true
    mediaType: "text/plain"
    notAlternative: true

outputs:
  home:
    - html
    - redirects
    - robots
  term:
    - html
    - json

taxonomies:

languages:
  en:
    languageName: English

params:
  analytics:
    hotjar:
      prod: 3169877
      stage: 3218181
    google: GTM-WL2QLG5
    onetrust: 8e0ebfd9-035d-4ec2-9b2f-a2de9c09f906
  algolia:
    appid: 3XRLW0LZH9
    apikey: 2899036ce47dba191b8dc1758e4bc6a4
    indexname: docker

  repo: https://github.com/docker/docs
  docs_url: https://docs.docker.com

  latest_engine_api_version: "1.43"
  docker_ce_version: "24.0.0"
  compose_v1_version: "1.29.2"
  compose_version: "v2.20.3"
  compose_file_v3: "3.8"
  compose_file_v2: "2.4"
  machine_version: "0.16.0"
  distribution_version: "2.7"
  compose_switch_version: "1.0.4"
  buildkit_version: "0.12.1"

  example_go_version: "1.20"
  example_golangci_lint_version: "v1.52"

  min_api_threshold: 1.40


menus:
  main:
  - name: Guides
    url: /get-started/overview/
    weight: 1
  - name: Manuals
    url: /desktop/
    weight: 2
  - name: Reference
    url: /reference/
    weight: 3
  - name: Samples
    url: /samples/
    weight: 4
  - name: FAQ
    url: /faq/
    weight: 5
  - name: Contribute
    url: /contribute/overview/
    weight: 6

  footer:
    - url: https://www.docker.com/products
      name: Product offerings
    - url: https://www.docker.com/products/personal
      name: Docker Personal
      parent: Product offerings
    - url: https://www.docker.com/products/pro
      name: Docker Pro
      parent: Product offerings
    - url: https://www.docker.com/products/team
      name: Docker Team
      parent: Product offerings
    - url: https://www.docker.com/products/business
      name: Docker Business
      parent: Product offerings
    - url: https://www.docker.com/pricing/faq
      name: Pricing FAQs
      parent: Product offerings
    - url: https://www.docker.com/partners/programs
      name: Docker Verified Publisher
      parent: Product offerings
    - url: https://www.docker.com/partners
      name: Partners
      parent: Product offerings

    - url: https://www.docker.com/
      name: Features
    - url: https://www.docker.com/products/docker-desktop
      name: Docker Desktop
      parent: Features
    - url: https://www.docker.com/products/docker-hub
      name: Docker Hub
      parent: Features
    - url: https://www.docker.com/products/secure-software-supply-chain
      name: Secure Software Supply Chain
      parent: Features
    - url: https://www.docker.com/products/container-runtime
      name: Container Runtime
      parent: Features
    - url: https://www.docker.com/products/developer-tools
      name: Developer Tools
      parent: Features
    - url: https://www.docker.com/partners
      name: Trusted Content
      parent: Features
    - url: https://www.docker.com/roadmap
      name: Docker Product Roadmap
      parent: Features

    - name: Developers
    - url: https://www.docker.com/use-cases
      name: Use cases
      parent: Developers
    - url: /get-started/
      name: Get started
      parent: Developers
    - url: https://www.docker.com/blog/
      name: Block
      parent: Developers
    - url: https://www.docker.com/docker-community
      name: Community
      parent: Developers
    - url: https://www.docker.com/open-source
      name: Open Source
      parent: Developers
    - url: https://www.docker.com/community/get-involved/developer-preview
      name: Preview Program
      parent: Developers

    - url: https://www.docker.com/company
      name: About us
    - url: https://www.docker.com/what-container
      name: What is a container?
      parent: About us
    - url: https://www.docker.com/why-docker
      name: Why Docker?
      parent: About us
    - url: https://www.docker.com/events
      name: Virtual events
      parent: About us
    - url: https://www.docker.com/swag
      name: Swag store
      parent: About us
    - url: https://www.docker.com/company/newsroom
      name: Newsroom
      parent: About us
    - url: https://www.docker.com/careers
      name: Careers
      parent: About us
    - url: https://www.docker.com/company/contact
      name: Contact us
      parent: About us
    - url: https://www.docker.com/customers
      name: Customers
      parent: About us
    - url: https://www.docker.com/newsletter-subscription
      name: Newsletter
      parent: About us

module:
  proxy: https://proxy.golang.org,direct
  hugoVersion:
    extended: false
    min: "0.116.1"
  mounts:
    - source: assets
      target: assets
    - source: hugo_stats.json
      target: assets/watching/hugo_stats.json
  imports:

    - path: github.com/moby/moby
      mounts:
        - source: docs/api
          target: content/engine/api
          includeFiles: "*.md"
        - source: docs/api
          target: static/reference/engine
          includeFiles: "*.yaml"

    - path: github.com/moby/buildkit
      mounts:
        - source: frontend/dockerfile/docs/reference.md
          target: content/engine/reference/builder.md
        - source: docs/buildkitd.toml.md
          target: content/build/buildkit/toml-configuration.md
        - source: docs/attestations/slsa-definitions.md
          target: content/build/attestations/slsa-definitions.md
        - source: docs/attestations/attestation-storage.md
          target: content/build/attestations/attestation-storage.md

    - path: github.com/docker/buildx
      mounts:
        - source: docs/bake-reference.md
          target: content/build/bake/reference.md

    - path: github.com/docker/scout-cli
      mounts:
        - source: docs
          includeFiles: "*.yaml"
          target: data/scout-cli

    - path: github.com/docker/cli
      mounts:
        - source: docs/extend
          target: content/engine/extend
          excludefiles: "index.md"
        - source: docs/extend/index.md
          target: content/engine/extend/_index.md
        - source: docs/deprecated.md
          target: content/engine/deprecated.md
        - source: docs/reference/run.md
          target: content/engine/reference/run.md
        - source: docs/reference/commandline/cli.md
          target: content/engine/reference/commandline/cli.md
        - source: docs/reference/commandline/dockerd.md
          target: content/engine/reference/commandline/dockerd.md

    - path: github.com/docker/compose-cli
      mounts:
        - source: docs/aci-compose-features.md
          target: content/cloud/aci-compose-features.md
        - source: docs/aci-container-features.md
          target: content/cloud/aci-container-features.md
        - source: docs/ecs-architecture.md
          target: content/cloud/ecs-architecture.md
        - source: docs/ecs-compose-examples.md
          target: content/cloud/ecs-compose-examples.md
        - source: docs/ecs-compose-features.md
          target: content/cloud/ecs-compose-features.md

    - path: github.com/distribution/distribution
      mounts:
      - source: docs
        target: content/registry
        excludeFiles:
        - "**/index.md"
        - "**/api.md.tmpl"
      - source: docs/spec/index.md
        target: content/registry/spec/_index.md
      - source: docs/spec/auth/index.md
        target: content/registry/spec/auth/_index.md

    - path: github.com/compose-spec/compose-spec
      mounts:
      - source: 01-status.md
        target: content/compose/compose-file/01-status.md
      - source: 02-model.md
        target: content/compose/compose-file/02-model.md
      - source: 03-compose-file.md
        target: content/compose/compose-file/03-compose-file.md
      - source: 04-version-and-name.md
        target: content/compose/compose-file/04-version-and-name.md
      - source: 05-services.md
        target: content/compose/compose-file/05-services.md
      - source: 06-networks.md
        target: content/compose/compose-file/06-networks.md
      - source: 07-volumes.md
        target: content/compose/compose-file/07-volumes.md
      - source: 08-configs.md
        target: content/compose/compose-file/08-configs.md
      - source: 09-secrets.md
        target: content/compose/compose-file/09-secrets.md
      - source: 10-fragments.md
        target: content/compose/compose-file/10-fragments.md
      - source: 11-extension.md
        target: content/compose/compose-file/11-extension.md
      - source: 12-interpolation.md
        target: content/compose/compose-file/12-interpolation.md
      - source: 13-merge.md
        target: content/compose/compose-file/13-merge.md
      - source: 14-include.md
        target: content/compose/compose-file/14-include.md
      - source: 15-profiles.md
        target: content/compose/compose-file/15-profiles.md
      - source: build.md
        target: content/compose/compose-file/build.md
      - source: deploy.md
        target: content/compose/compose-file/deploy.md