From c36309ed8a2fee5d587db4b00952cbc196b8f19b Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Tue, 3 Sep 2024 10:59:47 +0200 Subject: [PATCH] hugo: render site navigation using sections Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- CONTRIBUTING.md | 9 +- assets/css/global.css | 8 - assets/js/src/sidebar.js | 14 - data/toc.yaml | 2441 ------------------------- hugo.yaml | 10 +- hugo_stats.json | 6 +- layouts/partials/breadcrumbs.html | 21 +- layouts/partials/sidebar.html | 110 +- layouts/partials/top-nav.html | 4 +- layouts/partials/utils/tocparser.html | 49 - layouts/tag/term.html | 9 +- 11 files changed, 82 insertions(+), 2599 deletions(-) delete mode 100644 assets/js/src/sidebar.js delete mode 100644 data/toc.yaml delete mode 100644 layouts/partials/utils/tocparser.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc952ef94f..7be64aa7ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,9 +24,12 @@ The website is built using [Hugo](https://gohugo.io/). The content is primarily Markdown files in the `/content` directory of this repository (with a few exceptions, see [Content not edited here](#content-not-edited-here)). -The structure of the sidebar navigation on the site is defined in -[`/data/toc.yaml`](./data/toc.yaml). To rename or change the location of a page -in the left-hand navigation, edit the `toc.yaml` file. +The structure of the sidebar navigation on the site is defined by the site's +section hierarchy in the `contents` directory. The titles of the pages are +defined in the front matter of the Markdown files. You can use `title` and +`linkTitle` to define the title of the page. `title` is used for the page +title, and `linkTitle` is used for the sidebar title. If `linkTitle` is not +defined, the `title` is used for both. You must fork this repository to create a pull request to propose changes. For more details, see [Local setup](#local-setup). diff --git a/assets/css/global.css b/assets/css/global.css index 45eb8a3abf..1644831ce7 100644 --- a/assets/css/global.css +++ b/assets/css/global.css @@ -31,14 +31,6 @@ @apply dark:hue-rotate-180 dark:invert dark:filter; } - .sidebar-hover { - @apply hover:bg-gray-light-200 hover:dark:bg-gray-dark-200; - } - - .sidebar-underline { - @apply underline decoration-blue-light decoration-4 underline-offset-4 dark:decoration-blue-dark; - } - .bg-pattern-blue { background-color: theme(colors.white / 50%); background-image: url('/assets/images/bg-pattern-blue.webp'); diff --git a/assets/js/src/sidebar.js b/assets/js/src/sidebar.js deleted file mode 100644 index c455f7997b..0000000000 --- a/assets/js/src/sidebar.js +++ /dev/null @@ -1,14 +0,0 @@ -function toggleMenuItem(event) { - const section = event.currentTarget.parentElement; - const icons = event.currentTarget.querySelectorAll(".icon-svg"); - const subsection = section.querySelector("ul"); - subsection.classList.toggle("hidden"); - icons.forEach(i => i.classList.toggle('hidden')) -} - -const sectiontree = document.querySelector("#sectiontree"); -if (sectiontree) { - for (const button of sectiontree.querySelectorAll("button")) { - button.addEventListener("click", toggleMenuItem); - } -} diff --git a/data/toc.yaml b/data/toc.yaml deleted file mode 100644 index dec6477826..0000000000 --- a/data/toc.yaml +++ /dev/null @@ -1,2441 +0,0 @@ -Get started: -- title: Overview - path: /get-started/ -- title: Get Docker - path: /get-started/get-docker/ -- title: What is Docker? - path: /get-started/docker-overview/ -- sectiontitle: "Introduction" - section: - - title: "Overview" - path: /get-started/introduction/ - - title: "Get Docker Desktop" - path: /get-started/introduction/get-docker-desktop/ - - title: "Develop with containers" - path: /get-started/introduction/develop-with-containers/ - - title: "Build and push your first image" - path: /get-started/introduction/build-and-push-first-image/ - - title: "What's next" - path: /get-started/introduction/whats-next/ -- sectiontitle: "Docker concepts" - section: - - sectiontitle: "The basics" - section: - - title: "What is a container?" - path: /get-started/docker-concepts/the-basics/what-is-a-container/ - - title: "What is an image?" - path: /get-started/docker-concepts/the-basics/what-is-an-image/ - - title: "What is a registry?" - path: /get-started/docker-concepts/the-basics/what-is-a-registry/ - - title: "What is Docker Compose?" - path: /get-started/docker-concepts/the-basics/what-is-docker-compose/ - - sectiontitle: "Building images" - section: - - title: Overview - path: /get-started/docker-concepts/building-images/ - - title: "Understanding image layers" - path: /get-started/docker-concepts/building-images/understanding-image-layers/ - - title: "Writing a Dockerfile" - path: /get-started/docker-concepts/building-images/writing-a-dockerfile/ - - title: "Build, tag and publish an image" - path: /get-started/docker-concepts/building-images/build-tag-and-publish-an-image/ - - title: "Using the build cache" - path: /get-started/docker-concepts/building-images/using-the-build-cache/ - - title: "Multi-stage builds" - path: /get-started/docker-concepts/building-images/multi-stage-builds/ - - sectiontitle: "Running containers" - section: - - title: "Publishing ports" - path: /get-started/docker-concepts/running-containers/publishing-ports/ - - title: "Overriding container defaults" - path: /get-started/docker-concepts/running-containers/overriding-container-defaults/ - - title: "Persisting container data" - path: /get-started/docker-concepts/running-containers/persisting-container-data/ - - title: "Sharing local files with containers" - path: /get-started/docker-concepts/running-containers/sharing-local-files/ - - title: "Multi-container applications" - path: /get-started/docker-concepts/running-containers/multi-container-applications/ -- sectiontitle: Docker workshop - section: - - title: "Part 1: Overview" - path: /get-started/workshop/ - - title: "Part 2: Containerize an application" - path: /get-started/workshop/02_our_app/ - - title: "Part 3: Update the application" - path: /get-started/workshop/03_updating_app/ - - title: "Part 4: Share the application" - path: /get-started/workshop/04_sharing_app/ - - title: "Part 5: Persist the DB" - path: /get-started/workshop/05_persisting_data/ - - title: "Part 6: Use bind mounts" - path: /get-started/workshop/06_bind_mounts/ - - title: "Part 7: Multi-container apps" - path: /get-started/workshop/07_multi_container/ - - title: "Part 8: Use Docker Compose" - path: /get-started/workshop/08_using_compose/ - - title: "Part 9: Image-building best practices" - path: /get-started/workshop/09_image_best/ - - title: "Part 10: What next?" - path: /get-started/workshop/10_what_next/ - -Guides: -- title: Overview - path: /guides/ -- sectiontitle: Language-specific guides - section: - - path: /language/ - title: Overview - - sectiontitle: Node.js - section: - - title: "Overview" - path: /language/nodejs/ - - title: "Containerize your app" - path: /language/nodejs/containerize/ - - title: "Develop your app" - path: /language/nodejs/develop/ - - title: "Run your tests" - path: /language/nodejs/run-tests/ - - title: "Configure CI/CD" - path: /language/nodejs/configure-ci-cd/ - - title: "Test your deployment" - path: /language/nodejs/deploy/ - - sectiontitle: Python - section: - - title: "Overview" - path: /language/python/ - - title: "Containerize your app" - path: /language/python/containerize/ - - title: "Develop your app" - path: /language/python/develop/ - - title: "Configure CI/CD" - path: /language/python/configure-ci-cd/ - - title: "Test your deployment" - path: /language/python/deploy/ - - sectiontitle: R - section: - - title: "Overview" - path: /language/r/ - - title: "Containerize your app" - path: /language/r/containerize/ - - title: "Develop your app" - path: /language/r/develop/ - - title: "Configure CI/CD" - path: /language/r/configure-ci-cd/ - - title: "Test your deployment" - path: /language/r/deploy/ - - sectiontitle: Java - section: - - title: "Overview" - path: /language/java/ - - title: "Containerize your app" - path: /language/java/containerize/ - - title: "Develop your app" - path: /language/java/develop/ - - title: "Run your tests" - path: /language/java/run-tests/ - - title: "Configure CI/CD" - path: /language/java/configure-ci-cd/ - - title: "Test your deployment" - path: /language/java/deploy/ - - sectiontitle: Go - section: - - title: "Overview" - path: /language/golang/ - - title: "Build images" - path: /language/golang/build-images/ - - title: "Run containers" - path: /language/golang/run-containers/ - - title: "Develop your app" - path: /language/golang/develop/ - - title: "Run your tests" - path: /language/golang/run-tests/ - - title: "Configure CI/CD" - path: /language/golang/configure-ci-cd/ - - title: "Test your deployment" - path: /language/golang/deploy/ - - sectiontitle: C# (.NET) - section: - - title: "Overview" - path: /language/dotnet/ - - title: "Containerize your app" - path: /language/dotnet/containerize/ - - title: "Develop your app" - path: /language/dotnet/develop/ - - title: "Run your tests" - path: /language/dotnet/run-tests/ - - title: "Configure CI/CD" - path: /language/dotnet/configure-ci-cd/ - - title: "Test your deployment" - path: /language/dotnet/deploy/ - - sectiontitle: C++ - section: - - title: "Overview" - path: /language/cpp/ - - title: "Containerize your app" - path: /language/cpp/containerize/ - - title: "Develop your app" - path: /language/cpp/develop/ - - title: "Configure CI/CD" - path: /language/cpp/configure-ci-cd/ - - title: "Test your deployment" - path: /language/cpp/deploy/ - - sectiontitle: Rust - section: - - title: "Overview" - path: /language/rust/ - - title: "Build images" - path: /language/rust/build-images/ - - title: "Run containers" - path: /language/rust/run-containers/ - - title: "Develop your app" - path: /language/rust/develop/ - - title: "Configure CI/CD" - path: /language/rust/configure-ci-cd/ - - title: "Test your deployment" - path: /language/rust/deploy/ - - sectiontitle: PHP - section: - - title: "Overview" - path: /language/php/ - - title: "Containerize your app" - path: /language/php/containerize/ - - title: "Develop your app" - path: /language/php/develop/ - - title: "Run your tests" - path: /language/php/run-tests/ - - title: "Configure CI/CD" - path: /language/php/configure-ci-cd/ - - title: "Test your deployment" - path: /language/php/deploy/ - - sectiontitle: Ruby - section: - - title: "Overview" - path: /language/ruby/ - - title: "Containerize your app" - path: /language/ruby/containerize/ - - title: "Develop your app" - path: /language/ruby/develop/ - - title: "Configure CI/CD" - path: /language/ruby/configure-ci-cd/ - - title: "Test your deployment" - path: /language/ruby/deploy/ -- sectiontitle: Use-case guides - section: - - path: /guides/use-case/ - title: Overview - - sectiontitle: Machine learning & AI - section: - - sectiontitle: PDF analysis and chat - section: - - path: /guides/use-case/genai-pdf-bot/ - title: Overview - - path: /guides/use-case/genai-pdf-bot/containerize/ - title: Containerize your app - - path: /guides/use-case/genai-pdf-bot/develop/ - title: Develop your app - - path: /guides/use-case/genai-video-bot/ - title: Video transcription and chat - - path: /guides/use-case/tensorflowjs/ - title: Face detection with TensorFlow.js - - sectiontitle: Natural language processing - section: - - path: /guides/use-case/nlp/ - title: Overview - - path: /guides/use-case/nlp/language-translation/ - title: Language translation - - path: /guides/use-case/nlp/named-entity-recognition/ - title: Named entity recognition - - path: /guides/use-case/nlp/sentiment-analysis/ - title: Sentiment analysis - - path: /guides/use-case/nlp/text-classification/ - title: Text classification - - path: /guides/use-case/nlp/text-summarization/ - title: Text summarization - - path: /guides/use-case/jupyter/ - title: Data science with JupyterLab - - path: /guides/use-case/kafka/ - title: Event-driven applications with Kafka - - path: /guides/use-case/databases/ - title: Use containerized databases - -- sectiontitle: Deployment and orchestration - section: - - title: "Overview" - path: /guides/deployment-orchestration/orchestration/ - - title: "Deploy to Kubernetes" - path: /guides/deployment-orchestration/kube-deploy/ - - title: "Deploy to Swarm" - path: /guides/deployment-orchestration/swarm-deploy/ - - title: Cloud integrations - path: /cloud/ - -- path: /guides/resources/ - title: "Educational resources" - -- sectiontitle: Contribute - section: - - path: /contribute/ - title: Contribute to Docker's docs - - sectiontitle: Style guide - section: - - path: /contribute/style/grammar/ - title: Grammar and style - - path: /contribute/style/formatting/ - title: Formatting - - path: /contribute/style/recommended-words/ - title: Recommended word list - - path: /contribute/style/terminology/ - title: Docker terminology - - path: /contribute/style/voice-tone/ - title: Voice and tone - - path: /contribute/file-conventions/ - title: Source file conventions - - path: /contribute/ui/ - title: UI elements in content - - sectiontitle: Useful components - section: - - path: /contribute/components/accordions/ - title: Accordions - - path: /contribute/components/badges/ - title: Badges - - path: /contribute/components/call-outs/ - title: Callouts - - path: /contribute/components/cards/ - title: Cards - - path: /contribute/components/code-blocks/ - title: Code blocks - - path: /contribute/components/icons/ - title: Icons - - path: /contribute/components/images/ - title: Images - - path: /contribute/components/links/ - title: Links - - path: /contribute/components/lists/ - title: Lists - - path: /contribute/components/tables/ - title: Tables - - path: /contribute/components/tabs/ - title: Tabs - - path: /contribute/components/videos/ - title: Videos - - path: /contribute/components/buttons/ - title: Buttons - - path: /contribute/checklist/ - title: Writing checklist - -Reference: -- path: /reference/ - title: Reference documentation -- sectiontitle: CLI reference - section: - - path: /reference/cli/docker/ - title: docker (base command) - - path: /reference/cli/docker/build/ - title: docker build - - path: /reference/cli/docker/build-legacy/ - title: docker build (legacy builder) - - sectiontitle: docker builder - section: - - path: /reference/cli/docker/builder/ - title: docker builder - - path: /reference/cli/docker/builder/build/ - title: docker builder build - - path: /reference/cli/docker/builder/prune/ - title: docker builder prune - - sectiontitle: docker buildx - section: - - path: /reference/cli/docker/buildx/ - title: docker buildx - - path: /reference/cli/docker/buildx/bake/ - title: docker buildx bake - - path: /reference/cli/docker/buildx/build/ - title: docker buildx build - - path: /reference/cli/docker/buildx/create/ - title: docker buildx create - - path: /reference/cli/docker/buildx/debug/ - title: docker buildx debug - - path: /reference/cli/docker/buildx/debug/build/ - title: docker buildx debug build - - path: /reference/cli/docker/buildx/du/ - title: docker buildx du - - path: /reference/cli/docker/buildx/imagetools/ - title: docker buildx imagetools - - path: /reference/cli/docker/buildx/imagetools/create/ - title: docker buildx imagetools create - - path: /reference/cli/docker/buildx/imagetools/inspect/ - title: docker buildx imagetools inspect - - path: /reference/cli/docker/buildx/inspect/ - title: docker buildx inspect - - path: /reference/cli/docker/buildx/ls/ - title: docker buildx ls - - path: /reference/cli/docker/buildx/prune/ - title: docker buildx prune - - path: /reference/cli/docker/buildx/rm/ - title: docker buildx rm - - path: /reference/cli/docker/buildx/stop/ - title: docker buildx stop - - path: /reference/cli/docker/buildx/use/ - title: docker buildx use - - path: /reference/cli/docker/buildx/version/ - title: docker buildx version - - sectiontitle: docker checkpoint - section: - - path: /reference/cli/docker/checkpoint/ - title: docker checkpoint - - path: /reference/cli/docker/checkpoint/create/ - title: docker checkpoint create - - path: /reference/cli/docker/checkpoint/ls/ - title: docker checkpoint ls - - path: /reference/cli/docker/checkpoint/rm/ - title: docker checkpoint rm - - sectiontitle: docker compose - section: - - path: /reference/cli/docker/compose/ - title: docker compose - - path: /reference/cli/docker/compose/alpha/ - title: docker compose alpha - - path: /reference/cli/docker/compose/alpha/dry-run/ - title: docker compose alpha dry-run - - path: /reference/cli/docker/compose/alpha/publish/ - title: docker compose alpha publish - - path: /reference/cli/docker/compose/alpha/scale/ - title: docker compose alpha scale - - path: /reference/cli/docker/compose/alpha/viz/ - title: docker compose alpha viz - - path: /reference/cli/docker/compose/build/ - title: docker compose build - - path: /reference/cli/docker/compose/config/ - title: docker compose config - - path: /reference/cli/docker/compose/cp/ - title: docker compose cp - - path: /reference/cli/docker/compose/create/ - title: docker compose create - - path: /reference/cli/docker/compose/down/ - title: docker compose down - - path: /reference/cli/docker/compose/events/ - title: docker compose events - - path: /reference/cli/docker/compose/exec/ - title: docker compose exec - - path: /reference/cli/docker/compose/images/ - title: docker compose images - - path: /reference/cli/docker/compose/kill/ - title: docker compose kill - - path: /reference/cli/docker/compose/logs/ - title: docker compose logs - - path: /reference/cli/docker/compose/ls/ - title: docker compose ls - - path: /reference/cli/docker/compose/pause/ - title: docker compose pause - - path: /reference/cli/docker/compose/port/ - title: docker compose port - - path: /reference/cli/docker/compose/ps/ - title: docker compose ps - - path: /reference/cli/docker/compose/pull/ - title: docker compose pull - - path: /reference/cli/docker/compose/push/ - title: docker compose push - - path: /reference/cli/docker/compose/restart/ - title: docker compose restart - - path: /reference/cli/docker/compose/rm/ - title: docker compose rm - - path: /reference/cli/docker/compose/run/ - title: docker compose run - - path: /reference/cli/docker/compose/start/ - title: docker compose start - - path: /reference/cli/docker/compose/stop/ - title: docker compose stop - - path: /reference/cli/docker/compose/top/ - title: docker compose top - - path: /reference/cli/docker/compose/unpause/ - title: docker compose unpause - - path: /reference/cli/docker/compose/up/ - title: docker compose up - - path: /reference/cli/docker/compose/version/ - title: docker compose version - - path: /reference/cli/docker/compose/wait/ - title: docker compose wait - - path: /reference/cli/docker/compose/watch/ - title: docker compose watch - - sectiontitle: docker config - section: - - path: /reference/cli/docker/config/ - title: docker config - - path: /reference/cli/docker/config/create/ - title: docker config create - - path: /reference/cli/docker/config/inspect/ - title: docker config inspect - - path: /reference/cli/docker/config/ls/ - title: docker config ls - - path: /reference/cli/docker/config/rm/ - title: docker config rm - - sectiontitle: docker container - section: - - path: /reference/cli/docker/container/ - title: docker container - - path: /reference/cli/docker/container/attach/ - title: docker container attach - - path: /reference/cli/docker/container/commit/ - title: docker container commit - - path: /reference/cli/docker/container/cp/ - title: docker container cp - - path: /reference/cli/docker/container/create/ - title: docker container create - - path: /reference/cli/docker/container/diff/ - title: docker container diff - - path: /reference/cli/docker/container/exec/ - title: docker container exec - - path: /reference/cli/docker/container/export/ - title: docker container export - - path: /reference/cli/docker/container/inspect/ - title: docker container inspect - - path: /reference/cli/docker/container/kill/ - title: docker container kill - - path: /reference/cli/docker/container/logs/ - title: docker container logs - - path: /reference/cli/docker/container/ls/ - title: docker container ls - - path: /reference/cli/docker/container/pause/ - title: docker container pause - - path: /reference/cli/docker/container/port/ - title: docker container port - - path: /reference/cli/docker/container/prune/ - title: docker container prune - - path: /reference/cli/docker/container/rename/ - title: docker container rename - - path: /reference/cli/docker/container/restart/ - title: docker container restart - - path: /reference/cli/docker/container/rm/ - title: docker container rm - - path: /reference/cli/docker/container/run/ - title: docker container run - - path: /reference/cli/docker/container/start/ - title: docker container start - - path: /reference/cli/docker/container/stats/ - title: docker container stats - - path: /reference/cli/docker/container/stop/ - title: docker container stop - - path: /reference/cli/docker/container/top/ - title: docker container top - - path: /reference/cli/docker/container/unpause/ - title: docker container unpause - - path: /reference/cli/docker/container/update/ - title: docker container update - - path: /reference/cli/docker/container/wait/ - title: docker container wait - - sectiontitle: docker context - section: - - path: /reference/cli/docker/context/ - title: docker context - - path: /reference/cli/docker/context/create/ - title: docker context create - - path: /reference/cli/docker/context/export/ - title: docker context export - - path: /reference/cli/docker/context/import/ - title: docker context import - - path: /reference/cli/docker/context/inspect/ - title: docker context inspect - - path: /reference/cli/docker/context/ls/ - title: docker context ls - - path: /reference/cli/docker/context/rm/ - title: docker context rm - - path: /reference/cli/docker/context/show/ - title: docker context show - - path: /reference/cli/docker/context/update/ - title: docker context update - - path: /reference/cli/docker/context/use/ - title: docker context use - - path: /reference/cli/docker/debug/ - title: docker debug - - path: /reference/cli/docker/exec/ - title: docker exec - - sectiontitle: docker image - section: - - path: /reference/cli/docker/image/ - title: docker image - - path: /reference/cli/docker/image/build/ - title: docker image build - - path: /reference/cli/docker/image/history/ - title: docker image history - - path: /reference/cli/docker/image/import/ - title: docker image import - - path: /reference/cli/docker/image/inspect/ - title: docker image inspect - - path: /reference/cli/docker/image/load/ - title: docker image load - - path: /reference/cli/docker/image/ls/ - title: docker image ls - - path: /reference/cli/docker/image/prune/ - title: docker image prune - - path: /reference/cli/docker/image/pull/ - title: docker image pull - - path: /reference/cli/docker/image/push/ - title: docker image push - - path: /reference/cli/docker/image/rm/ - title: docker image rm - - path: /reference/cli/docker/image/save/ - title: docker image save - - path: /reference/cli/docker/image/tag/ - title: docker image tag - - path: /reference/cli/docker/images/ - title: docker images - - path: /reference/cli/docker/info/ - title: docker info - - path: /reference/cli/docker/init/ - title: docker init - - path: /reference/cli/docker/inspect/ - title: docker inspect - - path: /reference/cli/docker/login/ - title: docker login - - path: /reference/cli/docker/logout/ - title: docker logout - - sectiontitle: docker manifest - section: - - path: /reference/cli/docker/manifest/ - title: docker manifest - - path: /reference/cli/docker/manifest/annotate/ - title: docker manifest annotate - - path: /reference/cli/docker/manifest/create/ - title: docker manifest create - - path: /reference/cli/docker/manifest/inspect/ - title: docker manifest inspect - - path: /reference/cli/docker/manifest/push/ - title: docker manifest push - - path: /reference/cli/docker/manifest/rm/ - title: docker manifest rm - - sectiontitle: docker network - section: - - path: /reference/cli/docker/network/ - title: docker network - - path: /reference/cli/docker/network/connect/ - title: docker network connect - - path: /reference/cli/docker/network/create/ - title: docker network create - - path: /reference/cli/docker/network/disconnect/ - title: docker network disconnect - - path: /reference/cli/docker/network/inspect/ - title: docker network inspect - - path: /reference/cli/docker/network/ls/ - title: docker network ls - - path: /reference/cli/docker/network/prune/ - title: docker network prune - - path: /reference/cli/docker/network/rm/ - title: docker network rm - - sectiontitle: docker node - section: - - path: /reference/cli/docker/node/ - title: docker node - - path: /reference/cli/docker/node/demote/ - title: docker node demote - - path: /reference/cli/docker/node/inspect/ - title: docker node inspect - - path: /reference/cli/docker/node/ls/ - title: docker node ls - - path: /reference/cli/docker/node/promote/ - title: docker node promote - - path: /reference/cli/docker/node/ps/ - title: docker node ps - - path: /reference/cli/docker/node/rm/ - title: docker node rm - - path: /reference/cli/docker/node/update/ - title: docker node update - - sectiontitle: docker plugin - section: - - path: /reference/cli/docker/plugin/ - title: docker plugin - - path: /reference/cli/docker/plugin/create/ - title: docker plugin create - - path: /reference/cli/docker/plugin/disable/ - title: docker plugin disable - - path: /reference/cli/docker/plugin/enable/ - title: docker plugin enable - - path: /reference/cli/docker/plugin/inspect/ - title: docker plugin inspect - - path: /reference/cli/docker/plugin/install/ - title: docker plugin install - - path: /reference/cli/docker/plugin/ls/ - title: docker plugin ls - - path: /reference/cli/docker/plugin/rm/ - title: docker plugin rm - - path: /reference/cli/docker/plugin/set/ - title: docker plugin set - - path: /reference/cli/docker/plugin/upgrade/ - title: docker plugin upgrade - - path: /reference/cli/docker/ps/ - title: docker ps - - path: /reference/cli/docker/pull/ - title: docker pull - - path: /reference/cli/docker/push/ - title: docker push - - path: /reference/cli/docker/run/ - title: docker run - - sectiontitle: docker scout - section: - - path: /reference/cli/docker/scout/ - title: docker scout - - path: /reference/cli/docker/scout/attestation/ - title: docker scout attestation - - path: /reference/cli/docker/scout/attestation/add/ - title: docker scout attestation add - - path: /reference/cli/docker/scout/cache/ - title: docker scout cache - - path: /reference/cli/docker/scout/cache/df/ - title: docker scout cache df - - path: /reference/cli/docker/scout/cache/prune/ - title: docker scout cache prune - - path: /reference/cli/docker/scout/compare/ - title: docker scout compare - - path: /reference/cli/docker/scout/config/ - title: docker scout config - - path: /reference/cli/docker/scout/cves/ - title: docker scout cves - - path: /reference/cli/docker/scout/enroll/ - title: docker scout enroll - - path: /reference/cli/docker/scout/environment/ - title: docker scout environment - - path: /reference/cli/docker/scout/integration/ - title: docker scout integration - - path: /reference/cli/docker/scout/integration/configure/ - title: docker scout integration configure - - path: /reference/cli/docker/scout/integration/delete/ - title: docker scout integration delete - - path: /reference/cli/docker/scout/integration/list/ - title: docker scout integration list - - path: /reference/cli/docker/scout/policy/ - title: docker scout policy - - path: /reference/cli/docker/scout/push/ - title: docker scout push - - path: /reference/cli/docker/scout/quickview/ - title: docker scout quickview - - path: /reference/cli/docker/scout/recommendations/ - title: docker scout recommendations - - path: /reference/cli/docker/scout/repo/ - title: docker scout repo - - path: /reference/cli/docker/scout/repo/disable/ - title: docker scout repo disable - - path: /reference/cli/docker/scout/repo/enable/ - title: docker scout repo enable - - path: /reference/cli/docker/scout/repo/list/ - title: docker scout repo list - - path: /reference/cli/docker/scout/sbom/ - title: docker scout sbom - - path: /reference/cli/docker/scout/stream/ - title: docker scout stream - - path: /reference/cli/docker/scout/version/ - title: docker scout version - - path: /reference/cli/docker/scout/watch/ - title: docker scout watch - - path: /reference/cli/docker/search/ - title: docker search - - sectiontitle: docker secret - section: - - path: /reference/cli/docker/secret/ - title: docker secret - - path: /reference/cli/docker/secret/create/ - title: docker secret create - - path: /reference/cli/docker/secret/inspect/ - title: docker secret inspect - - path: /reference/cli/docker/secret/ls/ - title: docker secret ls - - path: /reference/cli/docker/secret/rm/ - title: docker secret rm - - sectiontitle: docker service - section: - - path: /reference/cli/docker/service/ - title: docker service - - path: /reference/cli/docker/service/create/ - title: docker service create - - path: /reference/cli/docker/service/inspect/ - title: docker service inspect - - path: /reference/cli/docker/service/logs/ - title: docker service logs - - path: /reference/cli/docker/service/ls/ - title: docker service ls - - path: /reference/cli/docker/service/ps/ - title: docker service ps - - path: /reference/cli/docker/service/rollback/ - title: docker service rollback - - path: /reference/cli/docker/service/rm/ - title: docker service rm - - path: /reference/cli/docker/service/scale/ - title: docker service scale - - path: /reference/cli/docker/service/update/ - title: docker service update - - sectiontitle: docker stack - section: - - path: /reference/cli/docker/stack/ - title: docker stack - - path: /reference/cli/docker/stack/config/ - title: docker stack config - - path: /reference/cli/docker/stack/deploy/ - title: docker stack deploy - - path: /reference/cli/docker/stack/ls/ - title: docker stack ls - - path: /reference/cli/docker/stack/ps/ - title: docker stack ps - - path: /reference/cli/docker/stack/rm/ - title: docker stack rm - - path: /reference/cli/docker/stack/services/ - title: docker stack services - - sectiontitle: docker swarm - section: - - path: /reference/cli/docker/swarm/ - title: docker swarm - - path: /reference/cli/docker/swarm/ca/ - title: docker swarm ca - - path: /reference/cli/docker/swarm/init/ - title: docker swarm init - - path: /reference/cli/docker/swarm/join-token/ - title: docker swarm join-token - - path: /reference/cli/docker/swarm/join/ - title: docker swarm join - - path: /reference/cli/docker/swarm/leave/ - title: docker swarm leave - - path: /reference/cli/docker/swarm/unlock-key/ - title: docker swarm unlock-key - - path: /reference/cli/docker/swarm/unlock/ - title: docker swarm unlock - - path: /reference/cli/docker/swarm/update/ - title: docker swarm update - - sectiontitle: docker system - section: - - path: /reference/cli/docker/system/ - title: docker system - - path: /reference/cli/docker/system/df/ - title: docker system df - - path: /reference/cli/docker/system/events/ - title: docker system events - - path: /reference/cli/docker/system/info/ - title: docker system info - - path: /reference/cli/docker/system/prune/ - title: docker system prune - - sectiontitle: docker trust - section: - - path: /reference/cli/docker/trust/ - title: docker trust - - path: /reference/cli/docker/trust/inspect/ - title: docker trust inspect - - path: /reference/cli/docker/trust/key/ - title: docker trust key - - path: /reference/cli/docker/trust/key/generate/ - title: docker trust key generate - - path: /reference/cli/docker/trust/key/load/ - title: docker trust key load - - path: /reference/cli/docker/trust/revoke/ - title: docker trust revoke - - path: /reference/cli/docker/trust/sign/ - title: docker trust sign - - path: /reference/cli/docker/trust/signer/ - title: docker trust signer - - path: /reference/cli/docker/trust/signer/add/ - title: docker trust signer add - - path: /reference/cli/docker/trust/signer/remove/ - title: docker trust signer remove - - path: /reference/cli/docker/version/ - title: docker version - - sectiontitle: docker volume - section: - - path: /reference/cli/docker/volume/create/ - title: docker volume create - - path: /reference/cli/docker/volume/inspect/ - title: docker volume inspect - - path: /reference/cli/docker/volume/ls/ - title: docker volume ls - - path: /reference/cli/docker/volume/prune/ - title: docker volume prune - - path: /reference/cli/docker/volume/rm/ - title: docker volume rm - - path: /reference/cli/docker/volume/update/ - title: docker volume update -- title: Dockerfile reference - path: /reference/dockerfile/ -- sectiontitle: Build checks - section: - - path: /reference/build-checks/ - title: Overview - - path: /reference/build-checks/consistent-instruction-casing/ - title: ConsistentInstructionCasing - - path: /reference/build-checks/copy-ignored-file/ - title: CopyIgnoredFile - - path: /reference/build-checks/duplicate-stage-name/ - title: DuplicateStageName - - path: /reference/build-checks/from-as-casing/ - title: FromAsCasing - - path: /reference/build-checks/from-platform-flag-const-disallowed/ - title: FromPlatformConstDisallowed - - path: /reference/build-checks/invalid-default-arg-in-from/ - title: InvalidDefaultArgInFrom - - path: /reference/build-checks/json-args-recommended/ - title: JSONArgsRecommended - - path: /reference/build-checks/legacy-key-value-format/ - title: LegacyKeyValueFormat - - path: /reference/build-checks/maintainer-deprecated/ - title: MaintainerDeprecated - - path: /reference/build-checks/multiple-instructions-disallowed/ - title: MultipleInstructionsDisallowed - - path: /reference/build-checks/no-empty-continuation/ - title: NoEmptyContinuation - - path: /reference/build-checks/redundant-target-platform/ - title: RedundantTargetPlatform - - path: /reference/build-checks/reserved-stage-name/ - title: ReservedStageName - - path: /reference/build-checks/secrets-used-in-arg-or-env/ - title: SecretsUsedInArgOrEnv - - path: /reference/build-checks/stage-name-casing/ - title: StageNameCasing - - path: /reference/build-checks/undefined-arg-in-from/ - title: UndefinedArgInFrom - - path: /reference/build-checks/undefined-var/ - title: UndefinedVar - - path: /reference/build-checks/workdir-relative-path/ - title: WorkdirRelativePath -- title: Daemon CLI (dockerd) - path: /reference/cli/dockerd/ -- sectiontitle: API reference - section: - - sectiontitle: Docker Engine API - section: - - path: /reference/api/engine/ - title: Overview - - path: /reference/api/engine/sdk/ - title: SDKs - - path: /reference/api/engine/sdk/examples/ - title: SDK examples - - path: /reference/api/engine/latest/ - title: v{{< param latest_engine_api_version >}} reference (latest) - - sectiontitle: API reference by version - section: - - path: /reference/api/engine/version-history/ - title: Version history overview - - path: /reference/api/engine/v1.46/ - title: v1.46 reference - - path: /reference/api/engine/v1.45/ - title: v1.45 reference - - path: /reference/api/engine/v1.44/ - title: v1.44 reference - - path: /reference/api/engine/v1.43/ - title: v1.43 reference - - path: /reference/api/engine/v1.42/ - title: v1.42 reference - - path: /reference/api/engine/v1.41/ - title: v1.41 reference - - path: /reference/api/engine/v1.40/ - title: v1.40 reference - - path: /reference/api/engine/v1.39/ - title: v1.39 reference - - path: /reference/api/engine/v1.38/ - title: v1.38 reference - - path: /reference/api/engine/v1.37/ - title: v1.37 reference - - path: /reference/api/engine/v1.36/ - title: v1.36 reference - - path: /reference/api/engine/v1.35/ - title: v1.35 reference - - path: /reference/api/engine/v1.34/ - title: v1.34 reference - - path: /reference/api/engine/v1.33/ - title: v1.33 reference - - path: /reference/api/engine/v1.32/ - title: v1.32 Reference - - path: /reference/api/engine/v1.31/ - title: v1.31 Reference - - path: /reference/api/engine/v1.30/ - title: v1.30 Reference - - path: /reference/api/engine/v1.29/ - title: v1.29 Reference - - path: /reference/api/engine/v1.28/ - title: v1.28 reference - - path: /reference/api/engine/v1.27/ - title: v1.27 reference - - path: /reference/api/engine/v1.26/ - title: v1.26 reference - - path: /reference/api/engine/v1.25/ - title: v1.25 reference - - path: /reference/api/engine/v1.24/ - title: v1.24 reference - - sectiontitle: Docker Hub API - section: - - title: Docker Hub API - path: /reference/api/hub/latest/ - - title: DVP Data API - path: /reference/api/hub/dvp/ - - title: Deprecated API - path: /reference/api/hub/deprecated/ - - sectiontitle: Docker Extension SDK API - section: - - path: /reference/api/extensions-sdk/ - title: API Reference - - path: /reference/api/extensions-sdk/DesktopUI/ - title: DesktopUI - - path: /reference/api/extensions-sdk/Dialog/ - title: Dialog - - path: /reference/api/extensions-sdk/Docker/ - title: Docker - - path: /reference/api/extensions-sdk/DockerCommand/ - title: DockerCommand - - path: /reference/api/extensions-sdk/DockerDesktopClient/ - title: DockerDesktopClient - - path: /reference/api/extensions-sdk/Exec/ - title: Exec - - path: /reference/api/extensions-sdk/ExecProcess/ - title: ExecProcess - - path: /reference/api/extensions-sdk/ExecResult/ - title: ExecResult - - path: /reference/api/extensions-sdk/ExecStreamOptions/ - title: ExecStreamOptions - - path: /reference/api/extensions-sdk/Extension/ - title: Extension - - path: /reference/api/extensions-sdk/ExtensionCli/ - title: ExtensionCli - - path: /reference/api/extensions-sdk/ExtensionHost/ - title: ExtensionHost - - path: /reference/api/extensions-sdk/ExtensionVM/ - title: ExtensionVM - - path: /reference/api/extensions-sdk/Host/ - title: Host - - path: /reference/api/extensions-sdk/HttpService/ - title: HttpService - - path: /reference/api/extensions-sdk/NavigationIntents/ - title: NavigationIntents - - path: /reference/api/extensions-sdk/OpenDialogResult/ - title: OpenDialogResult - - path: /reference/api/extensions-sdk/RawExecResult/ - title: RawExecResult - - path: /reference/api/extensions-sdk/RequestConfig/ - title: RequestConfig - - path: /reference/api/extensions-sdk/RequestConfigV0/ - title: RequestConfigV0 - - path: /reference/api/extensions-sdk/ServiceError/ - title: ServiceError - - path: /reference/api/extensions-sdk/ServiceError/ - title: SpawnOptions - - path: /reference/api/extensions-sdk/Toast/ - title: Toast - - path: /reference/api/extensions-sdk/ExecResultV0/ - title: ExecResultV0 - - path: /reference/api/extensions-sdk/BackendV0/ - title: BackendV0 -- sectiontitle: Compose file reference - section: - - sectiontitle: Compose Specification - section: - - path: /reference/compose-file/ - title: Overview - - path: /reference/compose-file/version-and-name/ - title: Version and name top-level element - - path: /reference/compose-file/services/ - title: Services top-level element - - path: /reference/compose-file/networks/ - title: Network top-level element - - path: /reference/compose-file/volumes/ - title: Volumes top-level element - - path: /reference/compose-file/configs/ - title: Configs top-level element - - path: /reference/compose-file/secrets/ - title: Secrets top-level element - - path: /reference/compose-file/fragments/ - title: Fragments - - path: /reference/compose-file/extension/ - title: Extensions - - path: /reference/compose-file/interpolation/ - title: Interpolation - - path: /reference/compose-file/merge/ - title: Merge - - path: /reference/compose-file/include/ - title: Include - - path: /reference/compose-file/profiles/ - title: Profiles - - path: /reference/compose-file/build/ - title: Compose Build Specification - - path: /reference/compose-file/deploy/ - title: Compose Deploy Specification - - path: /reference/compose-file/develop/ - title: Compose Develop Specification - - path: /reference/compose-file/legacy-versions/ - title: Legacy versions -- path: /reference/glossary/ - title: Glossary -- sectiontitle: Samples - section: - - path: /samples/ - title: Overview - - sectiontitle: Databases - section: - - path: /samples/mariadb/ - title: MariaDB - - path: /samples/mongodb/ - title: MongoDB - - path: /samples/ms-sql/ - title: MS-SQL - - path: /samples/mysql/ - title: MySQL - - path: /samples/postgres/ - title: PostgreSQL - - path: /samples/redis/ - title: Redis - - sectiontitle: Frameworks - section: - - path: /samples/dotnet/ - title: .NET - - path: /samples/angular/ - title: Angular - - path: /samples/django/ - title: Django - - path: /samples/express/ - title: Express - - path: /samples/fastapi/ - title: FastAPI - - path: /samples/flask/ - title: Flask - - path: /samples/nodejs/ - title: Node.js - - path: /samples/react/ - title: React - - path: /samples/rails/ - title: Rails - - path: /samples/spark/ - title: Spark - - path: /samples/spring/ - title: Spring Boot - - path: /samples/vuejs/ - title: Vue.js - - sectiontitle: Languages - section: - - path: /samples/go/ - title: Go - - path: /samples/java/ - title: Java - - path: /samples/javascript/ - title: JavaScript - - path: /samples/php/ - title: PHP - - path: /samples/python/ - title: Python - - path: /samples/ruby/ - title: Ruby - - path: /samples/rust/ - title: Rust - - path: /samples/typescript/ - title: TypeScript - - sectiontitle: Platforms - section: - - path: /samples/gitea/ - title: Gitea - - path: /samples/nextcloud/ - title: Nextcloud - - path: /samples/portainer/ - title: Portainer - - path: /samples/prometheus/ - title: Prometheus - - path: /samples/wordpress/ - title: WordPress - - sectiontitle: Other samples - section: - - path: /samples/ai-ml/ - title: AI/ML - - path: /samples/cloudflared/ - title: Cloudflared - - path: /samples/elasticsearch/ - title: Elasticsearch / Logstash / Kibana - - path: /samples/minecraft/ - title: Minecraft - - path: /samples/nginx/ - title: NGINX - - path: /samples/pi-hole/ - title: Pi-hole - - path: /samples/plex/ - title: Plex - - path: /samples/traefik/ - title: Traefik - - path: /samples/wireguard/ - title: Wireguard - -Manuals: -- path: /manuals/ - title: Overview -- sectiontitle: Docker Desktop - section: - - path: /desktop/ - title: Overview - - sectiontitle: Install - section: - - path: /desktop/install/mac-install/ - title: Mac - - path: /desktop/mac/permission-requirements/ - title: Understand permission requirements for Mac - - path: /desktop/install/windows-install/ - title: Windows - - sectiontitle: Use the MSI installer {{< badge color=green text="New" >}} - section: - - path: /desktop/install/msi/ - title: Overview - - path: /desktop/install/msi/install-and-configure/ - title: Install and configure - - path: /desktop/install/msi/use-intune/ - title: Use Intune - - path: /desktop/install/msi/faq/ - title: FAQs - - path: /desktop/windows/permission-requirements/ - title: Understand permission requirements for Windows - - path: /desktop/install/linux-install/ - title: Linux - - sectiontitle: Installation per Linux distro - section: - - path: /desktop/install/ubuntu/ - title: Ubuntu - - path: /desktop/install/debian/ - title: Debian - - path: /desktop/install/fedora/ - title: Fedora - - path: /desktop/install/archlinux/ - title: Arch - - path: /desktop/get-started/ - title: Sign in - - sectiontitle: Explore Docker Desktop - section: - - path: /desktop/use-desktop/ - title: Overview - - path: /desktop/use-desktop/container/ - title: Explore Containers - - path: /desktop/use-desktop/images/ - title: Explore Images - - path: /desktop/use-desktop/volumes/ - title: Explore Volumes - - path: /desktop/use-desktop/builds/ - title: Explore Builds - - path: /desktop/use-desktop/resource-saver/ - title: Resource Saver mode - - path: /desktop/use-desktop/pause/ - title: Pause Docker Desktop - - sectiontitle: Dev Environments (Beta) - section: - - path: /desktop/dev-environments/ - title: Overview - - path: /desktop/dev-environments/create-dev-env/ - title: Launch a dev environment - - path: /desktop/dev-environments/set-up/ - title: Set up a dev environment - - path: /desktop/dev-environments/share/ - title: Distribute your dev environment - - path: /desktop/dev-environments/dev-cli/ - title: Use the docker dev CLI plugin - - path: /desktop/containerd/ - title: containerd image store - - path: /desktop/wasm/ - title: Wasm workloads (Beta) - - path: /desktop/synchronized-file-sharing/ - title: Synchronized file shares - - sectiontitle: WSL - section: - - path: /desktop/wsl/ - title: Set up WSL 2 on Docker Desktop for Windows - - path: /desktop/wsl/use-wsl/ - title: Use WSL - - path: /desktop/wsl/best-practices/ - title: Best practices - - path: /desktop/gpu/ - title: GPU support - - sectiontitle: Additional resources - section: - - path: /desktop/kubernetes/ - title: Deploy on Kubernetes - - path: /desktop/backup-and-restore/ - title: Back up and restore data - - path: /desktop/networking/ - title: Explore networking features - - path: /desktop/vm-vdi/ - title: Run Docker Desktop for Windows in a VM or VDI environment - - path: /desktop/allow-list/ - title: Allowlist for Docker Desktop - - sectiontitle: Change settings - section: - - path: /desktop/settings/mac/ - title: On Mac - - path: /desktop/settings/windows/ - title: On Windows - - path: /desktop/settings/linux/ - title: On Linux - - sectiontitle: Troubleshoot and diagnose - section: - - path: /desktop/troubleshoot/overview/ - title: Overview - - path: /desktop/troubleshoot/topics/ - title: Troubleshoot topics - - path: /desktop/troubleshoot/workarounds/ - title: Workarounds for common problems - - path: /desktop/troubleshoot/known-issues/ - title: Known issues - - path: /desktop/uninstall/ - title: Uninstall Docker Desktop - - path: /desktop/feedback/ - title: Give feedback - - sectiontitle: Desktop FAQs - section: - - path: /desktop/faqs/general/ - title: General - - path: /desktop/faqs/macfaqs/ - title: Mac - - path: /desktop/faqs/windowsfaqs/ - title: Windows - - path: /desktop/faqs/linuxfaqs/ - title: Linux - - path: /desktop/faqs/releases/ - title: Releases - - path: /desktop/release-notes/ - title: Release notes - - sectiontitle: Previous versions - section: - - path: /desktop/previous-versions/3.x-windows/ - title: Desktop for Windows 3.x - - path: /desktop/previous-versions/3.x-mac/ - title: Desktop for Mac 3.x - - path: /desktop/previous-versions/2.x-windows/ - title: Desktop for Windows 2.x - - path: /desktop/previous-versions/2.x-mac/ - title: Desktop for Mac 2.x - - path: /desktop/previous-versions/edge-releases-windows/ - title: Windows edge releases - - path: /desktop/previous-versions/edge-releases-mac/ - title: Mac edge releases - - path: /desktop/previous-versions/archive-windows/ - title: Older versions for Windows - - path: /desktop/previous-versions/archive-mac/ - title: Older versions for Mac - -- sectiontitle: Docker Extensions - section: - - path: /extensions/ - title: Overview - - sectiontitle: Extensions on Docker Desktop - section: - - path: /extensions/marketplace/ - title: Manage Marketplace extensions - - path: /extensions/non-marketplace/ - title: Manage non-Marketplace extensions - - path: /extensions/settings-feedback/ - title: Change settings and give feedback - - path: /extensions/private-marketplace/ - title: Configure a private Marketplace (Beta) - - sectiontitle: Extensions SDK - section: - - path: /extensions/extensions-sdk/ - title: Overview - - path: /extensions/extensions-sdk/process/ - title: The build and publish process - - path: /extensions/extensions-sdk/quickstart/ - title: Quickstart - - sectiontitle: "Part one: Build" - section: - - title: Create a simple extension - path: /extensions/extensions-sdk/build/minimal-frontend-extension/ - - title: Create an advanced frontend extension - path: /extensions/extensions-sdk/build/frontend-extension-tutorial/ - - title: Add a backend to your extension - path: /extensions/extensions-sdk/build/backend-extension-tutorial/ - - sectiontitle: "Part two: Publish" - section: - - title: Overview - path: /extensions/extensions-sdk/extensions/ - - title: Labels - path: /extensions/extensions-sdk/extensions/labels/ - - title: Validate - path: /extensions/extensions-sdk/extensions/validate/ - - title: Package and release your extension - path: /extensions/extensions-sdk/extensions/DISTRIBUTION/ - - title: Generate a share link - path: /extensions/extensions-sdk/extensions/share/ - - title: Publish in the Marketplace - path: /extensions/extensions-sdk/extensions/publish/ - - title: Build multi-arch extensions - path: /extensions/extensions-sdk/extensions/multi-arch/ - - sectiontitle: "Architecture" - section: - - title: Overview - path: /extensions/extensions-sdk/architecture/ - - title: Metadata - path: /extensions/extensions-sdk/architecture/metadata/ - - title: Security - path: /extensions/extensions-sdk/architecture/security/ - - sectiontitle: "Design and UI styling" - section: - - title: UI styling guidelines - path: /extensions/extensions-sdk/design/ - - title: Guidelines - path: /extensions/extensions-sdk/design/design-guidelines/ - - title: Docker design principles - path: /extensions/extensions-sdk/design/design-principles/ - - title: MUI best practices - path: /extensions/extensions-sdk/design/mui-best-practices/ - - sectiontitle: "Developer Guides" - section: - - title: Invoke host binaries - path: /extensions/extensions-sdk/guides/invoke-host-binaries/ - - title: Use the Docker socket from the extension backend - path: /extensions/extensions-sdk/guides/use-docker-socket-from-backend/ - - title: Interacting with Kubernetes - path: /extensions/extensions-sdk/guides/kubernetes/ - - title: Authentication - path: /extensions/extensions-sdk/guides/oauth2-flow/ - - sectiontitle: Developer SDK tools - section: - - title: "Test and debug" - path: /extensions/extensions-sdk/dev/test-debug/ - - title: "Continuous integration" - path: /extensions/extensions-sdk/dev/continuous-integration/ - - title: CLI reference - path: /extensions/extensions-sdk/dev/usage/ - - sectiontitle: Extension APIs - section: - - title: Overview - path: /extensions/extensions-sdk/dev/api/overview/ - - title: Extension Backend - path: /extensions/extensions-sdk/dev/api/backend/ - - title: Docker - path: /extensions/extensions-sdk/dev/api/docker/ - - title: Dashboard - path: /extensions/extensions-sdk/dev/api/dashboard/ - - title: Navigation - path: /extensions/extensions-sdk/dev/api/dashboard-routes-navigation/ - -- sectiontitle: Docker Scout - section: - - path: /scout/ - title: Overview - - path: /scout/quickstart/ - title: Quickstart - - path: /scout/install/ - title: Install - - sectiontitle: Concepts - section: - - path: /scout/concepts/s3c/ - title: Software supply chain security - - path: /scout/concepts/sbom/ - title: Software Bill of Materials - - sectiontitle: Explore - section: - - path: /scout/explore/analysis/ - title: Analysis - - path: /scout/explore/dashboard/ - title: Dashboard - - path: /scout/explore/image-details-view/ - title: Image details view - - path: /scout/explore/exceptions/ - title: Exceptions {{< badge color=green text=New >}} - - path: /scout/explore/metrics-exporter/ - title: Metrics exporter - - sectiontitle: How-tos - section: - - path: /scout/how-tos/create-exceptions-gui/ - title: Create exceptions (GUI) - - path: /scout/how-tos/create-exceptions-vex/ - title: Create exceptions (VEX) - - path: /scout/how-tos/artifact-types/ - title: Specify artifact type or location - - path: /scout/how-tos/view-create-sboms/ - title: View and create SBOMs - - path: /scout/how-tos/configure-cli/ - title: Configure the CLI - - sectiontitle: Deep dive - section: - - path: /scout/deep-dive/advisory-db-sources/ - title: Advisory database - - path: /scout/deep-dive/data-handling/ - title: Data handling - - sectiontitle: Policy Evaluation - section: - - path: /scout/policy/ - title: Overview - - path: /scout/policy/scores/ - title: Health scores {{< badge color=blue text=Beta >}} - - path: /scout/policy/view/ - title: View policy status - - path: /scout/policy/configure/ - title: Configure policies - - path: /scout/policy/ci/ - title: Policy Evaluation in CI - - path: /scout/policy/remediation/ - title: Remediation - - sectiontitle: Integrations - section: - - title: Overview - path: /scout/integrations/ - - sectiontitle: Environment monitoring - section: - - title: Overview - path: /scout/integrations/environment/ - - title: Sysdig - path: /scout/integrations/environment/sysdig/ - - title: Generic - path: /scout/integrations/environment/cli/ - - sectiontitle: Container registries - section: - - title: Artifactory - path: /scout/integrations/registry/artifactory/ - - title: Elastic Container Registry - path: /scout/integrations/registry/ecr/ - - title: Azure Container Registry - path: /scout/integrations/registry/acr/ - - sectiontitle: Continuous integration - section: - - title: GitHub Actions - path: /scout/integrations/ci/gha/ - - title: GitLab - path: /scout/integrations/ci/gitlab/ - - title: Microsoft Azure DevOps Pipelines - path: /scout/integrations/ci/azure/ - - title: Circle CI - path: /scout/integrations/ci/circle-ci/ - - title: Jenkins - path: /scout/integrations/ci/jenkins/ - - sectiontitle: Code quality - section: - - title: SonarQube - path: /scout/integrations/code-quality/sonarqube/ - - sectiontitle: Source code management - section: - - title: GitHub - path: /scout/integrations/source-code-management/github/ - - sectiontitle: Team collaboration - section: - - title: Slack - path: /scout/integrations/team-collaboration/slack/ - - sectiontitle: Release notes - section: - - path: /scout/release-notes/cli/ - title: CLI and GitHub Action - - path: /scout/release-notes/platform/ - title: Platform - -- sectiontitle: Docker Engine - section: - - path: /engine/ - title: Overview - - sectiontitle: Install - section: - - path: /engine/install/ - title: Overview - - path: /engine/install/centos/ - title: CentOS - - path: /engine/install/debian/ - title: Debian - - path: /engine/install/fedora/ - title: Fedora - - path: /engine/install/rhel/ - title: RHEL - - path: /engine/install/sles/ - title: SLES - - path: /engine/install/ubuntu/ - title: Ubuntu - - path: /engine/install/raspberry-pi-os/ - title: Raspberry Pi OS (32-bit) - - path: /engine/install/binaries/ - title: Binaries - - path: /engine/install/linux-postinstall/ - title: Post-installation steps - - sectiontitle: Storage - section: - - path: /engine/storage/ - title: Overview - - path: /engine/storage/volumes/ - title: Volumes - - path: /engine/storage/bind-mounts/ - title: Bind mounts - - path: /engine/storage/tmpfs/ - title: tmpfs mounts - - sectiontitle: Storage drivers - section: - - path: /engine/storage/drivers/ - title: Overview - - path: /engine/storage/drivers/select-storage-driver/ - title: Select a storage driver - - path: /engine/storage/drivers/btrfs-driver/ - title: Use the Btrfs storage driver - - path: /engine/storage/drivers/device-mapper-driver/ - title: Use the Device mapper storage driver - - path: /engine/storage/drivers/overlayfs-driver/ - title: Use the OverlayFS storage driver - - path: /engine/storage/drivers/zfs-driver/ - title: Use the ZFS storage driver - - path: /engine/storage/drivers/vfs-driver/ - title: Use the VFS storage driver - - path: /engine/storage/drivers/aufs-driver/ - title: Use the AUFS storage driver (deprecated) - - path: /engine/storage/containerd/ - title: containerd snapshotters - - sectiontitle: Networking - section: - - path: /engine/network/ - title: Overview - - sectiontitle: Network drivers - section: - - path: /engine/network/drivers/ - title: Overview - - path: /engine/network/drivers/bridge/ - title: Bridge - - path: /engine/network/drivers/overlay/ - title: Overlay - - path: /engine/network/drivers/host/ - title: Host - - path: /engine/network/drivers/ipvlan/ - title: IPvlan - - path: /engine/network/drivers/macvlan/ - title: Macvlan - - path: /engine/network/drivers/none/ - title: None (no networking) - - path: /engine/network/packet-filtering-firewalls/ - title: Packet filtering and firewalls - - sectiontitle: Networking tutorials - section: - - path: /engine/network/tutorials/standalone/ - title: Bridge network tutorial - - path: /engine/network/tutorials/host/ - title: Host networking tutorial - - path: /engine/network/tutorials/overlay/ - title: Overlay networking tutorial - - path: /engine/network/tutorials/macvlan/ - title: Macvlan network tutorial - - sectiontitle: Legacy networking content - section: - - path: /engine/network/links/ - title: (Legacy) Container links - - sectiontitle: Containers - section: - - path: /engine/containers/run/ - title: Running containers - - path: /engine/containers/resource_constraints/ - title: Configure resource constraints - - path: /engine/containers/multi-service_container/ - title: Run multiple processes in a container - - path: /engine/containers/start-containers-automatically/ - title: Start containers automatically - - path: /engine/containers/runmetrics/ - title: Runtime metrics - - sectiontitle: CLI - section: - - path: /engine/cli/completion/ - title: Completion - - path: /engine/cli/proxy/ - title: Client proxy configuration - - path: /engine/cli/filter/ - title: Filter commands - - path: /engine/cli/formatting/ - title: Format command and log output - - path: /engine/cli/otel/ - title: OpenTelemetry - - sectiontitle: Manage resources - section: - - path: /engine/manage-resources/pruning/ - title: Prune unused objects - - path: /engine/manage-resources/labels/ - title: Labels - - path: /engine/manage-resources/contexts/ - title: Contexts - - sectiontitle: Daemon - section: - - path: /engine/daemon/start/ - title: Start the daemon - - path: /engine/daemon/ - title: Configure the daemon - - path: /engine/daemon/ipv6/ - title: Use IPv6 - - path: /engine/daemon/proxy/ - title: Daemon proxy configuration - - path: /engine/containers/live-restore/ - title: Live restore - - path: /engine/daemon/troubleshoot/ - title: Troubleshoot - - path: /engine/daemon/remote-access/ - title: Remote access - - path: /engine/daemon/alternative-runtimes/ - title: Alternative container runtimes - - path: /engine/daemon/logs/ - title: Daemon logs - - path: /engine/daemon/prometheus/ - title: Collect metrics with Prometheus - - sectiontitle: Engine plugins - section: - - path: /engine/extend/ - title: Managed plugin system - - path: /engine/extend/plugins_authorization/ - title: Access authorization plugin - - path: /engine/extend/legacy_plugins/ - title: Extending Docker with plugins - - path: /engine/extend/plugins_network/ - title: Network plugins - - path: /engine/extend/plugins_logging/ - title: Logging plugins - - path: /engine/extend/plugins_volume/ - title: Volume plugins - - title: Plugin configuration - path: /engine/extend/config/ - - path: /engine/extend/plugin_api/ - title: Plugin API - - sectiontitle: Logs and metrics - section: - - sectiontitle: Container logs - section: - - path: /engine/logging/ - title: View container logs - - path: /engine/logging/configure/ - title: Configure logging drivers - - path: /engine/logging/dual-logging/ - title: Use a remote logging driver - - path: /engine/logging/plugins/ - title: Use a logging driver plugin - - path: /engine/logging/log_tags/ - title: Customize log driver output - - sectiontitle: Logging drivers - section: - - path: /engine/logging/drivers/local/ - title: Local file logging driver - - path: /engine/logging/drivers/json-file/ - title: JSON File logging driver - - path: /engine/logging/drivers/gelf/ - title: Graylog Extended Format (GELF) logging driver - - path: /engine/logging/drivers/syslog/ - title: Syslog logging driver - - path: /engine/logging/drivers/awslogs/ - title: Amazon CloudWatch logs logging driver - - path: /engine/logging/drivers/etwlogs/ - title: ETW logging driver - - path: /engine/logging/drivers/fluentd/ - title: Fluentd logging driver - - path: /engine/logging/drivers/gcplogs/ - title: Google Cloud logging driver - - path: /engine/logging/drivers/journald/ - title: Journald logging driver - - path: /engine/logging/drivers/splunk/ - title: Splunk logging driver - - sectiontitle: Security - section: - - path: /engine/security/ - title: Overview - - path: /engine/security/rootless/ - title: Rootless mode - - path: /engine/security/non-events/ - title: Docker security non-events - - path: /engine/security/protect-access/ - title: Protect the Docker daemon socket - - path: /engine/security/certificates/ - title: Using certificates for repository client verification - - sectiontitle: Use trusted images - section: - - path: /engine/security/trust/ - title: Overview - - path: /engine/security/trust/trust_automation/ - title: Automation - - path: /engine/security/trust/trust_delegation/ - title: Delegations - - path: /engine/security/trust/deploying_notary/ - title: Deploy Notary - - path: /engine/security/trust/trust_key_mng/ - title: Manage content trust keys - - path: /engine/security/trust/trust_sandbox/ - title: Play in a content trust sandbox - - path: /engine/security/antivirus/ - title: Antivirus software - - path: /engine/security/apparmor/ - title: AppArmor security profiles - - path: /engine/security/seccomp/ - title: Seccomp security profiles - - path: /engine/security/userns-remap/ - title: Isolate containers with a user namespace - - sectiontitle: Swarm mode - section: - - path: /engine/swarm/ - title: Swarm mode overview - - path: /engine/swarm/key-concepts/ - title: Swarm mode key concepts - - sectiontitle: Get started with swarm mode - section: - - path: /engine/swarm/swarm-tutorial/ - title: Swarm mode tutorial overview - - path: /engine/swarm/swarm-tutorial/create-swarm/ - title: Create a swarm - - path: /engine/swarm/swarm-tutorial/add-nodes/ - title: Add nodes to the swarm - - path: /engine/swarm/swarm-tutorial/deploy-service/ - title: Deploy a service - - path: /engine/swarm/swarm-tutorial/inspect-service/ - title: Inspect the service - - path: /engine/swarm/swarm-tutorial/scale-service/ - title: Scale the service - - path: /engine/swarm/swarm-tutorial/delete-service/ - title: Delete the service - - path: /engine/swarm/swarm-tutorial/rolling-update/ - title: Apply rolling updates - - path: /engine/swarm/swarm-tutorial/drain-node/ - title: Drain a node - - path: /engine/swarm/ingress/ - title: Use Swarm mode routing mesh - - sectiontitle: How Swarm mode works - section: - - path: /engine/swarm/how-swarm-mode-works/nodes/ - title: How nodes work - - path: /engine/swarm/how-swarm-mode-works/services/ - title: How services work - - path: /engine/swarm/how-swarm-mode-works/pki/ - title: Manage swarm security with PKI - - path: /engine/swarm/how-swarm-mode-works/swarm-task-states/ - title: Swarm task states - - path: /engine/swarm/swarm-mode/ - title: Run Docker in Swarm mode - - path: /engine/swarm/join-nodes/ - title: Join nodes to a swarm - - path: /engine/swarm/manage-nodes/ - title: Manage nodes in a swarm - - path: /engine/swarm/services/ - title: Deploy services to a swarm - - path: /engine/swarm/stack-deploy/ - title: Deploy a stack to a swarm - - path: /engine/swarm/configs/ - title: Store service configuration data - - path: /engine/swarm/secrets/ - title: Manage sensitive data with Docker secrets - - path: /engine/swarm/swarm_manager_locking/ - title: Lock your swarm - - path: /engine/swarm/networking/ - title: Manage swarm service networks - - path: /engine/swarm/admin_guide/ - title: Swarm administration guide - - path: /engine/swarm/raft/ - title: Raft consensus in Swarm mode - - path: /engine/deprecated/ - title: Deprecated features - - sectiontitle: Release notes - section: - - path: /engine/release-notes/27/ - title: Engine v27 - - sectiontitle: Previous versions - section: - - path: /engine/release-notes/26.1/ - title: Engine 26.1 - - path: /engine/release-notes/26.0/ - title: Engine 26.0 - - path: /engine/release-notes/25.0/ - title: Engine 25.0 - - path: /engine/release-notes/24.0/ - title: Engine 24.0 - - path: /engine/release-notes/23.0/ - title: Engine 23.0 - - path: /engine/release-notes/20.10/ - title: Engine 20.10 - - path: /engine/release-notes/19.03/ - title: Engine 19.03 - - path: /engine/release-notes/18.09/ - title: Engine 18.09 - - path: /engine/release-notes/18.06/ - title: Engine 18.06 - - path: /engine/release-notes/18.05/ - title: Engine 18.05 - - path: /engine/release-notes/18.04/ - title: Engine 18.04 - - path: /engine/release-notes/18.03/ - title: Engine 18.03 - - path: /engine/release-notes/18.02/ - title: Engine 18.02 - - path: /engine/release-notes/18.01/ - title: Engine 18.01 - - path: /engine/release-notes/17.12/ - title: Engine 17.12 - - path: /engine/release-notes/17.11/ - title: Engine 17.11 - - path: /engine/release-notes/17.10/ - title: Engine 17.10 - - path: /engine/release-notes/17.09/ - title: Engine 17.09 - - path: /engine/release-notes/17.07/ - title: Engine 17.07 - - path: /engine/release-notes/17.06/ - title: Engine 17.06 - - path: /engine/release-notes/17.05/ - title: Engine 17.05 - - path: /engine/release-notes/17.04/ - title: Engine 17.04 - - path: /engine/release-notes/17.03/ - title: Engine 17.03 - - path: /engine/release-notes/prior-releases/ - title: Engine 1.13 and earlier -- sectiontitle: Docker Build - section: - - path: /build/ - title: Overview - - sectiontitle: Core concepts - section: - - path: /build/concepts/overview/ - title: Build overview - - path: /build/concepts/dockerfile/ - title: Dockerfile - - path: /build/concepts/context/ - title: Build context - - sectiontitle: Building - section: - - path: /build/building/multi-stage/ - title: Multi-stage builds - - path: /build/building/variables/ - title: Variables - - path: /build/building/multi-platform/ - title: Multi-platform images - - path: /build/building/secrets/ - title: Build secrets - - path: /build/building/export/ - title: Export binaries - - path: /build/building/best-practices/ - title: Best practices - - path: /build/building/base-images/ - title: Base images - - path: /build/checks/ - title: Build checks {{< badge color=green text=New >}} - - sectiontitle: Builders - section: - - path: /build/builders/ - title: Builders overview - - path: /build/builders/manage/ - title: Manage builders - - sectiontitle: Build drivers - section: - - path: /build/builders/drivers/ - title: Overview - - path: /build/builders/drivers/docker/ - title: Docker driver - - path: /build/builders/drivers/docker-container/ - title: Docker container driver - - path: /build/builders/drivers/kubernetes/ - title: Kubernetes driver - - path: /build/builders/drivers/remote/ - title: Remote driver - - sectiontitle: Bake - section: - - path: /build/bake/ - title: Overview - - path: /build/bake/introduction/ - title: Introduction - - path: /build/bake/targets/ - title: Targets - - path: /build/bake/inheritance/ - title: Inheritance - - path: /build/bake/variables/ - title: Variables - - path: /build/bake/expressions/ - title: Expressions - - path: /build/bake/funcs/ - title: Functions - - path: /build/bake/matrices/ - title: Matrices - - path: /build/bake/contexts/ - title: Contexts - - path: /build/bake/overrides/ - title: Overriding configuration - - path: /build/bake/reference/ - title: Bake file reference - - path: /build/bake/compose-file/ - title: Building from Compose file - - path: /build/bake/remote-definition/ - title: Remote Bake file definition - - sectiontitle: Cache - section: - - path: /build/cache/ - title: Overview - - path: /build/cache/invalidation/ - title: Cache invalidation - - path: /build/cache/optimize/ - title: Optimize cache usage - - path: /build/cache/garbage-collection/ - title: Garbage collection - - sectiontitle: Cache backends - section: - - path: /build/cache/backends/ - title: Overview - - path: /build/cache/backends/inline/ - title: Inline - - path: /build/cache/backends/local/ - title: Local - - path: /build/cache/backends/registry/ - title: Registry - - path: /build/cache/backends/gha/ - title: GitHub Actions - - path: /build/cache/backends/azblob/ - title: Azure Blob Storage - - path: /build/cache/backends/s3/ - title: Amazon S3 - - sectiontitle: GitHub Actions - section: - - path: /build/ci/github-actions/ - title: Introduction - - path: /build/ci/github-actions/build-summary/ - title: Build summary {{< badge color=blue text=Beta >}} - - path: /build/ci/github-actions/configure-builder/ - title: Configuring your builder - - path: /build/ci/github-actions/multi-platform/ - title: Multi-platform image - - path: /build/ci/github-actions/secrets/ - title: Secrets - - path: /build/ci/github-actions/push-multi-registries/ - title: Push to multiple registries - - path: /build/ci/github-actions/manage-tags-labels/ - title: Manage tags and labels - - path: /build/ci/github-actions/cache/ - title: Cache management - - path: /build/ci/github-actions/export-docker/ - title: Export to Docker - - path: /build/ci/github-actions/test-before-push/ - title: Test before push - - path: /build/ci/github-actions/local-registry/ - title: Local registry - - path: /build/ci/github-actions/share-image-jobs/ - title: Share built image between jobs - - path: /build/ci/github-actions/named-contexts/ - title: Named contexts - - path: /build/ci/github-actions/copy-image-registries/ - title: Copy image between registries - - path: /build/ci/github-actions/update-dockerhub-desc/ - title: Update Docker Hub repo description - - path: /build/ci/github-actions/attestations/ - title: SBOM and provenance attestations - - path: /build/ci/github-actions/annotations/ - title: Annotations - - path: /build/ci/github-actions/reproducible-builds/ - title: Reproducible builds - - sectiontitle: Metadata - section: - - path: /build/metadata/annotations/ - title: Annotations - - sectiontitle: Attestations - section: - - path: /build/metadata/attestations/ - title: Overview - - path: /build/metadata/attestations/sbom/ - title: SBOM - - path: /build/metadata/attestations/slsa-provenance/ - title: Provenance - - path: /build/metadata/attestations/slsa-definitions/ - title: SLSA definitions - - path: /build/metadata/attestations/attestation-storage/ - title: Attestation storage - - sectiontitle: Exporters - section: - - path: /build/exporters/ - title: Overview - - path: /build/exporters/image-registry/ - title: Image and registry exporters - - path: /build/exporters/local-tar/ - title: Local and tar exporters - - path: /build/exporters/oci-docker/ - title: OCI and Docker exporters - - sectiontitle: BuildKit - section: - - path: /build/buildkit/ - title: Overview - - path: /build/buildkit/configure/ - title: Configure - - path: /build/buildkit/toml-configuration/ - title: TOML configuration - - path: /build/buildkit/frontend/ - title: Custom Dockerfile syntax - - path: /build/buildkit/dockerfile-release-notes/ - title: Dockerfile release notes - - sectiontitle: Debugging - section: - - path: /build/debug/opentelemetry/ - title: OpenTelemetry support - - path: /build/release-notes/ - title: Release notes -- sectiontitle: Docker Build Cloud - section: - - path: /build-cloud/ - title: Overview - - path: /build-cloud/setup/ - title: Setup - - path: /build-cloud/usage/ - title: Usage - - path: /build-cloud/ci/ - title: Continuous integration - - path: /build-cloud/optimization/ - title: Optimization -- sectiontitle: Docker Compose - section: - - path: /compose/ - title: Overview - - sectiontitle: Introduction to Compose - section: - - path: /compose/intro/features-uses/ - title: Why use Compose? - - path: /compose/intro/history/ - title: History and development of Compose - - sectiontitle: Install - section: - - path: /compose/install/ - title: Overview - - path: /compose/install/linux/ - title: Install Compose plugin - - path: /compose/install/standalone/ - title: Install Compose standalone - - path: /compose/install/uninstall/ - title: Uninstall Compose - - path: /compose/compose-application-model/ - title: How Compose works - - path: /compose/gettingstarted/ - title: Quickstart - - path: /compose/project-name/ - title: Specify a project name - - sectiontitle: Environment variables - section: - - path: /compose/environment-variables/ - title: Overview - - path: /compose/environment-variables/set-environment-variables/ - title: Explore ways to set environment variables - - path: /compose/environment-variables/envvars-precedence/ - title: Understand environment variables precedence - - path: /compose/environment-variables/envvars/ - title: Set or change pre-defined environment variables - - path: /compose/environment-variables/variable-interpolation/ - title: Interpolation - - path: /compose/environment-variables/best-practices/ - title: Best practices - - path: /compose/profiles/ - title: Use service profiles - - path: /compose/file-watch/ - title: Use Compose Watch - - path: /compose/production/ - title: Compose in production - - path: /compose/use-secrets/ - title: Secrets in Compose - - sectiontitle: Working with multiple Compose files - section: - - path: /compose/multiple-compose-files/ - title: Overview - - path: /compose/multiple-compose-files/merge/ - title: Merge - - path: /compose/multiple-compose-files/extends/ - title: Extend - - path: /compose/multiple-compose-files/include/ - title: Include - - path: /compose/startup-order/ - title: Control startup order - - path: /compose/gpu-support/ - title: GPU support - - path: /compose/networking/ - title: Networking - - path: /compose/samples-for-compose/ - title: Sample apps - - path: /compose/feedback/ - title: Give feedback - - path: /compose/migrate/ - title: Migrate to Compose V2 - - path: /compose/faq/ - title: FAQs - - sectiontitle: Compose Bridge - section: - - path: /compose/bridge/ - title: Overview - - path: /compose/bridge/usage/ - title: Usage - - path: /compose/bridge/customize/ - title: Customize - - path: /compose/bridge/advanced-integration/ - title: Advanced - - path: /compose/release-notes/ - title: Release notes - -- sectiontitle: Docker Hub - section: - - path: /docker-hub/ - title: Overview - - path: /docker-hub/quickstart/ - title: Quickstart - - sectiontitle: Repositories - section: - - path: /docker-hub/repos/create/ - title: Create - - path: /docker-hub/repos/access/ - title: Access - - path: /docker-hub/repos/ - title: Manage - - path: /docker-hub/repos/categories/ - title: Categories - - path: /docker-hub/download-rate-limit/ - title: Usage and rate limits - - path: /docker-hub/webhooks/ - title: Webhooks - - path: /docker-hub/service-accounts/ - title: Service accounts - - sectiontitle: Automated builds - section: - - path: /docker-hub/builds/how-builds-work/ - title: How Automated builds work - - path: /docker-hub/builds/ - title: Set up Automated builds - - path: /docker-hub/builds/manage-builds/ - title: Manage your builds - - path: /docker-hub/builds/troubleshoot/ - title: Troubleshoot your builds - - path: /docker-hub/builds/automated-testing/ - title: Testing in Automated builds - - path: /docker-hub/builds/advanced/ - title: Advanced options for builds - - path: /docker-hub/builds/link-source/ - title: Link to GitHub and BitBucket - - path: /docker-hub/vulnerability-scanning/ - title: Vulnerability scanning - - path: /docker-hub/mirror/ - title: Mirroring - - path: /registry/ - title: Registry - - path: /docker-hub/oci-artifacts/ - title: OCI artifacts - - path: /docker-hub/release-notes/ - title: Release notes - -- title: Docker for GitHub Copilot {{< badge color=violet text="Early Access" >}} - path: /copilot/ - -- sectiontitle: Docker accounts - section: - - path: /accounts/ - title: Overview - - path: /accounts/create-account/ - title: Create an account - - path: /accounts/manage-account/ - title: Manage an account - - path: /accounts/deactivate-user-account/ - title: Deactivate an account - -- sectiontitle: Administration - section: - - path: /admin/ - title: Overview - - sectiontitle: Organization administration - section: - - path: /admin/organization/ - title: Overview - - path: /admin/organization/orgs/ - title: Create your organization - - path: /admin/organization/onboard/ - title: Onboard your organization - - path: /admin/organization/members/ - title: Manage members - - path: /admin/organization/manage-a-team/ - title: Create and manage a team - - path: /admin/organization/activity-logs/ - title: Activity logs - - path: /admin/organization/general-settings/ - title: Organization settings - - sectiontitle: Company administration - section: - - path: /admin/company/ - title: Overview - - path: /admin/company/new-company/ - title: Create a company - - path: /admin/company/organizations/ - title: Manage organizations - - path: /admin/company/users/ - title: Manage users - - path: /admin/company/owners/ - title: Manage company owners - - sectiontitle: Account and admin FAQ - section: - - path: /admin/faqs/general-faqs/ - title: General - - path: /admin/faqs/organization-faqs/ - title: Organization - - path: /admin/faqs/company-faqs/ - title: Company - - path: /admin/convert-account/ - title: Convert an account into an organization - - path: /admin/deactivate-account/ - title: Deactivate an organization - -- sectiontitle: Security - section: - - path: /security/ - title: Overview - - sectiontitle: For admins - section: - - sectiontitle: Single sign-on - section: - - path: /security/for-admins/single-sign-on/ - title: Overview - - path: /security/for-admins/single-sign-on/configure/ - title: Configure Docker - - path: /security/for-admins/single-sign-on/configure/configure-idp/ - title: Configure your IdP - - path: /security/for-admins/single-sign-on/connect/ - title: Connect - - path: /security/for-admins/single-sign-on/manage/ - title: Manage - - path: /security/for-admins/single-sign-on/troubleshoot/ - title: Troubleshoot - - sectiontitle: Provisioning - section: - - path: /security/for-admins/provisioning/scim/ - title: SCIM - - path: /security/for-admins/provisioning/just-in-time/ - title: Just-in-Time - - path: /security/for-admins/provisioning/group-mapping/ - title: Group mapping - - sectiontitle: Enforce sign-in - section: - - path: /security/for-admins/enforce-sign-in/ - title: Overview - - path: /security/for-admins/enforce-sign-in/methods/ - title: Methods - - path: /security/for-admins/roles-and-permissions/ - title: Roles and permissions - - path: /security/for-admins/domain-audit/ - title: Domain audit - - sectiontitle: Hardened Docker Desktop - section: - - path: /security/for-admins/hardened-desktop/ - title: Overview - - sectiontitle: Settings Management - section: - - path: /security/for-admins/hardened-desktop/settings-management/ - title: What is Settings Management? - - path: /security/for-admins/hardened-desktop/settings-management/configure/ - title: Configure Settings Management - - sectiontitle: Enhanced Container Isolation - section: - - path: /security/for-admins/hardened-desktop/enhanced-container-isolation/ - title: What is Enhanced Container Isolation? - - path: /security/for-admins/hardened-desktop/enhanced-container-isolation/how-eci-works/ - title: How does it work? - - path: /security/for-admins/hardened-desktop/enhanced-container-isolation/features-benefits/ - title: Key features and benefits - - path: /security/for-admins/hardened-desktop/enhanced-container-isolation/config/ - title: Advanced configuration options - - path: /security/for-admins/hardened-desktop/enhanced-container-isolation/limitations/ - title: Limitations - - path: /security/for-admins/hardened-desktop/enhanced-container-isolation/faq/ - title: FAQ - - path: /security/for-admins/hardened-desktop/air-gapped-containers/ - title: Air-Gapped Containers - - path: /security/for-admins/hardened-desktop/image-access-management/ - title: Image Access Management - - path: /security/for-admins/hardened-desktop/registry-access-management/ - title: Registry Access Management - - - sectiontitle: For developers - section: - - path: /security/for-developers/access-tokens/ - title: Create and manage access tokens - - sectiontitle: Two-factor authentication - section: - - path: /security/for-developers/2fa/ - title: Enable two-factor authentication - - path: /security/for-developers/2fa/disable-2fa/ - title: Disable two-factor authentication - - path: /security/for-developers/2fa/recover-hub-account/ - title: Recover your Docker account - - path: /security/for-developers/2fa/new-recovery-code/ - title: Generate a new recovery code - - path: /security/security-announcements/ - title: Security announcements - - sectiontitle: Security FAQs - section: - - path: /security/faqs/general/ - title: General - - path: /security/faqs/networking-and-vms/ - title: Networking and VMs - - path: /security/faqs/containers/ - title: Containers - - sectiontitle: Single Sign-On - section: - - path: /security/faqs/single-sign-on/faqs/ - title: General - - path: /security/faqs/single-sign-on/idp-faqs/ - title: Identity providers - - path: /security/faqs/single-sign-on/domain-faqs/ - title: Domains - - path: /security/faqs/single-sign-on/enforcement-faqs/ - title: Enforcement - - path: /security/faqs/single-sign-on/users-faqs/ - title: Manage users - -- sectiontitle: Billing - section: - - path: /billing/ - title: Overview - - sectiontitle: Docker Core billing - section: - - path: /billing/core-billing/get-started-core/ - title: Get started with Docker Core - - path: /billing/core-billing/payment-method/ - title: Add or update a payment method - - path: /billing/core-billing/details/ - title: Update the billing information - - path: /billing/core-billing/history/ - title: View your billing history - - path: /billing/core-billing/cycle/ - title: Change your billing cycle - - path: /billing/build-billing/ - title: Docker Build Cloud billing - - path: /billing/scout-billing/ - title: Docker Scout billing - - path: /billing/tax-certificate/ - title: Register a tax certificate - - path: /billing/3d-secure/ - title: 3D Secure authentication - - path: /billing/faqs/ - title: Billing FAQs - -- sectiontitle: Subscription - section: - - path: /subscription/ - title: Overview - - sectiontitle: Docker Core - section: - - path: /subscription/core-subscription/details/ - title: Subscriptions and features - - path: /subscription/core-subscription/upgrade/ - title: Upgrade - - path: /subscription/core-subscription/add-seats/ - title: Add seats - - path: /subscription/core-subscription/remove-seats/ - title: Remove seats - - path: /subscription/core-subscription/downgrade/ - title: Downgrade - - sectiontitle: Docker Build Cloud - section: - - path: /subscription/build-cloud/build-details/ - title: Subscriptions and features - - path: /subscription/build-cloud/manage-seats/ - title: Manage seats and invites - - path: /subscription/scout-details/ - title: Docker Scout subscriptions and features - - path: /subscription/desktop-license/ - title: Docker Desktop license agreement - - path: /subscription/faq/ - title: Subscription FAQ - -- sectiontitle: Trusted content - section: - - path: /trusted-content/ - title: Overview - - sectiontitle: Docker Official Images - section: - - path: /trusted-content/official-images/ - title: Overview - - path: /trusted-content/official-images/using/ - title: Using official images - - path: /trusted-content/official-images/contributing/ - title: Contributing - - path: /trusted-content/dvp-program/ - title: Docker Verified Publisher Program - - path: /trusted-content/dsos-program/ - title: Docker-Sponsored Open Source Program - - path: /trusted-content/insights-analytics/ - title: Insights and analytics - -- path: /support/ - title: Get support -- path: /release-lifecycle/ - title: Product release lifecycle - -Learning paths: -- title: Overview - path: /learning-paths/ -- title: Docker Build Cloud - path: /learning-paths/docker-build-cloud/ -- title: Docker Scout - path: /learning-paths/docker-scout/ -- title: Docker Compose - path: /learning-paths/docker-compose/ diff --git a/hugo.yaml b/hugo.yaml index 7dabd2bed9..c6ddf71a6d 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -120,19 +120,19 @@ params: menus: main: - name: Get started - url: /get-started/ + pageRef: /get-started/ weight: 1 - name: Guides - url: /guides/ + pageRef: /guides/ weight: 2 - name: Manuals - url: /manuals/ + pageRef: /manuals/ weight: 3 - name: Reference - url: /reference/ + pageRef: /reference/ weight: 4 - name: Learning paths - url: /learning-paths/ + pageRef: /learning-paths/ weight: 5 footer: diff --git a/hugo_stats.json b/hugo_stats.json index 6a2a617b13..240cf07be5 100644 --- a/hugo_stats.json +++ b/hugo_stats.json @@ -307,12 +307,16 @@ "highlight", "hover:bg-blue-light-400", "hover:bg-gray-light-100", + "hover:bg-gray-light-300", "hover:border-gray-light-200", + "hover:dark:bg-gray-dark-300", "hover:dark:border-gray-dark", + "hover:dark:text-blue-dark", "hover:drop-shadow-lg", "hover:opacity-75", "hover:opacity-90", "hover:text-black", + "hover:text-blue-light", "hover:underline", "hub-api", "icon-lg", @@ -451,9 +455,9 @@ "scale-75", "scroll-mt-20", "scroll-mt-36", + "select-none", "self-center", "shadow", - "sidebar-hover", "sm:flex-row", "sm:grid-cols-2", "sm:items-center", diff --git a/layouts/partials/breadcrumbs.html b/layouts/partials/breadcrumbs.html index 47be24db12..66822f2a78 100644 --- a/layouts/partials/breadcrumbs.html +++ b/layouts/partials/breadcrumbs.html @@ -1,18 +1,7 @@ -{{ $scratch := partialCached "utils/tocparser.html" . . }} -{{ $ctx := . }} - - diff --git a/layouts/partials/sidebar.html b/layouts/partials/sidebar.html index 023b890948..664320bb23 100644 --- a/layouts/partials/sidebar.html +++ b/layouts/partials/sidebar.html @@ -1,74 +1,78 @@ -{{/* Parse toc.yaml and store the resulting map to $scratch */}} -{{ $scratch := partialCached "utils/tocparser.html" . . }} -{{ $ctx := . }} - -{{/* Get the name of the first section */}} -{{ $firstSection := (index ($scratch.GetSortedMapValues "sections") 0).title }} - {{/* Render the top-nav in sidebar for small screens */}} -{{ if $firstSection }} -{{ $allSections := slice }} -{{ range $i, $e := ($scratch.GetSortedMapValues "sections") }} -{{ $allSections = $allSections | append (index $e "title") }} -{{ end }} -