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/Dockerfile b/Dockerfile index 9a13c04f58..9dafa32d31 100644 --- a/Dockerfile +++ b/Dockerfile @@ -50,8 +50,8 @@ USER root RUN --mount=type=bind,target=. \ /usr/local/bin/markdownlint-cli2 \ "content/**/*.md" \ - "#content/engine/release-notes/*.md" \ - "#content/desktop/previous-versions/*.md" + "#content/manuals/engine/release-notes/*.md" \ + "#content/manuals/desktop/previous-versions/*.md" # test validates HTML output and checks for broken links FROM wjdp/htmltest:v${HTMLTEST_VERSION} AS test diff --git a/_vendor/github.com/docker/cli/docs/deprecated.md b/_vendor/github.com/docker/cli/docs/deprecated.md index 1f28bbcff2..7f598ba8bc 100644 --- a/_vendor/github.com/docker/cli/docs/deprecated.md +++ b/_vendor/github.com/docker/cli/docs/deprecated.md @@ -1,4 +1,6 @@ --- +title: Deprecated Docker Engine features +linkTitle: Deprecated features aliases: ["/engine/misc/deprecated/"] description: "Deprecated Features." keywords: "docker, documentation, about, technology, deprecate" @@ -13,8 +15,6 @@ keywords: "docker, documentation, about, technology, deprecate" will be rejected. --> -# Deprecated Engine Features - This page provides an overview of features that are deprecated in Engine. Changes in packaging, and supported (Linux) distributions are not included. To learn about end of support for Linux distributions, refer to the diff --git a/_vendor/github.com/docker/cli/docs/extend/index.md b/_vendor/github.com/docker/cli/docs/extend/index.md index 8a4f9885d7..57528444d1 100644 --- a/_vendor/github.com/docker/cli/docs/extend/index.md +++ b/_vendor/github.com/docker/cli/docs/extend/index.md @@ -1,5 +1,6 @@ --- title: Docker Engine managed plugin system +linkTitle: Docker Engine plugins description: Develop and use a plugin with the managed plugin system keywords: "API, Usage, plugins, documentation, developer" aliases: diff --git a/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md b/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md index 9abe6d87f6..607c5e34ba 100644 --- a/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md +++ b/_vendor/github.com/moby/buildkit/docs/buildkitd.toml.md @@ -1,4 +1,6 @@ -# buildkitd.toml +--- +title: buildkitd.toml +--- The TOML file used to configure the buildkitd daemon settings has a short list of global settings followed by a series of sections for specific areas 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/content/engine/tutorials/_index.md b/content/engine/tutorials/_index.md deleted file mode 100644 index 98671e9839..0000000000 --- a/content/engine/tutorials/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -description: Explains how to work with containers -keywords: docker, introduction, documentation, about, technology, docker.io, user, - guide, user's, manual, platform, framework, home, intro -title: Engine tutorials -aliases: -- /engine/userguide/containers/ ---- - -Learn by example: - -* [Network containers](networkingcontainers.md) -* [Manage data in containers](/engine/storage/volumes.md) -* [Samples](../../samples/index.md) -* [Get Started](/get-started/introduction/_index.md) diff --git a/content/engine/tutorials/bridge1.png b/content/engine/tutorials/bridge1.png deleted file mode 100644 index 70b3128b2d..0000000000 Binary files a/content/engine/tutorials/bridge1.png and /dev/null differ diff --git a/content/engine/tutorials/bridge2.png b/content/engine/tutorials/bridge2.png deleted file mode 100644 index 9d44ab62de..0000000000 Binary files a/content/engine/tutorials/bridge2.png and /dev/null differ diff --git a/content/engine/tutorials/bridge3.png b/content/engine/tutorials/bridge3.png deleted file mode 100644 index b722653113..0000000000 Binary files a/content/engine/tutorials/bridge3.png and /dev/null differ diff --git a/content/engine/tutorials/networkingcontainers.md b/content/engine/tutorials/networkingcontainers.md deleted file mode 100644 index 4c98af9e63..0000000000 --- a/content/engine/tutorials/networkingcontainers.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -description: How to network Docker containers. -keywords: Examples, Usage, volume, docker, documentation, user guide, data, volumes -title: Network containers -aliases: -- /engine/userguide/containers/networkigncontainers/ -- /engine/userguide/networkigncontainers/ ---- - -If you are working your way through the user guide, you just built and ran a -simple application. You've also built in your own images. This section teaches -you how to network your containers. - -## Launch a container on the default network - -Docker includes support for networking containers through the use of **network -drivers**. By default, Docker provides two network drivers for you, the -`bridge` and the `overlay` drivers. You can also write a network driver plugin so -that you can create your own drivers but that is an advanced task. - -Every installation of the Docker Engine automatically includes three default networks. You can list them: - - $ docker network ls - - NETWORK ID NAME DRIVER - 18a2866682b8 none null - c288470c46f6 host host - 7b369448dccb bridge bridge - -The network named `bridge` is a special network. Unless you tell it otherwise, Docker always launches your containers in this network. Try this now: - - $ docker run -itd --name=networktest ubuntu - - 74695c9cea6d9810718fddadc01a727a5dd3ce6a69d09752239736c030599741 - -![bridge1](bridge1.png) - -Inspecting the network is an easy way to find out the container's IP address. - -```console -$ docker network inspect bridge - -[ - { - "Name": "bridge", - "Id": "f7ab26d71dbd6f557852c7156ae0574bbf62c42f539b50c8ebde0f728a253b6f", - "Scope": "local", - "Driver": "bridge", - "EnableIPv6": false, - "IPAM": { - "Driver": "default", - "Options": null, - "Config": [ - { - "Subnet": "172.17.0.1/16", - "Gateway": "172.17.0.1" - } - ] - }, - "Internal": false, - "Containers": { - "3386a527aa08b37ea9232cbcace2d2458d49f44bb05a6b775fba7ddd40d8f92c": { - "Name": "networktest", - "EndpointID": "647c12443e91faf0fd508b6edfe59c30b642abb60dfab890b4bdccee38750bc1", - "MacAddress": "02:42:ac:11:00:02", - "IPv4Address": "172.17.0.2/16", - "IPv6Address": "" - } - }, - "Options": { - "com.docker.network.bridge.default_bridge": "true", - "com.docker.network.bridge.enable_icc": "true", - "com.docker.network.bridge.enable_ip_masquerade": "true", - "com.docker.network.bridge.host_binding_ipv4": "0.0.0.0", - "com.docker.network.bridge.name": "docker0", - "com.docker.network.driver.mtu": "9001" - }, - "Labels": {} - } -] -``` - -You can remove a container from a network by disconnecting the container. To do this, you supply both the network name and the container name. You can also use the container ID. In this example, though, the name is faster. - - $ docker network disconnect bridge networktest - -While you can disconnect a container from a network, you cannot remove the -builtin `bridge` network named `bridge`. Networks are natural ways to isolate -containers from other containers or other networks. So, as you get more -experienced with Docker, create your own networks. - -## Create your own bridge network - -Docker Engine natively supports both bridge networks and overlay networks. A bridge network is limited to a single host running Docker Engine. An overlay network can include multiple hosts and is a more advanced topic. For this example, create a bridge network: - - $ docker network create -d bridge my_bridge - -The `-d` flag tells Docker to use the `bridge` driver for the new network. You could have left this flag off as `bridge` is the default value for this flag. Go ahead and list the networks on your machine: - - $ docker network ls - - NETWORK ID NAME DRIVER - 7b369448dccb bridge bridge - 615d565d498c my_bridge bridge - 18a2866682b8 none null - c288470c46f6 host host - -If you inspect the network, it has nothing in it. - - $ docker network inspect my_bridge - - [ - { - "Name": "my_bridge", - "Id": "5a8afc6364bccb199540e133e63adb76a557906dd9ff82b94183fc48c40857ac", - "Scope": "local", - "Driver": "bridge", - "IPAM": { - "Driver": "default", - "Config": [ - { - "Subnet": "10.0.0.0/24", - "Gateway": "10.0.0.1" - } - ] - }, - "Containers": {}, - "Options": {}, - "Labels": {} - } - ] - -## Add containers to a network - -To build web applications that act in concert but do so securely, create a -network. Networks, by definition, provide complete isolation for containers. You -can add containers to a network when you first run a container. - -Launch a container running a PostgreSQL database and pass it the `--net=my_bridge` flag to connect it to your new network: - - $ docker run -d --net=my_bridge --name db training/postgres - -If you inspect your `my_bridge` you can see it has a container attached. -You can also inspect your container to see where it is connected: - - - $ docker inspect --format='{{json .NetworkSettings.Networks}}' db - - - {"my_bridge":{"NetworkID":"7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99", - "EndpointID":"508b170d56b2ac9e4ef86694b0a76a22dd3df1983404f7321da5649645bf7043","Gateway":"10.0.0.1","IPAddress":"10.0.0.254","IPPrefixLen":24,"IPv6Gateway":"","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"MacAddress":"02:42:ac:11:00:02"}} - -Now, go ahead and start your by now familiar web application. This time don't specify a network. - - $ docker run -d --name web training/webapp python app.py - -![bridge2](bridge2.png) - -Which network is your `web` application running under? Inspect the application to verify that it is running in the default `bridge` network. - - - $ docker inspect --format='{{json .NetworkSettings.Networks}}' web - - - {"bridge":{"NetworkID":"7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812", - "EndpointID":"508b170d56b2ac9e4ef86694b0a76a22dd3df1983404f7321da5649645bf7043","Gateway":"172.17.0.1","IPAddress":"10.0.0.2","IPPrefixLen":24,"IPv6Gateway":"","GlobalIPv6Address":"","GlobalIPv6PrefixLen":0,"MacAddress":"02:42:ac:11:00:02"}} - -Then, get the IP address of your `web` - - - $ docker inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' web - - - 172.17.0.2 - -Now, open a shell to your running `db` container: - - $ docker container exec -it db bash - - root@a205f0dd33b2:/# ping 172.17.0.2 - ping 172.17.0.2 - PING 172.17.0.2 (172.17.0.2) 56(84) bytes of data. - ^C - --- 172.17.0.2 ping statistics --- - 44 packets transmitted, 0 received, 100% packet loss, time 43185ms - -After a bit, use `CTRL-C` to end the `ping` and notice that the ping failed. That is because the two containers are running on different networks. You can fix that. Then, use the `exit` command to close the container. - -Docker networking allows you to attach a container to as many networks as you like. You can also attach an already running container. Go ahead and attach your running `web` app to the `my_bridge`. - - $ docker network connect my_bridge web - - -![bridge3](bridge3.png) - -Open a shell into the `db` application again and try the ping command. This time just use the container name `web` rather than the IP address. - - $ docker container exec -it db bash - - root@a205f0dd33b2:/# ping web - PING web (10.0.0.2) 56(84) bytes of data. - 64 bytes from web (10.0.0.2): icmp_seq=1 ttl=64 time=0.095 ms - 64 bytes from web (10.0.0.2): icmp_seq=2 ttl=64 time=0.060 ms - 64 bytes from web (10.0.0.2): icmp_seq=3 ttl=64 time=0.066 ms - ^C - --- web ping statistics --- - 3 packets transmitted, 3 received, 0% packet loss, time 2000ms - rtt min/avg/max/mdev = 0.060/0.073/0.095/0.018 ms - -The `ping` shows it is contacting a different IP address, the address on the `my_bridge` which is different from its address on the `bridge` network. - -## Next steps - -Now that you know how to network containers, see [how to manage data in containers](/engine/storage/volumes.md). diff --git a/content/get-started/docker-concepts/_index.md b/content/get-started/docker-concepts/_index.md new file mode 100644 index 0000000000..d892b70a31 --- /dev/null +++ b/content/get-started/docker-concepts/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Docker concepts +weight: 40 +--- diff --git a/content/get-started/docker-concepts/building-images/_index.md b/content/get-started/docker-concepts/building-images/_index.md index fb760143f5..a999122c4d 100644 --- a/content/get-started/docker-concepts/building-images/_index.md +++ b/content/get-started/docker-concepts/building-images/_index.md @@ -1,5 +1,6 @@ --- title: Building images +weight: 20 keywords: build images, Dockerfile, layers, tag, push, cache, multi-stage description: | Learn how to build Docker images from a Dockerfile. You'll understand the diff --git a/content/get-started/docker-concepts/running-containers/_index.md b/content/get-started/docker-concepts/running-containers/_index.md new file mode 100644 index 0000000000..0c3f2b4caa --- /dev/null +++ b/content/get-started/docker-concepts/running-containers/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Running containers +weight: 30 +--- diff --git a/content/get-started/docker-concepts/running-containers/multi-container-applications.md b/content/get-started/docker-concepts/running-containers/multi-container-applications.md index 00647c4d2d..a674f4077f 100644 --- a/content/get-started/docker-concepts/running-containers/multi-container-applications.md +++ b/content/get-started/docker-concepts/running-containers/multi-container-applications.md @@ -1,5 +1,6 @@ --- title: Multi-container applications +weight: 5 keywords: concepts, build, images, container, docker desktop description: This concept page will teach you the significance of multi-container application and how it is different from single-container application aliases: diff --git a/content/get-started/docker-concepts/running-containers/overriding-container-defaults.md b/content/get-started/docker-concepts/running-containers/overriding-container-defaults.md index 6a80769e49..981b4d9fa8 100644 --- a/content/get-started/docker-concepts/running-containers/overriding-container-defaults.md +++ b/content/get-started/docker-concepts/running-containers/overriding-container-defaults.md @@ -1,5 +1,6 @@ --- title: Overriding container defaults +weight: 2 keywords: concepts, build, images, container, docker desktop description: This concept page will teach you how to override the container defaults using the `docker run` command. aliases: diff --git a/content/get-started/docker-concepts/running-containers/persisting-container-data.md b/content/get-started/docker-concepts/running-containers/persisting-container-data.md index 36bd8d16a9..a9ca760d14 100644 --- a/content/get-started/docker-concepts/running-containers/persisting-container-data.md +++ b/content/get-started/docker-concepts/running-containers/persisting-container-data.md @@ -1,5 +1,6 @@ --- title: Persisting container data +weight: 3 keywords: concepts, build, images, container, docker desktop description: This concept page will teach you the significance of data persistence in Docker aliases: diff --git a/content/get-started/docker-concepts/running-containers/publishing-ports.md b/content/get-started/docker-concepts/running-containers/publishing-ports.md index fe0708980c..9f72944441 100644 --- a/content/get-started/docker-concepts/running-containers/publishing-ports.md +++ b/content/get-started/docker-concepts/running-containers/publishing-ports.md @@ -2,6 +2,7 @@ title: Publishing and exposing ports keywords: concepts, build, images, container, docker desktop description: This concept page will teach you the significance of publishing and exposing ports in Docker +weight: 1 aliases: - /guides/docker-concepts/running-containers/publishing-ports/ --- diff --git a/content/get-started/docker-concepts/running-containers/sharing-local-files.md b/content/get-started/docker-concepts/running-containers/sharing-local-files.md index 0381fb2669..493bbd6cd8 100644 --- a/content/get-started/docker-concepts/running-containers/sharing-local-files.md +++ b/content/get-started/docker-concepts/running-containers/sharing-local-files.md @@ -1,5 +1,6 @@ --- title: Sharing local files with containers +weight: 4 keywords: concepts, images, container, docker desktop description: This concept page will teach you the various storage options available in Docker and their common usage. aliases: diff --git a/content/get-started/docker-concepts/the-basics/_index.md b/content/get-started/docker-concepts/the-basics/_index.md new file mode 100644 index 0000000000..75cf7bce5a --- /dev/null +++ b/content/get-started/docker-concepts/the-basics/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: The basics +weight: 10 +--- diff --git a/content/get-started/docker-concepts/the-basics/what-is-a-container.md b/content/get-started/docker-concepts/the-basics/what-is-a-container.md index 51310283aa..c8abe3f803 100644 --- a/content/get-started/docker-concepts/the-basics/what-is-a-container.md +++ b/content/get-started/docker-concepts/the-basics/what-is-a-container.md @@ -1,5 +1,6 @@ --- title: What is a container? +weight: 10 keywords: concepts, build, images, container, docker desktop description: What is a container? This concept page will teach you about containers and provide a quick hands-on where you will run your first container. aliases: diff --git a/content/get-started/docker-concepts/the-basics/what-is-a-registry.md b/content/get-started/docker-concepts/the-basics/what-is-a-registry.md index 6b837c6dc0..8d61803fd4 100644 --- a/content/get-started/docker-concepts/the-basics/what-is-a-registry.md +++ b/content/get-started/docker-concepts/the-basics/what-is-a-registry.md @@ -1,5 +1,6 @@ --- title: What is a registry? +weight: 30 keywords: concepts, build, images, container, docker desktop description: What is a registry? This Docker Concept will explain what a registry is, explore their interoperability, and have you interact with registries. aliases: diff --git a/content/get-started/docker-concepts/the-basics/what-is-an-image.md b/content/get-started/docker-concepts/the-basics/what-is-an-image.md index 831ee96188..34f2a05811 100644 --- a/content/get-started/docker-concepts/the-basics/what-is-an-image.md +++ b/content/get-started/docker-concepts/the-basics/what-is-an-image.md @@ -1,5 +1,6 @@ --- title: What is an image? +weight: 20 keywords: concepts, build, images, container, docker desktop description: What is an image aliases: diff --git a/content/get-started/docker-concepts/the-basics/what-is-docker-compose.md b/content/get-started/docker-concepts/the-basics/what-is-docker-compose.md index b5903ee83d..d0b47d6a13 100644 --- a/content/get-started/docker-concepts/the-basics/what-is-docker-compose.md +++ b/content/get-started/docker-concepts/the-basics/what-is-docker-compose.md @@ -1,5 +1,6 @@ --- title: What is Docker Compose? +weight: 40 keywords: concepts, build, images, container, docker desktop description: What is Docker Compose? aliases: diff --git a/content/get-started/docker-overview.md b/content/get-started/docker-overview.md index d95d3603d7..2d0309c989 100644 --- a/content/get-started/docker-overview.md +++ b/content/get-started/docker-overview.md @@ -5,6 +5,7 @@ keywords: what is a docker, docker daemon, why use docker, docker architecture, to use docker for, docker client, what is docker for, why docker, uses for docker, what is docker container used for, what are docker containers used for title: What is Docker? +weight: 20 aliases: - /introduction/understanding-docker/ - /engine/userguide/basics/ @@ -106,7 +107,7 @@ Docker API. The Docker client can communicate with more than one daemon. ### Docker Desktop -Docker Desktop is an easy-to-install application for your Mac, Windows or Linux environment that enables you to build and share containerized applications and microservices. Docker Desktop includes the Docker daemon (`dockerd`), the Docker client (`docker`), Docker Compose, Docker Content Trust, Kubernetes, and Credential Helper. For more information, see [Docker Desktop](/desktop/index.md). +Docker Desktop is an easy-to-install application for your Mac, Windows or Linux environment that enables you to build and share containerized applications and microservices. Docker Desktop includes the Docker daemon (`dockerd`), the Docker client (`docker`), Docker Compose, Docker Content Trust, Kubernetes, and Credential Helper. For more information, see [Docker Desktop](/manuals/desktop/index.md). ### Docker registries diff --git a/content/get-started/get-docker.md b/content/get-started/get-docker.md index d65f096925..17a26e0bf4 100644 --- a/content/get-started/get-docker.md +++ b/content/get-started/get-docker.md @@ -4,6 +4,7 @@ description: Download and install Docker on the platform of your choice, includi keywords: install docker, docker download, download docker, docker installation, how to install docker, get docker, docker locally title: Get Docker +weight: 10 aliases: - /install/ - /install/overview/ diff --git a/content/get-started/introduction/_index.md b/content/get-started/introduction/_index.md index 2f6b5be62c..e7362a868b 100644 --- a/content/get-started/introduction/_index.md +++ b/content/get-started/introduction/_index.md @@ -1,6 +1,7 @@ --- title: Introduction keywords: get started, getting started, how to get started +weight: 30 description: | Get started with Docker. You'll learn about Docker Desktop, developing with Docker, as well as how to build and push your first image. diff --git a/content/get-started/workshop/02_our_app.md b/content/get-started/workshop/02_our_app.md index 655dfa3ffc..0d01ca1744 100644 --- a/content/get-started/workshop/02_our_app.md +++ b/content/get-started/workshop/02_our_app.md @@ -1,5 +1,7 @@ --- title: Containerize an application +weight: 20 +linkTitle: "Part 1: Containerize an application" keywords: dockerfile example, Containerize an application, run docker file, running docker file, how to run dockerfile, example dockerfile, how to create a docker container, create dockerfile, simple dockerfile, creating containers diff --git a/content/get-started/workshop/03_updating_app.md b/content/get-started/workshop/03_updating_app.md index b9e8ee0eec..27a4ff2cf6 100644 --- a/content/get-started/workshop/03_updating_app.md +++ b/content/get-started/workshop/03_updating_app.md @@ -1,5 +1,7 @@ --- title: Update the application +weight: 30 +linkTitle: "Part 2: Update the application" keywords: get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop description: Making changes to your application diff --git a/content/get-started/workshop/04_sharing_app.md b/content/get-started/workshop/04_sharing_app.md index 4e65fcaece..5ba3b09f06 100644 --- a/content/get-started/workshop/04_sharing_app.md +++ b/content/get-started/workshop/04_sharing_app.md @@ -1,5 +1,7 @@ --- title: Share the application +weight: 40 +linkTitle: "Part 3: Share the application" keywords: get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop, docker hub, sharing description: Sharing your image you built for your example application so you can @@ -80,7 +82,7 @@ new instance that has never seen this container image. To do this, you will use > $ docker build --platform linux/amd64 -t YOUR-USER-NAME/getting-started . > ``` > -> Docker buildx also supports building multi-platform images. To learn more, see [Multi-platform images](/build/building/multi-platform.md). +> Docker buildx also supports building multi-platform images. To learn more, see [Multi-platform images](/manuals/build/building/multi-platform.md). 1. Open your browser to [Play with Docker](https://labs.play-with-docker.com/). @@ -112,7 +114,7 @@ new instance that has never seen this container image. To do this, you will use > on all interfaces of the host, making it available to the outside world. > > For more information about how port mapping works, see - > [Networking](/engine/network/_index.md#published-ports). + > [Networking](/manuals/engine/network/_index.md#published-ports). 6. Select the 3000 badge when it appears. @@ -129,8 +131,8 @@ can use the latest version of the image. Related information: - [docker CLI reference](/reference/cli/docker/) - - [Multi-platform images](/build/building/multi-platform.md) - - [Docker Hub overview](/docker-hub/_index.md) + - [Multi-platform images](/manuals/build/building/multi-platform.md) + - [Docker Hub overview](/manuals/docker-hub/_index.md) ## Next steps diff --git a/content/get-started/workshop/05_persisting_data.md b/content/get-started/workshop/05_persisting_data.md index 151ec06bc6..5e5864cde4 100644 --- a/content/get-started/workshop/05_persisting_data.md +++ b/content/get-started/workshop/05_persisting_data.md @@ -1,5 +1,7 @@ --- title: Persist the DB +weight: 50 +linkTitle: "Part 4: Persist the DB" keywords: get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop description: Making your DB persistent in your application @@ -63,7 +65,7 @@ With the previous experiment, you saw that each container starts from the image While containers can create, update, and delete files, those changes are lost when you remove the container and Docker isolates all changes to that container. With volumes, you can change all of this. -[Volumes](/engine/storage/volumes.md) provide the ability to connect specific filesystem paths of +[Volumes](/manuals/engine/storage/volumes.md) provide the ability to connect specific filesystem paths of the container back to the host machine. If you mount a directory in the container, changes in that directory are also seen on the host machine. If you mount that same directory across container restarts, you'd see the same files. @@ -118,7 +120,7 @@ You can create the volume and start the container using the CLI or Docker Deskto > ``` > > For more details about Git Bash's syntax differences, see - > [Working with Git Bash](../../desktop/troubleshoot/topics/#working-with-git-bash). + > [Working with Git Bash](/desktop/troubleshoot/topics/#working-with-git-bash). {{< /tab >}} @@ -205,7 +207,7 @@ In this section, you learned how to persist container data. Related information: - [docker CLI reference](/reference/cli/docker/) - - [Volumes](/engine/storage/volumes.md) + - [Volumes](/manuals/engine/storage/volumes.md) ## Next steps diff --git a/content/get-started/workshop/06_bind_mounts.md b/content/get-started/workshop/06_bind_mounts.md index b376526473..8c4ca7e184 100644 --- a/content/get-started/workshop/06_bind_mounts.md +++ b/content/get-started/workshop/06_bind_mounts.md @@ -1,5 +1,7 @@ --- title: Use bind mounts +weight: 60 +linkTitle: "Part 5: Use bind mounts" keywords: 'get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop' description: Using bind mounts in our application aliases: @@ -49,9 +51,9 @@ work. 1. Verify that your `getting-started-app` directory is in a directory defined in Docker Desktop's file sharing setting. This setting defines which parts of your filesystem you can share with containers. For details about accessing the -setting, see the topic for [Mac](/desktop/settings/mac.md#file-sharing), -[Windows](/desktop/settings/windows.md#file-sharing), or -[Linux](/desktop/settings/linux.md#file-sharing). +setting, see the topic for [Mac](/manuals/desktop/settings/mac.md#file-sharing), +[Windows](/manuals/desktop/settings/windows.md#file-sharing), or +[Linux](/manuals/desktop/settings/linux.md#file-sharing). 2. Open a terminal and change directory to the `getting-started-app` directory. diff --git a/content/get-started/workshop/07_multi_container.md b/content/get-started/workshop/07_multi_container.md index 7f680a257d..aab577adeb 100644 --- a/content/get-started/workshop/07_multi_container.md +++ b/content/get-started/workshop/07_multi_container.md @@ -1,5 +1,7 @@ --- title: Multi container apps +weight: 70 +linkTitle: "Part 6: Multi-container apps" keywords: get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop description: Using more than one container in your application @@ -313,7 +315,7 @@ container. You learned a little bit about container networking and service disco Related information: - [docker CLI reference](/reference/cli/docker/) - - [Networking overview](/engine/network/_index.md) + - [Networking overview](/manuals/engine/network/_index.md) ## Next steps diff --git a/content/get-started/workshop/08_using_compose.md b/content/get-started/workshop/08_using_compose.md index 58adf2407c..90011a77d1 100644 --- a/content/get-started/workshop/08_using_compose.md +++ b/content/get-started/workshop/08_using_compose.md @@ -1,5 +1,7 @@ --- title: Use Docker Compose +weight: 80 +linkTitle: "Part 7: Use Docker Compose" keywords: get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop description: Using Docker Compose for multi-container applications @@ -8,7 +10,7 @@ aliases: - /guides/workshop/08_using_compose/ --- -[Docker Compose](/compose/_index.md) is a tool that helps you define and +[Docker Compose](/manuals/compose/_index.md) is a tool that helps you define and share multi-container applications. With Compose, you can create a YAML file to define the services and with a single command, you can spin everything up or tear it all down. @@ -279,7 +281,7 @@ In this section, you learned about Docker Compose and how it helps you simplify the way you define and share multi-service applications. Related information: - - [Compose overview](/compose/_index.md) + - [Compose overview](/manuals/compose/_index.md) - [Compose file reference](/reference/compose-file/_index.md) - [Compose CLI reference](/reference/cli/docker/compose/_index.md) diff --git a/content/get-started/workshop/09_image_best.md b/content/get-started/workshop/09_image_best.md index d2d6c96cb0..2e91579a22 100644 --- a/content/get-started/workshop/09_image_best.md +++ b/content/get-started/workshop/09_image_best.md @@ -1,5 +1,7 @@ --- title: Image-building best practices +weight: 90 +linkTitle: "Part 8: Image-building best practices" keywords: get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop description: Tips for building images for your application @@ -201,7 +203,7 @@ In this section, you learned a few image building best practices, including laye Related information: - [Dockerfile reference](/reference/dockerfile/) - - [Dockerfile best practices](/build/building/best-practices.md) + - [Dockerfile best practices](/manuals/build/building/best-practices.md) ## Next steps diff --git a/content/get-started/workshop/10_what_next.md b/content/get-started/workshop/10_what_next.md index b1175f82bb..e14bfc54c3 100644 --- a/content/get-started/workshop/10_what_next.md +++ b/content/get-started/workshop/10_what_next.md @@ -1,5 +1,7 @@ --- title: What next after the Docker workshop +weight: 100 +linkTitle: "Part 9: What next" keywords: get started, setup, orientation, quickstart, intro, concepts, containers, docker desktop description: Making sure you have more ideas of what you could do next with your application @@ -52,4 +54,4 @@ If you'd like to see how containers are built from scratch, Liz Rice from Aqua S ## Language-specific guides -If you are looking for information on how to containerize an application using your favorite language, see the [Language-specific guides](/language/_index.md). +If you are looking for information on how to containerize an application using your favorite language, see the [Language-specific guides](/guides/language/_index.md). diff --git a/content/get-started/workshop/_index.md b/content/get-started/workshop/_index.md index 89e590331a..cc6a0beff9 100644 --- a/content/get-started/workshop/_index.md +++ b/content/get-started/workshop/_index.md @@ -1,5 +1,6 @@ --- title: Overview of the Docker workshop +linkTitle: Docker workshop keywords: docker basics, how to start a docker container, container settings, setup docker, how to setup docker, setting up docker, docker container guide, how to get started with docker diff --git a/content/guides/deployment-orchestration/_index.md b/content/guides/deployment-orchestration/_index.md new file mode 100644 index 0000000000..d98304876c --- /dev/null +++ b/content/guides/deployment-orchestration/_index.md @@ -0,0 +1,7 @@ +--- +title: Deployment and orchestration +weight: 30 +build: + render: never +--- + diff --git a/content/guides/deployment-orchestration/swarm-deploy.md b/content/guides/deployment-orchestration/swarm-deploy.md index d464ab8fc0..d5e93e8bab 100644 --- a/content/guides/deployment-orchestration/swarm-deploy.md +++ b/content/guides/deployment-orchestration/swarm-deploy.md @@ -103,8 +103,8 @@ In addition to deploying to Swarm, you've also described your application as a s Further documentation for all new Swarm objects and CLI commands used in this article are available here: - - [Swarm Mode](/engine/swarm/_index.md) - - [Swarm Mode Services](/engine/swarm/how-swarm-mode-works/services.md) - - [Swarm Stacks](/engine/swarm/stack-deploy.md) + - [Swarm Mode](/manuals/engine/swarm/_index.md) + - [Swarm Mode Services](/manuals/engine/swarm/how-swarm-mode-works/services.md) + - [Swarm Stacks](/manuals/engine/swarm/stack-deploy.md) - [`docker stack *`](/reference/cli/docker/stack/) - [`docker service *`](/reference/cli/docker/service/) diff --git a/content/guides/language/_index.md b/content/guides/language/_index.md new file mode 100644 index 0000000000..c028bbbab7 --- /dev/null +++ b/content/guides/language/_index.md @@ -0,0 +1,60 @@ +--- +description: Language-specific guides overview +linkTitle: Language-specific guides +weight: 10 +keywords: guides, docker, language, node, java, python, R, go, golang, .net, c++ +title: Language-specific guides overview +toc_min: 1 +toc_max: 2 +aliases: +- /guides/walkthroughs/containerize-your-app/ +- /language/ +--- + +The language-specific guides walk you through the process of: +* Containerizing language-specific applications +* Setting up a development environment +* Configuring a CI/CD pipeline +* Deploying an application locally using Kubernetes + +In addition to the language-specific modules, Docker documentation also provides guidelines to build images and efficiently manage your development environment. For more information, refer to the following topics: + +* [Building best practices](/manuals/build/building/best-practices.md) +* [Build images with BuildKit](/manuals/build/buildkit/index.md#getting-started) + +## Language-specific guides + +Learn how to containerize your applications and start developing using Docker. Choose one of the following languages to get started. + +
+
+ Develop with Node +
+
+ Develop with Python +
+
+ Develop with R +
+
+ Develop with Java +
+
+ Develop with Go +
+
+ Develop with C# +
+
+ Develop with C++ +
+
+ Develop with Rust +
+
+ Develop with PHP +
+
+ Develop with Ruby +
+
diff --git a/content/language/cpp/_index.md b/content/guides/language/cpp/_index.md similarity index 96% rename from content/language/cpp/_index.md rename to content/guides/language/cpp/_index.md index 1f17b40774..d422306115 100644 --- a/content/language/cpp/_index.md +++ b/content/guides/language/cpp/_index.md @@ -2,8 +2,11 @@ description: Containerize and develop C++ applications using Docker. keywords: getting started, c++ title: C++ language-specific guide +linkTitle: C++ toc_min: 1 toc_max: 2 +aliases: +- /language/cpp/ --- The C++ getting started guide teaches you how to create a containerized C++ application using Docker. In this guide, you'll learn how to: diff --git a/content/language/cpp/configure-ci-cd.md b/content/guides/language/cpp/configure-ci-cd.md similarity index 91% rename from content/language/cpp/configure-ci-cd.md rename to content/guides/language/cpp/configure-ci-cd.md index ffd08f52a0..1e00c05711 100644 --- a/content/language/cpp/configure-ci-cd.md +++ b/content/guides/language/cpp/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your C++ application +linkTitle: Configure CI/CD +weight: 40 keywords: ci/cd, github actions, c++, shiny description: Learn how to configure CI/CD using GitHub Actions for your C++ application. +aliases: +- /language/cpp/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -119,7 +123,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your C++ application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/cpp/containerize.md b/content/guides/language/cpp/containerize.md similarity index 90% rename from content/language/cpp/containerize.md rename to content/guides/language/cpp/containerize.md index d9e3b8469f..7a8c7f1d13 100644 --- a/content/language/cpp/containerize.md +++ b/content/guides/language/cpp/containerize.md @@ -1,7 +1,11 @@ --- title: Containerize a C++ application +linkTitle: Containerize your app +weight: 10 keywords: C++, containerize, initialize description: Learn how to containerize a C++ application. +aliases: +- /language/cpp/containerize/ --- ## Prerequisites @@ -34,8 +38,8 @@ directory. ``` To learn more about the files in the repository, see the following: - - [Dockerfile](../../reference/dockerfile.md) - - [.dockerignore](../../reference/dockerfile.md#dockerignore-file) + - [Dockerfile](/reference/dockerfile.md) + - [.dockerignore](/reference/dockerfile.md#dockerignore-file) - [compose.yml](/reference/compose-file/_index.md) ## Run the application @@ -79,7 +83,7 @@ In this section, you learned how you can containerize and run your C++ application using Docker. Related information: - - [Docker Compose overview](../../compose/_index.md) + - [Docker Compose overview](/manuals/compose/_index.md) ## Next steps diff --git a/content/language/cpp/deploy.md b/content/guides/language/cpp/deploy.md similarity index 95% rename from content/language/cpp/deploy.md rename to content/guides/language/cpp/deploy.md index 0f166fede7..28b0d0bb70 100644 --- a/content/language/cpp/deploy.md +++ b/content/guides/language/cpp/deploy.md @@ -1,7 +1,11 @@ --- title: Test your C++ deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, kubernetes, c++ description: Learn how to develop locally using Kubernetes +aliases: +- /language/cpp/deploy/ --- ## Prerequisites @@ -133,5 +137,5 @@ In this section, you learned how to use Docker Desktop to deploy your C++ applic Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/cpp/develop.md b/content/guides/language/cpp/develop.md similarity index 90% rename from content/language/cpp/develop.md rename to content/guides/language/cpp/develop.md index 952daf0f82..3d5414ee34 100644 --- a/content/language/cpp/develop.md +++ b/content/guides/language/cpp/develop.md @@ -1,7 +1,11 @@ --- title: Use containers for C++ development +linkTitle: Develop your app +weight: 20 keywords: C++, local, development description: Learn how to develop your C++ application locally. +aliases: +- /language/cpp/develop/ --- ## Prerequisites @@ -26,7 +30,7 @@ $ git clone https://github.com/Pradumnasaraf/c-plus-plus-docker.git Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose -Watch](../../compose/file-watch.md). +Watch](/manuals/compose/file-watch.md). Open your `compose.yml` file in an IDE or text editor and then add the Compose Watch instructions. The following example shows how to add Compose Watch to your `compose.yml` file. @@ -63,8 +67,8 @@ In this section, you also learned how to use Compose Watch to automatically rebu Related information: - [Compose file reference](/reference/compose-file/) - - [Compose file watch](../../compose/file-watch.md) - - [Multi-stage builds](../../build/building/multi-stage.md) + - [Compose file watch](/manuals/compose/file-watch.md) + - [Multi-stage builds](/manuals/build/building/multi-stage.md) ## Next steps diff --git a/content/language/dotnet/_index.md b/content/guides/language/dotnet/_index.md similarity index 95% rename from content/language/dotnet/_index.md rename to content/guides/language/dotnet/_index.md index b95f384b2d..d9f4482328 100644 --- a/content/language/dotnet/_index.md +++ b/content/guides/language/dotnet/_index.md @@ -1,9 +1,12 @@ --- +title: .NET language-specific guide +linkTitle: C# (.NET) description: Containerize and develop .NET apps using Docker keywords: getting started, .net -title: .NET language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/dotnet/ --- The .NET getting started guide teaches you how to create a containerized .NET application using Docker. In this guide, you'll learn how to: diff --git a/content/language/dotnet/configure-ci-cd.md b/content/guides/language/dotnet/configure-ci-cd.md similarity index 91% rename from content/language/dotnet/configure-ci-cd.md rename to content/guides/language/dotnet/configure-ci-cd.md index 5f7dc1faec..617564c6c9 100644 --- a/content/language/dotnet/configure-ci-cd.md +++ b/content/guides/language/dotnet/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your .NET application +linkTitle: Configure CI/CD +weight: 40 keywords: .net, CI/CD description: Learn how to Configure CI/CD for your .NET application +aliases: +- /language/dotnet/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -134,7 +138,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/dotnet/containerize.md b/content/guides/language/dotnet/containerize.md similarity index 91% rename from content/language/dotnet/containerize.md rename to content/guides/language/dotnet/containerize.md index b6296f3c3c..c7d4736562 100644 --- a/content/language/dotnet/containerize.md +++ b/content/guides/language/dotnet/containerize.md @@ -1,10 +1,13 @@ --- title: Containerize a .NET application +linkTitle: Containerize your app +weight: 10 keywords: .net, containerize, initialize description: Learn how to containerize an ASP.NET application. aliases: - /language/dotnet/build-images/ - /language/dotnet/run-containers/ +- /language/dotnet/containerize/ --- ## Prerequisites @@ -75,8 +78,8 @@ directory. ``` To learn more about the files that `docker init` added, see the following: - - [Dockerfile](../../reference/dockerfile.md) - - [.dockerignore](../../reference/dockerfile.md#dockerignore-file) + - [Dockerfile](/reference/dockerfile.md) + - [.dockerignore](/reference/dockerfile.md#dockerignore-file) - [compose.yaml](/reference/compose-file/_index.md) ## Run the application @@ -119,9 +122,9 @@ In this section, you learned how you can containerize and run your .NET application using Docker. Related information: - - [Dockerfile reference](../../reference/dockerfile.md) - - [.dockerignore file reference](../../reference/dockerfile.md#dockerignore-file) - - [Docker Compose overview](../../compose/_index.md) + - [Dockerfile reference](/reference/dockerfile.md) + - [.dockerignore file reference](/reference/dockerfile.md#dockerignore-file) + - [Docker Compose overview](/manuals/compose/_index.md) ## Next steps diff --git a/content/language/dotnet/deploy.md b/content/guides/language/dotnet/deploy.md similarity index 96% rename from content/language/dotnet/deploy.md rename to content/guides/language/dotnet/deploy.md index 65ed4e5e63..5990d42a8a 100644 --- a/content/language/dotnet/deploy.md +++ b/content/guides/language/dotnet/deploy.md @@ -1,7 +1,11 @@ --- title: Test your .NET deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, .net, local, development description: Learn how to deploy your application +aliases: +- /language/dotnet/deploy/ --- ## Prerequisites @@ -209,5 +213,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/dotnet/develop.md b/content/guides/language/dotnet/develop.md similarity index 97% rename from content/language/dotnet/develop.md rename to content/guides/language/dotnet/develop.md index ec869e1c52..ee03af0ad5 100644 --- a/content/language/dotnet/develop.md +++ b/content/guides/language/dotnet/develop.md @@ -1,7 +1,11 @@ --- title: Use containers for .NET development +linkTitle: Develop your app +weight: 20 keywords: .net, development description: Learn how to develop your .NET application locally using containers. +aliases: +- /language/dotnet/develop/ --- ## Prerequisites @@ -225,7 +229,7 @@ Press `ctrl+c` in the terminal to stop your application. ## Automatically update services -Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](../../compose/file-watch.md). +Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](/manuals/compose/file-watch.md). Open your `compose.yaml` file in an IDE or text editor and then add the Compose Watch instructions. The following is the updated `compose.yaml` file. @@ -292,7 +296,7 @@ Press `ctrl+c` in the terminal to stop your application. ## Create a development container -At this point, when you run your containerized application, it's using the .NET runtime image. While this small image is good for production, it lacks the SDK tools and dependencies you may need when developing. Also, during development, you may not need to run `dotnet publish`. You can use multi-stage builds to build stages for both development and production in the same Dockerfile. For more details, see [Multi-stage builds](../../build/building/multi-stage.md). +At this point, when you run your containerized application, it's using the .NET runtime image. While this small image is good for production, it lacks the SDK tools and dependencies you may need when developing. Also, during development, you may not need to run `dotnet publish`. You can use multi-stage builds to build stages for both development and production in the same Dockerfile. For more details, see [Multi-stage builds](/manuals/build/building/multi-stage.md). Add a new development stage to your Dockerfile and update your `compose.yaml` file to use this stage for local development. @@ -383,8 +387,8 @@ database and persist data. You also learned how to use Compose Watch to automati Related information: - [Compose file reference](/reference/compose-file/) - - [Compose file watch](../../compose/file-watch.md) - - [Multi-stage builds](../../build/building/multi-stage.md) + - [Compose file watch](/manuals/compose/file-watch.md) + - [Multi-stage builds](/manuals/build/building/multi-stage.md) ## Next steps diff --git a/content/language/dotnet/run-tests.md b/content/guides/language/dotnet/run-tests.md similarity index 98% rename from content/language/dotnet/run-tests.md rename to content/guides/language/dotnet/run-tests.md index b51d945211..0dce2d7995 100644 --- a/content/language/dotnet/run-tests.md +++ b/content/guides/language/dotnet/run-tests.md @@ -1,7 +1,11 @@ --- title: Run .NET tests in a container +linkTitle: Run your tests +weight: 30 keywords: .NET, test description: Learn how to run your .NET tests in a container. +aliases: +- /language/dotnet/run-tests/ --- ## Prerequisites diff --git a/content/language/golang/_index.md b/content/guides/language/golang/_index.md similarity index 86% rename from content/language/golang/_index.md rename to content/guides/language/golang/_index.md index 79b620c0c2..13cf37c7af 100644 --- a/content/language/golang/_index.md +++ b/content/guides/language/golang/_index.md @@ -1,9 +1,12 @@ --- +title: Go language-specific guide +linkTitle: Go description: Containerize Go apps using Docker keywords: docker, getting started, go, golang, language, dockerfile -title: Go language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/golang/ --- This guide will show you how to create, test, and deploy containerized Go applications using Docker. @@ -30,11 +33,11 @@ the [Go website](https://golang.org/) is a great place to explore, so *go* (pun intended) check it out! You also must know some basic [Docker concepts](/get-started/docker-concepts/the-basics/what-is-a-container.md) as well as to -be at least vaguely familiar with the [Dockerfile format](../../build/concepts/dockerfile.md). +be at least vaguely familiar with the [Dockerfile format](/manuals/build/concepts/dockerfile.md). -Your Docker set-up must have BuildKit enabled. BuildKit is enabled by default for all users on [Docker Desktop](../../desktop/index.md). +Your Docker set-up must have BuildKit enabled. BuildKit is enabled by default for all users on [Docker Desktop](/manuals/desktop/index.md). If you have installed Docker Desktop, you don’t have to manually enable BuildKit. If you are running Docker on Linux, -please check out BuildKit [getting started](../../build/buildkit/index.md#getting-started) page. +please check out BuildKit [getting started](/manuals/build/buildkit/index.md#getting-started) page. Some familiarity with the command line is also expected. diff --git a/content/language/golang/build-images.md b/content/guides/language/golang/build-images.md similarity index 97% rename from content/language/golang/build-images.md rename to content/guides/language/golang/build-images.md index 2a04c52e8c..3c1c6644ce 100644 --- a/content/language/golang/build-images.md +++ b/content/guides/language/golang/build-images.md @@ -1,9 +1,12 @@ --- title: Build your Go image +linkTitle: Build images +weight: 5 keywords: containers, images, go, golang, dockerfiles, coding, build, push, run description: Learn how to build your first Docker image by writing a Dockerfile aliases: - /get-started/golang/build-images/ +- /language/golang/build-images/ --- ## Overview @@ -17,7 +20,7 @@ application. To complete this tutorial, you need the following: -- Docker running locally. Follow the [instructions to download and install Docker](../../desktop/index.md). +- Docker running locally. Follow the [instructions to download and install Docker](/manuals/desktop/index.md). - An IDE or a text editor to edit files. [Visual Studio Code](https://code.visualstudio.com/) is a free and popular choice but you can use anything you feel comfortable with. - A Git client. This guide uses a command-line based `git` client, but you are free to use whatever works for you. - A command-line terminal application. The examples shown in this module are from the Linux shell, but they should work in PowerShell, Windows Command Prompt, or OS X Terminal with minimal, if any, modifications. @@ -113,7 +116,7 @@ has all necessary tools and libraries to compile and run a Go application. > [!NOTE] > -> If you are curious about creating your own base images, you can check out the following section of this guide: [creating base images](../../build/building/base-images.md#create-a-base-image). +> If you are curious about creating your own base images, you can check out the following section of this guide: [creating base images](/manuals/build/building/base-images.md#create-a-base-image). > Note, however, that this isn't necessary to continue with your task at hand. Now that you have defined the base image for your upcoming container image, you @@ -155,7 +158,7 @@ COPY go.mod go.sum ./ > > If you'd like to familiarize yourself with the trailing slash treatment by the > `COPY` command, see [Dockerfile -> reference](../../reference/dockerfile.md#copy). This trailing slash can +> reference](/reference/dockerfile.md#copy). This trailing slash can > cause issues in more ways than you can imagine. Now that you have the module files inside the Docker image that you are @@ -307,7 +310,7 @@ successfully built your image named `docker-gs-ping`. To see the list of images you have on your local machine, you have two options. One is to use the CLI and the other is to use [Docker -Desktop](../../desktop/index.md). Since you're currently working in the +Desktop](/manuals/desktop/index.md). Since you're currently working in the terminal, take a look at listing images with the CLI. To list images, run the `docker image ls`command (or the `docker images` shorthand): @@ -407,7 +410,7 @@ The answer is that the full toolchain is still there, in the container image. Not only this is inconvenient because of the large file size, but it may also present a security risk when the container is deployed. -These two issues can be solved by using [multi-stage builds](../../build/building/multi-stage.md). +These two issues can be solved by using [multi-stage builds](/manuals/build/building/multi-stage.md). In a nutshell, a multi-stage build can carry over the artifacts from one build stage into another, and every build stage can be instantiated from a different base image. @@ -478,7 +481,7 @@ This is so because the ["distroless"](https://github.com/GoogleContainerTools/di base image that you have used in the second stage of the build is very barebones and is designed for lean deployments of static binaries. There's much more to multi-stage builds, including the possibility of multi-architecture builds, -so feel free to check out [multi-stage builds](../../build/building/multi-stage.md). This is, however, not essential for your progress here. +so feel free to check out [multi-stage builds](/manuals/build/building/multi-stage.md). This is, however, not essential for your progress here. ## Next steps diff --git a/content/language/golang/configure-ci-cd.md b/content/guides/language/golang/configure-ci-cd.md similarity index 91% rename from content/language/golang/configure-ci-cd.md rename to content/guides/language/golang/configure-ci-cd.md index ffc51274af..3cbd753b45 100644 --- a/content/language/golang/configure-ci-cd.md +++ b/content/guides/language/golang/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your Go application +linkTitle: Configure CI/CD +weight: 40 keywords: go, CI/CD, local, development description: Learn how to Configure CI/CD for your Go application +aliases: +- /language/golang/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -119,7 +123,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/golang/deploy.md b/content/guides/language/golang/deploy.md similarity index 96% rename from content/language/golang/deploy.md rename to content/guides/language/golang/deploy.md index 99387d7f00..ef1b07195d 100644 --- a/content/language/golang/deploy.md +++ b/content/guides/language/golang/deploy.md @@ -1,7 +1,11 @@ --- title: Test your Go deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, go, local, development description: Learn how to deploy your Go application +aliases: +- /language/golang/deploy/ --- ## Prerequisites @@ -234,5 +238,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/golang/develop.md b/content/guides/language/golang/develop.md similarity index 98% rename from content/language/golang/develop.md rename to content/guides/language/golang/develop.md index d1893e452e..5b0fe22238 100644 --- a/content/language/golang/develop.md +++ b/content/guides/language/golang/develop.md @@ -1,9 +1,12 @@ --- title: Use containers for Go development +linkTitle: Develop your app +weight: 20 keywords: get started, go, golang, local, development description: Learn how to develop your application locally. aliases: - /get-started/golang/develop/ +- /language/golang/develop/ --- ## Prerequisites @@ -26,7 +29,7 @@ For more information on the relation between Go and CockroachDB, refer to the [C ### Storage -The point of a database is to have a persistent store of data. [Volumes](/engine/storage/volumes.md) are the preferred mechanism for persisting data generated by and used by Docker containers. Thus, before you start CockroachDB, create the volume for it. +The point of a database is to have a persistent store of data. [Volumes](/manuals/engine/storage/volumes.md) are the preferred mechanism for persisting data generated by and used by Docker containers. Thus, before you start CockroachDB, create the volume for it. To create a managed volume, run : @@ -65,7 +68,7 @@ daed20bbecce host host local 6aee44f40a39 none null local ``` -Your bridge network `mynet` has been created successfully. The other three networks, named `bridge`, `host`, and `none` are the default networks and they had been created by the Docker itself. While it's not relevant to this guide, you can learn more about Docker networking in the [networking overview](/engine/network/_index.md) section. +Your bridge network `mynet` has been created successfully. The other three networks, named `bridge`, `host`, and `none` are the default networks and they had been created by the Docker itself. While it's not relevant to this guide, you can learn more about Docker networking in the [networking overview](/manuals/engine/network/_index.md) section. ### Choose good names for volumes and networks @@ -568,7 +571,7 @@ networks: ``` -This Docker Compose configuration is super convenient as you don't have to type all the parameters to pass to the `docker run` command. You can declaratively do that in the Docker Compose file. The [Docker Compose documentation pages](../../compose/index.md) are quite extensive and include a full reference for the Docker Compose file format. +This Docker Compose configuration is super convenient as you don't have to type all the parameters to pass to the `docker run` command. You can declaratively do that in the Docker Compose file. The [Docker Compose documentation pages](/manuals/compose/index.md) are quite extensive and include a full reference for the Docker Compose file format. ### The `.env` file @@ -711,7 +714,7 @@ There are some tangential, yet interesting points that were purposefully not cov ### Persistent storage -A managed volume isn't the only way to provide your container with persistent storage. It is highly recommended to get acquainted with available storage options and their use cases, covered in [Manage data in Docker](/engine/storage/_index.md). +A managed volume isn't the only way to provide your container with persistent storage. It is highly recommended to get acquainted with available storage options and their use cases, covered in [Manage data in Docker](/manuals/engine/storage/_index.md). ### CockroachDB clusters diff --git a/content/language/golang/run-containers.md b/content/guides/language/golang/run-containers.md similarity index 99% rename from content/language/golang/run-containers.md rename to content/guides/language/golang/run-containers.md index a865a10b0c..c08e27c618 100644 --- a/content/language/golang/run-containers.md +++ b/content/guides/language/golang/run-containers.md @@ -1,9 +1,12 @@ --- title: Run your Go image as a container +linkTitle: Run containers +weight: 10 keywords: get started, go, golang, run, container description: Learn how to run the image as a container. aliases: - /get-started/golang/run-containers/ +- /language/golang/run-containers/ --- ## Prerequisites diff --git a/content/language/golang/run-tests.md b/content/guides/language/golang/run-tests.md similarity index 97% rename from content/language/golang/run-tests.md rename to content/guides/language/golang/run-tests.md index 08f8771c67..14c643f3df 100644 --- a/content/language/golang/run-tests.md +++ b/content/guides/language/golang/run-tests.md @@ -1,9 +1,12 @@ --- title: Run your tests using Go test +linkTitle: Run your tests +weight: 30 keywords: build, go, golang, test description: How to build and run your Go tests in a container aliases: - /get-started/golang/run-tests/ +- /language/golang/run-tests/ --- ## Prerequisites diff --git a/content/language/images/c-sharp.webp b/content/guides/language/images/c-sharp.webp similarity index 100% rename from content/language/images/c-sharp.webp rename to content/guides/language/images/c-sharp.webp diff --git a/content/language/images/cpp.webp b/content/guides/language/images/cpp.webp similarity index 100% rename from content/language/images/cpp.webp rename to content/guides/language/images/cpp.webp diff --git a/content/language/images/golang.webp b/content/guides/language/images/golang.webp similarity index 100% rename from content/language/images/golang.webp rename to content/guides/language/images/golang.webp diff --git a/content/language/images/java.webp b/content/guides/language/images/java.webp similarity index 100% rename from content/language/images/java.webp rename to content/guides/language/images/java.webp diff --git a/content/language/images/nodejs.webp b/content/guides/language/images/nodejs.webp similarity index 100% rename from content/language/images/nodejs.webp rename to content/guides/language/images/nodejs.webp diff --git a/content/language/images/php-logo.webp b/content/guides/language/images/php-logo.webp similarity index 100% rename from content/language/images/php-logo.webp rename to content/guides/language/images/php-logo.webp diff --git a/content/language/images/python.webp b/content/guides/language/images/python.webp similarity index 100% rename from content/language/images/python.webp rename to content/guides/language/images/python.webp diff --git a/content/language/images/r.webp b/content/guides/language/images/r.webp similarity index 100% rename from content/language/images/r.webp rename to content/guides/language/images/r.webp diff --git a/content/language/images/ruby-on-rails.webp b/content/guides/language/images/ruby-on-rails.webp similarity index 100% rename from content/language/images/ruby-on-rails.webp rename to content/guides/language/images/ruby-on-rails.webp diff --git a/content/language/images/rust-logo.webp b/content/guides/language/images/rust-logo.webp similarity index 100% rename from content/language/images/rust-logo.webp rename to content/guides/language/images/rust-logo.webp diff --git a/content/language/java/_index.md b/content/guides/language/java/_index.md similarity index 95% rename from content/language/java/_index.md rename to content/guides/language/java/_index.md index aa26ab189f..5f4bb7b1f7 100644 --- a/content/language/java/_index.md +++ b/content/guides/language/java/_index.md @@ -1,9 +1,12 @@ --- title: Java language-specific guide +linkTitle: Java keywords: java, getting started description: Containerize Java apps using Docker toc_min: 1 toc_max: 2 +aliases: +- /language/java/ --- The Java getting started guide teaches you how to create a containerized Spring Boot application using Docker. In this module, you’ll learn how to: diff --git a/content/language/java/configure-ci-cd.md b/content/guides/language/java/configure-ci-cd.md similarity index 92% rename from content/language/java/configure-ci-cd.md rename to content/guides/language/java/configure-ci-cd.md index 6f289ee932..2f0d40e42a 100644 --- a/content/language/java/configure-ci-cd.md +++ b/content/guides/language/java/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your Java application +linkTitle: Configure CI/CD +weight: 40 keywords: java, CI/CD, local, development description: Learn how to Configure CI/CD for your Java application +aliases: +- /language/java/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -129,7 +133,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/java/containerize.md b/content/guides/language/java/containerize.md similarity index 99% rename from content/language/java/containerize.md rename to content/guides/language/java/containerize.md index 3e715c2348..4141a17b90 100644 --- a/content/language/java/containerize.md +++ b/content/guides/language/java/containerize.md @@ -1,10 +1,13 @@ --- title: Containerize a Java application +linkTitle: Containerize your app +weight: 10 keywords: java, containerize, initialize, maven, build description: Learn how to containerize a Java application. aliases: - /language/java/build-images/ - /language/java/run-containers/ + - /language/java/containerize/ --- ## Prerequisites diff --git a/content/language/java/deploy.md b/content/guides/language/java/deploy.md similarity index 95% rename from content/language/java/deploy.md rename to content/guides/language/java/deploy.md index 7322f60671..0c6cc47367 100644 --- a/content/language/java/deploy.md +++ b/content/guides/language/java/deploy.md @@ -1,7 +1,11 @@ --- title: Test your Java deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, kubernetes, java description: Learn how to develop locally using Kubernetes +aliases: +- /language/java/deploy/ --- ## Prerequisites @@ -144,5 +148,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/java/develop.md b/content/guides/language/java/develop.md similarity index 98% rename from content/language/java/develop.md rename to content/guides/language/java/develop.md index de553f911c..62e6978525 100644 --- a/content/language/java/develop.md +++ b/content/guides/language/java/develop.md @@ -1,7 +1,11 @@ --- title: Use containers for Java development +linkTitle: Develop your app +weight: 20 keywords: Java, local, development, run, description: Learn how to develop your application locally. +aliases: +- /language/java/develop/ --- ## Prerequisites @@ -261,7 +265,7 @@ Press `ctrl+c` in the terminal to stop your application. Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see -[Use Compose Watch](../../compose/file-watch.md). +[Use Compose Watch](/manuals/compose/file-watch.md). Open your `docker-compose.yaml` file in an IDE or text editor and then add the Compose Watch instructions. The following is the updated `docker-compose.yaml` @@ -336,7 +340,7 @@ In this section, you took a look at running a database locally and persisting th Related information: - [Compose file reference](/reference/compose-file/) - - [Compose Watch](../../compose/file-watch.md) + - [Compose Watch](/manuals/compose/file-watch.md) - [Dockerfile reference](/reference/dockerfile/) ## Next steps diff --git a/content/language/java/images/compose-logs.webp b/content/guides/language/java/images/compose-logs.webp similarity index 100% rename from content/language/java/images/compose-logs.webp rename to content/guides/language/java/images/compose-logs.webp diff --git a/content/language/java/images/connect-debugger.webp b/content/guides/language/java/images/connect-debugger.webp similarity index 100% rename from content/language/java/images/connect-debugger.webp rename to content/guides/language/java/images/connect-debugger.webp diff --git a/content/language/java/images/debug-menu.webp b/content/guides/language/java/images/debug-menu.webp similarity index 100% rename from content/language/java/images/debug-menu.webp rename to content/guides/language/java/images/debug-menu.webp diff --git a/content/language/java/images/debugger-breakpoint.webp b/content/guides/language/java/images/debugger-breakpoint.webp similarity index 100% rename from content/language/java/images/debugger-breakpoint.webp rename to content/guides/language/java/images/debugger-breakpoint.webp diff --git a/content/language/java/run-tests.md b/content/guides/language/java/run-tests.md similarity index 98% rename from content/language/java/run-tests.md rename to content/guides/language/java/run-tests.md index 82ecbfc0c6..47458d4cb2 100644 --- a/content/language/java/run-tests.md +++ b/content/guides/language/java/run-tests.md @@ -1,7 +1,11 @@ --- title: Run your Java tests +linkTitle: Run your tests +weight: 30 keywords: Java, build, test description: How to build and run your Java tests +aliases: +- /language/java/run-tests/ --- ## Prerequisites diff --git a/content/language/nodejs/_index.md b/content/guides/language/nodejs/_index.md similarity index 94% rename from content/language/nodejs/_index.md rename to content/guides/language/nodejs/_index.md index 44eafc84b1..4c54fe7c06 100644 --- a/content/language/nodejs/_index.md +++ b/content/guides/language/nodejs/_index.md @@ -1,9 +1,12 @@ --- +title: Node.js language-specific guide +linkTitle: Node.js description: Containerize and develop Node.js apps using Docker keywords: getting started, node, node.js -title: Node.js language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/nodejs/ --- The Node.js language-specific guide teaches you how to containerize a Node.js application using Docker. In this guide, you’ll learn how to: diff --git a/content/language/nodejs/configure-ci-cd.md b/content/guides/language/nodejs/configure-ci-cd.md similarity index 91% rename from content/language/nodejs/configure-ci-cd.md rename to content/guides/language/nodejs/configure-ci-cd.md index ce3a2c2e7b..ebb6454ccb 100644 --- a/content/language/nodejs/configure-ci-cd.md +++ b/content/guides/language/nodejs/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your Node.js application +linkTitle: Configure CI/CD +weight: 40 keywords: ci/cd, github actions, node.js, node description: Learn how to configure CI/CD using GitHub Actions for your Node.js application. +aliases: +- /language/nodejs/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -126,7 +130,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your Node.js application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/nodejs/containerize.md b/content/guides/language/nodejs/containerize.md similarity index 95% rename from content/language/nodejs/containerize.md rename to content/guides/language/nodejs/containerize.md index faca0c1814..e8e4677814 100644 --- a/content/language/nodejs/containerize.md +++ b/content/guides/language/nodejs/containerize.md @@ -1,11 +1,14 @@ --- title: Containerize a Node.js application +linkTitle: Containerize your app +weight: 10 keywords: node.js, node, containerize, initialize description: Learn how to containerize a Node.js application. aliases: - /get-started/nodejs/build-images/ - /language/nodejs/build-images/ - /language/nodejs/run-containers/ + - /language/nodejs/containerize/ --- ## Prerequisites @@ -227,8 +230,8 @@ You should now have at least the following contents in your ``` To learn more about the files, see the following: - - [Dockerfile](../../reference/dockerfile.md) - - [.dockerignore](../../reference/dockerfile.md#dockerignore-file) + - [Dockerfile](/reference/dockerfile.md) + - [.dockerignore](/reference/dockerfile.md#dockerignore-file) - [compose.yaml](/reference/compose-file/_index.md) @@ -274,9 +277,9 @@ In this section, you learned how you can containerize and run your Node.js application using Docker. Related information: - - [Dockerfile reference](../../reference/dockerfile.md) - - [.dockerignore file reference](../../reference/dockerfile.md#dockerignore-file) - - [Docker Compose overview](../../compose/_index.md) + - [Dockerfile reference](/reference/dockerfile.md) + - [.dockerignore file reference](/reference/dockerfile.md#dockerignore-file) + - [Docker Compose overview](/manuals/compose/_index.md) ## Next steps diff --git a/content/language/nodejs/deploy.md b/content/guides/language/nodejs/deploy.md similarity index 95% rename from content/language/nodejs/deploy.md rename to content/guides/language/nodejs/deploy.md index f9a8a58595..46a1e7b811 100644 --- a/content/language/nodejs/deploy.md +++ b/content/guides/language/nodejs/deploy.md @@ -1,7 +1,11 @@ --- title: Test your Node.js deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, kubernetes, node, node.js description: Learn how to deploy locally to test and debug your Kubernetes deployment +aliases: +- /language/nodejs/deploy/ --- ## Prerequisites @@ -133,5 +137,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/nodejs/develop.md b/content/guides/language/nodejs/develop.md similarity index 98% rename from content/language/nodejs/develop.md rename to content/guides/language/nodejs/develop.md index ff962d32e8..f777d7c554 100644 --- a/content/language/nodejs/develop.md +++ b/content/guides/language/nodejs/develop.md @@ -1,9 +1,12 @@ --- title: Use containers for Node.js development +linkTitle: Develop your app +weight: 20 keywords: node, node.js, development description: Learn how to develop your Node.js application locally using containers. aliases: - /get-started/nodejs/develop/ +- /language/nodejs/develop/ --- ## Prerequisites @@ -270,7 +273,7 @@ have these variables defined yet. ## Configure and run a development container -You can use a bind mount to mount your source code into the container. The container can then see the changes you make to the code immediately, as soon as you save a file. This means that you can run processes, like nodemon, in the container that watch for filesystem changes and respond to them. To learn more about bind mounts, see [Storage overview](/engine/storage/index.md). +You can use a bind mount to mount your source code into the container. The container can then see the changes you make to the code immediately, as soon as you save a file. This means that you can run processes, like nodemon, in the container that watch for filesystem changes and respond to them. To learn more about bind mounts, see [Storage overview](/manuals/engine/storage/index.md). In addition to adding a bind mount, you can configure your Dockerfile and `compose.yaml` file to install development dependencies and run development tools. @@ -320,7 +323,7 @@ in other build stages. Next, you add a new build stage labeled `dev` to install your development dependencies and start the container using `npm run dev`. Finally, you add a stage labeled `prod` that omits the dev dependencies and runs your application using `node src/index.js`. To learn more about multi-stage -builds, see [Multi-stage builds](../../build/building/multi-stage.md). +builds, see [Multi-stage builds](/manuals/build/building/multi-stage.md). Next, you'll need to update your Compose file to use the new stage. @@ -419,7 +422,7 @@ Dockerfile and set up a bind mount for development. Related information: - [Volumes top-level element](/reference/compose-file/volumes/) - [Services top-level element](/reference/compose-file/services/) - - [Multi-stage builds](../../build/building/multi-stage.md) + - [Multi-stage builds](/manuals/build/building/multi-stage.md) ## Next steps diff --git a/content/language/nodejs/run-tests.md b/content/guides/language/nodejs/run-tests.md similarity index 98% rename from content/language/nodejs/run-tests.md rename to content/guides/language/nodejs/run-tests.md index 1ba52882a7..d629eee907 100644 --- a/content/language/nodejs/run-tests.md +++ b/content/guides/language/nodejs/run-tests.md @@ -1,7 +1,11 @@ --- title: Run Node.js tests in a container +linkTitle: Run your tests +weight: 30 keywords: node.js, node, test description: Learn how to run your Node.js tests in a container. +aliases: +- /language/nodejs/run-tests/ --- ## Prerequisites diff --git a/content/language/php/_index.md b/content/guides/language/php/_index.md similarity index 95% rename from content/language/php/_index.md rename to content/guides/language/php/_index.md index c5f90fb38b..7fddb6306f 100644 --- a/content/language/php/_index.md +++ b/content/guides/language/php/_index.md @@ -1,9 +1,12 @@ --- +title: PHP language-specific guide +linkTitle: PHP description: Containerize and develop PHP apps using Docker keywords: getting started, php, composer -title: PHP language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/php/ --- The PHP language-specific guide teaches you how to create a containerized PHP application using Docker. In this guide, you'll learn how to: diff --git a/content/language/php/configure-ci-cd.md b/content/guides/language/php/configure-ci-cd.md similarity index 91% rename from content/language/php/configure-ci-cd.md rename to content/guides/language/php/configure-ci-cd.md index db06cca6dc..83ea135ae8 100644 --- a/content/language/php/configure-ci-cd.md +++ b/content/guides/language/php/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your PHP application +linkTitle: Configure CI/CD +weight: 40 keywords: php, CI/CD description: Learn how to Configure CI/CD for your PHP application +aliases: +- /language/php/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -134,7 +138,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/php/containerize.md b/content/guides/language/php/containerize.md similarity index 94% rename from content/language/php/containerize.md rename to content/guides/language/php/containerize.md index 715d0544e7..5361c2d8d8 100644 --- a/content/language/php/containerize.md +++ b/content/guides/language/php/containerize.md @@ -1,7 +1,11 @@ --- title: Containerize a PHP application +linkTitle: Containerize your app +weight: 10 keywords: php, containerize, initialize, apache, composer description: Learn how to containerize a PHP application. +aliases: +- /language/php/containerize/ --- ## Prerequisites @@ -76,8 +80,8 @@ directory. ``` To learn more about the files that `docker init` added, see the following: - - [Dockerfile](../../reference/dockerfile.md) - - [.dockerignore](../../reference/dockerfile.md#dockerignore-file) + - [Dockerfile](/reference/dockerfile.md) + - [.dockerignore](/reference/dockerfile.md#dockerignore-file) - [compose.yaml](/reference/compose-file/_index.md) ## Run the application @@ -120,7 +124,7 @@ In this section, you learned how you can containerize and run a simple PHP application using Docker. Related information: - - [docker init reference](../../reference/cli/docker/init.md) + - [docker init reference](/reference/cli/docker/init.md) ## Next steps diff --git a/content/language/php/deploy.md b/content/guides/language/php/deploy.md similarity index 95% rename from content/language/php/deploy.md rename to content/guides/language/php/deploy.md index d7a53f8dbc..e60dfb1fab 100644 --- a/content/language/php/deploy.md +++ b/content/guides/language/php/deploy.md @@ -1,7 +1,11 @@ --- title: Test your PHP deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, php, local, development description: Learn how to deploy your application +aliases: +- /language/php/deploy/ --- ## Prerequisites @@ -136,5 +140,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/php/develop.md b/content/guides/language/php/develop.md similarity index 97% rename from content/language/php/develop.md rename to content/guides/language/php/develop.md index 54eced386a..8b01bde354 100644 --- a/content/language/php/develop.md +++ b/content/guides/language/php/develop.md @@ -1,7 +1,11 @@ --- title: Use containers for PHP development +linkTitle: Develop your app +weight: 20 keywords: php, development description: Learn how to develop your PHP application locally using containers. +aliases: +- /language/php/develop/ --- ## Prerequisites @@ -236,7 +240,7 @@ Press `ctrl+c` in the terminal to stop your application. ## Automatically update services -Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](../../compose/file-watch.md). +Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose Watch](/manuals/compose/file-watch.md). Open your `compose.yaml` file in an IDE or text editor and then add the Compose Watch instructions. The following is the updated `compose.yaml` file. @@ -313,7 +317,7 @@ Press `ctrl+c` in the terminal to stop Compose Watch. Run `docker compose down` ## Create a development container -At this point, when you run your containerized application, Composer isn't installing the dev dependencies. While this small image is good for production, it lacks the tools and dependencies you may need when developing and it doesn't include the `tests` directory. You can use multi-stage builds to build stages for both development and production in the same Dockerfile. For more details, see [Multi-stage builds](../../build/building/multi-stage.md). +At this point, when you run your containerized application, Composer isn't installing the dev dependencies. While this small image is good for production, it lacks the tools and dependencies you may need when developing and it doesn't include the `tests` directory. You can use multi-stage builds to build stages for both development and production in the same Dockerfile. For more details, see [Multi-stage builds](/manuals/build/building/multi-stage.md). In the `Dockerfile`, you'll need to update the following: 1. Split the `deps` staged into two stages. One stage for production @@ -418,8 +422,8 @@ database and persist data. You also learned how to use Compose Watch to automati Related information: - [Compose file reference](/reference/compose-file/) - - [Compose file watch](../../compose/file-watch.md) - - [Dockerfile reference](../../reference/dockerfile.md) + - [Compose file watch](/manuals/compose/file-watch.md) + - [Dockerfile reference](/reference/dockerfile.md) - [Official Docker Image for PHP](https://hub.docker.com/_/php) ## Next steps diff --git a/content/language/php/run-tests.md b/content/guides/language/php/run-tests.md similarity index 98% rename from content/language/php/run-tests.md rename to content/guides/language/php/run-tests.md index d6e18c8af2..41bb5695ad 100644 --- a/content/language/php/run-tests.md +++ b/content/guides/language/php/run-tests.md @@ -1,7 +1,11 @@ --- title: Run PHP tests in a container +linkTitle: Run your tests +weight: 30 keywords: php, test description: Learn how to run your PHP tests in a container. +aliases: +- /language/php/run-tests/ --- ## Prerequisites diff --git a/content/language/python/_index.md b/content/guides/language/python/_index.md similarity index 94% rename from content/language/python/_index.md rename to content/guides/language/python/_index.md index df5ca126cc..c93e625103 100644 --- a/content/language/python/_index.md +++ b/content/guides/language/python/_index.md @@ -1,9 +1,12 @@ --- +title: Python language-specific guide +linkTitle: Python description: Containerize Python apps using Docker keywords: Docker, getting started, Python, language -title: Python language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/python/ --- The Python language-specific guide teaches you how to containerize a Python application using Docker. In this guide, you’ll learn how to: diff --git a/content/language/python/configure-ci-cd.md b/content/guides/language/python/configure-ci-cd.md similarity index 91% rename from content/language/python/configure-ci-cd.md rename to content/guides/language/python/configure-ci-cd.md index 72c3289d48..f8cfc897d3 100644 --- a/content/language/python/configure-ci-cd.md +++ b/content/guides/language/python/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your Python application +linkTitle: Configure CI/CD +weight: 40 keywords: ci/cd, github actions, python, flask description: Learn how to configure CI/CD using GitHub Actions for your Python application. +aliases: +- /language/python/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -119,7 +123,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your Python application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/python/containerize.md b/content/guides/language/python/containerize.md similarity index 97% rename from content/language/python/containerize.md rename to content/guides/language/python/containerize.md index 12115c4143..92cdd169ac 100644 --- a/content/language/python/containerize.md +++ b/content/guides/language/python/containerize.md @@ -1,10 +1,13 @@ --- title: Containerize a Python application +linkTitle: Containerize your app +weight: 10 keywords: python, flask, containerize, initialize description: Learn how to containerize a Python application. aliases: - /language/python/build-images/ - /language/python/run-containers/ + - /language/python/containerize/ --- ## Prerequisites @@ -315,8 +318,8 @@ directory. ``` To learn more about the files, see the following: - - [Dockerfile](../../reference/dockerfile.md) - - [.dockerignore](../../reference/dockerfile.md#dockerignore-file) + - [Dockerfile](/reference/dockerfile.md) + - [.dockerignore](/reference/dockerfile.md#dockerignore-file) - [.gitignore](https://git-scm.com/docs/gitignore) - [compose.yaml](/reference/compose-file/_index.md) @@ -364,7 +367,7 @@ In this section, you learned how you can containerize and run your Python application using Docker. Related information: - - [Docker Compose overview](../../compose/_index.md) + - [Docker Compose overview](/manuals/compose/_index.md) ## Next steps diff --git a/content/language/python/deploy.md b/content/guides/language/python/deploy.md similarity index 97% rename from content/language/python/deploy.md rename to content/guides/language/python/deploy.md index 805512cc82..12ffeb5e4e 100644 --- a/content/language/python/deploy.md +++ b/content/guides/language/python/deploy.md @@ -1,7 +1,11 @@ --- title: Test your Python deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, kubernetes, python description: Learn how to develop locally using Kubernetes +aliases: +- /language/python/deploy/ --- ## Prerequisites @@ -247,5 +251,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/python/develop.md b/content/guides/language/python/develop.md similarity index 98% rename from content/language/python/develop.md rename to content/guides/language/python/develop.md index dc68e3cac8..691259423c 100644 --- a/content/language/python/develop.md +++ b/content/guides/language/python/develop.md @@ -1,7 +1,11 @@ --- title: Use containers for Python development +linkTitle: Develop your app +weight: 20 keywords: python, local, development description: Learn how to develop your Python application locally. +aliases: +- /language/python/develop/ --- ## Prerequisites @@ -469,7 +473,7 @@ Press `ctrl+c` in the terminal to stop your application. Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose -Watch](../../compose/file-watch.md). +Watch](/manuals/compose/file-watch.md). Open your `compose.yaml` file in an IDE or text editor and then add the Compose Watch instructions. The following is the updated `compose.yaml` file. @@ -558,8 +562,8 @@ database and persist data. You also learned how to use Compose Watch to automati Related information: - [Compose file reference](/reference/compose-file/) - - [Compose file watch](../../compose/file-watch.md) - - [Multi-stage builds](../../build/building/multi-stage.md) + - [Compose file watch](/manuals/compose/file-watch.md) + - [Multi-stage builds](/manuals/build/building/multi-stage.md) ## Next steps diff --git a/content/language/r/_index.md b/content/guides/language/r/_index.md similarity index 94% rename from content/language/r/_index.md rename to content/guides/language/r/_index.md index 63edb1a9b2..036b12a45e 100644 --- a/content/language/r/_index.md +++ b/content/guides/language/r/_index.md @@ -1,9 +1,12 @@ --- +title: R language-specific guide +linkTitle: R description: Containerize R apps using Docker keywords: Docker, getting started, R, language -title: R language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/r/ --- The R language-specific guide teaches you how to containerize a R application using Docker. In this guide, you’ll learn how to: diff --git a/content/language/r/configure-ci-cd.md b/content/guides/language/r/configure-ci-cd.md similarity index 91% rename from content/language/r/configure-ci-cd.md rename to content/guides/language/r/configure-ci-cd.md index 89c02b3bb5..6047d773ed 100644 --- a/content/language/r/configure-ci-cd.md +++ b/content/guides/language/r/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your R application +linkTitle: Configure CI/CD +weight: 40 keywords: ci/cd, github actions, R, shiny description: Learn how to configure CI/CD using GitHub Actions for your R application. +aliases: +- /language/r/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -119,7 +123,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your R application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/r/containerize.md b/content/guides/language/r/containerize.md similarity index 91% rename from content/language/r/containerize.md rename to content/guides/language/r/containerize.md index 3bb24c702d..9407ba9d2a 100644 --- a/content/language/r/containerize.md +++ b/content/guides/language/r/containerize.md @@ -1,10 +1,13 @@ --- title: Containerize a R application +linkTitle: Containerize your app +weight: 10 keywords: R, containerize, initialize description: Learn how to containerize a R application. aliases: - /language/R/build-images/ - /language/R/run-containers/ + - /language/r/containerize/ --- ## Prerequisites @@ -40,8 +43,8 @@ directory. ``` To learn more about the files in the repository, see the following: - - [Dockerfile](../../reference/dockerfile.md) - - [.dockerignore](../../reference/dockerfile.md#dockerignore-file) + - [Dockerfile](/reference/dockerfile.md) + - [.dockerignore](/reference/dockerfile.md#dockerignore-file) - [compose.yaml](/reference/compose-file/_index.md) ## Run the application @@ -86,7 +89,7 @@ In this section, you learned how you can containerize and run your R application using Docker. Related information: - - [Docker Compose overview](../../compose/_index.md) + - [Docker Compose overview](/manuals/compose/_index.md) ## Next steps diff --git a/content/language/r/deploy.md b/content/guides/language/r/deploy.md similarity index 95% rename from content/language/r/deploy.md rename to content/guides/language/r/deploy.md index 5c236a2c8f..c70e602672 100644 --- a/content/language/r/deploy.md +++ b/content/guides/language/r/deploy.md @@ -1,7 +1,11 @@ --- title: Test your R deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, kubernetes, R description: Learn how to develop locally using Kubernetes +aliases: +- /language/r/deploy/ --- ## Prerequisites @@ -137,5 +141,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/r/develop.md b/content/guides/language/r/develop.md similarity index 96% rename from content/language/r/develop.md rename to content/guides/language/r/develop.md index 4779dea919..5fde1668e7 100644 --- a/content/language/r/develop.md +++ b/content/guides/language/r/develop.md @@ -1,7 +1,11 @@ --- title: Use containers for R development +linkTitle: Develop your app +weight: 20 keywords: R, local, development description: Learn how to develop your R application locally. +aliases: +- /language/r/develop/ --- ## Prerequisites @@ -143,7 +147,7 @@ Press `ctrl+c` in the terminal to stop your application. Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose -Watch](../../compose/file-watch.md). +Watch](/manuals/compose/file-watch.md). Lines 15 to 18 in the `compose.yaml` file contain properties that trigger Docker to rebuild the image when a file in the current working directory is changed: @@ -209,8 +213,8 @@ database and persist data. You also learned how to use Compose Watch to automati Related information: - [Compose file reference](/reference/compose-file/) - - [Compose file watch](../../compose/file-watch.md) - - [Multi-stage builds](../../build/building/multi-stage.md) + - [Compose file watch](/manuals/compose/file-watch.md) + - [Multi-stage builds](/manuals/build/building/multi-stage.md) ## Next steps diff --git a/content/language/ruby/_index.md b/content/guides/language/ruby/_index.md similarity index 94% rename from content/language/ruby/_index.md rename to content/guides/language/ruby/_index.md index 2da18bcabb..9b1d8ba57b 100644 --- a/content/language/ruby/_index.md +++ b/content/guides/language/ruby/_index.md @@ -1,9 +1,12 @@ --- +title: Ruby on Rails language-specific guide +linkTitle: Ruby description: Containerize Ruby on Rails apps using Docker keywords: Docker, getting started, ruby, language -title: Ruby on Rails language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/ruby/ --- The Ruby language-specific guide teaches you how to containerize a Ruby on Rails application using Docker. In this guide, you’ll learn how to: diff --git a/content/language/ruby/configure-ci-cd.md b/content/guides/language/ruby/configure-ci-cd.md similarity index 91% rename from content/language/ruby/configure-ci-cd.md rename to content/guides/language/ruby/configure-ci-cd.md index 6fbb4fb887..a7d8f13eee 100644 --- a/content/language/ruby/configure-ci-cd.md +++ b/content/guides/language/ruby/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your Ruby on Rails application +linkTitle: Configure CI/CD +weight: 40 keywords: ci/cd, github actions, ruby, flask description: Learn how to configure CI/CD using GitHub Actions for your Ruby on Rails application. +aliases: +- /language/ruby/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -119,7 +123,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your Ruby on Rails application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/ruby/containerize.md b/content/guides/language/ruby/containerize.md similarity index 97% rename from content/language/ruby/containerize.md rename to content/guides/language/ruby/containerize.md index 516726c34c..279783954e 100644 --- a/content/language/ruby/containerize.md +++ b/content/guides/language/ruby/containerize.md @@ -1,10 +1,13 @@ --- title: Containerize a Ruby on Rails application +linkTitle: Containerize your app +weight: 10 keywords: ruby, flask, containerize, initialize description: Learn how to containerize a Ruby on Rails application. aliases: - /language/ruby/build-images/ - /language/ruby/run-containers/ + - /language/ruby/containerize/ --- ## Prerequisites @@ -339,8 +342,8 @@ directory. To learn more about the files, see the following: - - [Dockerfile](../../reference/dockerfile.md) - - [.dockerignore](../../reference/dockerfile.md#dockerignore-file) + - [Dockerfile](/reference/dockerfile.md) + - [.dockerignore](/reference/dockerfile.md#dockerignore-file) - [compose.yaml](/reference/compose-file/_index.md) ## Run the application @@ -385,7 +388,7 @@ In this section, you learned how you can containerize and run your Ruby application using Docker. Related information: - - [Docker Compose overview](../../compose/_index.md) + - [Docker Compose overview](/manuals/compose/_index.md) ## Next steps diff --git a/content/language/ruby/deploy.md b/content/guides/language/ruby/deploy.md similarity index 96% rename from content/language/ruby/deploy.md rename to content/guides/language/ruby/deploy.md index b587a25b0d..94ae9e4d96 100644 --- a/content/language/ruby/deploy.md +++ b/content/guides/language/ruby/deploy.md @@ -1,7 +1,11 @@ --- title: Test your Ruby on Rails deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, kubernetes, ruby description: Learn how to develop locally using Kubernetes +aliases: +- /language/ruby/deploy/ --- ## Prerequisites @@ -158,5 +162,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/ruby/develop.md b/content/guides/language/ruby/develop.md similarity index 96% rename from content/language/ruby/develop.md rename to content/guides/language/ruby/develop.md index 4c0a9afab2..3c437c0a0b 100644 --- a/content/language/ruby/develop.md +++ b/content/guides/language/ruby/develop.md @@ -1,7 +1,11 @@ --- title: Use containers for Ruby on Rails development +linkTitle: Develop your app +weight: 20 keywords: ruby, local, development description: Learn how to develop your Ruby on Rails application locally. +aliases: +- /language/ruby/develop/ --- ## Prerequisites @@ -125,7 +129,7 @@ Press `ctrl+c` in the terminal to stop your application and run `docker compose Use Compose Watch to automatically update your running Compose services as you edit and save your code. For more details about Compose Watch, see [Use Compose -Watch](../../compose/file-watch.md). +Watch](/manuals/compose/file-watch.md). Open your `compose.yaml` file in an IDE or text editor and then add the Compose Watch instructions. The following is the updated `compose.yaml` file. @@ -189,8 +193,8 @@ database and persist data. You also learned how to use Compose Watch to automati Related information: - [Compose file reference](/reference/compose-file/) - - [Compose file watch](../../compose/file-watch.md) - - [Multi-stage builds](../../build/building/multi-stage.md) + - [Compose file watch](/manuals/compose/file-watch.md) + - [Multi-stage builds](/manuals/build/building/multi-stage.md) ## Next steps diff --git a/content/language/rust/_index.md b/content/guides/language/rust/_index.md similarity index 95% rename from content/language/rust/_index.md rename to content/guides/language/rust/_index.md index 19f9b81483..08c6ae38ad 100644 --- a/content/language/rust/_index.md +++ b/content/guides/language/rust/_index.md @@ -1,9 +1,12 @@ --- +title: Rust language-specific guide +linkTitle: Rust description: Containerize Rust apps using Docker keywords: Docker, getting started, Rust, language -title: Rust language-specific guide toc_min: 1 toc_max: 2 +aliases: +- /language/rust/ --- The Rust language-specific guide teaches you how to create a containerized Rust application using Docker. In this guide, you'll learn how to: diff --git a/content/language/rust/build-images.md b/content/guides/language/rust/build-images.md similarity index 91% rename from content/language/rust/build-images.md rename to content/guides/language/rust/build-images.md index b778ce47cd..8ac2d15853 100644 --- a/content/language/rust/build-images.md +++ b/content/guides/language/rust/build-images.md @@ -1,7 +1,11 @@ --- title: Build your Rust image +linkTitle: Build images +weight: 5 keywords: rust, build, images, dockerfile description: Learn how to build your first Rust Docker image +aliases: +- /language/rust/build-images/ --- ## Prerequisites @@ -58,11 +62,11 @@ directory: For building an image, only the Dockerfile is necessary. Open the Dockerfile in your favorite IDE or text editor and see what it contains. To learn more -about Dockerfiles, see the [Dockerfile reference](../../reference/dockerfile.md). +about Dockerfiles, see the [Dockerfile reference](/reference/dockerfile.md). ## .dockerignore file -When you run `docker init`, it also creates a [`.dockerignore`](../../reference/dockerfile.md#dockerignore-file) file. Use the `.dockerignore` file to specify patterns and paths that you don't want copied into the image in order to keep the image as small as possible. Open up the `.dockerignore` file in your favorite IDE or text editor and see what's inside already. +When you run `docker init`, it also creates a [`.dockerignore`](/reference/dockerfile.md#dockerignore-file) file. Use the `.dockerignore` file to specify patterns and paths that you don't want copied into the image in order to keep the image as small as possible. Open up the `.dockerignore` file in your favorite IDE or text editor and see what's inside already. ## Build an image @@ -110,7 +114,7 @@ You should see output like the following. ## View local images -To see a list of images you have on your local machine, you have two options. One is to use the Docker CLI and the other is to use [Docker Desktop](../../desktop/use-desktop/images.md). As you are working in the terminal already, take a look at listing images using the CLI. +To see a list of images you have on your local machine, you have two options. One is to use the Docker CLI and the other is to use [Docker Desktop](/manuals/desktop/use-desktop/images.md). As you are working in the terminal already, take a look at listing images using the CLI. To list images, run the `docker images` command. @@ -171,10 +175,10 @@ Docker removed the image tagged with `:v1.0.0`, but the `docker-rust-image:lates This section showed how you can use `docker init` to create a Dockerfile and .dockerignore file for a Rust application. It then showed you how to build an image. And finally, it showed you how to tag an image and list all images. Related information: - - [Dockerfile reference](../../reference/dockerfile.md) - - [.dockerignore file](../../reference/dockerfile.md#dockerignore-file) - - [docker init CLI reference](../../reference/cli/docker/init.md) - - [docker build CLI reference](../../reference/cli/docker/buildx/build.md) + - [Dockerfile reference](/reference/dockerfile.md) + - [.dockerignore file](/reference/dockerfile.md#dockerignore-file) + - [docker init CLI reference](/reference/cli/docker/init.md) + - [docker build CLI reference](/reference/cli/docker/buildx/build.md) ## Next steps diff --git a/content/language/rust/configure-ci-cd.md b/content/guides/language/rust/configure-ci-cd.md similarity index 91% rename from content/language/rust/configure-ci-cd.md rename to content/guides/language/rust/configure-ci-cd.md index 322ecdb1ac..4d66837f47 100644 --- a/content/language/rust/configure-ci-cd.md +++ b/content/guides/language/rust/configure-ci-cd.md @@ -1,7 +1,11 @@ --- title: Configure CI/CD for your Rust application +linkTitle: Configure CI/CD +weight: 40 keywords: rust, CI/CD, local, development description: Learn how to Configure CI/CD for your application +aliases: +- /language/rust/configure-ci-cd/ --- ## Prerequisites @@ -27,7 +31,7 @@ Create a GitHub repository, configure the Docker Hub credentials, and push your 3. Create a new **Repository variable** named `DOCKER_USERNAME` and your Docker ID as value. -4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. +4. Create a new [Personal Access Token (PAT)](/manuals/security/for-developers/access-tokens.md#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write. 5. Add the PAT as a **Repository secret** in your GitHub repository, with the name `DOCKERHUB_TOKEN`. @@ -118,7 +122,7 @@ Save the workflow file and run the job. In this section, you learned how to set up a GitHub Actions workflow for your Rust application. Related information: - - [Introduction to GitHub Actions](../../build/ci/github-actions/_index.md) + - [Introduction to GitHub Actions](/manuals/build/ci/github-actions/_index.md) - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) ## Next steps diff --git a/content/language/rust/deploy.md b/content/guides/language/rust/deploy.md similarity index 96% rename from content/language/rust/deploy.md rename to content/guides/language/rust/deploy.md index c9d2e1c28e..24186d915a 100644 --- a/content/language/rust/deploy.md +++ b/content/guides/language/rust/deploy.md @@ -1,7 +1,11 @@ --- title: Test your Rust deployment +linkTitle: Test your deployment +weight: 50 keywords: deploy, kubernetes, rust description: Learn how to test your Rust deployment locally using Kubernetes +aliases: +- /language/rust/deploy/ --- ## Prerequisites @@ -223,5 +227,5 @@ In this section, you learned how to use Docker Desktop to deploy your applicatio Related information: - [Kubernetes documentation](https://kubernetes.io/docs/home/) - - [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md) - - [Swarm mode overview](../../engine/swarm/_index.md) + - [Deploy on Kubernetes with Docker Desktop](/manuals/desktop/kubernetes.md) + - [Swarm mode overview](/manuals/engine/swarm/_index.md) diff --git a/content/language/rust/develop.md b/content/guides/language/rust/develop.md similarity index 96% rename from content/language/rust/develop.md rename to content/guides/language/rust/develop.md index 48b8ffe59a..e3e2e884c8 100644 --- a/content/language/rust/develop.md +++ b/content/guides/language/rust/develop.md @@ -1,13 +1,17 @@ --- title: Develop your Rust application +linkTitle: Develop your app +weight: 20 keywords: rust, local, development, run, description: Learn how to develop your Rust application locally. +aliases: +- /language/rust/develop/ --- ## Prerequisites * You have installed the latest version of [Docker Desktop](/get-started/get-docker.md). -* You have completed the walkthroughs in the Docker Desktop [Learning Center](../../desktop/get-started.md) to learn about Docker concepts. +* You have completed the walkthroughs in the Docker Desktop [Learning Center](/manuals/desktop/get-started.md) to learn about Docker concepts. * You have a [git client](https://git-scm.com/downloads). The examples in this section use a command-line based git client, but you can use any client. ## Overview @@ -35,7 +39,7 @@ $ docker network create postgresnet ``` Now you can run PostgreSQL in a container and attach to the volume and network that you created previously. Docker pulls the image from Hub and runs it for you locally. -In the following command, option `--mount` is for starting the container with a volume. For more information, see [Docker volumes](/engine/storage/volumes.md). +In the following command, option `--mount` is for starting the container with a volume. For more information, see [Docker volumes](/manuals/engine/storage/volumes.md). ```console $ docker run --rm -d --mount \ @@ -277,7 +281,7 @@ secrets: file: db/password.txt ``` -Note that the file doesn't specify a network for those 2 services. When you use Compose, it automatically creates a network and connects the services to it. For more information see [Networking in Compose](../../compose/networking.md). +Note that the file doesn't specify a network for those 2 services. When you use Compose, it automatically creates a network and connects the services to it. For more information see [Networking in Compose](/manuals/compose/networking.md). Before you run the application using Compose, notice that this Compose file specifies a `password.txt` file to hold the database's password. You must create this file as it's not included in the source repository. @@ -287,7 +291,7 @@ In the cloned repository's directory, create a new directory named `db` and insi mysecretpassword ``` -If you have any other containers running from the previous sections, [stop](./run-containers.md/#stop-start-and-name-containers) them now. +If you have any other containers running from the previous sections, [stop](./run-containers.md#stop-start-and-name-containers) them now. Now, run the following `docker compose up` command to start your application. @@ -314,8 +318,8 @@ You should receive the following response: In this section, you took a look at setting up your Compose file to run your Rust application and database with a single command. Related information: - - [Docker volumes](/engine/storage/volumes.md) - - [Compose overview](../../compose/index.md) + - [Docker volumes](/manuals/engine/storage/volumes.md) + - [Compose overview](/manuals/compose/index.md) ## Next steps diff --git a/content/language/rust/run-containers.md b/content/guides/language/rust/run-containers.md similarity index 98% rename from content/language/rust/run-containers.md rename to content/guides/language/rust/run-containers.md index d7379cf450..4ebc1db1a2 100644 --- a/content/language/rust/run-containers.md +++ b/content/guides/language/rust/run-containers.md @@ -1,7 +1,11 @@ --- title: Run your Rust image as a container +linkTitle: Run containers +weight: 10 keywords: rust, run, image, container, description: Learn how to run your Rust image as a container. +aliases: +- /language/rust/run-containers/ --- ## Prerequisite @@ -192,7 +196,7 @@ That’s better! You can now easily identify your container based on the name. In this section, you took a look at running containers. You also took a look at managing containers by starting, stopping, and restarting them. And finally, you looked at naming your containers so they are more easily identifiable. Related information: - - [docker run CLI reference](../../reference/cli/docker/container/run.md) + - [docker run CLI reference](/reference/cli/docker/container/run.md) ## Next steps diff --git a/content/guides/use-case/_index.md b/content/guides/use-case/_index.md index e8f55f27fa..c360b7468a 100644 --- a/content/guides/use-case/_index.md +++ b/content/guides/use-case/_index.md @@ -1,5 +1,6 @@ --- title: Use-case guides +weight: 20 keywords: guide, use-case description: Learn how to accomplish tasks with Docker. notoc: true diff --git a/content/guides/use-case/genai-pdf-bot/_index.md b/content/guides/use-case/genai-pdf-bot/_index.md index bb4a09326a..f6e4ff22b9 100644 --- a/content/guides/use-case/genai-pdf-bot/_index.md +++ b/content/guides/use-case/genai-pdf-bot/_index.md @@ -1,7 +1,7 @@ --- +title: PDF analysis and chat description: Containerize generative AI (GenAI) apps using Docker keywords: python, generative ai, genai, llm, neo4j, ollama, langchain -title: Generative AI guide toc_min: 1 toc_max: 2 --- diff --git a/content/guides/use-case/genai-pdf-bot/containerize.md b/content/guides/use-case/genai-pdf-bot/containerize.md index 1d6797efab..4aefec2384 100644 --- a/content/guides/use-case/genai-pdf-bot/containerize.md +++ b/content/guides/use-case/genai-pdf-bot/containerize.md @@ -1,5 +1,7 @@ --- title: Containerize a generative AI application +linkTitle: Containerize your app +weight: 10 keywords: python, generative ai, genai, llm, neo4j, ollama, containerize, intitialize, langchain, openai description: Learn how to containerize a generative AI (GenAI) application. --- @@ -8,9 +10,9 @@ description: Learn how to containerize a generative AI (GenAI) application. > [!NOTE] > -> GenAI applications can often benefit from GPU acceleration. Currently Docker Desktop supports GPU acceleration only on [Windows with the WSL2 backend](../../../desktop/gpu.md#using-nvidia-gpus-with-wsl2). Linux users can also access GPU acceleration using a native installation of the [Docker Engine](../../../engine/install/_index.md). +> GenAI applications can often benefit from GPU acceleration. Currently Docker Desktop supports GPU acceleration only on [Windows with the WSL2 backend](/manuals/desktop/gpu.md#using-nvidia-gpus-with-wsl2). Linux users can also access GPU acceleration using a native installation of the [Docker Engine](/manuals/engine/install/_index.md). -* You have installed the latest version of [Docker Desktop](/get-started/get-docker.md) or, if you are a Linux user and are planning to use GPU acceleration, [Docker Engine](../../../engine/install/_index.md). Docker adds new features regularly and some parts of this guide may work only with the latest version of Docker Desktop. +* You have installed the latest version of [Docker Desktop](/get-started/get-docker.md) or, if you are a Linux user and are planning to use GPU acceleration, [Docker Engine](/manuals/engine/install/_index.md). Docker adds new features regularly and some parts of this guide may work only with the latest version of Docker Desktop. * You have a [git client](https://git-scm.com/downloads). The examples in this section use a command-line based git client, but you can use any client. ## Overview diff --git a/content/guides/use-case/genai-pdf-bot/develop.md b/content/guides/use-case/genai-pdf-bot/develop.md index 11c49da2e6..78ad0bb80b 100644 --- a/content/guides/use-case/genai-pdf-bot/develop.md +++ b/content/guides/use-case/genai-pdf-bot/develop.md @@ -1,5 +1,7 @@ --- title: Use containers for generative AI development +linkTitle: Develop your app +weight: 20 keywords: python, local, development, generative ai, genai, llm, neo4j, ollama, langchain, openai description: Learn how to develop your generative AI (GenAI) application locally. --- @@ -99,7 +101,7 @@ When running Ollama in a container, you should have a CUDA-supported GPU. While To run Ollama in a container and provide GPU access: 1. Install the prerequisites. - For Docker Engine on Linux, install the [NVIDIA Container Toolkilt](https://github.com/NVIDIA/nvidia-container-toolkit). - - For Docker Desktop on Windows 10/11, install the latest [NVIDIA driver](https://www.nvidia.com/Download/index.aspx) and make sure you are using the [WSL2 backend](../../../desktop/wsl/index.md/#turn-on-docker-desktop-wsl-2) + - For Docker Desktop on Windows 10/11, install the latest [NVIDIA driver](https://www.nvidia.com/Download/index.aspx) and make sure you are using the [WSL2 backend](/manuals/desktop/wsl/index.md#turn-on-docker-desktop-wsl-2) 2. Add the Ollama service and a volume in your `compose.yaml`. The following is the updated `compose.yaml`: @@ -146,7 +148,7 @@ To run Ollama in a container and provide GPU access: > [!NOTE] > - > For more details about the Compose instructions, see [Turn on GPU access with Docker Compose](../../../compose/gpu-support.md). + > For more details about the Compose instructions, see [Turn on GPU access with Docker Compose](/manuals/compose/gpu-support.md). 3. Add the ollama-pull service to your `compose.yaml` file. This service uses the `docker/genai:ollama-pull` image, based on the GenAI Stack's diff --git a/content/guides/use-case/genai-video-bot/_index.md b/content/guides/use-case/genai-video-bot/index.md similarity index 98% rename from content/guides/use-case/genai-video-bot/_index.md rename to content/guides/use-case/genai-video-bot/index.md index 1d23cd4bac..742cc91012 100644 --- a/content/guides/use-case/genai-video-bot/_index.md +++ b/content/guides/use-case/genai-video-bot/index.md @@ -1,7 +1,8 @@ --- +title: GenAI video transcription and chat +linkTitle: Video transcription and chat description: Explore a generative AI video analysis app that uses Docker, OpenAI, and Pinecone. keywords: python, generative ai, genai, llm, whisper, pinecone, openai, whisper -title: GenAI video transcription and chat --- ## Overview @@ -183,7 +184,7 @@ underlying system differences. To learn more about Docker, see the [Getting star Docker Compose is a tool for defining and running multi-container applications. Compose makes it easy to run this application with a single command, `docker -compose up`. For more details, see the [Compose overview](../../../compose/_index.md). +compose up`. For more details, see the [Compose overview](/manuals/compose/_index.md). ### OpenAI API diff --git a/content/guides/use-case/jupyter.md b/content/guides/use-case/jupyter.md index 4be1c9b8ca..81e22759c0 100644 --- a/content/guides/use-case/jupyter.md +++ b/content/guides/use-case/jupyter.md @@ -371,7 +371,7 @@ $ docker run --rm -p 8889:8888 YOUR-USER-NAME/my-jupyer-image start-notebook.py ### Share your volume -This example uses the Docker Desktop [Volumes Backup & Share](https://hub.docker.com/extensions/docker/volumes-backup-extension) extension. Alternatively, in the CLI you can [back up the volume](/engine/storage/volumes/#back-up-a-volume) and then [push it using the ORAS CLI](/docker-hub/oci-artifacts/#push-a-volume). +This example uses the Docker Desktop [Volumes Backup & Share](https://hub.docker.com/extensions/docker/volumes-backup-extension) extension. Alternatively, in the CLI you can [back up the volume](/engine/storage/volumes/#back-up-a-volume) and then [push it using the ORAS CLI](/manuals/docker-hub/oci-artifacts.md#push-a-volume). 1. Install the Volumes Backup & Share extension. 1. Open the Docker Dashboard and select **Extensions**. diff --git a/content/guides/use-case/nlp/_index.md b/content/guides/use-case/nlp/_index.md index 27a746a4d5..0759c97dcf 100644 --- a/content/guides/use-case/nlp/_index.md +++ b/content/guides/use-case/nlp/_index.md @@ -1,7 +1,8 @@ --- +title: Natural language processing guides +linkTitle: Natural language processing description: Learn how to build natural language processing (NLP) applications. keywords: nlp, natural language processing -title: Natural language processing guides --- The natural language processing (NLP) guides teach you how to build and run NLP diff --git a/content/guides/use-case/nlp/language-translation.md b/content/guides/use-case/nlp/language-translation.md index 6f496c3b93..56a58a111e 100644 --- a/content/guides/use-case/nlp/language-translation.md +++ b/content/guides/use-case/nlp/language-translation.md @@ -1,5 +1,6 @@ --- title: Build a language translation app +linkTitle: Language translation keywords: nlp, natural language processing, text summarization, python, language translation, googletrans description: Learn how to build and run a language translation application using Python, Googletrans, and Docker. --- diff --git a/content/guides/use-case/nlp/named-entity-recognition.md b/content/guides/use-case/nlp/named-entity-recognition.md index 439007beb1..af9d94c204 100644 --- a/content/guides/use-case/nlp/named-entity-recognition.md +++ b/content/guides/use-case/nlp/named-entity-recognition.md @@ -1,5 +1,6 @@ --- title: Build a named entity recognition app +linkTitle: Named entity recognition keywords: nlp, natural language processing, named entity recognition, python, spacy, ner description: Learn how to build and run a named entity recognition application using Python, spaCy, and Docker. --- diff --git a/content/guides/use-case/nlp/sentiment-analysis.md b/content/guides/use-case/nlp/sentiment-analysis.md index dfb9f4623c..61b8edc8eb 100644 --- a/content/guides/use-case/nlp/sentiment-analysis.md +++ b/content/guides/use-case/nlp/sentiment-analysis.md @@ -1,5 +1,6 @@ --- title: Build a sentiment analysis app +linkTitle: Sentiment analysis keywords: nlp, natural language processing, sentiment analysis, python, nltk description: Learn how to build and run a sentiment analysis application using Python, NLTK, and Docker. --- diff --git a/content/guides/use-case/nlp/text-classification.md b/content/guides/use-case/nlp/text-classification.md index 97e4eb87e5..ce67029754 100644 --- a/content/guides/use-case/nlp/text-classification.md +++ b/content/guides/use-case/nlp/text-classification.md @@ -1,5 +1,6 @@ --- title: Build a text recognition app +linkTitle: Text classification keywords: nlp, natural language processing, sentiment analysis, python, nltk, scikit-learn, text classification description: Learn how to build and run a text recognition application using Python, NLTK, scikit-learn, and Docker. --- diff --git a/content/guides/use-case/nlp/text-summarization.md b/content/guides/use-case/nlp/text-summarization.md index fea2452fc7..164a750b97 100644 --- a/content/guides/use-case/nlp/text-summarization.md +++ b/content/guides/use-case/nlp/text-summarization.md @@ -1,5 +1,6 @@ --- title: Build a text summarization app +linkTitle: Text summarization keywords: nlp, natural language processing, text summarization, python, bert extractive summarizer description: Learn how to build and run a text summarization application using Python, Bert Extractive Summarizer, and Docker. --- diff --git a/content/guides/use-case/tensorflowjs.md b/content/guides/use-case/tensorflowjs.md index 8c8789f0c7..547262f14c 100644 --- a/content/guides/use-case/tensorflowjs.md +++ b/content/guides/use-case/tensorflowjs.md @@ -431,7 +431,7 @@ Docker Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application's services, networks, and volumes. In this case, the application isn't a multi-container application, but Docker Compose has other useful features for -development, like [Compose Watch](../../compose/file-watch.md). +development, like [Compose Watch](/manuals/compose/file-watch.md). The sample application doesn't have a Compose file yet. To create a Compose file, in the `TensorJS-Face-Detection` directory, create a text file named diff --git a/content/includes/compose-bridge-experimental.md b/content/includes/compose-bridge-experimental.md index e88f5e10ca..472486f27a 100644 --- a/content/includes/compose-bridge-experimental.md +++ b/content/includes/compose-bridge-experimental.md @@ -2,5 +2,5 @@ --- {{% experimental %}} -Compose Bridge is an [Experimental](/release-lifecycle.md#experimental) product. +Compose Bridge is an [Experimental](/manuals/release-lifecycle.md#experimental) product. {{% /experimental %}} diff --git a/content/language/_index.md b/content/language/_index.md deleted file mode 100644 index bc36ac4da6..0000000000 --- a/content/language/_index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: Language-specific guides overview -keywords: guides, docker, language, node, java, python, R, go, golang, .net, c++ -title: Language-specific guides overview -toc_min: 1 -toc_max: 2 -aliases: -- /guides/walkthroughs/containerize-your-app/ ---- - -The language-specific guides walk you through the process of: -* Containerizing language-specific applications -* Setting up a development environment -* Configuring a CI/CD pipeline -* Deploying an application locally using Kubernetes - -In addition to the language-specific modules, Docker documentation also provides guidelines to build images and efficiently manage your development environment. For more information, refer to the following topics: - -* [Building best practices](../build/building/best-practices.md) -* [Build images with BuildKit](../build/buildkit/index.md#getting-started) - -## Language-specific guides - -Learn how to containerize your applications and start developing using Docker. Choose one of the following languages to get started. - -
-
- Develop with Node -
-
- Develop with Python -
-
- Develop with R -
-
- Develop with Java -
-
- Develop with Go -
-
- Develop with C# -
-
- Develop with C++ -
-
- Develop with Rust -
-
- Develop with PHP -
-
- Develop with Ruby -
-
diff --git a/content/manuals.md b/content/manuals/_index.md similarity index 93% rename from content/manuals.md rename to content/manuals/_index.md index 39009c1230..9e67bc318c 100644 --- a/content/manuals.md +++ b/content/manuals/_index.md @@ -2,6 +2,11 @@ title: Manuals description: Learn how to install, set up, configure, and use Docker products with this collection of user guides keywords: docker, docs, manuals, products, user guides, how-to +# hard-code the URL of this page +url: /manuals/ +# remove the /manuals/ prefix for pages in this section +cascade: +- url: /:sections[1:]/:slugorfilename notoc: true development: - title: Docker Desktop diff --git a/content/accounts/_index.md b/content/manuals/accounts/_index.md similarity index 97% rename from content/accounts/_index.md rename to content/manuals/accounts/_index.md index b5857a05e4..ae9594d7ba 100644 --- a/content/accounts/_index.md +++ b/content/manuals/accounts/_index.md @@ -1,7 +1,9 @@ --- +title: Docker account overview +linkTitle: Docker accounts +weight: 200 description: Learn how to create and manage your Docker account. keywords: accounts, docker ID, account management, account settings, docker account, docker home -title: Docker account overview grid: - title: Create a Docker ID description: Get started with Docker and create an account. diff --git a/content/accounts/create-account.md b/content/manuals/accounts/create-account.md similarity index 97% rename from content/accounts/create-account.md rename to content/manuals/accounts/create-account.md index 9a6af48ab5..1780b4ec13 100644 --- a/content/accounts/create-account.md +++ b/content/manuals/accounts/create-account.md @@ -1,8 +1,9 @@ --- +title: Create an account +weight: 10 description: Learn how to register for a Docker ID and sign in to your account keywords: accounts, docker ID, billing, paid plans, support, Hub, Store, Forums, knowledge base, beta access, email, activation, verification -title: Create an account aliases: - /docker-hub/accounts/ - /docker-id/ @@ -64,7 +65,7 @@ Your Docker ID becomes your username for hosted Docker services, and [Docker for Once you register and verify your Docker ID email address, you can sign in to [your Docker account](https://login.docker.com/u/login/). You can sign in with your email address (or username) and password. Or, you can sign in with your social provider. See [Sign in with your social provider](#sign-in-with-your-social-provider). -You can also sign in through the CLI using the `docker login` command. For more information, see [`docker login`](../reference/cli/docker/login.md). +You can also sign in through the CLI using the `docker login` command. For more information, see [`docker login`](/reference/cli/docker/login.md). > [!WARNING] > diff --git a/content/accounts/deactivate-user-account.md b/content/manuals/accounts/deactivate-user-account.md similarity index 98% rename from content/accounts/deactivate-user-account.md rename to content/manuals/accounts/deactivate-user-account.md index 0bbfc97f69..245096200c 100644 --- a/content/accounts/deactivate-user-account.md +++ b/content/manuals/accounts/deactivate-user-account.md @@ -1,5 +1,6 @@ --- -title: Deactivating a user account +title: Deactivate an account +weight: 30 description: Learn how to deactivate a Docker user account. keywords: Docker Hub, delete, deactivate, account, account management --- diff --git a/content/accounts/manage-account.md b/content/manuals/accounts/manage-account.md similarity index 98% rename from content/accounts/manage-account.md rename to content/manuals/accounts/manage-account.md index e74244fcce..554541f3bc 100644 --- a/content/accounts/manage-account.md +++ b/content/manuals/accounts/manage-account.md @@ -1,7 +1,8 @@ --- +title: Manage an account +weight: 20 description: Learn how to manage settings for your Docker account. keywords: accounts, docker ID, account settings, account management, docker home -title: Manage your Docker account --- You can centrally manage the settings for your Docker account. Here you can also take administrative actions for your account and manage your account security. diff --git a/content/admin/_index.md b/content/manuals/admin/_index.md similarity index 98% rename from content/admin/_index.md rename to content/manuals/admin/_index.md index 64564e6e76..0779e2a8e0 100644 --- a/content/admin/_index.md +++ b/content/manuals/admin/_index.md @@ -1,7 +1,9 @@ --- +title: Administration overview +linkTitle: Administration +weight: 200 description: Discover manuals on administration for accounts, organizations, and companies. keywords: admin, administration, company, organization, Admin Console, user accounts, account management -title: Administration overview grid: - title: Company administration description: Explore how to manage a company. diff --git a/content/admin/company/_index.md b/content/manuals/admin/company/_index.md similarity index 97% rename from content/admin/company/_index.md rename to content/manuals/admin/company/_index.md index 69e17ada95..42b2bb20a1 100644 --- a/content/admin/company/_index.md +++ b/content/manuals/admin/company/_index.md @@ -1,7 +1,8 @@ --- +title: Company administration +weight: 20 description: Learn how to manage multiple organizations using companies, including managing users, owners, and security. keywords: company, multiple organizations, manage companies -title: Company overview grid: - title: Create a company description: Get started by learning how to create a company. diff --git a/content/admin/company/new-company.md b/content/manuals/admin/company/new-company.md similarity index 100% rename from content/admin/company/new-company.md rename to content/manuals/admin/company/new-company.md diff --git a/content/admin/company/organizations.md b/content/manuals/admin/company/organizations.md similarity index 100% rename from content/admin/company/organizations.md rename to content/manuals/admin/company/organizations.md diff --git a/content/admin/company/owners.md b/content/manuals/admin/company/owners.md similarity index 100% rename from content/admin/company/owners.md rename to content/manuals/admin/company/owners.md diff --git a/content/admin/company/users.md b/content/manuals/admin/company/users.md similarity index 100% rename from content/admin/company/users.md rename to content/manuals/admin/company/users.md diff --git a/content/admin/convert-account.md b/content/manuals/admin/convert-account.md similarity index 100% rename from content/admin/convert-account.md rename to content/manuals/admin/convert-account.md diff --git a/content/admin/deactivate-account.md b/content/manuals/admin/deactivate-account.md similarity index 100% rename from content/admin/deactivate-account.md rename to content/manuals/admin/deactivate-account.md diff --git a/content/manuals/admin/faqs/_index.md b/content/manuals/admin/faqs/_index.md new file mode 100644 index 0000000000..5bae20c90b --- /dev/null +++ b/content/manuals/admin/faqs/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Account and admin FAQ +weight: 30 +--- diff --git a/content/admin/faqs/company-faqs.md b/content/manuals/admin/faqs/company-faqs.md similarity index 94% rename from content/admin/faqs/company-faqs.md rename to content/manuals/admin/faqs/company-faqs.md index 5d569285d5..d7e5e6cd57 100644 --- a/content/admin/faqs/company-faqs.md +++ b/content/manuals/admin/faqs/company-faqs.md @@ -1,7 +1,9 @@ --- +title: FAQs on companies +linkTitle: Company +weight: 30 description: Company FAQs keywords: Docker, Docker Hub, SSO FAQs, single sign-on, company, administration, company management -title: FAQs on companies tags: [FAQ] aliases: - /docker-hub/company-faqs/ @@ -51,7 +53,7 @@ A company name must be unique to that of its child organization. If a child orga ### How does a company owner add an organization to the company? -You can add organizations to a company in the [Admin Console](../../admin/company/organizations.md/#add-organizations-to-a-company.md) or [Docker Hub](../../admin/company/new-company.md/#add-organizations-to-a-company.md). +You can add organizations to a company in the [Admin Console](../../admin/company/organizations.md#add-organizations-to-a-company.md) or [Docker Hub](../../admin/company/new-company.md#add-organizations-to-a-company.md). ### How does a company owner manage SSO/SCIM settings from a company? diff --git a/content/admin/faqs/general-faqs.md b/content/manuals/admin/faqs/general-faqs.md similarity index 99% rename from content/admin/faqs/general-faqs.md rename to content/manuals/admin/faqs/general-faqs.md index 0e3d93b56b..4efe6dcce2 100644 --- a/content/admin/faqs/general-faqs.md +++ b/content/manuals/admin/faqs/general-faqs.md @@ -1,5 +1,7 @@ --- title: General FAQs for Docker accounts +linkTitle: General +weight: 10 description: Frequently asked Docker account and administration questions keywords: onboarding, docker, teams, orgs, user accounts, organization accounts tags: [FAQ] diff --git a/content/admin/faqs/organization-faqs.md b/content/manuals/admin/faqs/organization-faqs.md similarity index 96% rename from content/admin/faqs/organization-faqs.md rename to content/manuals/admin/faqs/organization-faqs.md index 4a67f01799..027615cbbf 100644 --- a/content/admin/faqs/organization-faqs.md +++ b/content/manuals/admin/faqs/organization-faqs.md @@ -1,5 +1,7 @@ --- description: Organization FAQs +linkTitle: Organization +weight: 20 keywords: Docker, Docker Hub, SSO FAQs, single sign-on, organizations, administration, Admin Console, members, organization management, manage orgs title: FAQs on organizations tags: [FAQ] @@ -28,7 +30,7 @@ No. Organization owners can invite users with their email address, and also assi Yes. You can [enforce sign-in](../../security/for-admins/enforce-sign-in/_index.md) and some benefits are: -- Administrators can enforce features like [Image Access Management](/security/for-admins/hardened-desktop/image-access-management.md) and [Registry Access Management](../../security/for-admins/hardened-desktop/registry-access-management.md). +- Administrators can enforce features like [Image Access Management](/manuals/security/for-admins/hardened-desktop/image-access-management.md) and [Registry Access Management](../../security/for-admins/hardened-desktop/registry-access-management.md). - Administrators can ensure compliance by blocking Docker Desktop usage for users who don't sign in as members of the organization. ### If a user has their personal email associated with a user account in Docker Hub, do they have to convert to using the organization's domain before they can be invited to join an organization? diff --git a/content/admin/images/docker-admin-structure.webp b/content/manuals/admin/images/docker-admin-structure.webp similarity index 100% rename from content/admin/images/docker-admin-structure.webp rename to content/manuals/admin/images/docker-admin-structure.webp diff --git a/content/admin/images/org-structure.webp b/content/manuals/admin/images/org-structure.webp similarity index 100% rename from content/admin/images/org-structure.webp rename to content/manuals/admin/images/org-structure.webp diff --git a/content/admin/images/remove-owner.png b/content/manuals/admin/images/remove-owner.png similarity index 100% rename from content/admin/images/remove-owner.png rename to content/manuals/admin/images/remove-owner.png diff --git a/content/admin/images/team-repo-permission.png b/content/manuals/admin/images/team-repo-permission.png similarity index 100% rename from content/admin/images/team-repo-permission.png rename to content/manuals/admin/images/team-repo-permission.png diff --git a/content/admin/organization/_index.md b/content/manuals/admin/organization/_index.md similarity index 97% rename from content/admin/organization/_index.md rename to content/manuals/admin/organization/_index.md index 6cd964324d..605c5eb269 100644 --- a/content/admin/organization/_index.md +++ b/content/manuals/admin/organization/_index.md @@ -1,7 +1,9 @@ --- +title: Organization administration overview +linkTitle: Organization administration +weight: 10 description: Learn about managing organizations in Docker including how they relate to teams, how to onboard, and more keywords: organizations, admin, overview -title: Organization administration overview grid: - title: Onboard your organization description: Learn how to onboard and secure your organization. diff --git a/content/admin/organization/activity-logs.md b/content/manuals/admin/organization/activity-logs.md similarity index 99% rename from content/admin/organization/activity-logs.md rename to content/manuals/admin/organization/activity-logs.md index ef6d720263..11e596bb47 100644 --- a/content/admin/organization/activity-logs.md +++ b/content/manuals/admin/organization/activity-logs.md @@ -1,7 +1,8 @@ --- +title: Activity logs +weight: 50 description: Learn about activity logs. keywords: team, organization, activity, log, audit, activities -title: Activity logs aliases: - /docker-hub/audit-log/ --- @@ -19,7 +20,7 @@ Owners can also see the activity logs for their repository if the repository is > [!NOTE] > -> Activity logs requires a [Docker Team or Business subscription](../../../subscription/_index.md). +> Activity logs requires a [Docker Team or Business subscription](/manuals/subscription/_index.md). ## Manage activity logs diff --git a/content/admin/organization/general-settings.md b/content/manuals/admin/organization/general-settings.md similarity index 96% rename from content/admin/organization/general-settings.md rename to content/manuals/admin/organization/general-settings.md index 39f0adab19..9b26bc8b0e 100644 --- a/content/admin/organization/general-settings.md +++ b/content/manuals/admin/organization/general-settings.md @@ -1,7 +1,8 @@ --- +title: Organization settings +weight: 60 description: Learn how to manage settings for organizations using Docker Admin Console. keywords: organization, settings, Admin Console -title: General organization settings --- {{< include "admin-early-access.md" >}} diff --git a/content/admin/organization/insights.md b/content/manuals/admin/organization/insights.md similarity index 99% rename from content/admin/organization/insights.md rename to content/manuals/admin/organization/insights.md index f98dee9f60..a991ecb0a7 100644 --- a/content/admin/organization/insights.md +++ b/content/manuals/admin/organization/insights.md @@ -185,4 +185,4 @@ solutions to resolve common problems. Users who don’t sign in to an account associated with your organization are not represented in the data. To ensure users sign in with an account associated with your organization, you can [enforce - sign-in](/security/for-admins/enforce-sign-in/). \ No newline at end of file + sign-in](/security/for-admins/enforce-sign-in/). diff --git a/content/admin/organization/manage-a-team.md b/content/manuals/admin/organization/manage-a-team.md similarity index 99% rename from content/admin/organization/manage-a-team.md rename to content/manuals/admin/organization/manage-a-team.md index 88a551ecc9..55fad01c3a 100644 --- a/content/admin/organization/manage-a-team.md +++ b/content/manuals/admin/organization/manage-a-team.md @@ -1,8 +1,9 @@ --- +title: Create and manage a team +weight: 40 description: Learn how to create and manage teams for your organization keywords: Docker, docker, registry, teams, organizations, plans, Dockerfile, Docker Hub, docs, documentation, repository permissions -title: Create and manage a team aliases: - /docker-hub/manage-a-team/ --- diff --git a/content/admin/organization/members.md b/content/manuals/admin/organization/members.md similarity index 99% rename from content/admin/organization/members.md rename to content/manuals/admin/organization/members.md index 17edee17d3..275e306974 100644 --- a/content/admin/organization/members.md +++ b/content/manuals/admin/organization/members.md @@ -1,7 +1,8 @@ --- +title: Manage organization members +weight: 30 description: Learn how to manage organization members in Docker Hub and Docker Admin Console. keywords: members, teams, organizations, invite members, manage team members -title: Manage organization members aliases: - /docker-hub/members/ --- diff --git a/content/admin/organization/onboard.md b/content/manuals/admin/organization/onboard.md similarity index 99% rename from content/admin/organization/onboard.md rename to content/manuals/admin/organization/onboard.md index d6b4cec3bd..b445002ba0 100644 --- a/content/admin/organization/onboard.md +++ b/content/manuals/admin/organization/onboard.md @@ -1,7 +1,8 @@ --- +title: Onboard your organization +weight: 20 description: Get started onboarding your Docker Team or Business organization. keywords: business, team, organizations, get started, onboarding -title: Onboard your organization toc_min: 1 toc_max: 2 aliases: diff --git a/content/admin/organization/orgs.md b/content/manuals/admin/organization/orgs.md similarity index 94% rename from content/admin/organization/orgs.md rename to content/manuals/admin/organization/orgs.md index 110e1fe536..6e8ad5357a 100644 --- a/content/admin/organization/orgs.md +++ b/content/manuals/admin/organization/orgs.md @@ -1,8 +1,9 @@ --- +title: Create your organization +weight: 10 description: Learn how to create an organization. keywords: Docker, docker, registry, teams, organizations, plans, Dockerfile, Docker Hub, docs, documentation -title: Create your organization aliases: - /docker-hub/orgs/ --- @@ -99,7 +100,7 @@ configure your organization. - **Settings**: Displays information about your organization, and allows you to view and change your repository privacy settings, configure org permissions such as - [Image Access Management](/security/for-admins/hardened-desktop/image-access-management.md), configure notification settings, and [deactivate](../deactivate-account.md#deactivate-an-organization) You can also update your organization name and company name that appear on your organization landing page. You must be an owner to access the + [Image Access Management](/manuals/security/for-admins/hardened-desktop/image-access-management.md), configure notification settings, and [deactivate](../deactivate-account.md#deactivate-an-organization) You can also update your organization name and company name that appear on your organization landing page. You must be an owner to access the organization's **Settings** page. - **Billing**: Displays information about your existing diff --git a/content/billing/3d-secure.md b/content/manuals/billing/3d-secure.md similarity index 100% rename from content/billing/3d-secure.md rename to content/manuals/billing/3d-secure.md diff --git a/content/billing/_index.md b/content/manuals/billing/_index.md similarity index 98% rename from content/billing/_index.md rename to content/manuals/billing/_index.md index 902bfb88a5..5a046e414a 100644 --- a/content/billing/_index.md +++ b/content/manuals/billing/_index.md @@ -1,5 +1,7 @@ --- title: Billing and payments +linkTitle: Billing +weight: 200 description: Discover information on billing and payment processes for Docker subscriptions. keywords: billing, invoice, payment, subscription grid_core: diff --git a/content/billing/build-billing.md b/content/manuals/billing/build-billing.md similarity index 100% rename from content/billing/build-billing.md rename to content/manuals/billing/build-billing.md diff --git a/content/manuals/billing/core-billing/_index.md b/content/manuals/billing/core-billing/_index.md new file mode 100644 index 0000000000..67af83b5de --- /dev/null +++ b/content/manuals/billing/core-billing/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Docker Core billing +weight: 10 +--- diff --git a/content/billing/core-billing/cycle.md b/content/manuals/billing/core-billing/cycle.md similarity index 99% rename from content/billing/core-billing/cycle.md rename to content/manuals/billing/core-billing/cycle.md index 7096a6d421..c81d7bb3c4 100644 --- a/content/billing/core-billing/cycle.md +++ b/content/manuals/billing/core-billing/cycle.md @@ -1,5 +1,6 @@ --- title: Change your billing cycle +weight: 50 description: Learn to change your billing cycle for your Docker subscription keywords: billing, cycle, payments, subscription aliases: diff --git a/content/billing/core-billing/details.md b/content/manuals/billing/core-billing/details.md similarity index 99% rename from content/billing/core-billing/details.md rename to content/manuals/billing/core-billing/details.md index b717a9fd20..f96e0883e4 100644 --- a/content/billing/core-billing/details.md +++ b/content/manuals/billing/core-billing/details.md @@ -1,5 +1,6 @@ --- title: Update the billing information +weight: 30 description: Learn how to update your billing information in Docker Hub keywords: payments, billing, subscription, invoices aliases: diff --git a/content/billing/core-billing/get-started-core.md b/content/manuals/billing/core-billing/get-started-core.md similarity index 86% rename from content/billing/core-billing/get-started-core.md rename to content/manuals/billing/core-billing/get-started-core.md index 293c275921..af759cbe7b 100644 --- a/content/billing/core-billing/get-started-core.md +++ b/content/manuals/billing/core-billing/get-started-core.md @@ -1,5 +1,6 @@ --- title: Get started with Docker Core +weight: 10 description: Learn how to start your Docker Core subscription. keywords: payments, billing, subscription, invoices, docker core, subscribe --- @@ -16,7 +17,7 @@ In this section, learn how to get started with a Docker Core subscription for in 2. Select your avatar in the top-right corner then select **Billing**. 3. In **Billing Details**, select your personal account. 4. Select **Buy now**. -5. To continue to use [**Docker Core Personal**](/subscription/core-subscription/details/#docker-personal), select **Continue with Personal**. To buy [**Docker Core Pro**](/subscription/core-subscription/details/#docker-pro), select **Buy Now** on the **Pro** card. +5. To continue to use [**Docker Core Personal**](/manuals/subscription/core-subscription/details.md#docker-personal), select **Continue with Personal**. To buy [**Docker Core Pro**](/manuals/subscription/core-subscription/details.md#docker-pro), select **Buy Now** on the **Pro** card. 6. Enter your billing information, then select **Submit**. 7. Follow the on-screen instructions to confirm monthly or annual billing cycle and enter your payment information. 8. Select **Subscribe**. diff --git a/content/billing/core-billing/history.md b/content/manuals/billing/core-billing/history.md similarity index 99% rename from content/billing/core-billing/history.md rename to content/manuals/billing/core-billing/history.md index 8ffd74bc18..1f0e2624f9 100644 --- a/content/billing/core-billing/history.md +++ b/content/manuals/billing/core-billing/history.md @@ -1,5 +1,6 @@ --- title: View billing history +weight: 40 description: Discover how to view your billing history in Docker Hub keywords: payments, billing, subscription, invoices, renewals, invoice management, billing administration aliases: diff --git a/content/billing/core-billing/payment-method.md b/content/manuals/billing/core-billing/payment-method.md similarity index 99% rename from content/billing/core-billing/payment-method.md rename to content/manuals/billing/core-billing/payment-method.md index e665dbef8b..813c339a3e 100644 --- a/content/billing/core-billing/payment-method.md +++ b/content/manuals/billing/core-billing/payment-method.md @@ -1,5 +1,6 @@ --- title: Add or update a payment method +weight: 20 description: Learn how to add or update a payment method in Docker Hub keywords: payments, billing, subscription, supported payment methods, failed payments, coupons billing: diff --git a/content/billing/faqs.md b/content/manuals/billing/faqs.md similarity index 100% rename from content/billing/faqs.md rename to content/manuals/billing/faqs.md diff --git a/content/billing/scout-billing.md b/content/manuals/billing/scout-billing.md similarity index 100% rename from content/billing/scout-billing.md rename to content/manuals/billing/scout-billing.md diff --git a/content/billing/tax-certificate.md b/content/manuals/billing/tax-certificate.md similarity index 100% rename from content/billing/tax-certificate.md rename to content/manuals/billing/tax-certificate.md diff --git a/content/build-cloud/_index.md b/content/manuals/build-cloud/_index.md similarity index 93% rename from content/build-cloud/_index.md rename to content/manuals/build-cloud/_index.md index d78537141d..adca1293e9 100644 --- a/content/build-cloud/_index.md +++ b/content/manuals/build-cloud/_index.md @@ -1,5 +1,6 @@ --- title: Docker Build Cloud +weight: 100 description: Find documentation on Docker Build Cloud to help you build your container images faster, both locally and in CI keywords: build, cloud, cloud build, remote builder aliases: @@ -64,6 +65,6 @@ Once you've signed up and created a builder, continue by [setting up the builder in your local environment](./setup.md). For more information about the available subscription plans, see -[Docker Build Cloud subscriptions and features](/subscription/build-cloud/build-details.md). +[Docker Build Cloud subscriptions and features](/manuals/subscription/build-cloud/build-details.md). For information about roles and permissions related to Docker Build Cloud, see -[Roles and Permissions](/security/for-admins/roles-and-permissions.md#docker-build-cloud). +[Roles and Permissions](/manuals/security/for-admins/roles-and-permissions.md#docker-build-cloud). diff --git a/content/build-cloud/ci.md b/content/manuals/build-cloud/ci.md similarity index 99% rename from content/build-cloud/ci.md rename to content/manuals/build-cloud/ci.md index cfda154337..f38ebdc40c 100644 --- a/content/build-cloud/ci.md +++ b/content/manuals/build-cloud/ci.md @@ -1,5 +1,7 @@ --- title: Use Docker Build Cloud in CI +linkTitle: Continuous integration +weight: 30 description: Speed up your continuous integration pipelines with Docker Build Cloud in CI keywords: build, cloud build, ci, gha, gitlab, buildkite, jenkins, circle ci aliases: @@ -37,7 +39,7 @@ See [Loading build results](./usage/#loading-build-results) for details. > > Version 4.0.0 and later of `docker/build-push-action` and > `docker/bake-action` builds images with [provenance attestations by -> default](/build/ci/github-actions/attestations.md#default-provenance). Docker +> default](/manuals/build/ci/github-actions/attestations.md#default-provenance). Docker > Build Cloud automatically attempts to load images to the local image store if > you don't explicitly push them to a registry. > diff --git a/content/build-cloud/optimization.md b/content/manuals/build-cloud/optimization.md similarity index 95% rename from content/build-cloud/optimization.md rename to content/manuals/build-cloud/optimization.md index cc5c15e91d..cde8112428 100644 --- a/content/build-cloud/optimization.md +++ b/content/manuals/build-cloud/optimization.md @@ -1,5 +1,7 @@ --- title: Optimize for building in the cloud +linkTitle: Optimization +weight: 40 description: Building remotely is different from building locally. Here's how to optimize for remote builders. keywords: build, cloud build, optimize, remote, local, cloud aliases: @@ -30,11 +32,11 @@ more efficient: - [Multi-threaded tools](#multi-threaded-tools) For more information on how to optimize your builds, see -[Building best practices](/build/building/best-practices.md). +[Building best practices](/manuals/build/building/best-practices.md). ### Dockerignore files -Using a [`.dockerignore` file](/build/concepts/context.md#dockerignore-files), +Using a [`.dockerignore` file](/manuals/build/concepts/context.md#dockerignore-files), you can be explicit about which local files you don’t want to include in the build context. Files caught by the glob patterns you specify in your ignore-file aren't transferred to the remote builder. diff --git a/content/build-cloud/setup.md b/content/manuals/build-cloud/setup.md similarity index 98% rename from content/build-cloud/setup.md rename to content/manuals/build-cloud/setup.md index 0687e95b11..cbf4098c7b 100644 --- a/content/build-cloud/setup.md +++ b/content/manuals/build-cloud/setup.md @@ -1,5 +1,7 @@ --- title: Docker Build Cloud setup +linkTitle: Setup +weight: 10 description: How to get started with Docker Build Cloud keywords: build, cloud build aliases: diff --git a/content/build-cloud/usage.md b/content/manuals/build-cloud/usage.md similarity index 98% rename from content/build-cloud/usage.md rename to content/manuals/build-cloud/usage.md index 4403a660e2..83bdde6ed0 100644 --- a/content/build-cloud/usage.md +++ b/content/manuals/build-cloud/usage.md @@ -1,5 +1,7 @@ --- title: Building with Docker Build Cloud +linkTitle: Usage +weight: 20 description: Invoke your cloud builds with the Buildx CLI client keywords: build, cloud build, usage, cli, buildx, client aliases: @@ -66,7 +68,7 @@ $ docker compose build In addition to `docker buildx use`, you can also use the `docker compose build --builder` flag or the [`BUILDX_BUILDER` environment -variable](/build/building/variables.md#buildx_builder) to select the cloud builder. +variable](/manuals/build/building/variables.md#buildx_builder) to select the cloud builder. ## Loading build results diff --git a/content/build/_index.md b/content/manuals/build/_index.md similarity index 98% rename from content/build/_index.md rename to content/manuals/build/_index.md index e552e5886a..5fbdec6cfe 100644 --- a/content/build/_index.md +++ b/content/manuals/build/_index.md @@ -1,5 +1,7 @@ --- title: Overview of Docker Build +linkTitle: Docker Build +weight: 100 description: Get an overview of Docker Build to package and bundle your code and ship it anywhere keywords: build, buildx, buildkit grid: diff --git a/content/build/bake/_index.md b/content/manuals/build/bake/_index.md similarity index 98% rename from content/build/bake/_index.md rename to content/manuals/build/bake/_index.md index 17ec6eb4a8..92d86924e0 100644 --- a/content/build/bake/_index.md +++ b/content/manuals/build/bake/_index.md @@ -1,5 +1,6 @@ --- -title: Buildx Bake +title: Bake +weight: 50 keywords: build, buildx, bake, buildkit, hcl, json, compose aliases: - /build/customize/bake/ diff --git a/content/build/bake/compose-file.md b/content/manuals/build/bake/compose-file.md similarity index 100% rename from content/build/bake/compose-file.md rename to content/manuals/build/bake/compose-file.md diff --git a/content/build/bake/contexts.md b/content/manuals/build/bake/contexts.md similarity index 97% rename from content/build/bake/contexts.md rename to content/manuals/build/bake/contexts.md index 86bc55e3f9..cf43b4aa45 100644 --- a/content/build/bake/contexts.md +++ b/content/manuals/build/bake/contexts.md @@ -1,5 +1,7 @@ --- title: Using Bake with additional contexts +linkTitle: Contexts +weight: 80 description: | Additional contexts are useful when you want to pin image versions, or reference the output of other targets @@ -12,7 +14,7 @@ aliases: In addition to the main `context` key that defines the build context, each target can also define additional named contexts with a map defined with key `contexts`. These values map to the `--build-context` flag in the [build -command](../../reference/cli/docker/buildx/build.md#build-context). +command](/reference/cli/docker/buildx/build.md#build-context). Inside the Dockerfile these contexts can be used with the `FROM` instruction or `--from` flag. diff --git a/content/build/bake/expressions.md b/content/manuals/build/bake/expressions.md similarity index 98% rename from content/build/bake/expressions.md rename to content/manuals/build/bake/expressions.md index b486d5b36a..ded6d0eb50 100644 --- a/content/build/bake/expressions.md +++ b/content/manuals/build/bake/expressions.md @@ -1,5 +1,7 @@ --- title: Expression evaluation in Bake +linkTitle: Expressions +weight: 50 description: Learn about advanced Bake features, like user-defined functions keywords: build, buildx, bake, buildkit, hcl, expressions, evaluation, math, arithmetic, conditionals aliases: diff --git a/content/build/bake/funcs.md b/content/manuals/build/bake/funcs.md similarity index 98% rename from content/build/bake/funcs.md rename to content/manuals/build/bake/funcs.md index 737db98671..76a39b2825 100644 --- a/content/build/bake/funcs.md +++ b/content/manuals/build/bake/funcs.md @@ -1,5 +1,6 @@ --- -title: HCL functions +title: Functions +weight: 60 description: Learn about built-in and user-defined HCL functions with Bake keywords: build, buildx, bake, buildkit, hcl, functions, user-defined, built-in, custom, gocty aliases: diff --git a/content/build/bake/inheritance.md b/content/manuals/build/bake/inheritance.md similarity index 99% rename from content/build/bake/inheritance.md rename to content/manuals/build/bake/inheritance.md index c3556408fb..b07a56bcec 100644 --- a/content/build/bake/inheritance.md +++ b/content/manuals/build/bake/inheritance.md @@ -1,5 +1,7 @@ --- title: Inheritance in Bake +linkTitle: Inheritance +weight: 30 description: Learn how to inherit attributes from other targets in Bake keywords: buildx, buildkit, bake, inheritance, targets, attributes --- diff --git a/content/build/bake/introduction.md b/content/manuals/build/bake/introduction.md similarity index 98% rename from content/build/bake/introduction.md rename to content/manuals/build/bake/introduction.md index 872c9da5b4..02c23ff673 100644 --- a/content/build/bake/introduction.md +++ b/content/manuals/build/bake/introduction.md @@ -1,5 +1,7 @@ --- title: Introduction to Bake +linkTitle: Introduction +weight: 10 description: Get started with using Bake to build your project keywords: bake, quickstart, build, project, introduction, getting started --- diff --git a/content/build/bake/matrices.md b/content/manuals/build/bake/matrices.md similarity index 99% rename from content/build/bake/matrices.md rename to content/manuals/build/bake/matrices.md index f859550cd5..c4764132f4 100644 --- a/content/build/bake/matrices.md +++ b/content/manuals/build/bake/matrices.md @@ -1,5 +1,6 @@ --- title: Matrix targets +weight: 70 description: Learn how to define and use matrix targets in Bake to fork a single target into multiple different variants keywords: build, buildx, bake, buildkit, matrix, hcl, json --- diff --git a/content/build/bake/overrides.md b/content/manuals/build/bake/overrides.md similarity index 99% rename from content/build/bake/overrides.md rename to content/manuals/build/bake/overrides.md index 6523b262b7..2028650f16 100644 --- a/content/build/bake/overrides.md +++ b/content/manuals/build/bake/overrides.md @@ -173,7 +173,7 @@ $ docker buildx bake -f docker-bake.hcl -f overrides.hcl --print ## Command line You can also override target configurations from the command line with the -[`--set` flag](../../reference/cli/docker/buildx/bake.md#set): +[`--set` flag](/reference/cli/docker/buildx/bake.md#set): ```hcl # docker-bake.hcl diff --git a/content/build/bake/remote-definition.md b/content/manuals/build/bake/remote-definition.md similarity index 100% rename from content/build/bake/remote-definition.md rename to content/manuals/build/bake/remote-definition.md diff --git a/content/build/bake/targets.md b/content/manuals/build/bake/targets.md similarity index 98% rename from content/build/bake/targets.md rename to content/manuals/build/bake/targets.md index 122c879b08..64b74e2590 100644 --- a/content/build/bake/targets.md +++ b/content/manuals/build/bake/targets.md @@ -1,5 +1,7 @@ --- title: Bake targets +linkTitle: Targets +weight: 20 description: Learn how to define and use targets in Bake keywords: bake, target, targets, buildx, docker, buildkit, default --- diff --git a/content/build/bake/variables.md b/content/manuals/build/bake/variables.md similarity index 99% rename from content/build/bake/variables.md rename to content/manuals/build/bake/variables.md index dff87195d8..1dfa803900 100644 --- a/content/build/bake/variables.md +++ b/content/manuals/build/bake/variables.md @@ -1,5 +1,7 @@ --- title: Variables in Bake +linkTitle: Variables +weight: 40 description: keywords: build, buildx, bake, buildkit, hcl, variables --- diff --git a/content/build/builders/_index.md b/content/manuals/build/builders/_index.md similarity index 96% rename from content/build/builders/_index.md rename to content/manuals/build/builders/_index.md index 53ff751cf4..fbd77d6a68 100644 --- a/content/build/builders/_index.md +++ b/content/manuals/build/builders/_index.md @@ -1,5 +1,6 @@ --- title: Builders +weight: 40 keywords: build, buildx, builders, buildkit, drivers, backend description: Learn about builders and how to manage them --- @@ -18,7 +19,7 @@ for your builds. This builder uses the BuildKit library bundled with the daemon. This builder requires no configuration. The default builder is directly bound to the Docker daemon and its -[context](/engine/manage-resources/contexts.md). If you change the +[context](/manuals/engine/manage-resources/contexts.md). If you change the Docker context, your `default` builder refers to the new Docker context. ## Build drivers diff --git a/content/build/builders/drivers/_index.md b/content/manuals/build/builders/drivers/_index.md similarity index 97% rename from content/build/builders/drivers/_index.md rename to content/manuals/build/builders/drivers/_index.md index ae88709f38..a75e455de6 100644 --- a/content/build/builders/drivers/_index.md +++ b/content/manuals/build/builders/drivers/_index.md @@ -34,7 +34,7 @@ The following table outlines some differences between drivers. | **BuildKit configuration** | | ✅ | ✅ | Managed externally | \* _The `docker` driver doesn't support all cache export options. -See [Cache storage backends](/build/cache/backends/_index.md) for more information._ +See [Cache storage backends](/manuals/build/cache/backends/_index.md) for more information._ ## Loading to local image store diff --git a/content/build/builders/drivers/docker-container.md b/content/manuals/build/builders/drivers/docker-container.md similarity index 97% rename from content/build/builders/drivers/docker-container.md rename to content/manuals/build/builders/drivers/docker-container.md index aea65c4320..a71b9de1b4 100644 --- a/content/build/builders/drivers/docker-container.md +++ b/content/manuals/build/builders/drivers/docker-container.md @@ -16,7 +16,7 @@ Docker driver. For example: - Specify custom BuildKit versions to use. - Build multi-arch images, see [QEMU](#qemu) -- Advanced options for [cache import and export](/build/cache/backends/_index.md) +- Advanced options for [cache import and export](/manuals/build/cache/backends/_index.md) ## Synopsis @@ -47,7 +47,7 @@ pass to `--driver-opt`: | `default-load` | Boolean | `false` | Automatically load images to the Docker Engine image store. | | `network` | String | | Sets the network mode for the container. | | `cgroup-parent` | String | `/docker/buildx` | Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver. | -| `restart-policy` | String | `unless-stopped` | Sets the container's [restart policy](/engine/containers/start-containers-automatically.md#use-a-restart-policy). | +| `restart-policy` | String | `unless-stopped` | Sets the container's [restart policy](/manuals/engine/containers/start-containers-automatically.md#use-a-restart-policy). | | `env.` | String | | Sets the environment variable `key` to the specified `value` in the container. | Before you configure the resource limits for the container, diff --git a/content/build/builders/drivers/docker.md b/content/manuals/build/builders/drivers/docker.md similarity index 100% rename from content/build/builders/drivers/docker.md rename to content/manuals/build/builders/drivers/docker.md diff --git a/content/build/builders/drivers/kubernetes.md b/content/manuals/build/builders/drivers/kubernetes.md similarity index 99% rename from content/build/builders/drivers/kubernetes.md rename to content/manuals/build/builders/drivers/kubernetes.md index 8a973732c5..12da0a79ce 100644 --- a/content/build/builders/drivers/kubernetes.md +++ b/content/manuals/build/builders/drivers/kubernetes.md @@ -144,7 +144,7 @@ $ docker buildx create \ ## Multi-platform builds The Kubernetes driver has support for creating -[multi-platform images](/build/building/multi-platform.md), +[multi-platform images](/manuals/build/building/multi-platform.md), either using QEMU or by leveraging the native architecture of nodes. ### QEMU diff --git a/content/build/builders/drivers/remote.md b/content/manuals/build/builders/drivers/remote.md similarity index 100% rename from content/build/builders/drivers/remote.md rename to content/manuals/build/builders/drivers/remote.md diff --git a/content/build/builders/manage.md b/content/manuals/build/builders/manage.md similarity index 92% rename from content/build/builders/manage.md rename to content/manuals/build/builders/manage.md index 7a1cd63c8c..e73c1a0924 100644 --- a/content/build/builders/manage.md +++ b/content/manuals/build/builders/manage.md @@ -16,7 +16,7 @@ that use other drivers, such as the which runs the BuildKit daemon in a container. Use the -[`docker buildx create`](../../reference/cli/docker/buildx/create.md) +[`docker buildx create`](/reference/cli/docker/buildx/create.md) command to create a builder. ```console @@ -100,7 +100,7 @@ Total: 2.01GB ## Remove a builder Use the -[`docker buildx remove`](../../reference/cli/docker/buildx/create.md) +[`docker buildx remove`](/reference/cli/docker/buildx/create.md) command to remove a builder. ```console @@ -122,9 +122,9 @@ It only removes your connection to the builder. ## Manage builders with Docker Desktop If you have turned on the -[Docker Desktop Builds view](../../desktop/use-desktop/builds.md), +[Docker Desktop Builds view](/manuals/desktop/use-desktop/builds.md), you can inspect builders in Docker Desktop settings. See: -- [Change settings, Windows](../../desktop/settings/windows.md#builders) -- [Change settings, Mac](../../desktop/settings/mac.md#builders) -- [Change settings, Linux](../../desktop/settings/linux.md#builders) +- [Change settings, Windows](/manuals/desktop/settings/windows.md#builders) +- [Change settings, Mac](/manuals/desktop/settings/mac.md#builders) +- [Change settings, Linux](/manuals/desktop/settings/linux.md#builders) diff --git a/content/manuals/build/building/_index.md b/content/manuals/build/building/_index.md new file mode 100644 index 0000000000..bf74fab552 --- /dev/null +++ b/content/manuals/build/building/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Building +weight: 20 +--- diff --git a/content/build/building/base-images.md b/content/manuals/build/building/base-images.md similarity index 95% rename from content/build/building/base-images.md rename to content/manuals/build/building/base-images.md index 8dcf38a7ff..96174bd03d 100644 --- a/content/build/building/base-images.md +++ b/content/manuals/build/building/base-images.md @@ -1,5 +1,6 @@ --- title: Base images +weight: 70 description: Learn about base images and how they're created keywords: images, base image, examples aliases: @@ -62,7 +63,7 @@ ADD hello / CMD ["/hello"] ``` -Assuming an executable binary named `hello` exists at the root of the [build context](/build/concepts/context.md). +Assuming an executable binary named `hello` exists at the root of the [build context](/manuals/build/concepts/context.md). You can build this Docker image using the following `docker build` command: ```console @@ -120,6 +121,6 @@ There are more example scripts for creating base images in For more information about building images and writing Dockerfiles, see: -* [Dockerfile reference](../../reference/dockerfile.md) -* [Dockerfile best practices](../../build/building/best-practices.md) +* [Dockerfile reference](/reference/dockerfile.md) +* [Dockerfile best practices](/manuals/build/building/best-practices.md) * [Docker Official Images](../../trusted-content/official-images/_index.md) diff --git a/content/build/building/best-practices.md b/content/manuals/build/building/best-practices.md similarity index 94% rename from content/build/building/best-practices.md rename to content/manuals/build/building/best-practices.md index 02d13dd21b..ef6c37960f 100644 --- a/content/build/building/best-practices.md +++ b/content/manuals/build/building/best-practices.md @@ -1,7 +1,9 @@ --- +title: Building best practices +linkTitle: Best practices +weight: 60 description: Hints, tips and guidelines for writing clean, reliable Dockerfiles keywords: base images, dockerfile, best practices, hub, official image -title: Building best practices tags: [Best practices] aliases: - /articles/dockerfile_best-practices/ @@ -24,7 +26,7 @@ resulting output only contains the files that's needed to run the application. Using multiple stages can also let you build more efficiently by executing build steps in parallel. -See [Multi-stage builds](../../build/building/multi-stage.md) for more +See [Multi-stage builds](/manuals/build/building/multi-stage.md) for more information. ### Create reusable stages @@ -114,7 +116,7 @@ For example, to exclude all files with the `.md` extension: ``` For information on creating one, see -[Dockerignore file](/build/concepts/context.md#dockerignore-files). +[Dockerignore file](/manuals/build/concepts/context.md#dockerignore-files). ## Create ephemeral containers @@ -143,14 +145,14 @@ database, and an in-memory cache in a decoupled manner. Limiting each container to one process is a good rule of thumb, but it's not a hard and fast rule. For example, not only can containers be -[spawned with an init process](/engine/containers/run.md#specify-an-init-process), +[spawned with an init process](/manuals/engine/containers/run.md#specify-an-init-process), some programs might spawn additional processes of their own accord. For instance, [Celery](https://docs.celeryproject.org/) can spawn multiple worker processes, and [Apache](https://httpd.apache.org/) can create one process per request. Use your best judgment to keep containers as clean and modular as possible. If -containers depend on each other, you can use [Docker container networks](/engine/network/_index.md) +containers depend on each other, you can use [Docker container networks](/manuals/engine/network/_index.md) to ensure that these containers can communicate. ## Sort multi-line arguments @@ -181,7 +183,7 @@ checks whether it can reuse the instruction from the build cache. Understanding how the build cache works, and how cache invalidation occurs, is critical for ensuring faster builds. For more information about the Docker build cache and how to optimize your builds, -see [Docker build cache](../../build/cache/_index.md). +see [Docker build cache](/manuals/build/cache/_index.md). ## Pin base image versions @@ -254,7 +256,7 @@ automatically build and tag a Docker image and test it. ## Dockerfile instructions -Follow these recommendations on how to properly use the [Dockerfile instructions](../../reference/dockerfile.md) +Follow these recommendations on how to properly use the [Dockerfile instructions](/reference/dockerfile.md) to create an efficient and maintainable Dockerfile. ### FROM @@ -264,7 +266,7 @@ images. Docker recommends the [Alpine image](https://hub.docker.com/_/alpine/) a is tightly controlled and small in size (currently under 6 MB), while still being a full Linux distribution. -For more information about the `FROM` instruction, see [Dockerfile reference for the FROM instruction](../../reference/dockerfile.md#from). +For more information about the `FROM` instruction, see [Dockerfile reference for the FROM instruction](/reference/dockerfile.md#from). ### LABEL @@ -306,11 +308,11 @@ LABEL vendor=ACME\ Incorporated \ com.example.release-date="2015-02-12" ``` -See [Understanding object labels](/engine/manage-resources/labels.md) +See [Understanding object labels](/manuals/engine/manage-resources/labels.md) for guidelines about acceptable label keys and values. For information about querying labels, refer to the items related to filtering in -[Managing labels on objects](/engine/manage-resources/labels.md#manage-labels-on-objects). -See also [LABEL](../../reference/dockerfile.md#label) in the Dockerfile reference. +[Managing labels on objects](/manuals/engine/manage-resources/labels.md#manage-labels-on-objects). +See also [LABEL](/reference/dockerfile.md#label) in the Dockerfile reference. ### RUN @@ -329,7 +331,7 @@ RUN apt-get update && apt-get install -y \ ``` By default, backslash escapes a newline character, but you can change it with -the [`escape` directive](../../reference/dockerfile.md#escape). +the [`escape` directive](/reference/dockerfile.md#escape). You can also use here documents to run multiple commands without chaining them with a pipeline operator: @@ -344,7 +346,7 @@ apt-get install -y \ EOF ``` -For more information about `RUN`, see [Dockerfile reference for the RUN instruction](../../reference/dockerfile.md#run). +For more information about `RUN`, see [Dockerfile reference for the RUN instruction](/reference/dockerfile.md#run). #### apt-get @@ -486,11 +488,11 @@ python and perl. For example, `CMD ["perl", "-de0"]`, `CMD ["python"]`, or `CMD ["php", "-a"]`. Using this form means that when you execute something like `docker run -it python`, you’ll get dropped into a usable shell, ready to go. `CMD` should rarely be used in the manner of `CMD ["param", "param"]` in -conjunction with [`ENTRYPOINT`](../../reference/dockerfile.md#entrypoint), unless +conjunction with [`ENTRYPOINT`](/reference/dockerfile.md#entrypoint), unless you and your expected users are already quite familiar with how `ENTRYPOINT` works. -For more information about `CMD`, see [Dockerfile reference for the CMD instruction](../../reference/dockerfile.md#cmd). +For more information about `CMD`, see [Dockerfile reference for the CMD instruction](/reference/dockerfile.md#cmd). ### EXPOSE @@ -505,7 +507,7 @@ how to map the specified port to the port of their choice. For container linking, Docker provides environment variables for the path from the recipient container back to the source (for example, `MYSQL_PORT_3306_TCP`). -For more information about `EXPOSE`, see [Dockerfile reference for the EXPOSE instruction](../../reference/dockerfile.md#expose). +For more information about `EXPOSE`, see [Dockerfile reference for the EXPOSE instruction](/reference/dockerfile.md#expose). ### ENV @@ -573,13 +575,13 @@ $ docker run --rm test sh -c 'echo $ADMIN_USER' ``` -For more information about `ENV`, see [Dockerfile reference for the ENV instruction](../../reference/dockerfile.md#env). +For more information about `ENV`, see [Dockerfile reference for the ENV instruction](/reference/dockerfile.md#env). ### ADD or COPY `ADD` and `COPY` are functionally similar. `COPY` supports basic copying of -files into the container, from the [build context](/build/concepts/context.md) -or from a stage in a [multi-stage build](/build/building/multi-stage.md). +files into the container, from the [build context](/manuals/build/concepts/context.md) +or from a stage in a [multi-stage build](/manuals/build/building/multi-stage.md). `ADD` supports features for fetching files from remote HTTPS and Git URLs, and extracting tar files automatically when adding files from the build context. @@ -605,7 +607,7 @@ as part of your build. `ADD` is better than manually adding files using something like `wget` and `tar`, because it ensures a more precise build cache. `ADD` also has built-in support for checksum validation of the remote resources, and a protocol for parsing branches, tags, and subdirectories from -[Git URLs](../../reference/cli/docker/buildx/build.md#git-repositories). +[Git URLs](/reference/cli/docker/buildx/build.md#git-repositories). The following example uses `ADD` to download a .NET installer. Combined with multi-stage builds, only the .NET runtime remains in the final stage, no @@ -634,8 +636,8 @@ RUN ln -s /usr/share/dotnet/dotnet /usr/bin/dotnet ``` For more information about `ADD` or `COPY`, see the following: -- [Dockerfile reference for the ADD instruction](../../reference/dockerfile.md#add) -- [Dockerfile reference for the COPY instruction](../../reference/dockerfile.md#copy) +- [Dockerfile reference for the ADD instruction](/reference/dockerfile.md#add) +- [Dockerfile reference for the COPY instruction](/reference/dockerfile.md#copy) ### ENTRYPOINT @@ -691,7 +693,7 @@ exec "$@" ``` -This script uses [the `exec` Bash command](https://wiki.bash-hackers.org/commands/builtin/exec) so that the final running application becomes the container's PID 1. This allows the application to receive any Unix signals sent to the container. For more information, see the [`ENTRYPOINT` reference](../../reference/dockerfile.md#entrypoint). +This script uses [the `exec` Bash command](https://wiki.bash-hackers.org/commands/builtin/exec) so that the final running application becomes the container's PID 1. This allows the application to receive any Unix signals sent to the container. For more information, see the [`ENTRYPOINT` reference](/reference/dockerfile.md#entrypoint). In the following example, a helper script is copied into the container and run via `ENTRYPOINT` on container start: @@ -722,7 +724,7 @@ Lastly, you can use it to start a totally different tool, such as Bash: $ docker run --rm -it postgres bash ``` -For more information about `ENTRYPOINT`, see [Dockerfile reference for the ENTRYPOINT instruction](../../reference/dockerfile.md#entrypoint). +For more information about `ENTRYPOINT`, see [Dockerfile reference for the ENTRYPOINT instruction](/reference/dockerfile.md#entrypoint). ### VOLUME @@ -731,7 +733,7 @@ configuration storage, or files and folders created by your Docker container. Yo are strongly encouraged to use `VOLUME` for any combination of mutable or user-serviceable parts of your image. -For more information about `VOLUME`, see [Dockerfile reference for the VOLUME instruction](../../reference/dockerfile.md#volume). +For more information about `VOLUME`, see [Dockerfile reference for the VOLUME instruction](/reference/dockerfile.md#volume). ### USER @@ -768,7 +770,7 @@ running it as non-`root`, consider using [“gosu”](https://github.com/tianon/ Lastly, to reduce layers and complexity, avoid switching `USER` back and forth frequently. -For more information about `USER`, see [Dockerfile reference for the USER instruction](../../reference/dockerfile.md#user). +For more information about `USER`, see [Dockerfile reference for the USER instruction](/reference/dockerfile.md#user). ### WORKDIR @@ -777,7 +779,7 @@ For clarity and reliability, you should always use absolute paths for your like `RUN cd … && do-something`, which are hard to read, troubleshoot, and maintain. -For more information about `WORKDIR`, see [Dockerfile reference for the WORKDIR instruction](../../reference/dockerfile.md#workdir). +For more information about `WORKDIR`, see [Dockerfile reference for the WORKDIR instruction](/reference/dockerfile.md#workdir). ### ONBUILD @@ -802,4 +804,4 @@ fails catastrophically if the new build's context is missing the resource being added. Adding a separate tag, as recommended above, helps mitigate this by allowing the Dockerfile author to make a choice. -For more information about `ONBUILD`, see [Dockerfile reference for the ONBUILD instruction](../../reference/dockerfile.md#onbuild). +For more information about `ONBUILD`, see [Dockerfile reference for the ONBUILD instruction](/reference/dockerfile.md#onbuild). diff --git a/content/build/building/export.md b/content/manuals/build/building/export.md similarity index 95% rename from content/build/building/export.md rename to content/manuals/build/building/export.md index 48f2238a0d..1b813c3f89 100644 --- a/content/build/building/export.md +++ b/content/manuals/build/building/export.md @@ -1,5 +1,6 @@ --- title: Export binaries +weight: 50 description: Using Docker builds to create and export executable binaries keywords: build, buildkit, buildx, guide, tutorial, build arguments, arg aliases: @@ -25,7 +26,7 @@ your build. If you specify a filepath to the `docker build --output` flag, Docker exports the contents of the build container at the end of the build to the specified location on your host's filesystem. This uses the `local` -[exporter](/build/exporters/local-tar.md). +[exporter](/manuals/build/exporters/local-tar.md). The neat thing about this is that you can use Docker's powerful isolation and build features to create standalone binaries. This @@ -84,7 +85,7 @@ World!", and exports the binary to the host filesystem. ## Exporting multi-platform builds You use the `local` exporter to export binaries in combination with -[multi-platform builds](/build/building/multi-platform.md). This lets you +[multi-platform builds](/manuals/build/building/multi-platform.md). This lets you compile multiple binaries at once, that can be run on any machine of any architecture, provided that the target platform is supported by the compiler you use. @@ -130,4 +131,4 @@ out/ In addition to the `local` exporter, there are other exporters available. To learn more about the available exporters and how to use them, see the -[exporters](/build/exporters/_index.md) documentation. +[exporters](/manuals/build/exporters/_index.md) documentation. diff --git a/content/build/building/multi-platform.md b/content/manuals/build/building/multi-platform.md similarity index 99% rename from content/build/building/multi-platform.md rename to content/manuals/build/building/multi-platform.md index 29c00cf465..3046141ef6 100644 --- a/content/build/building/multi-platform.md +++ b/content/manuals/build/building/multi-platform.md @@ -1,5 +1,7 @@ --- title: Multi-platform builds +linkTitle: Multi-platform +weight: 40 description: Introduction to what multi-platform builds are and how to execute them using Docker Buildx. keywords: build, buildx, buildkit, multi-platform, cross-platform, cross-compilation, emulation, QEMU, ARM, x86, Windows, Linux, macOS aliases: @@ -230,7 +232,7 @@ $ docker build \ --push . ``` -For more information, see [Docker Build Cloud](/build-cloud/_index.md). +For more information, see [Docker Build Cloud](/manuals/build-cloud/_index.md). ### Cross-compilation @@ -320,7 +322,7 @@ do CPU-intensive tasks like compilation. Prerequisites: -- You've [signed up for Docker Build Cloud and created a builder](/build-cloud/setup.md) +- You've [signed up for Docker Build Cloud and created a builder](/manuals/build-cloud/setup.md) Steps: diff --git a/content/build/building/multi-stage.md b/content/manuals/build/building/multi-stage.md similarity index 99% rename from content/build/building/multi-stage.md rename to content/manuals/build/building/multi-stage.md index 449798db49..e96552de41 100644 --- a/content/build/building/multi-stage.md +++ b/content/manuals/build/building/multi-stage.md @@ -1,5 +1,7 @@ --- title: Multi-stage builds +linkTitle: Multi-stage +weight: 10 description: | Learn about multi-stage builds and how you can use them to improve your builds and get smaller images diff --git a/content/build/building/secrets.md b/content/manuals/build/building/secrets.md similarity index 93% rename from content/build/building/secrets.md rename to content/manuals/build/building/secrets.md index 49d1b85afc..4e24146e08 100644 --- a/content/build/building/secrets.md +++ b/content/manuals/build/building/secrets.md @@ -1,5 +1,7 @@ --- title: Build secrets +linkTitle: Secrets +weight: 30 description: Manage credentials and other secrets securely keywords: build, secrets, credentials, passwords, tokens, ssh, git, auth, http tags: [Secrets] @@ -16,7 +18,7 @@ secret mounts or SSH mounts, which expose secrets to your builds securely. Secret mounts expose secrets to the build containers as files. You [mount the secrets to the `RUN` -instructions](../../reference/dockerfile.md#run---mounttypesecret) that +instructions](/reference/dockerfile.md#run---mounttypesecret) that need to access them, similar to how you would define a bind mount or cache mount. @@ -26,7 +28,7 @@ RUN --mount=type=secret,id=mytoken \ ``` To pass a secret to a build, use the [`docker build --secret` -flag](../../reference/cli/docker/buildx/build.md#secret), or the +flag](/reference/cli/docker/buildx/build.md#secret), or the equivalent options for [Bake](../bake/reference.md#targetsecret). {{< tabs >}} @@ -57,8 +59,8 @@ target "default" { ### Sources The source of a secret can be either a -[file](../../reference/cli/docker/buildx/build.md#file) or an -[environment variable](../../reference/cli/docker/buildx/build.md#env). +[file](/reference/cli/docker/buildx/build.md#file) or an +[environment variable](/reference/cli/docker/buildx/build.md#env). When you use the CLI or Bake, the type can be detected automatically. You can also specify it explicitly with `type=file` or `type=env`. @@ -102,7 +104,7 @@ you can use the SSH mount instead of a secret mount. Cloning private Git repositories is a common use case for SSH mounts. The following example clones a private GitHub repository using a [Dockerfile -SSH mount](../../reference/dockerfile.md#run---mounttypessh). +SSH mount](/reference/dockerfile.md#run---mounttypessh). ```dockerfile # syntax=docker/dockerfile:1 @@ -111,7 +113,7 @@ ADD git@github.com:me/myprivaterepo.git /src/ ``` To pass an SSH socket the build, you use the [`docker build --ssh` -flag](../../reference/cli/docker/buildx/build.md#ssh), or equivalent +flag](/reference/cli/docker/buildx/build.md#ssh), or equivalent options for [Bake](../bake/reference.md#targetssh). ```console diff --git a/content/build/building/variables.md b/content/manuals/build/building/variables.md similarity index 96% rename from content/build/building/variables.md rename to content/manuals/build/building/variables.md index dde685e7e5..93a23ba211 100644 --- a/content/build/building/variables.md +++ b/content/manuals/build/building/variables.md @@ -1,5 +1,7 @@ --- title: Build variables +linkTitle: Variables +weight: 20 description: Using build arguments and environment variables to configure builds keywords: build, args, variables, parameters, env, environment variables, config aliases: @@ -116,8 +118,8 @@ $ docker build --build-arg NODE_VERSION=current . For more information on how to use build arguments, refer to: -- [`ARG` Dockerfile reference](../../reference/dockerfile.md#arg) -- [`docker build --build-arg` reference](../../reference/cli/docker/buildx/build.md#build-arg) +- [`ARG` Dockerfile reference](/reference/dockerfile.md#arg) +- [`docker build --build-arg` reference](/reference/cli/docker/buildx/build.md#build-arg) ## `ENV` usage example @@ -167,7 +169,7 @@ using them can lead to unintended side-effects for the application's runtime. For more information on how to use environment variables in builds, refer to: -- [`ENV` Dockerfile reference](../../reference/dockerfile.md#env) +- [`ENV` Dockerfile reference](/reference/dockerfile.md#env) ## Scoping @@ -264,7 +266,7 @@ RUN GOOS=$TARGETOS go build -o ./exe . ``` For more information about multi-platform build arguments, refer to -[Multi-platform arguments](../../reference/dockerfile.md#automatic-platform-args-in-the-global-scope) +[Multi-platform arguments](/reference/dockerfile.md#automatic-platform-args-in-the-global-scope) ### Proxy arguments @@ -293,7 +295,7 @@ $ docker build --build-arg HTTP_PROXY=https://my-proxy.example.com . ``` For more information about proxy build arguments, refer to -[Proxy arguments](../../reference/dockerfile.md#predefined-args). +[Proxy arguments](/reference/dockerfile.md#predefined-args). ## Build tool configuration variables @@ -322,7 +324,7 @@ They're used to configure the Buildx client, or the BuildKit daemon. | [EXPERIMENTAL_BUILDKIT_SOURCE_POLICY](#experimental_buildkit_source_policy) | String | Specify a BuildKit source policy file. | BuildKit also supports a few additional configuration parameters. Refer to -[BuildKit built-in build args](../../reference/dockerfile.md#buildkit-built-in-build-args). +[BuildKit built-in build args](/reference/dockerfile.md#buildkit-built-in-build-args). You can express Boolean values for environment variables in different ways. For example, `true`, `1`, and `T` all evaluate to true. @@ -520,7 +522,7 @@ $ export BUILDX_EXPERIMENTAL=1 {{< introduced buildx 0.10.4 "../release-notes.md#0104" >}} When set to true, checks for dirty state in source control information for -[provenance attestations](/build/metadata/attestations/slsa-provenance.md). +[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md). Usage: @@ -533,7 +535,7 @@ $ export BUILDX_GIT_CHECK_DIRTY=1 {{< introduced buildx 0.10.0 "../release-notes.md#0100" >}} When set to false, removes source control information from -[provenance attestations](/build/metadata/attestations/slsa-provenance.md). +[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md). Usage: @@ -575,7 +577,7 @@ If the repository is in a dirty state, the `revision` gets a `-dirty` suffix. {{< introduced buildx 0.10.4 "../release-notes.md#0104" >}} By default, BuildKit v0.11 and later adds -[provenance attestations](/build/metadata/attestations/slsa-provenance.md) to images you +[provenance attestations](/manuals/build/metadata/attestations/slsa-provenance.md) to images you build. Set `BUILDX_NO_DEFAULT_ATTESTATIONS=1` to disable the default provenance attestations. diff --git a/content/build/buildkit/_index.md b/content/manuals/build/buildkit/_index.md similarity index 99% rename from content/build/buildkit/_index.md rename to content/manuals/build/buildkit/_index.md index f255637284..71927e5670 100644 --- a/content/build/buildkit/_index.md +++ b/content/manuals/build/buildkit/_index.md @@ -1,5 +1,6 @@ --- title: BuildKit +weight: 100 description: Introduction and overview of BuildKit keywords: build, buildkit --- @@ -65,7 +66,7 @@ it to LLB so BuildKit can execute it. Frontends can be distributed as images, and the user can target a specific version of a frontend that is guaranteed to work for the features used by their definition. -For example, to build a [Dockerfile](../../reference/dockerfile.md) with +For example, to build a [Dockerfile](/reference/dockerfile.md) with BuildKit, you would [use an external Dockerfile frontend](frontend.md). diff --git a/content/build/buildkit/configure.md b/content/manuals/build/buildkit/configure.md similarity index 96% rename from content/build/buildkit/configure.md rename to content/manuals/build/buildkit/configure.md index cad59cd8dd..bef1959c75 100644 --- a/content/build/buildkit/configure.md +++ b/content/manuals/build/buildkit/configure.md @@ -6,7 +6,7 @@ keywords: build, buildkit, configuration, buildx, network, cni, registry If you create a `docker-container` or `kubernetes` builder with Buildx, you can apply a custom [BuildKit configuration](toml-configuration.md) by passing the -[`--config` flag](../../reference/cli/docker/buildx/create.md#config) to +[`--config` flag](/reference/cli/docker/buildx/create.md#config) to the `docker buildx create` command. ## Registry mirror @@ -166,7 +166,7 @@ ADD https://raw.githubusercontent.com/moby/buildkit/${BUILDKIT_VERSION}/hack/fix ``` Now you can build this image, and create a builder instance from it using -[the `--driver-opt image` option](../../reference/cli/docker/buildx/create.md#driver-opt): +[the `--driver-opt image` option](/reference/cli/docker/buildx/create.md#driver-opt): ```console $ docker buildx build --tag buildkit-cni:local --load . @@ -183,7 +183,7 @@ $ docker buildx create --use --bootstrap \ You can limit the parallelism of the BuildKit solver, which is particularly useful for low-powered machines, using a [BuildKit configuration](toml-configuration.md) -while creating a builder with the [`--config` flags](../../reference/cli/docker/buildx/create.md#config). +while creating a builder with the [`--config` flags](/reference/cli/docker/buildx/create.md#config). ```toml # /etc/buildkitd.toml @@ -191,7 +191,7 @@ while creating a builder with the [`--config` flags](../../reference/cli/docker/ max-parallelism = 4 ``` -Now you can [create a `docker-container` builder](/build/builders/drivers/docker-container.md) +Now you can [create a `docker-container` builder](/manuals/build/builders/drivers/docker-container.md) that will use this BuildKit configuration to limit parallelism. ```console diff --git a/content/build/buildkit/dockerfile-release-notes.md b/content/manuals/build/buildkit/dockerfile-release-notes.md similarity index 86% rename from content/build/buildkit/dockerfile-release-notes.md rename to content/manuals/build/buildkit/dockerfile-release-notes.md index 7808eb579d..5fd8813e56 100644 --- a/content/build/buildkit/dockerfile-release-notes.md +++ b/content/manuals/build/buildkit/dockerfile-release-notes.md @@ -9,7 +9,7 @@ aliases: --- This page contains information about the new features, improvements, known -issues, and bug fixes in [Dockerfile reference](../../reference/dockerfile.md). +issues, and bug fixes in [Dockerfile reference](/reference/dockerfile.md). For usage, see the [Dockerfile frontend syntax](frontend.md) page. @@ -106,10 +106,10 @@ The full release note for this release is available [moby/buildkit#3001](https://github.com/moby/buildkit/pull/3001), [moby/buildkit#4720](https://github.com/moby/buildkit/pull/4720), [moby/buildkit#4728](https://github.com/moby/buildkit/pull/4728), - [docs](../../reference/dockerfile.md#copy---parents) + [docs](/reference/dockerfile.md#copy---parents) - New `--exclude` flag can be used in `COPY` and `ADD` commands to apply filter to copied files. [moby/buildkit#4561](https://github.com/moby/buildkit/pull/4561), - [docs](../../reference/dockerfile.md#copy---exclude) + [docs](/reference/dockerfile.md#copy---exclude) ## 1.6.0 @@ -118,12 +118,12 @@ The full release note for this release is available ### New - Add `--start-interval` flag to the - [`HEALTHCHECK` instruction](../../reference/dockerfile.md#healthcheck). + [`HEALTHCHECK` instruction](/reference/dockerfile.md#healthcheck). The following features have graduated from the labs channel to stable: -- The `ADD` instruction can now [import files directly from Git URLs](../../reference/dockerfile.md#adding-a-git-repository-add-git-ref-dir) -- The `ADD` instruction now supports [`--checksum` flag](../../reference/dockerfile.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) +- The `ADD` instruction can now [import files directly from Git URLs](/reference/dockerfile.md#adding-a-git-repository-add-git-ref-dir) +- The `ADD` instruction now supports [`--checksum` flag](/reference/dockerfile.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) to validate the contents of the remote URL contents ### Bug fixes and enhancements @@ -161,7 +161,7 @@ The following features have graduated from the labs channel to stable: ### New -- `ADD` command now supports [`--checksum` flag](../../reference/dockerfile.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) +- `ADD` command now supports [`--checksum` flag](/reference/dockerfile.md#verifying-a-remote-file-checksum-add---checksumchecksum-http-src-dest) to validate the contents of the remote URL contents ## 1.5.0 @@ -170,7 +170,7 @@ The following features have graduated from the labs channel to stable: ### New -- `ADD` command can now [import files directly from Git URLs](../../reference/dockerfile.md#adding-a-git-repository-add-git-ref-dir) +- `ADD` command can now [import files directly from Git URLs](/reference/dockerfile.md#adding-a-git-repository-add-git-ref-dir) ### Bug fixes and enhancements @@ -220,17 +220,17 @@ The following features have graduated from the labs channel to stable: ### New -- [`COPY --link` and `ADD --link`](../../reference/dockerfile.md#copy---link) +- [`COPY --link` and `ADD --link`](/reference/dockerfile.md#copy---link) allow copying files with increased cache efficiency and rebase images without requiring them to be rebuilt. `--link` copies files to a separate layer and then uses new LLB MergeOp implementation to chain independent layers together -- [Heredocs](../../reference/dockerfile.md#here-documents) support have +- [Heredocs](/reference/dockerfile.md#here-documents) support have been promoted from labs channel to stable. This feature allows writing multiline inline scripts and files -- Additional [named build contexts](../../reference/cli/docker/buildx/build.md#build-context) +- Additional [named build contexts](/reference/cli/docker/buildx/build.md#build-context) can be passed to build to add or overwrite a stage or an image inside the build. A source for the context can be a local source, image, Git, or HTTP URL -- [`BUILDKIT_SANDBOX_HOSTNAME` build-arg](../../reference/dockerfile.md#buildkit-built-in-build-args) +- [`BUILDKIT_SANDBOX_HOSTNAME` build-arg](/reference/dockerfile.md#buildkit-built-in-build-args) can be used to set the default hostname for the `RUN` steps ### Bug fixes and enhancements @@ -255,7 +255,7 @@ The following features have graduated from the labs channel to stable: ### New -- `RUN` and `COPY` commands now support [Here-document syntax](../../reference/dockerfile.md#here-documents) +- `RUN` and `COPY` commands now support [Here-document syntax](/reference/dockerfile.md#here-documents) allowing writing multiline inline scripts and files ## 1.3.0 @@ -264,7 +264,7 @@ The following features have graduated from the labs channel to stable: ### New -- `RUN` command allows [`--network` flag](../../reference/dockerfile.md#run---network) +- `RUN` command allows [`--network` flag](/reference/dockerfile.md#run---network) for requesting a specific type of network conditions. `--network=host` requires allowing `network.host` entitlement. This feature was previously only available on labs channel @@ -272,9 +272,9 @@ The following features have graduated from the labs channel to stable: ### Bug fixes and enhancements - `ADD` command with a remote URL input now correctly handles the `--chmod` flag -- Values for [`RUN --mount` flag](../../reference/dockerfile.md#run---mount) +- Values for [`RUN --mount` flag](/reference/dockerfile.md#run---mount) now support variable expansion, except for the `from` field -- Allow [`BUILDKIT_MULTI_PLATFORM` build arg](../../reference/dockerfile.md#buildkit-built-in-build-args) +- Allow [`BUILDKIT_MULTI_PLATFORM` build arg](/reference/dockerfile.md#buildkit-built-in-build-args) to force always creating multi-platform image, even if only contains single platform @@ -286,7 +286,7 @@ The following features have graduated from the labs channel to stable: ### Bug fixes and enhancements -- `RUN` command allows [`--network` flag](../../reference/dockerfile.md#run---network) +- `RUN` command allows [`--network` flag](/reference/dockerfile.md#run---network) for requesting a specific type of network conditions. `--network=host` requires allowing `network.host` entitlement @@ -315,10 +315,10 @@ The following features have graduated from the labs channel to stable: ### New -- [`RUN --mount` syntax](../../reference/dockerfile.md#run---mount) for +- [`RUN --mount` syntax](/reference/dockerfile.md#run---mount) for creating secret, ssh, bind, and cache mounts have been moved to mainline channel -- [`ARG` command](../../reference/dockerfile.md#arg) now supports defining +- [`ARG` command](/reference/dockerfile.md#arg) now supports defining multiple build args on the same line similarly to `ENV` ### Bug fixes and enhancements @@ -345,10 +345,10 @@ The following features have graduated from the labs channel to stable: ### Bug fixes and enhancements - Allow setting security mode for a process with `RUN --security=sandbox|insecure` -- Allow setting uid/gid for [cache mounts](../../reference/dockerfile.md#run---mounttypecache) +- Allow setting uid/gid for [cache mounts](/reference/dockerfile.md#run---mounttypecache) - Avoid requesting internally linked paths to be pulled to build context - Ensure missing cache IDs default to target paths -- Allow setting namespace for cache mounts with [`BUILDKIT_CACHE_MOUNT_NS` build arg](../../reference/dockerfile.md#buildkit-built-in-build-args) +- Allow setting namespace for cache mounts with [`BUILDKIT_CACHE_MOUNT_NS` build arg](/reference/dockerfile.md#buildkit-built-in-build-args) ## 1.1.2 diff --git a/content/build/buildkit/frontend.md b/content/manuals/build/buildkit/frontend.md similarity index 97% rename from content/build/buildkit/frontend.md rename to content/manuals/build/buildkit/frontend.md index 941774b953..8217b45909 100644 --- a/content/build/buildkit/frontend.md +++ b/content/manuals/build/buildkit/frontend.md @@ -10,8 +10,8 @@ aliases: ## Dockerfile frontend BuildKit supports loading frontends dynamically from container images. To use -an external Dockerfile frontend, the first line of your [Dockerfile](../../reference/dockerfile.md) -needs to set the [`syntax` directive](../../reference/dockerfile.md#syntax) +an external Dockerfile frontend, the first line of your [Dockerfile](/reference/dockerfile.md) +needs to set the [`syntax` directive](/reference/dockerfile.md#syntax) pointing to the specific image you want to use: ```dockerfile diff --git a/content/build/cache/_index.md b/content/manuals/build/cache/_index.md similarity index 98% rename from content/build/cache/_index.md rename to content/manuals/build/cache/_index.md index 5aa9168fa4..ed41bc7327 100644 --- a/content/build/cache/_index.md +++ b/content/manuals/build/cache/_index.md @@ -1,5 +1,7 @@ --- title: Docker build cache +linkTitle: Cache +weight: 60 description: Improve your build speed with effective use of the build cache keywords: build, buildx, buildkit, dockerfile, image layers, build instructions, build context aliases: diff --git a/content/build/cache/backends/_index.md b/content/manuals/build/cache/backends/_index.md similarity index 95% rename from content/build/cache/backends/_index.md rename to content/manuals/build/cache/backends/_index.md index 328e785542..71865b2770 100644 --- a/content/build/cache/backends/_index.md +++ b/content/manuals/build/cache/backends/_index.md @@ -18,14 +18,14 @@ environments usually have little-to-no persistence between runs, but it's still important to keep the runtime of image builds as low as possible. The default `docker` driver supports the `inline`, `local`, `registry`, and -`gha` cache backends, but only if you have enabled the [containerd image store](/desktop/containerd.md). -Other cache backends require you to select a different [driver](/build/builders/drivers/_index.md). +`gha` cache backends, but only if you have enabled the [containerd image store](/manuals/desktop/containerd.md). +Other cache backends require you to select a different [driver](/manuals/build/builders/drivers/_index.md). > [!WARNING] > > If you use secrets or credentials inside your build process, ensure you > manipulate them using the dedicated -> [`--secret` option](../../../reference/cli/docker/buildx/build.md#secret). +> [`--secret` option](/reference/cli/docker/buildx/build.md#secret). > Manually managing secrets using `COPY` or `ARG` could result in leaked > credentials. @@ -56,9 +56,9 @@ Buildx supports the following cache storage backends: ## Command syntax To use any of the cache backends, you first need to specify it on build with the -[`--cache-to` option](../../../reference/cli/docker/buildx/build.md#cache-to) +[`--cache-to` option](/reference/cli/docker/buildx/build.md#cache-to) to export the cache to your storage backend of choice. Then, use the -[`--cache-from` option](../../../reference/cli/docker/buildx/build.md#cache-from) +[`--cache-from` option](/reference/cli/docker/buildx/build.md#cache-from) to import the cache from the storage backend into the current build. Unlike the local BuildKit cache (which is always enabled), all of the cache storage backends must be explicitly exported to, and explicitly imported from. diff --git a/content/build/cache/backends/azblob.md b/content/manuals/build/cache/backends/azblob.md similarity index 96% rename from content/build/cache/backends/azblob.md rename to content/manuals/build/cache/backends/azblob.md index df10b5f4b6..f2508e342c 100644 --- a/content/build/cache/backends/azblob.md +++ b/content/manuals/build/cache/backends/azblob.md @@ -16,7 +16,7 @@ The `azblob` cache store uploads your resulting build cache to This cache storage backend is not supported with the default `docker` driver. To use this feature, create a new builder using a different driver. See -[Build drivers](/build/builders/drivers/_index.md) for more information. +[Build drivers](/manuals/build/builders/drivers/_index.md) for more information. ## Synopsis diff --git a/content/build/cache/backends/gha.md b/content/manuals/build/cache/backends/gha.md similarity index 98% rename from content/build/cache/backends/gha.md rename to content/manuals/build/cache/backends/gha.md index 5a7440a4b1..807d143611 100644 --- a/content/build/cache/backends/gha.md +++ b/content/manuals/build/cache/backends/gha.md @@ -20,7 +20,7 @@ use case falls within the This cache storage backend is not supported with the default `docker` driver. To use this feature, create a new builder using a different driver. See -[Build drivers](/build/builders/drivers/_index.md) for more information. +[Build drivers](/manuals/build/builders/drivers/_index.md) for more information. ## Synopsis diff --git a/content/build/cache/backends/inline.md b/content/manuals/build/cache/backends/inline.md similarity index 100% rename from content/build/cache/backends/inline.md rename to content/manuals/build/cache/backends/inline.md diff --git a/content/build/cache/backends/local.md b/content/manuals/build/cache/backends/local.md similarity index 100% rename from content/build/cache/backends/local.md rename to content/manuals/build/cache/backends/local.md diff --git a/content/build/cache/backends/registry.md b/content/manuals/build/cache/backends/registry.md similarity index 98% rename from content/build/cache/backends/registry.md rename to content/manuals/build/cache/backends/registry.md index 1872ac0907..9a4ff0d1a0 100644 --- a/content/build/cache/backends/registry.md +++ b/content/manuals/build/cache/backends/registry.md @@ -20,7 +20,7 @@ everything that the inline cache can do, and more: This cache storage backend is not supported with the default `docker` driver. To use this feature, create a new builder using a different driver. See -[Build drivers](/build/builders/drivers/_index.md) for more information. +[Build drivers](/manuals/build/builders/drivers/_index.md) for more information. ## Synopsis diff --git a/content/build/cache/backends/s3.md b/content/manuals/build/cache/backends/s3.md similarity index 97% rename from content/build/cache/backends/s3.md rename to content/manuals/build/cache/backends/s3.md index c075d86a11..0e5f390d4c 100644 --- a/content/build/cache/backends/s3.md +++ b/content/manuals/build/cache/backends/s3.md @@ -17,7 +17,7 @@ or other S3-compatible services, such as [MinIO](https://min.io/). This cache storage backend is not supported with the default `docker` driver. To use this feature, create a new builder using a different driver. See -[Build drivers](/build/builders/drivers/_index.md) for more information. +[Build drivers](/manuals/build/builders/drivers/_index.md) for more information. ## Synopsis diff --git a/content/build/cache/garbage-collection.md b/content/manuals/build/cache/garbage-collection.md similarity index 91% rename from content/build/cache/garbage-collection.md rename to content/manuals/build/cache/garbage-collection.md index d046ddbbf7..e371473a5e 100644 --- a/content/build/cache/garbage-collection.md +++ b/content/manuals/build/cache/garbage-collection.md @@ -6,8 +6,8 @@ aliases: - /build/building/cache/garbage-collection/ --- -While [`docker builder prune`](../../reference/cli/docker/builder/prune.md) -or [`docker buildx prune`](../../reference/cli/docker/buildx/prune.md) +While [`docker builder prune`](/reference/cli/docker/builder/prune.md) +or [`docker buildx prune`](/reference/cli/docker/buildx/prune.md) commands run at once, garbage collection runs periodically and follows an ordered list of prune policies. @@ -22,7 +22,7 @@ Depending on the [driver](../builders/drivers/_index.md) used by your builder in the garbage collection will use a different configuration file. If you're using the [`docker` driver](../builders/drivers/docker.md), garbage collection -can be configured in the [Docker Daemon configuration](../../reference/cli/dockerd.md#daemon-configuration-file). +can be configured in the [Docker Daemon configuration](/reference/cli/dockerd.md#daemon-configuration-file). file: ```json diff --git a/content/build/cache/invalidation.md b/content/manuals/build/cache/invalidation.md similarity index 96% rename from content/build/cache/invalidation.md rename to content/manuals/build/cache/invalidation.md index e4daffc6e0..a81222a3de 100644 --- a/content/build/cache/invalidation.md +++ b/content/manuals/build/cache/invalidation.md @@ -6,7 +6,7 @@ keywords: build, buildx, buildkit, cache, invalidation, cache miss When building an image, Docker steps through the instructions in your Dockerfile, executing each in the order specified. For each instruction, the -[builder](/build/builders/_index.md) checks whether it can reuse the +[builder](/manuals/build/builders/_index.md) checks whether it can reuse the instruction from the build cache. ## General rules @@ -60,7 +60,7 @@ To force a re-execution of the `RUN` instruction, you can: - Make sure that a layer before it has changed - Clear the build cache ahead of the build using - [`docker builder prune`](../../reference/cli/docker/builder/prune.md) + [`docker builder prune`](/reference/cli/docker/builder/prune.md) - Use the `--no-cache` or `--no-cache-filter` options The `--no-cache-filter` option lets you specify a specific build stage to diff --git a/content/build/cache/optimize.md b/content/manuals/build/cache/optimize.md similarity index 97% rename from content/build/cache/optimize.md rename to content/manuals/build/cache/optimize.md index 8561eb680a..d0551b6f35 100644 --- a/content/build/cache/optimize.md +++ b/content/manuals/build/cache/optimize.md @@ -361,8 +361,8 @@ speed up the build process. For more information about the concepts discussed in this guide, see: -- [.dockerignore files](/build/concepts/context.md#dockerignore-files) -- [Cache invalidation](/build/cache/invalidation.md) +- [.dockerignore files](/manuals/build/concepts/context.md#dockerignore-files) +- [Cache invalidation](/manuals/build/cache/invalidation.md) - [Cache mounts](/reference/dockerfile.md#run---mounttypecache) -- [Cache backend types](/build/cache/backends/_index.md) -- [Building best practices](/build/building/best-practices.md) +- [Cache backend types](/manuals/build/cache/backends/_index.md) +- [Building best practices](/manuals/build/building/best-practices.md) diff --git a/content/build/checks.md b/content/manuals/build/checks.md similarity index 99% rename from content/build/checks.md rename to content/manuals/build/checks.md index bd98768c96..3c4cb1b576 100644 --- a/content/build/checks.md +++ b/content/manuals/build/checks.md @@ -1,5 +1,7 @@ --- title: Checking your build configuration +linkTitle: Build checks {{< badge color="green" text="New" >}} +weight: 30 description: Learn how to use build checks to validate your build configuration. keywords: build, buildx, buildkit, checks, validate, configuration, lint --- diff --git a/content/build/ci/_index.md b/content/manuals/build/ci/_index.md similarity index 99% rename from content/build/ci/_index.md rename to content/manuals/build/ci/_index.md index c77e6f625d..5dcf36b5fc 100644 --- a/content/build/ci/_index.md +++ b/content/manuals/build/ci/_index.md @@ -1,7 +1,9 @@ --- +title: Continuous integration with Docker +linkTitle: CI +weight: 70 description: Using Docker for continuous integration keywords: ci, build -title: Continuous integration with Docker aliases: - /ci-cd/best-practices/ --- diff --git a/content/build/ci/github-actions/_index.md b/content/manuals/build/ci/github-actions/_index.md similarity index 98% rename from content/build/ci/github-actions/_index.md rename to content/manuals/build/ci/github-actions/_index.md index d11d4a7021..f9ade474f7 100644 --- a/content/build/ci/github-actions/_index.md +++ b/content/manuals/build/ci/github-actions/_index.md @@ -1,5 +1,6 @@ --- title: Introduction to GitHub Actions +linkTitle: GitHub Actions description: Docker maintains a set of official GitHub Actions for building Docker images. keywords: ci, github actions, gha, build, introduction, tutorial aliases: diff --git a/content/build/ci/github-actions/annotations.md b/content/manuals/build/ci/github-actions/annotations.md similarity index 99% rename from content/build/ci/github-actions/annotations.md rename to content/manuals/build/ci/github-actions/annotations.md index 6b922ab9eb..713c452f47 100644 --- a/content/build/ci/github-actions/annotations.md +++ b/content/manuals/build/ci/github-actions/annotations.md @@ -1,5 +1,6 @@ --- title: Add image annotations with GitHub Actions +linkTitle: Annotations description: Add OCI annotations to image components using GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, annotations, oci --- diff --git a/content/build/ci/github-actions/attestations.md b/content/manuals/build/ci/github-actions/attestations.md similarity index 97% rename from content/build/ci/github-actions/attestations.md rename to content/manuals/build/ci/github-actions/attestations.md index 918fa9c752..4e37da3df7 100644 --- a/content/build/ci/github-actions/attestations.md +++ b/content/manuals/build/ci/github-actions/attestations.md @@ -1,5 +1,6 @@ --- title: Add SBOM and provenance attestations with GitHub Actions +linkTitle: Attestations description: Add SBOM and provenance attestations to your images with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, attestations, sbom, provenance, slsa --- @@ -33,7 +34,7 @@ attestations to your image, with the following conditions: > arguments to pass secrets to your build, such as user credentials or > authentication tokens, those secrets are exposed in the provenance > attestation. Refactor your build to pass those secrets using -> [secret mounts](../../../reference/cli/docker/buildx/build.md#secret) +> [secret mounts](/reference/cli/docker/buildx/build.md#secret) > instead. Also remember to rotate any secrets you may have exposed. ## Max-level provenance diff --git a/content/build/ci/github-actions/build-summary.md b/content/manuals/build/ci/github-actions/build-summary.md similarity index 95% rename from content/build/ci/github-actions/build-summary.md rename to content/manuals/build/ci/github-actions/build-summary.md index 53504a26e4..841b486402 100644 --- a/content/build/ci/github-actions/build-summary.md +++ b/content/manuals/build/ci/github-actions/build-summary.md @@ -1,5 +1,6 @@ --- title: GitHub Actions build summary +linkTitle: Build summary descripion: Get an overview of your Docker Builds with GitHub Actions keywords: github actions, gha, build, summary, annotation --- @@ -41,7 +42,7 @@ run. The build record archive is a ZIP file containing the details about a build (or builds, if you use `docker/bake-action` to build multiple targets). You can import this build record archive into Docker Desktop, which gives you a powerful, graphical interface for further analyzing the build's performance via -the [Docker Desktop **Builds** view](../../../desktop/use-desktop/builds.md). +the [Docker Desktop **Builds** view](/manuals/desktop/use-desktop/builds.md). To import the build record archive into Docker Desktop: @@ -103,7 +104,7 @@ contain a link to download the build record archive. Build summaries are currently not supported for: -- Builds using [Docker Build Cloud](/build-cloud/_index.md). Support for Docker +- Builds using [Docker Build Cloud](/manuals/build-cloud/_index.md). Support for Docker Build Cloud is planned for a future release. - Repositories hosted on GitHub Enterprise Servers. Summaries can only be viewed for repositories hosted on GitHub.com. diff --git a/content/build/ci/github-actions/cache.md b/content/manuals/build/ci/github-actions/cache.md similarity index 99% rename from content/build/ci/github-actions/cache.md rename to content/manuals/build/ci/github-actions/cache.md index 10be7423c6..eb8d9d47d6 100644 --- a/content/build/ci/github-actions/cache.md +++ b/content/manuals/build/ci/github-actions/cache.md @@ -1,5 +1,6 @@ --- title: Cache management with GitHub Actions +linkTitle: Cache management keywords: ci, github actions, gha, buildkit, buildx, cache --- diff --git a/content/build/ci/github-actions/configure-builder.md b/content/manuals/build/ci/github-actions/configure-builder.md similarity index 87% rename from content/build/ci/github-actions/configure-builder.md rename to content/manuals/build/ci/github-actions/configure-builder.md index 0bed4fd18d..a02c83a80a 100644 --- a/content/build/ci/github-actions/configure-builder.md +++ b/content/manuals/build/ci/github-actions/configure-builder.md @@ -1,5 +1,6 @@ --- title: Configuring your GitHub Actions builder +linkTitle: BuildKit configuration description: Configuring BuildKit instances for building in CI with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx --- @@ -65,7 +66,7 @@ Logs will be available at the end of a job: ## BuildKit Daemon configuration You can provide a [BuildKit configuration](../../buildkit/toml-configuration.md) -to your builder if you're using the [`docker-container` driver](/build/builders/drivers/docker-container.md) +to your builder if you're using the [`docker-container` driver](/manuals/build/builders/drivers/docker-container.md) (default) with the `config` or `config-inline` inputs: ### Registry mirror @@ -139,13 +140,13 @@ fields: | Name | Type | Description | | ----------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | String | [Name of the node](../../../reference/cli/docker/buildx/create.md#node). If empty, it's the name of the builder it belongs to, with an index number suffix. This is useful to set it if you want to modify/remove a node in an underlying step of you workflow. | -| `endpoint` | String | [Docker context or endpoint](../../../reference/cli/docker/buildx/create.md#description) of the node to add to the builder | -| `driver-opts` | List | List of additional [driver-specific options](../../../reference/cli/docker/buildx/create.md#driver-opt) | -| `buildkitd-flags` | String | [Flags for buildkitd](../../../reference/cli/docker/buildx/create.md#buildkitd-flags) daemon | -| `platforms` | String | Fixed [platforms](../../../reference/cli/docker/buildx/create.md#platform) for the node. If not empty, values take priority over the detected ones. | +| `name` | String | [Name of the node](/reference/cli/docker/buildx/create.md#node). If empty, it's the name of the builder it belongs to, with an index number suffix. This is useful to set it if you want to modify/remove a node in an underlying step of you workflow. | +| `endpoint` | String | [Docker context or endpoint](/reference/cli/docker/buildx/create.md#description) of the node to add to the builder | +| `driver-opts` | List | List of additional [driver-specific options](/reference/cli/docker/buildx/create.md#driver-opt) | +| `buildkitd-flags` | String | [Flags for buildkitd](/reference/cli/docker/buildx/create.md#buildkitd-flags) daemon | +| `platforms` | String | Fixed [platforms](/reference/cli/docker/buildx/create.md#platform) for the node. If not empty, values take priority over the detected ones. | -Here is an example using remote nodes with the [`remote` driver](/build/builders/drivers/remote.md) +Here is an example using remote nodes with the [`remote` driver](/manuals/build/builders/drivers/remote.md) and [TLS authentication](#tls-authentication): ```yaml @@ -187,7 +188,7 @@ using SSH or TLS. ### SSH authentication -To be able to connect to an SSH endpoint using the [`docker-container` driver](/build/builders/drivers/docker-container.md), +To be able to connect to an SSH endpoint using the [`docker-container` driver](/manuals/build/builders/drivers/docker-container.md), you have to set up the SSH private key and configuration on the GitHub Runner: ```yaml @@ -215,7 +216,7 @@ jobs: ### TLS authentication -You can also [set up a remote BuildKit instance](/build/builders/drivers/remote.md#example-remote-buildkit-in-docker-container) +You can also [set up a remote BuildKit instance](/manuals/build/builders/drivers/remote.md#example-remote-buildkit-in-docker-container) using the remote driver. To ease the integration in your workflow, you can use an environment variables that sets up authentication using the BuildKit client certificates for the `tcp://`: @@ -288,7 +289,7 @@ some packages may be particularly resource-intensive to build and require more compute. Or they require a builder equipped with a particular capability or hardware. -For more information about remote builder, see [`remote` driver](/build/builders/drivers/remote.md) +For more information about remote builder, see [`remote` driver](/manuals/build/builders/drivers/remote.md) and the [append builder nodes example](#append-additional-nodes-to-the-builder). ```yaml diff --git a/content/build/ci/github-actions/copy-image-registries.md b/content/manuals/build/ci/github-actions/copy-image-registries.md similarity index 92% rename from content/build/ci/github-actions/copy-image-registries.md rename to content/manuals/build/ci/github-actions/copy-image-registries.md index 48f4970e96..b66e9f6739 100644 --- a/content/build/ci/github-actions/copy-image-registries.md +++ b/content/manuals/build/ci/github-actions/copy-image-registries.md @@ -1,11 +1,12 @@ --- title: Copy image between registries with GitHub Actions +linkTitle: Copy image between registries description: Build multi-platform images and copy them between registries with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, registry --- [Multi-platform images](../../building/multi-platform.md) built using Buildx can -be copied from one registry to another using the [`buildx imagetools create` command](../../../reference/cli/docker/buildx/imagetools/create.md): +be copied from one registry to another using the [`buildx imagetools create` command](/reference/cli/docker/buildx/imagetools/create.md): ```yaml name: ci diff --git a/content/build/ci/github-actions/export-docker.md b/content/manuals/build/ci/github-actions/export-docker.md similarity index 96% rename from content/build/ci/github-actions/export-docker.md rename to content/manuals/build/ci/github-actions/export-docker.md index 91bbdc6b63..61489e886d 100644 --- a/content/build/ci/github-actions/export-docker.md +++ b/content/manuals/build/ci/github-actions/export-docker.md @@ -1,5 +1,6 @@ --- title: Export to Docker with GitHub Actions +linkTitle: Export to Docker description: Load the build results to the image store with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, docker, export, load --- diff --git a/content/build/ci/github-actions/images/buildkit-container-logs.png b/content/manuals/build/ci/github-actions/images/buildkit-container-logs.png similarity index 100% rename from content/build/ci/github-actions/images/buildkit-container-logs.png rename to content/manuals/build/ci/github-actions/images/buildkit-container-logs.png diff --git a/content/build/ci/github-actions/local-registry.md b/content/manuals/build/ci/github-actions/local-registry.md similarity index 97% rename from content/build/ci/github-actions/local-registry.md rename to content/manuals/build/ci/github-actions/local-registry.md index d881d60132..807b7e7c32 100644 --- a/content/build/ci/github-actions/local-registry.md +++ b/content/manuals/build/ci/github-actions/local-registry.md @@ -1,5 +1,6 @@ --- title: Local registry with GitHub Actions +linkTitle: Local registry description: Create and use a local OCI registry with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, registry --- diff --git a/content/build/ci/github-actions/manage-tags-labels.md b/content/manuals/build/ci/github-actions/manage-tags-labels.md similarity index 98% rename from content/build/ci/github-actions/manage-tags-labels.md rename to content/manuals/build/ci/github-actions/manage-tags-labels.md index 8b90becef6..162536a63d 100644 --- a/content/build/ci/github-actions/manage-tags-labels.md +++ b/content/manuals/build/ci/github-actions/manage-tags-labels.md @@ -1,5 +1,6 @@ --- title: Manage tags and labels with GitHub Actions +linkTitle: Tags and labels description: Assign tags and labels to images automatically with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, tags, labels --- diff --git a/content/build/ci/github-actions/multi-platform.md b/content/manuals/build/ci/github-actions/multi-platform.md similarity index 98% rename from content/build/ci/github-actions/multi-platform.md rename to content/manuals/build/ci/github-actions/multi-platform.md index dde3ebc140..5fb013ed7e 100644 --- a/content/build/ci/github-actions/multi-platform.md +++ b/content/manuals/build/ci/github-actions/multi-platform.md @@ -1,5 +1,6 @@ --- title: Multi-platform image with GitHub Actions +linkTitle: Multi-platform image description: Build for multiple architectures with GitHub Actions using QEMU emulation or multiple native builders keywords: ci, github actions, gha, buildkit, buildx, multi-platform --- @@ -51,7 +52,7 @@ take a long time depending on the number of platforms and your Dockerfile. To solve this issue you can use a matrix strategy to distribute the build for each platform across multiple runners and create manifest list using the -[`buildx imagetools create` command](../../../reference/cli/docker/buildx/imagetools/create.md). +[`buildx imagetools create` command](/reference/cli/docker/buildx/imagetools/create.md). The following workflow will build the image for each platform on a dedicated runner using a matrix strategy and push by digest. Then, the `merge` job will diff --git a/content/build/ci/github-actions/named-contexts.md b/content/manuals/build/ci/github-actions/named-contexts.md similarity index 96% rename from content/build/ci/github-actions/named-contexts.md rename to content/manuals/build/ci/github-actions/named-contexts.md index 253548e0d9..fe81c03e07 100644 --- a/content/build/ci/github-actions/named-contexts.md +++ b/content/manuals/build/ci/github-actions/named-contexts.md @@ -1,10 +1,11 @@ --- title: Named contexts with GitHub Actions +linkTitle: Named contexts description: Use additional contexts in multi-stage builds with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, context --- -You can define [additional build contexts](../../../reference/cli/docker/buildx/build.md#build-context), +You can define [additional build contexts](/reference/cli/docker/buildx/build.md#build-context), and access them in your Dockerfile with `FROM name` or `--from=name`. When Dockerfile defines a stage with the same name it's overwritten. diff --git a/content/build/ci/github-actions/push-multi-registries.md b/content/manuals/build/ci/github-actions/push-multi-registries.md similarity index 97% rename from content/build/ci/github-actions/push-multi-registries.md rename to content/manuals/build/ci/github-actions/push-multi-registries.md index 860eb64fe2..5b2cb4c184 100644 --- a/content/build/ci/github-actions/push-multi-registries.md +++ b/content/manuals/build/ci/github-actions/push-multi-registries.md @@ -1,5 +1,6 @@ --- title: Push to multiple registries with GitHub Actions +linkTitle: Push to multiple registries description: Push to multiple registries with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, registry --- diff --git a/content/build/ci/github-actions/reproducible-builds.md b/content/manuals/build/ci/github-actions/reproducible-builds.md similarity index 99% rename from content/build/ci/github-actions/reproducible-builds.md rename to content/manuals/build/ci/github-actions/reproducible-builds.md index 86b9399283..a88cc019f6 100644 --- a/content/build/ci/github-actions/reproducible-builds.md +++ b/content/manuals/build/ci/github-actions/reproducible-builds.md @@ -1,5 +1,6 @@ --- title: Reproducible builds with GitHub Actions +linkTitle: Reproducible builds description: How to create reproducible builds in GitHub Actions using the SOURCE_EPOCH environment variable keywords: build, buildx, github actions, ci, gha, reproducible builds, SOURCE_DATE_EPOCH --- diff --git a/content/build/ci/github-actions/secrets.md b/content/manuals/build/ci/github-actions/secrets.md similarity index 99% rename from content/build/ci/github-actions/secrets.md rename to content/manuals/build/ci/github-actions/secrets.md index 0dda2551ea..4d08136f7a 100644 --- a/content/build/ci/github-actions/secrets.md +++ b/content/manuals/build/ci/github-actions/secrets.md @@ -1,5 +1,6 @@ --- title: Using secrets with GitHub Actions +linkTitle: Build secrets description: Example using secret mounts with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, secret tags: [Secrets] diff --git a/content/build/ci/github-actions/share-image-jobs.md b/content/manuals/build/ci/github-actions/share-image-jobs.md similarity index 97% rename from content/build/ci/github-actions/share-image-jobs.md rename to content/manuals/build/ci/github-actions/share-image-jobs.md index 3a2566aa4b..995dd08a89 100644 --- a/content/build/ci/github-actions/share-image-jobs.md +++ b/content/manuals/build/ci/github-actions/share-image-jobs.md @@ -1,5 +1,6 @@ --- title: Share built image between jobs with GitHub Actions +linkTitle: Share image between jobs description: Share an image between runners without pushing to a registry keywords: ci, github actions, gha, buildkit, buildx --- diff --git a/content/build/ci/github-actions/test-before-push.md b/content/manuals/build/ci/github-actions/test-before-push.md similarity index 98% rename from content/build/ci/github-actions/test-before-push.md rename to content/manuals/build/ci/github-actions/test-before-push.md index a780e45cf0..064f45665c 100644 --- a/content/build/ci/github-actions/test-before-push.md +++ b/content/manuals/build/ci/github-actions/test-before-push.md @@ -1,5 +1,6 @@ --- title: Test before push with GitHub Actions +linkTitle: Test before push description: Here's how you can validate an image, before pushing it to a registry keywords: ci, github actions, gha, buildkit, buildx, test --- diff --git a/content/build/ci/github-actions/update-dockerhub-desc.md b/content/manuals/build/ci/github-actions/update-dockerhub-desc.md similarity index 96% rename from content/build/ci/github-actions/update-dockerhub-desc.md rename to content/manuals/build/ci/github-actions/update-dockerhub-desc.md index 8ee4e36126..04ed5cc3a6 100644 --- a/content/build/ci/github-actions/update-dockerhub-desc.md +++ b/content/manuals/build/ci/github-actions/update-dockerhub-desc.md @@ -1,5 +1,6 @@ --- title: Update Docker Hub description with GitHub Actions +linkTitle: Update Docker Hub description description: How to update the repository README in Docker Hub using with GitHub Actions keywords: ci, github actions, gha, buildkit, buildx, docker hub --- diff --git a/content/build/ci/images/build_summary_error.png b/content/manuals/build/ci/images/build_summary_error.png similarity index 100% rename from content/build/ci/images/build_summary_error.png rename to content/manuals/build/ci/images/build_summary_error.png diff --git a/content/build/ci/images/continuous-integration.svg b/content/manuals/build/ci/images/continuous-integration.svg similarity index 100% rename from content/build/ci/images/continuous-integration.svg rename to content/manuals/build/ci/images/continuous-integration.svg diff --git a/content/build/ci/images/gha_build_summary.png b/content/manuals/build/ci/images/gha_build_summary.png similarity index 100% rename from content/build/ci/images/gha_build_summary.png rename to content/manuals/build/ci/images/gha_build_summary.png diff --git a/content/manuals/build/concepts/_index.md b/content/manuals/build/concepts/_index.md new file mode 100644 index 0000000000..caa8fc9bd3 --- /dev/null +++ b/content/manuals/build/concepts/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Core concepts +weight: 10 +--- diff --git a/content/build/concepts/context.md b/content/manuals/build/concepts/context.md similarity index 98% rename from content/build/concepts/context.md rename to content/manuals/build/concepts/context.md index 2402129c29..cb5a41c4d4 100644 --- a/content/build/concepts/context.md +++ b/content/manuals/build/concepts/context.md @@ -1,5 +1,6 @@ --- title: Build context +weight: 30 description: Learn how to use the build context to access files from your Dockerfile keywords: build, buildx, buildkit, context, git, tarball, stdin aliases: @@ -7,7 +8,7 @@ aliases: --- The `docker build` and `docker buildx build` commands build Docker images from -a [Dockerfile](../../reference/dockerfile.md) and a context. +a [Dockerfile](/reference/dockerfile.md) and a context. ## What is a build context? @@ -248,7 +249,7 @@ docker build github.com/docker/buildx#d4f088e By default, BuildKit doesn't keep the `.git` directory when using Git contexts. You can configure BuildKit to keep the directory by setting the -[`BUILDKIT_CONTEXT_KEEP_GIT_DIR` build argument](../../reference/dockerfile.md#buildkit-built-in-build-args). +[`BUILDKIT_CONTEXT_KEEP_GIT_DIR` build argument](/reference/dockerfile.md#buildkit-built-in-build-args). This can be useful to if you want to retrieve Git information during your build: ```dockerfile @@ -274,7 +275,7 @@ either SSH or token-based authentication. Buildx automatically detects and uses SSH credentials if the Git context you specify is an SSH or Git address. By default, this uses `$SSH_AUTH_SOCK`. You can configure the SSH credentials to use with the -[`--ssh` flag](../../reference/cli/docker/buildx/build.md#ssh). +[`--ssh` flag](/reference/cli/docker/buildx/build.md#ssh). ```console $ docker buildx build --ssh default git@github.com:user/private.git @@ -282,7 +283,7 @@ $ docker buildx build --ssh default git@github.com:user/private.git If you want to use token-based authentication instead, you can pass the token using the -[`--secret` flag](../../reference/cli/docker/buildx/build.md#secret). +[`--secret` flag](/reference/cli/docker/buildx/build.md#secret). ```console $ GIT_AUTH_TOKEN= docker buildx build \ diff --git a/content/build/concepts/dockerfile.md b/content/manuals/build/concepts/dockerfile.md similarity index 82% rename from content/build/concepts/dockerfile.md rename to content/manuals/build/concepts/dockerfile.md index b4af64897a..7643d3a22a 100644 --- a/content/build/concepts/dockerfile.md +++ b/content/manuals/build/concepts/dockerfile.md @@ -1,5 +1,6 @@ --- title: Dockerfile overview +weight: 20 description: Learn about Dockerfiles and how to use them with Docker Images to build and package your software keywords: build, buildx, buildkit, getting started, dockerfile aliases: @@ -14,17 +15,17 @@ It all starts with a Dockerfile. Docker builds images by reading the instructions from a Dockerfile. A Dockerfile is a text file containing instructions for building your source code. The Dockerfile instruction syntax is defined by the specification -reference in the [Dockerfile reference](../../reference/dockerfile.md). +reference in the [Dockerfile reference](/reference/dockerfile.md). Here are the most common types of instructions: | Instruction | Description | | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`FROM `](../../reference/dockerfile.md#from) | Defines a base for your image. | -| [`RUN `](../../reference/dockerfile.md#run) | Executes any commands in a new layer on top of the current image and commits the result. `RUN` also has a shell form for running commands. | -| [`WORKDIR `](../../reference/dockerfile.md#workdir) | Sets the working directory for any `RUN`, `CMD`, `ENTRYPOINT`, `COPY`, and `ADD` instructions that follow it in the Dockerfile. | -| [`COPY `](../../reference/dockerfile.md#copy) | Copies new files or directories from `` and adds them to the filesystem of the container at the path ``. | -| [`CMD `](../../reference/dockerfile.md#cmd) | Lets you define the default program that is run once you start the container based on this image. Each Dockerfile only has one `CMD`, and only the last `CMD` instance is respected when multiple exist. | +| [`FROM `](/reference/dockerfile.md#from) | Defines a base for your image. | +| [`RUN `](/reference/dockerfile.md#run) | Executes any commands in a new layer on top of the current image and commits the result. `RUN` also has a shell form for running commands. | +| [`WORKDIR `](/reference/dockerfile.md#workdir) | Sets the working directory for any `RUN`, `CMD`, `ENTRYPOINT`, `COPY`, and `ADD` instructions that follow it in the Dockerfile. | +| [`COPY `](/reference/dockerfile.md#copy) | Copies new files or directories from `` and adds them to the filesystem of the container at the path ``. | +| [`CMD `](/reference/dockerfile.md#cmd) | Lets you define the default program that is run once you start the container based on this image. Each Dockerfile only has one `CMD`, and only the last `CMD` instance is respected when multiple exist. | Dockerfiles are crucial inputs for image builds and can facilitate automated, multi-layer image builds based on your unique configurations. Dockerfiles can @@ -40,7 +41,7 @@ Some projects may need distinct Dockerfiles for specific purposes. A common convention is to name these `.Dockerfile`. You can specify the Dockerfile filename using the `--file` flag for the `docker build` command. Refer to the -[`docker build` CLI reference](../../reference/cli/docker/buildx/build.md#file) +[`docker build` CLI reference](/reference/cli/docker/buildx/build.md#file) to learn about the `--file` flag. > [!NOTE] @@ -111,11 +112,11 @@ Here's a breakdown of what this Dockerfile does: ### Dockerfile syntax -The first line to add to a Dockerfile is a [`# syntax` parser directive](../../reference/dockerfile.md#syntax). +The first line to add to a Dockerfile is a [`# syntax` parser directive](/reference/dockerfile.md#syntax). While optional, this directive instructs the Docker builder what syntax to use when parsing the Dockerfile, and allows older Docker versions with [BuildKit enabled](../buildkit/index.md#getting-started) to use a specific [Dockerfile frontend](../buildkit/frontend.md) before -starting the build. [Parser directives](../../reference/dockerfile.md#parser-directives) +starting the build. [Parser directives](/reference/dockerfile.md#parser-directives) must appear before any other comment, whitespace, or Dockerfile instruction in your Dockerfile, and should be the first line in Dockerfiles. @@ -137,7 +138,7 @@ The line following the syntax directive defines what base image to use: FROM ubuntu:22.04 ``` -The [`FROM` instruction](../../reference/dockerfile.md#from) sets your base +The [`FROM` instruction](/reference/dockerfile.md#from) sets your base image to the 22.04 release of Ubuntu. All instructions that follow are executed in this base image: an Ubuntu environment. The notation `ubuntu:22.04`, follows the `name:tag` standard for naming Docker images. When you build images, you @@ -157,7 +158,7 @@ The following line executes a build command inside the base image. RUN apt-get update && apt-get install -y python3 python3-pip ``` -This [`RUN` instruction](../../reference/dockerfile.md#run) executes a +This [`RUN` instruction](/reference/dockerfile.md#run) executes a shell in Ubuntu that updates the APT package index and installs Python tools in the container. @@ -192,7 +193,7 @@ use the command to install the flask web framework. ### Copying files The next instruction uses the -[`COPY` instruction](../../reference/dockerfile.md#copy) to copy the +[`COPY` instruction](/reference/dockerfile.md#copy) to copy the `hello.py` file from the local build context into the root directory of our image. ```dockerfile @@ -208,7 +209,7 @@ of the build container. ### Setting environment variables If your application uses environment variables, you can set environment variables -in your Docker build using the [`ENV` instruction](../../reference/dockerfile.md#env). +in your Docker build using the [`ENV` instruction](/reference/dockerfile.md#env). ```dockerfile ENV FLASK_APP=hello @@ -220,7 +221,7 @@ flask wouldn't know where to find our application to be able to run it. ### Exposed ports -The [`EXPOSE` instruction](../../reference/dockerfile.md#expose) marks that +The [`EXPOSE` instruction](/reference/dockerfile.md#expose) marks that our final image has a service listening on port `8000`. ```dockerfile @@ -232,7 +233,7 @@ team members understand what this application is doing. ### Starting the application -Finally, [`CMD` instruction](../../reference/dockerfile.md#cmd) sets the +Finally, [`CMD` instruction](/reference/dockerfile.md#cmd) sets the command that is run when the user starts a container based on this image. ```dockerfile @@ -250,7 +251,7 @@ CMD flask run --host 0.0.0.0 --port 8000 There are subtle differences between these two versions, for example in how they trap signals like `SIGTERM` and `SIGKILL`. For more information about these differences, see -[Shell and exec form](../../reference/dockerfile.md#shell-and-exec-form) +[Shell and exec form](/reference/dockerfile.md#shell-and-exec-form) ## Building diff --git a/content/build/concepts/overview.md b/content/manuals/build/concepts/overview.md similarity index 96% rename from content/build/concepts/overview.md rename to content/manuals/build/concepts/overview.md index bda815578b..8b30d38540 100644 --- a/content/build/concepts/overview.md +++ b/content/manuals/build/concepts/overview.md @@ -1,5 +1,6 @@ --- title: Docker Build Overview +weight: 10 description: Learn about Docker Build and its components. keywords: build, buildkit, buildx, architecture aliases: @@ -69,4 +70,4 @@ Examples of resources that BuildKit can request from Buildx include: - SSH sockets - Registry authentication tokens -For more information about BuildKit, see [BuildKit](/build/buildkit/_index.md). +For more information about BuildKit, see [BuildKit](/manuals/build/buildkit/_index.md). diff --git a/content/manuals/build/debug/_index.md b/content/manuals/build/debug/_index.md new file mode 100644 index 0000000000..b3e7f5b081 --- /dev/null +++ b/content/manuals/build/debug/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Debugging +weight: 110 +--- diff --git a/content/build/debug/opentelemetry.md b/content/manuals/build/debug/opentelemetry.md similarity index 91% rename from content/build/debug/opentelemetry.md rename to content/manuals/build/debug/opentelemetry.md index 5f891de723..575d8fc157 100644 --- a/content/build/debug/opentelemetry.md +++ b/content/manuals/build/debug/opentelemetry.md @@ -18,7 +18,7 @@ First create a Jaeger container: $ docker run -d --name jaeger -p "6831:6831/udp" -p "16686:16686" --restart unless-stopped jaegertracing/all-in-one ``` -Then [create a `docker-container` builder](/build/builders/drivers/docker-container.md) +Then [create a `docker-container` builder](/manuals/build/builders/drivers/docker-container.md) that will use the Jaeger instance via the `JAEGER_TRACE` environment variable: ```console diff --git a/content/build/exporters/_index.md b/content/manuals/build/exporters/_index.md similarity index 98% rename from content/build/exporters/_index.md rename to content/manuals/build/exporters/_index.md index df3c1fb3f3..e5dc78fbc0 100644 --- a/content/build/exporters/_index.md +++ b/content/manuals/build/exporters/_index.md @@ -1,5 +1,7 @@ --- title: Exporters overview +linkTitle: Exporters +weight: 90 description: Build exporters define the output format of your build result keywords: build, buildx, buildkit, exporter, image, registry, local, tar, oci, docker, cacheonly aliases: @@ -8,7 +10,7 @@ aliases: Exporters save your build results to a specified output type. You specify the exporter to use with the -[`--output` CLI option](../../reference/cli/docker/buildx/build.md#output). +[`--output` CLI option](/reference/cli/docker/buildx/build.md#output). Buildx supports the following exporters: - `image`: exports the build result to a container image. diff --git a/content/build/exporters/image-registry.md b/content/manuals/build/exporters/image-registry.md similarity index 100% rename from content/build/exporters/image-registry.md rename to content/manuals/build/exporters/image-registry.md diff --git a/content/build/exporters/local-tar.md b/content/manuals/build/exporters/local-tar.md similarity index 100% rename from content/build/exporters/local-tar.md rename to content/manuals/build/exporters/local-tar.md diff --git a/content/build/exporters/oci-docker.md b/content/manuals/build/exporters/oci-docker.md similarity index 97% rename from content/build/exporters/oci-docker.md rename to content/manuals/build/exporters/oci-docker.md index 68707e8adc..fdd49b550b 100644 --- a/content/build/exporters/oci-docker.md +++ b/content/manuals/build/exporters/oci-docker.md @@ -12,7 +12,7 @@ The `oci` exporter outputs the build result into an tarball. The `docker` exporter behaves the same way, except it exports a Docker image layout instead. -The [`docker` driver](/build/builders/drivers/docker.md) doesn't support these exporters. You +The [`docker` driver](/manuals/build/builders/drivers/docker.md) doesn't support these exporters. You must use `docker-container` or some other driver if you want to generate these outputs. diff --git a/content/build/images/build-variables.svg b/content/manuals/build/images/build-variables.svg similarity index 100% rename from content/build/images/build-variables.svg rename to content/manuals/build/images/build-variables.svg diff --git a/content/build/images/build_summary_error.png b/content/manuals/build/images/build_summary_error.png similarity index 100% rename from content/build/images/build_summary_error.png rename to content/manuals/build/images/build_summary_error.png diff --git a/content/build/images/buildkit-dag.svg b/content/manuals/build/images/buildkit-dag.svg similarity index 100% rename from content/build/images/buildkit-dag.svg rename to content/manuals/build/images/buildkit-dag.svg diff --git a/content/build/images/cache-stack-invalidate-copy.dot b/content/manuals/build/images/cache-stack-invalidate-copy.dot similarity index 100% rename from content/build/images/cache-stack-invalidate-copy.dot rename to content/manuals/build/images/cache-stack-invalidate-copy.dot diff --git a/content/build/images/cache-stack-invalidate-rest.dot b/content/manuals/build/images/cache-stack-invalidate-rest.dot similarity index 100% rename from content/build/images/cache-stack-invalidate-rest.dot rename to content/manuals/build/images/cache-stack-invalidate-rest.dot diff --git a/content/build/images/cache-stack-invalidated.png b/content/manuals/build/images/cache-stack-invalidated.png similarity index 100% rename from content/build/images/cache-stack-invalidated.png rename to content/manuals/build/images/cache-stack-invalidated.png diff --git a/content/build/images/cache-stack.dot b/content/manuals/build/images/cache-stack.dot similarity index 100% rename from content/build/images/cache-stack.dot rename to content/manuals/build/images/cache-stack.dot diff --git a/content/build/images/cache-stack.png b/content/manuals/build/images/cache-stack.png similarity index 100% rename from content/build/images/cache-stack.png rename to content/manuals/build/images/cache-stack.png diff --git a/content/build/images/cache-stack.svg b/content/manuals/build/images/cache-stack.svg similarity index 100% rename from content/build/images/cache-stack.svg rename to content/manuals/build/images/cache-stack.svg diff --git a/content/build/images/cache.excalidraw b/content/manuals/build/images/cache.excalidraw similarity index 100% rename from content/build/images/cache.excalidraw rename to content/manuals/build/images/cache.excalidraw diff --git a/content/build/images/continuous-integration.svg b/content/manuals/build/images/continuous-integration.svg similarity index 100% rename from content/build/images/continuous-integration.svg rename to content/manuals/build/images/continuous-integration.svg diff --git a/content/build/images/gha-check-annotations.png b/content/manuals/build/images/gha-check-annotations.png similarity index 100% rename from content/build/images/gha-check-annotations.png rename to content/manuals/build/images/gha-check-annotations.png diff --git a/content/build/images/gha_build_summary.png b/content/manuals/build/images/gha_build_summary.png similarity index 100% rename from content/build/images/gha_build_summary.png rename to content/manuals/build/images/gha_build_summary.png diff --git a/content/build/images/hub-official-images.webp b/content/manuals/build/images/hub-official-images.webp similarity index 100% rename from content/build/images/hub-official-images.webp rename to content/manuals/build/images/hub-official-images.webp diff --git a/content/build/images/opentelemetry.png b/content/manuals/build/images/opentelemetry.png similarity index 100% rename from content/build/images/opentelemetry.png rename to content/manuals/build/images/opentelemetry.png diff --git a/content/build/images/set-default-builder-gui.webp b/content/manuals/build/images/set-default-builder-gui.webp similarity index 100% rename from content/build/images/set-default-builder-gui.webp rename to content/manuals/build/images/set-default-builder-gui.webp diff --git a/content/build/images/single-vs-multiplatform-image.svg b/content/manuals/build/images/single-vs-multiplatform-image.svg similarity index 100% rename from content/build/images/single-vs-multiplatform-image.svg rename to content/manuals/build/images/single-vs-multiplatform-image.svg diff --git a/content/manuals/build/metadata/_index.md b/content/manuals/build/metadata/_index.md new file mode 100644 index 0000000000..05370d42dd --- /dev/null +++ b/content/manuals/build/metadata/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Metadata +weight: 80 +--- diff --git a/content/build/metadata/annotations.md b/content/manuals/build/metadata/annotations.md similarity index 93% rename from content/build/metadata/annotations.md rename to content/manuals/build/metadata/annotations.md index 7a881047ad..910ce96f9d 100644 --- a/content/build/metadata/annotations.md +++ b/content/manuals/build/metadata/annotations.md @@ -43,7 +43,7 @@ manifest or index. > The Docker Engine image store doesn't support loading images with > annotations. To build with annotations, make sure to push the image directly > to a registry, using the `--push` CLI flag or the -> [registry exporter](/build/exporters/image-registry.md). +> [registry exporter](/manuals/build/exporters/image-registry.md). To specify annotations on the command line, use the `--annotation` flag for the `docker build` command: @@ -52,7 +52,7 @@ To specify annotations on the command line, use the `--annotation` flag for the $ docker build --push --annotation "foo=bar" . ``` -If you're using [Bake](/build/bake/_index.md), you can use the `annotations` +If you're using [Bake](/manuals/build/bake/_index.md), you can use the `annotations` attribute to specify annotations for a given target: ```hcl @@ -63,7 +63,7 @@ target "default" { ``` For examples on how to add annotations to images built with GitHub Actions, see -[Add image annotations with GitHub Actions](/build/ci/github-actions/annotations.md) +[Add image annotations with GitHub Actions](/manuals/build/ci/github-actions/annotations.md) You can also add annotations to an image created using `docker buildx imagetools create`. This command only supports adding annotations to an index @@ -197,21 +197,21 @@ $ docker build --tag --push --annotation "manifest[linux/amd64]:foo=bar" Related articles: -- [Add image annotations with GitHub Actions](/build/ci/github-actions/annotations.md) +- [Add image annotations with GitHub Actions](/manuals/build/ci/github-actions/annotations.md) - [Annotations OCI specification][specification] Reference information: - [`docker buildx build --annotation`](/reference/cli/docker/buildx/build.md#annotation) -- [Bake file reference: `annotations`](/build/bake/reference.md#targetannotations) +- [Bake file reference: `annotations`](/manuals/build/bake/reference.md#targetannotations) - [`docker buildx imagetools create --annotation`](/reference/cli/docker/buildx/imagetools/create.md#annotation) [specification]: https://github.com/opencontainers/image-spec/blob/main/annotations.md -[attestations]: /build/metadata/attestations/_index.md +[attestations]: /manuals/build/metadata/attestations/_index.md [config]: https://github.com/opencontainers/image-spec/blob/main/config.md [descriptors]: https://github.com/opencontainers/image-spec/blob/main/descriptor.md [indexes]: https://github.com/opencontainers/image-spec/blob/main/image-index.md -[labels]: /engine/manage-resources/labels.md +[labels]: /manuals/engine/manage-resources/labels.md [manifests]: https://github.com/opencontainers/image-spec/blob/main/manifest.md diff --git a/content/build/metadata/attestations/_index.md b/content/manuals/build/metadata/attestations/_index.md similarity index 96% rename from content/build/metadata/attestations/_index.md rename to content/manuals/build/metadata/attestations/_index.md index e763f465ca..84ccfac5c0 100644 --- a/content/build/metadata/attestations/_index.md +++ b/content/manuals/build/metadata/attestations/_index.md @@ -60,13 +60,13 @@ $ docker buildx build --sbom=true --provenance=true . > > - Use a `docker-container` driver with the `--push` flag to push the image to > a registry directly. -> - Enable the [containerd image store](/desktop/containerd.md). +> - Enable the [containerd image store](/manuals/desktop/containerd.md). > [!NOTE] > > Provenance attestations are enabled by default, with the `mode=min` option. > You can disable provenance attestations using the `--provenance=false` flag, -> or by setting the [`BUILDX_NO_DEFAULT_ATTESTATIONS`](/build/building/variables.md#buildx_no_default_attestations) environment variable. +> or by setting the [`BUILDX_NO_DEFAULT_ATTESTATIONS`](/manuals/build/building/variables.md#buildx_no_default_attestations) environment variable. > > Using the `--provenance=true` flag attaches provenance attestations with `mode=max` > by default. See [Provenance attestation](./slsa-provenance.md) for more details. diff --git a/content/build/metadata/attestations/sbom.md b/content/manuals/build/metadata/attestations/sbom.md similarity index 97% rename from content/build/metadata/attestations/sbom.md rename to content/manuals/build/metadata/attestations/sbom.md index 6d8fb860af..ffbd535431 100644 --- a/content/build/metadata/attestations/sbom.md +++ b/content/manuals/build/metadata/attestations/sbom.md @@ -40,7 +40,7 @@ $ docker buildx build --tag /: \ Alternatively, you can use the shorthand `--sbom=true` option instead of `--attest type=sbom`. For an example on how to add SBOM attestations with GitHub Actions, see -[Add attestations with GitHub Actions](/build/ci/github-actions/attestations.md). +[Add attestations with GitHub Actions](/manuals/build/ci/github-actions/attestations.md). ## Verify SBOM attestations @@ -71,7 +71,7 @@ exist in the build context. This may cause you to overlook vulnerabilities in those dependencies, which could impact the security of your final build artifacts. -For instance, you might use [multi-stage builds](/build/building/multi-stage.md), +For instance, you might use [multi-stage builds](/manuals/build/building/multi-stage.md), with a `FROM scratch` stanza for your final stage to achieve a smaller image size. ```dockerfile @@ -227,7 +227,7 @@ $ docker buildx build --attest type=sbom,generator= . > [!TIP] > > The Docker Scout SBOM generator is available. See -> [Docker Scout SBOMs](/scout/how-tos/view-create-sboms.md). +> [Docker Scout SBOMs](/manuals/scout/how-tos/view-create-sboms.md). ## SBOM attestation example diff --git a/content/build/metadata/attestations/slsa-provenance.md b/content/manuals/build/metadata/attestations/slsa-provenance.md similarity index 99% rename from content/build/metadata/attestations/slsa-provenance.md rename to content/manuals/build/metadata/attestations/slsa-provenance.md index 761beb586b..f3add2da14 100644 --- a/content/build/metadata/attestations/slsa-provenance.md +++ b/content/manuals/build/metadata/attestations/slsa-provenance.md @@ -36,7 +36,7 @@ Alternatively, you can use the shorthand `--provenance=true` option instead of ` To specify the `mode` parameter using the shorthand option, use: `--provenance=mode=max`. For an example on how to add provenance attestations with GitHub Actions, see -[Add attestations with GitHub Actions](/build/ci/github-actions/attestations.md). +[Add attestations with GitHub Actions](/manuals/build/ci/github-actions/attestations.md). ## Mode diff --git a/content/build/release-notes.md b/content/manuals/build/release-notes.md similarity index 98% rename from content/build/release-notes.md rename to content/manuals/build/release-notes.md index 932fbe7708..8ef6281344 100644 --- a/content/build/release-notes.md +++ b/content/manuals/build/release-notes.md @@ -1,5 +1,6 @@ --- title: Build release notes +weight: 120 description: Learn about the new features, bug fixes, and breaking changes for the newest Buildx release keywords: build, buildx, buildkit, release notes tags: [Release notes] @@ -91,12 +92,12 @@ The full release note for this release is available In addition to the default `build` method, the following methods are implemented by Dockerfile frontend: - - [`--call=check`](/reference/cli/docker/buildx/build.md#check): Run validation routines for your build configuration. For more information about build checks, see [Build checks](/build/checks.md) + - [`--call=check`](/reference/cli/docker/buildx/build.md#check): Run validation routines for your build configuration. For more information about build checks, see [Build checks](/manuals/build/checks.md) - [`--call=outline`](/reference/cli/docker/buildx/build.md#call-outline): Show configuration that would be used by current build, including all build arguments, secrets, SSH mounts, etc., that your build would use. - [`--call=targets`](/reference/cli/docker/buildx/build.md#call-targets): Show all available targets and their descriptions. - New `--prefer-index` flag has been added to the `docker buildx imagetools create` command to control the behavior of creating image out of one single-platform image manifest. [docker/buildx#2482](https://github.com/docker/buildx/pull/2482/) -- The [`kubernetes` driver](/build/builders/drivers/kubernetes.md) now supports a `timeout` option for configuring deployment timeout. [docker/buildx#2492](https://github.com/docker/buildx/pull/2492/) +- The [`kubernetes` driver](/manuals/build/builders/drivers/kubernetes.md) now supports a `timeout` option for configuring deployment timeout. [docker/buildx#2492](https://github.com/docker/buildx/pull/2492/) - New metrics definitions have been added for build warning types. [docker/buildx#2482](https://github.com/docker/buildx/pull/2482/), [docker/buildx#2507](https://github.com/docker/buildx/pull/2507/) - The [`buildx prune`](/reference/cli/docker/buildx/prune.md) and [`buildx du`](/reference/cli/docker/buildx/du.md) commands now support negative and prefix filters. [docker/buildx#2473](https://github.com/docker/buildx/pull/2473/) - Building Compose files with Bake now supports passing SSH forwarding configuration. [docker/buildx#2445](https://github.com/docker/buildx/pull/2445/) @@ -127,7 +128,7 @@ The full release note for this release is available [docker/buildx#2363](https://github.com/docker/buildx/pull/2363) - New `default-load` driver option for the `docker-container`, `remote`, and `kubernetes` drivers to load build results to the Docker Engine image store by default. [docker/buildx#2259](https://github.com/docker/buildx/pull/2259) -- Add `requests.ephemeral-storage`, `limits.ephemeral-storage` and `schedulername` options to the [`kubernetes` driver](/build/builders/drivers/kubernetes.md). +- Add `requests.ephemeral-storage`, `limits.ephemeral-storage` and `schedulername` options to the [`kubernetes` driver](/manuals/build/builders/drivers/kubernetes.md). [docker/buildx#2370](https://github.com/docker/buildx/pull/2370), [docker/buildx#2415](https://github.com/docker/buildx/pull/2415) - Add `indexof` function for `docker-bake.hcl` files. @@ -355,7 +356,7 @@ The full release note for this release is available ### New -- Bake now supports [matrix builds](../build/bake/reference.md#targetmatrix). +- Bake now supports [matrix builds](/manuals/build/bake/reference.md#targetmatrix). The new matrix field on `target` lets you create multiple similar targets to remove duplication in bake files. [docker/buildx#1690](https://github.com/docker/buildx/pull/1690) - New experimental `--detach` flag for running builds in detached mode. @@ -494,8 +495,8 @@ The full release note for this release is available shorthands `--sbom` and `--provenance`, for adding attestations for your current build. [docker/buildx#1412](https://github.com/docker/buildx/issues/1412) [docker/buildx#1475](https://github.com/docker/buildx/issues/1475) - - `--attest type=sbom` or `--sbom=true` adds [SBOM attestations](/build/metadata/attestations/sbom.md). - - `--attest type=provenance` or `--provenance=true` adds [SLSA provenance attestation](/build/metadata/attestations/slsa-provenance.md). + - `--attest type=sbom` or `--sbom=true` adds [SBOM attestations](/manuals/build/metadata/attestations/sbom.md). + - `--attest type=provenance` or `--provenance=true` adds [SLSA provenance attestation](/manuals/build/metadata/attestations/slsa-provenance.md). - When creating OCI images, a minimal provenance attestation is included with the image by default. - When building with BuildKit that supports provenance attestations Buildx will @@ -524,7 +525,7 @@ The full release note for this release is available - Bake definition now supports null values for [variables](bake/reference.md#variable) and [labels](bake/reference.md#targetlabels) for build arguments and labels to use the defaults set in the Dockerfile. [docker/buildx#1449](https://github.com/docker/buildx/issues/1449) -- The [`buildx imagetools inspect` command](../reference/cli/docker/buildx/imagetools/inspect.md) +- The [`buildx imagetools inspect` command](/reference/cli/docker/buildx/imagetools/inspect.md) now supports showing SBOM and Provenance data. [docker/buildx#1444](https://github.com/docker/buildx/issues/1444), [docker/buildx#1498](https://github.com/docker/buildx/issues/1498) @@ -533,7 +534,7 @@ The full release note for this release is available [docker/buildx#1454](https://github.com/docker/buildx/issues/1454), [docker/buildx#1455](https://github.com/docker/buildx/issues/1455), [docker/buildx#1345](https://github.com/docker/buildx/issues/1345) -- Adding extra hosts with [Docker driver](/build/builders/drivers/docker.md) now supports +- Adding extra hosts with [Docker driver](/manuals/build/builders/drivers/docker.md) now supports Docker-specific `host-gateway` special value. [docker/buildx#1446](https://github.com/docker/buildx/issues/1446) - [OCI exporter](exporters/oci-docker.md) now supports `tar=false` option for exporting OCI format directly in a directory. [docker/buildx#1420](https://github.com/docker/buildx/issues/1420) @@ -575,7 +576,7 @@ For more details, see the complete release notes in the [Buildx GitHub repositor ### New -- Support for a new [`remote` driver](/build/builders/drivers/remote.md) that you can use +- Support for a new [`remote` driver](/manuals/build/builders/drivers/remote.md) that you can use to connect to any already running BuildKit instance. [docker/buildx#1078](https://github.com/docker/buildx/issues/1078), [docker/buildx#1093](https://github.com/docker/buildx/issues/1093), @@ -586,7 +587,7 @@ For more details, see the complete release notes in the [Buildx GitHub repositor - You can now load Dockerfile from standard input even when the build context is coming from external Git or HTTP URL. [docker/buildx#994](https://github.com/docker/buildx/issues/994) - Build commands now support new the build context type `oci-layout://` for loading - [build context from local OCI layout directories](../reference/cli/docker/buildx/build.md#source-oci-layout). + [build context from local OCI layout directories](/reference/cli/docker/buildx/build.md#source-oci-layout). Note that this feature depends on an unreleased BuildKit feature and builder instance from `moby/buildkit:master` needs to be used until BuildKit v0.11 is released. [docker/buildx#1173](https://github.com/docker/buildx/issues/1173) diff --git a/content/cloud/_index.md b/content/manuals/cloud/index.md similarity index 100% rename from content/cloud/_index.md rename to content/manuals/cloud/index.md diff --git a/content/compose/_index.md b/content/manuals/compose/_index.md similarity index 98% rename from content/compose/_index.md rename to content/manuals/compose/_index.md index 144b89cac8..0e649f37f5 100644 --- a/content/compose/_index.md +++ b/content/manuals/compose/_index.md @@ -1,10 +1,12 @@ --- +title: Docker Compose overview +linkTitle: Docker Compose +weight: 100 description: Learn how to use Docker Compose to define and run multi-container applications with this detailed introduction to the tool. keywords: docker compose, docker-compose, docker compose command, docker compose files, docker compose documentation, using docker compose, compose container, docker compose service -title: Docker Compose overview grid: - title: Why use Compose? description: Understand Docker Compose's key benefits diff --git a/content/compose/bridge/_index.md b/content/manuals/compose/bridge/_index.md similarity index 98% rename from content/compose/bridge/_index.md rename to content/manuals/compose/bridge/_index.md index 015c91ce05..1f5d12cae5 100644 --- a/content/compose/bridge/_index.md +++ b/content/manuals/compose/bridge/_index.md @@ -2,6 +2,8 @@ description: Understand what Compose Bridge is and how it can be useful keywords: compose, orchestration, kubernetes, bridge title: Overview of Compose Bridge +linkTitle: Compose Bridge +weight: 180 --- {{< include "compose-bridge-experimental.md" >}} diff --git a/content/compose/bridge/advanced-integration.md b/content/manuals/compose/bridge/advanced-integration.md similarity index 97% rename from content/compose/bridge/advanced-integration.md rename to content/manuals/compose/bridge/advanced-integration.md index a0ec52f2cc..e83e38939f 100644 --- a/content/compose/bridge/advanced-integration.md +++ b/content/manuals/compose/bridge/advanced-integration.md @@ -1,5 +1,7 @@ --- title: Advanced integration +linkTitle: Advanced +weight: 30 description: Learn about how Compose Bridge can function a kubectl plugin keywords: kubernetes, compose, compose bridge, plugin, advanced --- diff --git a/content/compose/bridge/customize.md b/content/manuals/compose/bridge/customize.md similarity index 99% rename from content/compose/bridge/customize.md rename to content/manuals/compose/bridge/customize.md index 03432b161a..f56a0d0445 100644 --- a/content/compose/bridge/customize.md +++ b/content/manuals/compose/bridge/customize.md @@ -1,5 +1,7 @@ --- title: Customize Compose Bridge +linkTitle: Customize +weight: 20 description: Learn about the Compose Bridge templates syntax keywords: compose, bridge, templates --- diff --git a/content/compose/bridge/usage.md b/content/manuals/compose/bridge/usage.md similarity index 99% rename from content/compose/bridge/usage.md rename to content/manuals/compose/bridge/usage.md index 463f36043d..ee425cf8f6 100644 --- a/content/compose/bridge/usage.md +++ b/content/manuals/compose/bridge/usage.md @@ -1,5 +1,7 @@ --- title: Use the default Compose Bridge transformation +linkTitle: Usage +weight: 10 description: Learn about and use the Compose Bridge default transformation keywords: compose, bridge, kubernetes --- diff --git a/content/compose/compose-application-model.md b/content/manuals/compose/compose-application-model.md similarity index 99% rename from content/compose/compose-application-model.md rename to content/manuals/compose/compose-application-model.md index d882149737..8458de5e28 100644 --- a/content/compose/compose-application-model.md +++ b/content/manuals/compose/compose-application-model.md @@ -1,5 +1,6 @@ --- title: How Compose works +weight: 30 description: Understand how Compose works and the Compose application model with an illustrative example keywords: compose, docker compose, compose specification, compose model aliases: @@ -81,7 +82,7 @@ To lists all the services along with their current status: $ docker compose ps ``` -For a full list of all the Compose CLI commands, see the [reference documentation](../reference/cli/docker/compose/_index.md). +For a full list of all the Compose CLI commands, see the [reference documentation](/reference/cli/docker/compose/_index.md). ## Illustrative example diff --git a/content/compose/environment-variables/_index.md b/content/manuals/compose/environment-variables/_index.md similarity index 92% rename from content/compose/environment-variables/_index.md rename to content/manuals/compose/environment-variables/_index.md index 19ea021101..27b802c81a 100644 --- a/content/compose/environment-variables/_index.md +++ b/content/manuals/compose/environment-variables/_index.md @@ -1,5 +1,7 @@ --- -title: Overview +title: Environment variables in Compose +linkTitle: Environment variables +weight: 60 description: Explainer on the ways to set, use and manage environment variables in Compose keywords: compose, orchestration, environment, env file diff --git a/content/compose/environment-variables/best-practices.md b/content/manuals/compose/environment-variables/best-practices.md similarity index 97% rename from content/compose/environment-variables/best-practices.md rename to content/manuals/compose/environment-variables/best-practices.md index d2dbb7cade..c7ceb42a90 100644 --- a/content/compose/environment-variables/best-practices.md +++ b/content/manuals/compose/environment-variables/best-practices.md @@ -1,5 +1,6 @@ --- title: Best practices for working with environment variables in Docker Compose +linkTitle: Best practices description: Explainer on the best ways to set, use, and manage environment variables in Compose keywords: compose, orchestration, environment, env file, environment variables diff --git a/content/compose/environment-variables/envvars-precedence.md b/content/manuals/compose/environment-variables/envvars-precedence.md similarity index 98% rename from content/compose/environment-variables/envvars-precedence.md rename to content/manuals/compose/environment-variables/envvars-precedence.md index 3bcd912f9b..914756cd8a 100644 --- a/content/compose/environment-variables/envvars-precedence.md +++ b/content/manuals/compose/environment-variables/envvars-precedence.md @@ -1,5 +1,6 @@ --- title: Environment variables precedence in Docker Compose +linkTitle: Environment variables precedence description: Scenario overview illustrating how environment variables are resolved in Compose keywords: compose, environment, env file @@ -16,7 +17,7 @@ The order of precedence (highest to lowest) is as follows: 2. Set with either the `environment` or `env_file` attribute but with the value interpolated from your [shell](variable-interpolation.md#substitute-from-the-shell) or an environment file. (either your default [`.env` file](variable-interpolation.md#env-file), or with the [`--env-file` argument](variable-interpolation.md#substitute-with---env-file) in the CLI). 3. Set using just the [`environment` attribute](set-environment-variables.md#use-the-environment-attribute) in the Compose file. 4. Use of the [`env_file` attribute](set-environment-variables.md#use-the-env_file-attribute) in the Compose file. -5. Set in a container image in the [ENV directive](../../reference/dockerfile.md#env). +5. Set in a container image in the [ENV directive](/reference/dockerfile.md#env). Having any `ARG` or `ENV` setting in a `Dockerfile` evaluates only if there is no Docker Compose entry for `environment`, `env_file` or `run --env`. ## Simple example diff --git a/content/compose/environment-variables/envvars.md b/content/manuals/compose/environment-variables/envvars.md similarity index 97% rename from content/compose/environment-variables/envvars.md rename to content/manuals/compose/environment-variables/envvars.md index eb76c08f14..879856517a 100644 --- a/content/compose/environment-variables/envvars.md +++ b/content/manuals/compose/environment-variables/envvars.md @@ -2,6 +2,7 @@ description: Compose pre-defined environment variables keywords: fig, composition, compose, docker, orchestration, cli, reference title: Set or change pre-defined environment variables in Docker Compose +linkTitle: Pre-defined environment variables aliases: - /compose/reference/envvars/ --- @@ -156,7 +157,7 @@ If `COMPOSE_ENV_FILES` is not set, and you don't provide `--env-file` in the CLI ### COMPOSE\_MENU -When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](../../reference/cli/docker/debug.md). +When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](/reference/cli/docker/debug.md). * Supported values: * `true` or `1`, to enable, @@ -169,7 +170,7 @@ When enabled, Compose displays a navigation menu where you can choose to open th ### COMPOSE\_EXPERIMENTAL -This is an opt-out variable. When turned off it deactivates the experimental features such as the navigation menu or [Synchronized file shares](../../desktop/synchronized-file-sharing.md). +This is an opt-out variable. When turned off it deactivates the experimental features such as the navigation menu or [Synchronized file shares](/manuals/desktop/synchronized-file-sharing.md). * Supported values: * `true` or `1`, to enable, diff --git a/content/compose/environment-variables/set-environment-variables.md b/content/manuals/compose/environment-variables/set-environment-variables.md similarity index 99% rename from content/compose/environment-variables/set-environment-variables.md rename to content/manuals/compose/environment-variables/set-environment-variables.md index c931593117..e2ea244b62 100644 --- a/content/compose/environment-variables/set-environment-variables.md +++ b/content/manuals/compose/environment-variables/set-environment-variables.md @@ -1,5 +1,7 @@ --- title: Set environment variables within your container's environment +linkTitle: Set environment variables +weight: 10 description: How to set, use, and manage environment variables with Compose keywords: compose, orchestration, environment, environment variables, container environment variables aliases: diff --git a/content/compose/environment-variables/variable-interpolation.md b/content/manuals/compose/environment-variables/variable-interpolation.md similarity index 98% rename from content/compose/environment-variables/variable-interpolation.md rename to content/manuals/compose/environment-variables/variable-interpolation.md index 3113b54f15..e7d2a32e31 100644 --- a/content/compose/environment-variables/variable-interpolation.md +++ b/content/manuals/compose/environment-variables/variable-interpolation.md @@ -1,5 +1,6 @@ --- title: Set, use, and manage variables in a Compose file with interpolation +linkTitle: Interpolation description: How to set, use, and manage variables in your Compose file with interpolation keywords: compose, orchestration, environment, variables, interpolation aliases: @@ -25,7 +26,7 @@ services: ``` When you run `docker compose up`, the `web` service defined in the Compose file [interpolates](variable-interpolation.md) in the image `webapp:v1.5` which was set in the `.env` file. You can verify this with the -[config command](../../reference/cli/docker/compose/config.md), which prints your resolved application config to the terminal: +[config command](/reference/cli/docker/compose/config.md), which prints your resolved application config to the terminal: ```console $ docker compose config diff --git a/content/compose/faq.md b/content/manuals/compose/faq.md similarity index 97% rename from content/compose/faq.md rename to content/manuals/compose/faq.md index da1949eba5..e9ebef24a2 100644 --- a/content/compose/faq.md +++ b/content/manuals/compose/faq.md @@ -2,6 +2,7 @@ description: Frequently asked questions for Docker Compose keywords: documentation, docs, docker, compose, faq, docker compose vs docker-compose title: Compose FAQs +weight: 170 tags: [FAQ] --- @@ -36,7 +37,7 @@ containers. ### Why do my services take 10 seconds to recreate or stop? The `docker compose stop` command attempts to stop a container by sending a `SIGTERM`. It then waits -for a [default timeout of 10 seconds](../reference/cli/docker/compose/stop.md). After the timeout, +for a [default timeout of 10 seconds](/reference/cli/docker/compose/stop.md). After the timeout, a `SIGKILL` is sent to the container to forcefully kill it. If you are waiting for this timeout, it means that your containers aren't shutting down when they receive the `SIGTERM` signal. diff --git a/content/compose/feedback.md b/content/manuals/compose/feedback.md similarity index 98% rename from content/compose/feedback.md rename to content/manuals/compose/feedback.md index dea5dee1ed..49d86c3640 100644 --- a/content/compose/feedback.md +++ b/content/manuals/compose/feedback.md @@ -2,6 +2,7 @@ description: Find a way to provide feedback on Docker Compose that's right for you keywords: Feedback, Docker Compose, Community forum, bugs, problems, issues title: Give feedback +weight: 150 --- There are many ways you can provide feedback on Docker Compose. diff --git a/content/compose/file-watch.md b/content/manuals/compose/file-watch.md similarity index 99% rename from content/compose/file-watch.md rename to content/manuals/compose/file-watch.md index cb4e40582f..e216f5bbe1 100644 --- a/content/compose/file-watch.md +++ b/content/manuals/compose/file-watch.md @@ -2,6 +2,7 @@ description: Use File watch to automatically update running services as you work keywords: compose, file watch, experimental title: Use Compose Watch +weight: 80 --- {{< introduced compose 2.22.0 "release-notes.md#2220" >}} diff --git a/content/compose/gettingstarted.md b/content/manuals/compose/gettingstarted.md similarity index 99% rename from content/compose/gettingstarted.md rename to content/manuals/compose/gettingstarted.md index c0afea8d0f..a1e075f355 100644 --- a/content/compose/gettingstarted.md +++ b/content/manuals/compose/gettingstarted.md @@ -6,6 +6,8 @@ keywords: docker compose example, docker compose tutorial, how to use docker com compose command example, run docker compose file, how to create a docker compose file, run a docker compose file title: Docker Compose Quickstart +linkTitle: Quickstart +weight: 40 --- This tutorial aims to introduce fundamental concepts of Docker Compose by guiding you through the development of a basic Python web application. @@ -239,7 +241,7 @@ services: Whenever a file is changed, Compose syncs the file to the corresponding location under `/code` inside the container. Once copied, the bundler updates the running application without a restart. -For more information on how Compose Watch works, see [Use Compose Watch](file-watch.md). Alternatively, see [Manage data in containers](/engine/storage/volumes.md) for other options. +For more information on how Compose Watch works, see [Use Compose Watch](file-watch.md). Alternatively, see [Manage data in containers](/manuals/engine/storage/volumes.md) for other options. > [!NOTE] > diff --git a/content/compose/gpu-support.md b/content/manuals/compose/gpu-support.md similarity index 97% rename from content/compose/gpu-support.md rename to content/manuals/compose/gpu-support.md index ac0993ef48..4bbdbf966b 100644 --- a/content/compose/gpu-support.md +++ b/content/manuals/compose/gpu-support.md @@ -2,9 +2,11 @@ description: Understand GPU support in Docker Compose keywords: documentation, docs, docker, compose, GPU access, NVIDIA, samples title: Turn on GPU access with Docker Compose +linkTitle: GPU support +weight: 120 --- -Compose services can define GPU device reservations if the Docker host contains such devices and the Docker Daemon is set accordingly. For this, make sure you install the [prerequisites](/engine/containers/resource_constraints.md#gpu) if you haven't already done so. +Compose services can define GPU device reservations if the Docker host contains such devices and the Docker Daemon is set accordingly. For this, make sure you install the [prerequisites](/manuals/engine/containers/resource_constraints.md#gpu) if you haven't already done so. The examples in the following sections focus specifically on providing service containers access to GPU devices with Docker Compose. You can use either `docker-compose` or `docker compose` commands. For more information, see [Migrate to Compose V2](migrate.md). diff --git a/content/compose/images/compose-application.webp b/content/manuals/compose/images/compose-application.webp similarity index 100% rename from content/compose/images/compose-application.webp rename to content/manuals/compose/images/compose-application.webp diff --git a/content/compose/images/quick-hello-world-1.png b/content/manuals/compose/images/quick-hello-world-1.png similarity index 100% rename from content/compose/images/quick-hello-world-1.png rename to content/manuals/compose/images/quick-hello-world-1.png diff --git a/content/compose/images/quick-hello-world-2.png b/content/manuals/compose/images/quick-hello-world-2.png similarity index 100% rename from content/compose/images/quick-hello-world-2.png rename to content/manuals/compose/images/quick-hello-world-2.png diff --git a/content/compose/images/quick-hello-world-3.png b/content/manuals/compose/images/quick-hello-world-3.png similarity index 100% rename from content/compose/images/quick-hello-world-3.png rename to content/manuals/compose/images/quick-hello-world-3.png diff --git a/content/compose/images/v1-versus-v2.png b/content/manuals/compose/images/v1-versus-v2.png similarity index 100% rename from content/compose/images/v1-versus-v2.png rename to content/manuals/compose/images/v1-versus-v2.png diff --git a/content/compose/install/_index.md b/content/manuals/compose/install/_index.md similarity index 90% rename from content/compose/install/_index.md rename to content/manuals/compose/install/_index.md index 1828363f50..ae58b2fecc 100644 --- a/content/compose/install/_index.md +++ b/content/manuals/compose/install/_index.md @@ -5,6 +5,8 @@ keywords: install docker compose, docker compose install, install docker compose installing docker compose, docker compose download, docker compose not found, docker compose windows, how to install docker compose title: Overview of installing Docker Compose +linkTitle: Install +weight: 20 toc_max: 3 aliases: - /compose/compose-desktop/ @@ -22,9 +24,9 @@ The easiest and recommended way to get Docker Compose is to install Docker Deskt includes Docker Compose along with Docker Engine and Docker CLI which are Compose prerequisites. Docker Desktop is available on: -- [Linux](../../desktop/install/linux-install.md) -- [Mac](../../desktop/install/mac-install.md) -- [Windows](../../desktop/install/windows-install.md) +- [Linux](/manuals/desktop/install/linux-install.md) +- [Mac](/manuals/desktop/install/mac-install.md) +- [Windows](/manuals/desktop/install/windows-install.md) If you have already installed Docker Desktop, you can check which version of Compose you have by selecting **About Docker Desktop** from the Docker menu {{< inline-image src="../../desktop/images/whale-x.svg" alt="whale menu" >}}. diff --git a/content/compose/install/linux.md b/content/manuals/compose/install/linux.md similarity index 87% rename from content/compose/install/linux.md rename to content/manuals/compose/install/linux.md index 62d27f0680..cb1dad15b4 100644 --- a/content/compose/install/linux.md +++ b/content/manuals/compose/install/linux.md @@ -27,13 +27,13 @@ For Compose standalone, see [Install Compose Standalone](standalone.md). 1. Set up the repository. Find distro-specific instructions in: - [Ubuntu](../../engine/install/ubuntu.md/#install-using-the-repository) | - [CentOS](../../engine/install/centos.md/#set-up-the-repository) | - [Debian](../../engine/install/debian.md/#install-using-the-repository) | - [Raspberry Pi OS](../../engine/install/raspberry-pi-os.md/#install-using-the-repository) | - [Fedora](../../engine/install/fedora.md/#set-up-the-repository) | - [RHEL](../../engine/install/rhel.md/#set-up-the-repository) | - [SLES](../../engine/install/sles.md/#set-up-the-repository). + [Ubuntu](/manuals/engine/install/ubuntu.md#install-using-the-repository) | + [CentOS](/manuals/engine/install/centos.md#set-up-the-repository) | + [Debian](/manuals/engine/install/debian.md#install-using-the-repository) | + [Raspberry Pi OS](/manuals/engine/install/raspberry-pi-os.md#install-using-the-repository) | + [Fedora](/manuals/engine/install/fedora.md#set-up-the-repository) | + [RHEL](/manuals/engine/install/rhel.md#set-up-the-repository) | + [SLES](/manuals/engine/install/sles.md#set-up-the-repository). 2. Update the package index, and install the latest version of Docker Compose: diff --git a/content/compose/install/standalone.md b/content/manuals/compose/install/standalone.md similarity index 100% rename from content/compose/install/standalone.md rename to content/manuals/compose/install/standalone.md diff --git a/content/compose/install/uninstall.md b/content/manuals/compose/install/uninstall.md similarity index 95% rename from content/compose/install/uninstall.md rename to content/manuals/compose/install/uninstall.md index e5a1d183a1..12e373e185 100644 --- a/content/compose/install/uninstall.md +++ b/content/manuals/compose/install/uninstall.md @@ -9,7 +9,7 @@ Uninstalling Docker Compose depends on the method you have used to install Docke ## Uninstalling Docker Desktop -If you want to uninstall Compose and you have installed Docker Desktop, see [Uninstall Docker Desktop](../../desktop/uninstall.md). +If you want to uninstall Compose and you have installed Docker Desktop, see [Uninstall Docker Desktop](/manuals/desktop/uninstall.md). > [!NOTE] > diff --git a/content/manuals/compose/intro/_index.md b/content/manuals/compose/intro/_index.md new file mode 100644 index 0000000000..2fb13c9f5f --- /dev/null +++ b/content/manuals/compose/intro/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Introduction to Compose +weight: 10 +--- diff --git a/content/compose/intro/features-uses.md b/content/manuals/compose/intro/features-uses.md similarity index 100% rename from content/compose/intro/features-uses.md rename to content/manuals/compose/intro/features-uses.md diff --git a/content/compose/intro/history.md b/content/manuals/compose/intro/history.md similarity index 100% rename from content/compose/intro/history.md rename to content/manuals/compose/intro/history.md diff --git a/content/compose/migrate.md b/content/manuals/compose/migrate.md similarity index 98% rename from content/compose/migrate.md rename to content/manuals/compose/migrate.md index 7167fc8ed2..4d74cc6a60 100644 --- a/content/compose/migrate.md +++ b/content/manuals/compose/migrate.md @@ -1,5 +1,6 @@ --- title: Migrate to Compose V2 +weight: 160 description: How to migrate from Compose V1 to V2 keywords: compose, upgrade, migration, v1, v2, docker compose vs docker-compose aliases: @@ -13,7 +14,7 @@ Compose V2, which was first released in 2020, is included with all currently sup ## How do I switch to Compose V2? -The easiest and recommended way is to make sure you have the latest version of [Docker Desktop](../desktop/release-notes.md), which bundles the Docker Engine and Docker CLI platform including Compose V2. +The easiest and recommended way is to make sure you have the latest version of [Docker Desktop](/manuals/desktop/release-notes.md), which bundles the Docker Engine and Docker CLI platform including Compose V2. With Docker Desktop, Compose V2 is always accessible as `docker compose`. Additionally, the **Use Compose V2** setting is turned on by default, which provides an alias from `docker-compose`. diff --git a/content/compose/multiple-compose-files/_index.md b/content/manuals/compose/multiple-compose-files/_index.md similarity index 96% rename from content/compose/multiple-compose-files/_index.md rename to content/manuals/compose/multiple-compose-files/_index.md index 944403e86d..78de91e26f 100644 --- a/content/compose/multiple-compose-files/_index.md +++ b/content/manuals/compose/multiple-compose-files/_index.md @@ -2,7 +2,8 @@ description: General overview for the different ways you can work with multiple compose files in Docker Compose keywords: compose, compose file, merge, extends, include, docker compose, -f flag -title: Overview +linkTitle: Working with multiple Compose files +weight: 110 --- This section contains information on the ways you can work with multiple Compose files. diff --git a/content/compose/multiple-compose-files/extends.md b/content/manuals/compose/multiple-compose-files/extends.md similarity index 99% rename from content/compose/multiple-compose-files/extends.md rename to content/manuals/compose/multiple-compose-files/extends.md index b3207402cd..edf180cbf7 100644 --- a/content/compose/multiple-compose-files/extends.md +++ b/content/manuals/compose/multiple-compose-files/extends.md @@ -3,6 +3,7 @@ description: How to use Docker Compose's extends keyword to share configuration files and projects keywords: fig, composition, compose, docker, orchestration, documentation, docs title: Extend your Compose file +linkTitle: Extend aliases: - /compose/extends/ --- diff --git a/content/compose/multiple-compose-files/include.md b/content/manuals/compose/multiple-compose-files/include.md similarity index 99% rename from content/compose/multiple-compose-files/include.md rename to content/manuals/compose/multiple-compose-files/include.md index 5130dded2b..cf7302cc95 100644 --- a/content/compose/multiple-compose-files/include.md +++ b/content/manuals/compose/multiple-compose-files/include.md @@ -2,6 +2,7 @@ description: How to use Docker Compose's include top-level element keywords: compose, docker, include, compose file title: Include +linkTitle: Include --- {{< introduced compose 2.20.3 "../release-notes.md#2203" >}} diff --git a/content/compose/multiple-compose-files/merge.md b/content/manuals/compose/multiple-compose-files/merge.md similarity index 97% rename from content/compose/multiple-compose-files/merge.md rename to content/manuals/compose/multiple-compose-files/merge.md index ad8f80c9dd..7841e29b09 100644 --- a/content/compose/multiple-compose-files/merge.md +++ b/content/manuals/compose/multiple-compose-files/merge.md @@ -2,6 +2,7 @@ description: How merging Compose files works keywords: compose, docker, merge, compose file title: Merge Compose files +linkTitle: Merge --- Docker Compose lets you merge and override a set of Compose files together to create a composite Compose file. @@ -100,7 +101,7 @@ relative to the base file. - You can use the `-f` flag to specify a path to a Compose file that is not located in the current directory, either from the command line or by setting up a [COMPOSE_FILE environment variable](../environment-variables/envvars.md#compose_file) in your shell or in an environment file. - For example, if you are running the [Compose Rails sample](https://github.com/docker/awesome-compose/tree/master/official-documentation-samples/rails/README.md), and have a `compose.yml` file in a directory called `sandbox/rails`. You can use a command like [docker compose pull](../../reference/cli/docker/compose/pull.md) to get the postgres image for the `db` service from anywhere by using the `-f` flag as follows: `docker compose -f ~/sandbox/rails/compose.yml pull db` + For example, if you are running the [Compose Rails sample](https://github.com/docker/awesome-compose/tree/master/official-documentation-samples/rails/README.md), and have a `compose.yml` file in a directory called `sandbox/rails`. You can use a command like [docker compose pull](/reference/cli/docker/compose/pull.md) to get the postgres image for the `db` service from anywhere by using the `-f` flag as follows: `docker compose -f ~/sandbox/rails/compose.yml pull db` Here's the full example: diff --git a/content/compose/networking.md b/content/manuals/compose/networking.md similarity index 96% rename from content/compose/networking.md rename to content/manuals/compose/networking.md index 86e83b9116..9c5ceb3934 100644 --- a/content/compose/networking.md +++ b/content/manuals/compose/networking.md @@ -2,6 +2,8 @@ description: How Docker Compose sets up networking between containers keywords: documentation, docs, docker, compose, orchestration, containers, networking title: Networking in Compose +linkTitle: Networking +weight: 130 --- {{< include "compose-eol.md" >}} @@ -84,13 +86,13 @@ See the [links reference](/reference/compose-file/services.md#links) for more in ## Multi-host networking -When deploying a Compose application on a Docker Engine with [Swarm mode enabled](../engine/swarm/_index.md), +When deploying a Compose application on a Docker Engine with [Swarm mode enabled](/manuals/engine/swarm/_index.md), you can make use of the built-in `overlay` driver to enable multi-host communication. Overlay networks are always created as `attachable`. You can optionally set the [`attachable`](/reference/compose-file/networks.md#attachable) property to `false`. -Consult the [Swarm mode section](../engine/swarm/_index.md), to see how to set up -a Swarm cluster, and the [Getting started with multi-host networking](/engine/network/tutorials/overlay.md) +Consult the [Swarm mode section](/manuals/engine/swarm/_index.md), to see how to set up +a Swarm cluster, and the [Getting started with multi-host networking](/manuals/engine/network/tutorials/overlay.md) to learn about multi-host overlay networks. ## Specify custom networks diff --git a/content/compose/production.md b/content/manuals/compose/production.md similarity index 98% rename from content/compose/production.md rename to content/manuals/compose/production.md index 009f00c698..54cfd1112b 100644 --- a/content/compose/production.md +++ b/content/manuals/compose/production.md @@ -1,7 +1,8 @@ --- description: Guide to using Docker Compose in production keywords: compose, orchestration, containers, production -title: Use Compose in production +title: Compose in production +weight: 90 --- When you define your app with Compose in development, you can use this diff --git a/content/compose/profiles.md b/content/manuals/compose/profiles.md similarity index 99% rename from content/compose/profiles.md rename to content/manuals/compose/profiles.md index 6769790b8a..e9bcff0ba8 100644 --- a/content/compose/profiles.md +++ b/content/manuals/compose/profiles.md @@ -1,5 +1,7 @@ --- title: Using profiles with Compose +linkTitle: Use service profiles +weight: 70 desription: How to use profiles with Docker Compose keywords: cli, compose, profile, profiles reference --- diff --git a/content/compose/project-name.md b/content/manuals/compose/project-name.md similarity index 99% rename from content/compose/project-name.md rename to content/manuals/compose/project-name.md index 73c6097e16..fa9138fc65 100644 --- a/content/compose/project-name.md +++ b/content/manuals/compose/project-name.md @@ -1,5 +1,6 @@ --- title: Specify a project name +weight: 50 description: Understand the different ways you can set a project name in Compose and what the precedence is. keywords: name, compose, project, -p flag, name top-level element --- diff --git a/content/compose/release-notes.md b/content/manuals/compose/release-notes.md similarity index 99% rename from content/compose/release-notes.md rename to content/manuals/compose/release-notes.md index e4d321f8a3..8d046f95e7 100644 --- a/content/compose/release-notes.md +++ b/content/manuals/compose/release-notes.md @@ -1,5 +1,6 @@ --- title: Docker Compose release notes +weight: 999 description: Learn about the new features, bug fixes, and breaking changes for the newest Docker Compose release keywords: release notes, compose tags: [Release notes] @@ -2322,7 +2323,7 @@ naming scheme accordingly before upgrading. - Added support for `extra_hosts` in build configuration - Added support for the [long syntax](/reference/compose-file/legacy-versions.md) for volume entries, as previously introduced in the 3.2 format. - Using this syntax will create [mounts](/engine/storage/bind-mounts.md) instead of volumes. + Using this syntax will create [mounts](/manuals/engine/storage/bind-mounts.md) instead of volumes. #### Compose file version 2.1 and up @@ -3269,7 +3270,7 @@ naming scheme accordingly before upgrading. By default, you don't have to configure any networks. In fact, using networking with Compose involves even less configuration than using links. - Consult the [networking guide](../compose/networking.md) for how to use it. + Consult the [networking guide](/manuals/compose/networking.md) for how to use it. The experimental flags `--x-networking` and `--x-network-driver`, introduced in Compose 1.5, have been removed. @@ -3756,7 +3757,7 @@ The highlights: This means the GitHub repository has moved to [https://github.com/docker/fig](https://github.com/docker/fig) and our IRC channel is now #docker-fig on Freenode. - - Fig can be used with the [official Docker OS X installer](../desktop/install/mac-install.md). Boot2Docker will mount the home directory from your host machine so volumes work as expected. + - Fig can be used with the [official Docker OS X installer](/manuals/desktop/install/mac-install.md). Boot2Docker will mount the home directory from your host machine so volumes work as expected. - Fig supports Docker 1.3. diff --git a/content/compose/samples-for-compose.md b/content/manuals/compose/samples-for-compose.md similarity index 94% rename from content/compose/samples-for-compose.md rename to content/manuals/compose/samples-for-compose.md index 6016b10073..efed0f5d4c 100644 --- a/content/compose/samples-for-compose.md +++ b/content/manuals/compose/samples-for-compose.md @@ -2,6 +2,8 @@ description: Summary of samples related to Compose keywords: documentation, docs, docker, compose, samples title: Sample apps with Compose +linkTitle: Sample apps +weight: 140 --- The following samples show the various aspects of how to work with Docker @@ -18,7 +20,7 @@ The samples should help you to: - Understand the relationship between `compose.yml` and [Dockerfiles](/reference/dockerfile/) - Learn how to make calls to your application services from Compose files -- Learn how to deploy applications and services to a [swarm](../engine/swarm/index.md) +- Learn how to deploy applications and services to a [swarm](/manuals/engine/swarm/index.md) ## Samples tailored to demo Compose diff --git a/content/compose/startup-order.md b/content/manuals/compose/startup-order.md similarity index 98% rename from content/compose/startup-order.md rename to content/manuals/compose/startup-order.md index 920958cfbf..9b01b8b09f 100644 --- a/content/compose/startup-order.md +++ b/content/manuals/compose/startup-order.md @@ -2,6 +2,8 @@ description: How to control service startup and shutdown order in Docker Compose keywords: documentation, docs, docker, compose, startup, shutdown, order title: Control startup and shutdown order in Compose +linkTitle: Control startup order +weight: 120 notoc: true --- diff --git a/content/compose/use-secrets.md b/content/manuals/compose/use-secrets.md similarity index 98% rename from content/compose/use-secrets.md rename to content/manuals/compose/use-secrets.md index 2df461a87a..cc869a1b4c 100644 --- a/content/compose/use-secrets.md +++ b/content/manuals/compose/use-secrets.md @@ -1,5 +1,7 @@ --- title: How to use secrets in Docker Compose +linkTitle: Secrets in Compose +weight: 100 description: How to use secrets in Compose and their benefits keywords: secrets, compose, security, environment variables tags: [Secrets] diff --git a/content/copilot/copilot-action-prompt.png b/content/manuals/copilot/copilot-action-prompt.png similarity index 100% rename from content/copilot/copilot-action-prompt.png rename to content/manuals/copilot/copilot-action-prompt.png diff --git a/content/copilot/copilot-button.png b/content/manuals/copilot/copilot-button.png similarity index 100% rename from content/copilot/copilot-button.png rename to content/manuals/copilot/copilot-button.png diff --git a/content/copilot/docker-agent-copilot.png b/content/manuals/copilot/docker-agent-copilot.png similarity index 100% rename from content/copilot/docker-agent-copilot.png rename to content/manuals/copilot/docker-agent-copilot.png diff --git a/content/copilot/index.md b/content/manuals/copilot/index.md similarity index 98% rename from content/copilot/index.md rename to content/manuals/copilot/index.md index 567467c6e9..aeb2e4387c 100644 --- a/content/copilot/index.md +++ b/content/manuals/copilot/index.md @@ -1,5 +1,7 @@ --- title: Docker for GitHub Copilot +linkTitle: Docker for GitHub Copilot {{< badge color="violet" text="Early Access" >}} +weight: 100 description: Learn how to use the Docker Extension for GitHub Copilot to streamline Docker-related tasks. keywords: Docker, GitHub Copilot, extension, Visual Studio Code, chat, ai, containerization --- diff --git a/content/desktop/_index.md b/content/manuals/desktop/_index.md similarity index 93% rename from content/desktop/_index.md rename to content/manuals/desktop/_index.md index 882ce814eb..64e33093cc 100644 --- a/content/desktop/_index.md +++ b/content/manuals/desktop/_index.md @@ -1,8 +1,10 @@ --- +title: Overview of Docker Desktop +linkTitle: Docker Desktop +weight: 100 description: Explore Docker Desktop, what it has to offer, and its key features. Take the next step by downloading or find additional resources keywords: how to use docker desktop, what is docker desktop used for, what does docker desktop do, using docker desktop -title: Overview of Docker Desktop grid: - title: Install Docker Desktop description: | @@ -50,13 +52,13 @@ Docker Desktop reduces the time spent on complex setups so you can focus on writ {{< tabs >}} {{< tab name="What's included in Docker Desktop?" >}} -- [Docker Engine](../engine/_index.md) +- [Docker Engine](/manuals/engine/_index.md) - Docker CLI client - [Docker Scout](../scout/_index.md) (additional subscription may apply) -- [Docker Build](../build/_index.md) +- [Docker Build](/manuals/build/_index.md) - [Docker Extensions](../extensions/_index.md) -- [Docker Compose](../compose/_index.md) -- [Docker Content Trust](../engine/security/trust/_index.md) +- [Docker Compose](/manuals/compose/_index.md) +- [Docker Content Trust](/manuals/engine/security/trust/_index.md) - [Kubernetes](https://github.com/kubernetes/kubernetes/) - [Credential Helper](https://github.com/docker/docker-credential-helpers/) diff --git a/content/desktop/allow-list.md b/content/manuals/desktop/allow-list.md similarity index 100% rename from content/desktop/allow-list.md rename to content/manuals/desktop/allow-list.md diff --git a/content/desktop/backup-and-restore.md b/content/manuals/desktop/backup-and-restore.md similarity index 68% rename from content/desktop/backup-and-restore.md rename to content/manuals/desktop/backup-and-restore.md index dd0e969d1a..6fb57cbb47 100644 --- a/content/desktop/backup-and-restore.md +++ b/content/manuals/desktop/backup-and-restore.md @@ -13,7 +13,7 @@ computer, for example. ## Save your data -1. Commit your containers to an image with [`docker container commit`](../reference/cli/docker/container/commit.md). +1. Commit your containers to an image with [`docker container commit`](/reference/cli/docker/container/commit.md). Committing a container stores the container filesystem changes and some of the container's configuration, for example labels and environment-variables, as a local image. Be aware that environment variables may contain sensitive @@ -23,15 +23,15 @@ computer, for example. Also note that filesystem changes in volume that are attached to the container are not included in the image, and must be backed up separately. - If you used a [named volume](/engine/storage/index.md#more-details-about-mount-types) to store container data, such as databases, refer to the [back up, restore, or migrate data volumes](/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section. + If you used a [named volume](/manuals/engine/storage/index.md#more-details-about-mount-types) to store container data, such as databases, refer to the [back up, restore, or migrate data volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section. -2. Use [`docker push`](../reference/cli/docker/image/push.md) to push any +2. Use [`docker push`](/reference/cli/docker/image/push.md) to push any images you have built locally and want to keep to the [Docker Hub registry](../docker-hub/index.md). Make sure to configure the [repository's visibility as "private"](../docker-hub/repos/index.md) for images that should not be publicly accessible. - Alternatively, use [`docker image save -o images.tar image1 [image2 ...]`](../reference/cli/docker/image/save.md) + Alternatively, use [`docker image save -o images.tar image1 [image2 ...]`](/reference/cli/docker/image/save.md) to save any images you want to keep to a local tar file. After backing up your data, you can uninstall the current version of Docker Desktop @@ -39,13 +39,13 @@ and [install a different version](release-notes.md) or reset Docker Desktop to f ## Restore your data -1. Use [`docker pull`](../reference/cli/docker/image/pull.md) to restore images +1. Use [`docker pull`](/reference/cli/docker/image/pull.md) to restore images you pushed to Docker Hub. - If you backed up your images to a local tar file, use [`docker image load -i images.tar`](../reference/cli/docker/image/load.md) + If you backed up your images to a local tar file, use [`docker image load -i images.tar`](/reference/cli/docker/image/load.md) to restore previously saved images. -2. Re-create your containers if needed, using [`docker run`](../reference/cli/docker/container/run.md), - or [Docker Compose](../compose/index.md). +2. Re-create your containers if needed, using [`docker run`](/reference/cli/docker/container/run.md), + or [Docker Compose](/manuals/compose/index.md). -Refer to the [backup, restore, or migrate data volumes](/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section to restore volume data. +Refer to the [backup, restore, or migrate data volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) page in the storage section to restore volume data. diff --git a/content/desktop/containerd.md b/content/manuals/desktop/containerd.md similarity index 99% rename from content/desktop/containerd.md rename to content/manuals/desktop/containerd.md index b054b99659..35ed7c4d76 100644 --- a/content/desktop/containerd.md +++ b/content/manuals/desktop/containerd.md @@ -1,5 +1,6 @@ --- title: containerd image store +weight: 40 description: How to activate the containerd integration feature in Docker Desktop keywords: Docker, containerd, engine, image store, lazy-pull toc_max: 3 diff --git a/content/desktop/dev-environments/_index.md b/content/manuals/desktop/dev-environments/_index.md similarity index 98% rename from content/desktop/dev-environments/_index.md rename to content/manuals/desktop/dev-environments/_index.md index 88e476d1d0..6c3d9e4811 100644 --- a/content/desktop/dev-environments/_index.md +++ b/content/manuals/desktop/dev-environments/_index.md @@ -2,6 +2,8 @@ description: Dev Environments keywords: Dev Environments, share, local, Compose title: Overview of Dev Environments +linkTitle: Dev Environments (Beta) +weight: 30 --- {{< include "dev-envs-changing.md" >}} diff --git a/content/desktop/dev-environments/create-dev-env.md b/content/manuals/desktop/dev-environments/create-dev-env.md similarity index 100% rename from content/desktop/dev-environments/create-dev-env.md rename to content/manuals/desktop/dev-environments/create-dev-env.md diff --git a/content/desktop/dev-environments/dev-cli.md b/content/manuals/desktop/dev-environments/dev-cli.md similarity index 100% rename from content/desktop/dev-environments/dev-cli.md rename to content/manuals/desktop/dev-environments/dev-cli.md diff --git a/content/desktop/dev-environments/set-up.md b/content/manuals/desktop/dev-environments/set-up.md similarity index 100% rename from content/desktop/dev-environments/set-up.md rename to content/manuals/desktop/dev-environments/set-up.md diff --git a/content/desktop/dev-environments/share.md b/content/manuals/desktop/dev-environments/share.md similarity index 100% rename from content/desktop/dev-environments/share.md rename to content/manuals/desktop/dev-environments/share.md diff --git a/content/desktop/enterprise/_index.md b/content/manuals/desktop/enterprise/_index.md similarity index 100% rename from content/desktop/enterprise/_index.md rename to content/manuals/desktop/enterprise/_index.md diff --git a/content/manuals/desktop/faqs/_index.md b/content/manuals/desktop/faqs/_index.md new file mode 100644 index 0000000000..54f6f71f86 --- /dev/null +++ b/content/manuals/desktop/faqs/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Desktop FAQs +--- diff --git a/content/desktop/faqs/general.md b/content/manuals/desktop/faqs/general.md similarity index 97% rename from content/desktop/faqs/general.md rename to content/manuals/desktop/faqs/general.md index 33f2d3f60c..afa929f9e1 100644 --- a/content/desktop/faqs/general.md +++ b/content/manuals/desktop/faqs/general.md @@ -23,7 +23,7 @@ This includes: - [Static vulnerability scanning](../../docker-hub/vulnerability-scanning.md) - Viewing remote images in the Docker Dashboard - Setting up [Dev Environments](../dev-environments/index.md) -- Docker Build when using [BuildKit](../../build/buildkit/index.md#getting-started). +- Docker Build when using [BuildKit](/manuals/build/buildkit/index.md#getting-started). You can work around this by disabling BuildKit. Run `DOCKER_BUILDKIT=0 docker build .` to disable BuildKit. - [Kubernetes](../kubernetes.md) (Images are download when you enable Kubernetes for the first time) - Checking for updates diff --git a/content/desktop/faqs/linuxfaqs.md b/content/manuals/desktop/faqs/linuxfaqs.md similarity index 100% rename from content/desktop/faqs/linuxfaqs.md rename to content/manuals/desktop/faqs/linuxfaqs.md diff --git a/content/desktop/faqs/macfaqs.md b/content/manuals/desktop/faqs/macfaqs.md similarity index 99% rename from content/desktop/faqs/macfaqs.md rename to content/manuals/desktop/faqs/macfaqs.md index 8b13a98a17..000b8edc71 100644 --- a/content/desktop/faqs/macfaqs.md +++ b/content/manuals/desktop/faqs/macfaqs.md @@ -229,5 +229,5 @@ also in your keychain. To learn more about how to install a CA root certificate for the registry and how to set the client TLS certificate for verification, see -[Verify repository client with certificates](../../engine/security/certificates.md) +[Verify repository client with certificates](/manuals/engine/security/certificates.md) in the Docker Engine topics. diff --git a/content/desktop/faqs/releases.md b/content/manuals/desktop/faqs/releases.md similarity index 100% rename from content/desktop/faqs/releases.md rename to content/manuals/desktop/faqs/releases.md diff --git a/content/desktop/faqs/windowsfaqs.md b/content/manuals/desktop/faqs/windowsfaqs.md similarity index 96% rename from content/desktop/faqs/windowsfaqs.md rename to content/manuals/desktop/faqs/windowsfaqs.md index b477993d26..d781a27f0e 100644 --- a/content/desktop/faqs/windowsfaqs.md +++ b/content/manuals/desktop/faqs/windowsfaqs.md @@ -52,7 +52,7 @@ Docker Desktop creates a certificate bundle of all user-trusted CAs based on the Windows certificate store, and appends it to Moby trusted certificates. Therefore, if an enterprise SSL certificate is trusted by the user on the host, it is trusted by Docker Desktop. To learn more about how to install a CA root certificate for the registry, see -[Verify repository client with certificates](../../engine/security/certificates.md) +[Verify repository client with certificates](/manuals/engine/security/certificates.md) in the Docker Engine topics. ### How do I add client certificates? @@ -75,6 +75,6 @@ certificates. Commands like `docker run` that attempt to pull from the registry produce error messages on the command line, as well as on the registry. To learn more about how to set the client TLS certificate for verification, see -[Verify repository client with certificates](../../engine/security/certificates.md) +[Verify repository client with certificates](/manuals/engine/security/certificates.md) in the Docker Engine topics. diff --git a/content/desktop/feedback.md b/content/manuals/desktop/feedback.md similarity index 100% rename from content/desktop/feedback.md rename to content/manuals/desktop/feedback.md diff --git a/content/desktop/get-started.md b/content/manuals/desktop/get-started.md similarity index 96% rename from content/desktop/get-started.md rename to content/manuals/desktop/get-started.md index 21d44f2b30..031c7a35ea 100644 --- a/content/desktop/get-started.md +++ b/content/manuals/desktop/get-started.md @@ -4,6 +4,8 @@ description: Explore the Learning center and understand the benefits of signing keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual, learning center, guide, sign in title: Sign in to Docker Desktop +linkTitle: Sign in +weight: 20 aliases: - /desktop/linux/ - /desktop/linux/index/ @@ -41,7 +43,7 @@ In large enterprises where admin access is restricted, administrators can [enfor - Authenticated users also get a higher pull rate limit compared to anonymous users. For example, if you are authenticated, you get 200 pulls per 6 hour period, compared to 100 pulls per 6 hour period per IP address for anonymous users. For more information, see [Download rate limit](../docker-hub/download-rate-limit.md). -- Improve your organization’s security posture for containerized development by taking advantage of [Hardened Desktop](/security/for-admins/hardened-desktop/index.md). +- Improve your organization’s security posture for containerized development by taking advantage of [Hardened Desktop](/manuals/security/for-admins/hardened-desktop/index.md). > [!NOTE] > diff --git a/content/desktop/gpu.md b/content/manuals/desktop/gpu.md similarity index 95% rename from content/desktop/gpu.md rename to content/manuals/desktop/gpu.md index 0e3b2e5ce1..d107604707 100644 --- a/content/desktop/gpu.md +++ b/content/manuals/desktop/gpu.md @@ -1,5 +1,7 @@ --- title: GPU support in Docker Desktop +linkTitle: GPU support +weight: 80 description: How to use GPU in Docker Desktop keywords: gpu, gpu support, nvidia, wsl2, docker desktop, windows toc_max: 3 @@ -17,7 +19,7 @@ Docker Desktop for Windows supports WSL 2 GPU Paravirtualization (GPU-PV) on NVI - Up to date Windows 10 or Windows 11 installation - [Up to date drivers](https://developer.nvidia.com/cuda/wsl) from NVIDIA supporting WSL 2 GPU Paravirtualization - The latest version of the WSL 2 Linux kernel. Use `wsl --update` on the command line -- To make sure the [WSL 2 backend is turned on](wsl/index.md/#turn-on-docker-desktop-wsl-2) in Docker Desktop +- To make sure the [WSL 2 backend is turned on](wsl/index.md#turn-on-docker-desktop-wsl-2) in Docker Desktop To validate that everything works as expected, execute a `docker run` command with the `--gpus=all` flag. For example, the following will run a short benchmark on your GPU: diff --git a/content/desktop/images/build-ui-active-builds.webp b/content/manuals/desktop/images/build-ui-active-builds.webp similarity index 100% rename from content/desktop/images/build-ui-active-builds.webp rename to content/manuals/desktop/images/build-ui-active-builds.webp diff --git a/content/desktop/images/build-ui-error.webp b/content/manuals/desktop/images/build-ui-error.webp similarity index 100% rename from content/desktop/images/build-ui-error.webp rename to content/manuals/desktop/images/build-ui-error.webp diff --git a/content/desktop/images/build-ui-history.webp b/content/manuals/desktop/images/build-ui-history.webp similarity index 100% rename from content/desktop/images/build-ui-history.webp rename to content/manuals/desktop/images/build-ui-history.webp diff --git a/content/desktop/images/build-ui-jaeger-screenshot.png b/content/manuals/desktop/images/build-ui-jaeger-screenshot.png similarity index 100% rename from content/desktop/images/build-ui-jaeger-screenshot.png rename to content/manuals/desktop/images/build-ui-jaeger-screenshot.png diff --git a/content/desktop/images/build-ui-manage-builders.webp b/content/manuals/desktop/images/build-ui-manage-builders.webp similarity index 100% rename from content/desktop/images/build-ui-manage-builders.webp rename to content/manuals/desktop/images/build-ui-manage-builders.webp diff --git a/content/desktop/images/build-ui-platform-menu.webp b/content/manuals/desktop/images/build-ui-platform-menu.webp similarity index 100% rename from content/desktop/images/build-ui-platform-menu.webp rename to content/manuals/desktop/images/build-ui-platform-menu.webp diff --git a/content/desktop/images/build-ui-timing-chart.webp b/content/manuals/desktop/images/build-ui-timing-chart.webp similarity index 100% rename from content/desktop/images/build-ui-timing-chart.webp rename to content/manuals/desktop/images/build-ui-timing-chart.webp diff --git a/content/desktop/images/builds-view.webp b/content/manuals/desktop/images/builds-view.webp similarity index 100% rename from content/desktop/images/builds-view.webp rename to content/manuals/desktop/images/builds-view.webp diff --git a/content/desktop/images/console.png b/content/manuals/desktop/images/console.png similarity index 100% rename from content/desktop/images/console.png rename to content/manuals/desktop/images/console.png diff --git a/content/desktop/images/dashboard.webp b/content/manuals/desktop/images/dashboard.webp similarity index 100% rename from content/desktop/images/dashboard.webp rename to content/manuals/desktop/images/dashboard.webp diff --git a/content/desktop/images/diagnose-support.png b/content/manuals/desktop/images/diagnose-support.png similarity index 100% rename from content/desktop/images/diagnose-support.png rename to content/manuals/desktop/images/diagnose-support.png diff --git a/content/desktop/images/hyperv-enabled.png b/content/manuals/desktop/images/hyperv-enabled.png similarity index 100% rename from content/desktop/images/hyperv-enabled.png rename to content/manuals/desktop/images/hyperv-enabled.png diff --git a/content/desktop/images/notifications.svg b/content/manuals/desktop/images/notifications.svg similarity index 100% rename from content/desktop/images/notifications.svg rename to content/manuals/desktop/images/notifications.svg diff --git a/content/desktop/images/resource-saver-settings.png b/content/manuals/desktop/images/resource-saver-settings.png similarity index 100% rename from content/desktop/images/resource-saver-settings.png rename to content/manuals/desktop/images/resource-saver-settings.png diff --git a/content/desktop/images/resource-saver-status-bar.png b/content/manuals/desktop/images/resource-saver-status-bar.png similarity index 100% rename from content/desktop/images/resource-saver-status-bar.png rename to content/manuals/desktop/images/resource-saver-status-bar.png diff --git a/content/desktop/images/shared-folder-on-demand.png b/content/manuals/desktop/images/shared-folder-on-demand.png similarity index 100% rename from content/desktop/images/shared-folder-on-demand.png rename to content/manuals/desktop/images/shared-folder-on-demand.png diff --git a/content/desktop/images/synched-file-shares.webp b/content/manuals/desktop/images/synched-file-shares.webp similarity index 100% rename from content/desktop/images/synched-file-shares.webp rename to content/manuals/desktop/images/synched-file-shares.webp diff --git a/content/desktop/images/troubleshoot.png b/content/manuals/desktop/images/troubleshoot.png similarity index 100% rename from content/desktop/images/troubleshoot.png rename to content/manuals/desktop/images/troubleshoot.png diff --git a/content/desktop/images/virtualization-enabled.png b/content/manuals/desktop/images/virtualization-enabled.png similarity index 100% rename from content/desktop/images/virtualization-enabled.png rename to content/manuals/desktop/images/virtualization-enabled.png diff --git a/content/desktop/images/whale-x.svg b/content/manuals/desktop/images/whale-x.svg similarity index 100% rename from content/desktop/images/whale-x.svg rename to content/manuals/desktop/images/whale-x.svg diff --git a/content/desktop/images/wsl2-enabled.png b/content/manuals/desktop/images/wsl2-enabled.png similarity index 100% rename from content/desktop/images/wsl2-enabled.png rename to content/manuals/desktop/images/wsl2-enabled.png diff --git a/content/manuals/desktop/install/_index.md b/content/manuals/desktop/install/_index.md new file mode 100644 index 0000000000..186d97b05d --- /dev/null +++ b/content/manuals/desktop/install/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Install +weight: 10 +--- diff --git a/content/desktop/install/archlinux.md b/content/manuals/desktop/install/archlinux.md similarity index 92% rename from content/desktop/install/archlinux.md rename to content/manuals/desktop/install/archlinux.md index 3dd862f36a..aab7c69c64 100644 --- a/content/desktop/install/archlinux.md +++ b/content/manuals/desktop/install/archlinux.md @@ -4,6 +4,8 @@ description: Instructions for installing Docker Desktop Arch package. Mostly mea keywords: Arch Linux, install, uninstall, upgrade, update, linux, desktop, docker desktop, docker desktop for linux, dd4l title: Install Docker Desktop on Arch-based distributions +linkTitle: Arch +weight: 80 aliases: - /desktop/linux/install/archlinux/ --- @@ -30,7 +32,7 @@ $ sudo pacman -S gnome-terminal 1. Install client binaries. Docker does not have an Arch package repository. Binaries not included in the package must be installed manually before installing Docker Desktop. -2. [Install Docker client binary on Linux](../../engine/install/binaries.md#install-daemon-and-client-binaries-on-linux). On Arch-based distributions, users must install the Docker client binary. +2. [Install Docker client binary on Linux](/manuals/engine/install/binaries.md#install-daemon-and-client-binaries-on-linux). On Arch-based distributions, users must install the Docker client binary. Static binaries for the Docker client are available for Linux (as `docker`). 3. Download the latest Arch package from the [Release notes](../release-notes.md). diff --git a/content/desktop/install/debian.md b/content/manuals/desktop/install/debian.md similarity index 96% rename from content/desktop/install/debian.md rename to content/manuals/desktop/install/debian.md index 264bdd5cd1..74ecf041cc 100644 --- a/content/desktop/install/debian.md +++ b/content/manuals/desktop/install/debian.md @@ -3,6 +3,8 @@ description: Instructions for installing Docker Desktop on Debian keywords: debian, install, uninstall, upgrade, update, linux, desktop, docker desktop, docker desktop for linux, dd4l title: Install Docker Desktop on Debian +linkTitle: Debian +weight: 60 toc_max: 4 aliases: - /desktop/linux/install/debian/ @@ -35,7 +37,7 @@ To install Docker Desktop successfully, you must: Recommended approach to install Docker Desktop on Debian: 1. Set up Docker's `apt` repository. - See step one of [Install using the `apt` repository](../../engine/install/debian.md#install-using-the-repository). + See step one of [Install using the `apt` repository](/manuals/engine/install/debian.md#install-using-the-repository). 2. Download the latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). For checksums, see the [Release notes](../release-notes.md). diff --git a/content/desktop/install/fedora.md b/content/manuals/desktop/install/fedora.md similarity index 96% rename from content/desktop/install/fedora.md rename to content/manuals/desktop/install/fedora.md index 358a7641bd..c9a0da6b44 100644 --- a/content/desktop/install/fedora.md +++ b/content/manuals/desktop/install/fedora.md @@ -3,6 +3,8 @@ description: Instructions for installing Docker Desktop on Fedora keywords: fedora, rpm, update install, uninstall, upgrade, update, linux, desktop, docker desktop, docker desktop for linux, dd4l title: Install Docker Desktop on Fedora +linkTitle: Fedora +weight: 70 toc_max: 4 aliases: - /desktop/linux/install/fedora/ @@ -35,7 +37,7 @@ $ sudo dnf install gnome-terminal To install Docker Desktop on Fedora: -1. Set up [Docker's package repository](../../engine/install/fedora.md#set-up-the-repository). +1. Set up [Docker's package repository](/manuals/engine/install/fedora.md#set-up-the-repository). 2. Download the latest [RPM package](https://desktop.docker.com/linux/main/amd64/docker-desktop-x86_64.rpm?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). For checksums, see the [Release notes](../release-notes.md). diff --git a/content/desktop/install/images/docker-app-in-apps.png b/content/manuals/desktop/install/images/docker-app-in-apps.png similarity index 100% rename from content/desktop/install/images/docker-app-in-apps.png rename to content/manuals/desktop/install/images/docker-app-in-apps.png diff --git a/content/desktop/install/images/whale-x.svg b/content/manuals/desktop/install/images/whale-x.svg similarity index 100% rename from content/desktop/install/images/whale-x.svg rename to content/manuals/desktop/install/images/whale-x.svg diff --git a/content/desktop/install/linux-install.md b/content/manuals/desktop/install/linux-install.md similarity index 97% rename from content/desktop/install/linux-install.md rename to content/manuals/desktop/install/linux-install.md index f1b93e3b24..4f093f811c 100644 --- a/content/desktop/install/linux-install.md +++ b/content/manuals/desktop/install/linux-install.md @@ -5,10 +5,10 @@ keywords: linux, docker linux install, docker linux, linux docker installation, for linux, docker desktop for linux, installing docker on linux, docker download linux, how to install docker on linux, linux vs docker engine, switch docker contexts title: Install Docker Desktop on Linux +linkTitle: Linux +weight: 40 aliases: - /desktop/linux/install/ -'yes': '![yes](/assets/images/green-check.svg){: .inline style="height: 14px; margin: - 0 auto"}' --- > **Docker Desktop terms** @@ -70,7 +70,7 @@ $ sudo systemctl disable docker docker.socket containerd The Docker CLI can be used to interact with multiple Docker Engines. For example, you can use the same Docker CLI to control a local Docker Engine and to control -a remote Docker Engine instance running in the cloud. [Docker Contexts](/engine/manage-resources/contexts.md) +a remote Docker Engine instance running in the cloud. [Docker Contexts](/manuals/engine/manage-resources/contexts.md) allow you to switch between Docker Engines instances. When installing Docker Desktop, a dedicated "desktop-linux" context is created to @@ -107,7 +107,7 @@ $ docker context use desktop-linux desktop-linux Current context is now "desktop-linux" ``` -Refer to the [Docker Context documentation](/engine/manage-resources/contexts.md) for more details. +Refer to the [Docker Context documentation](/manuals/engine/manage-resources/contexts.md) for more details. {{< /accordion >}} ## Supported platforms diff --git a/content/desktop/install/mac-install.md b/content/manuals/desktop/install/mac-install.md similarity index 98% rename from content/desktop/install/mac-install.md rename to content/manuals/desktop/install/mac-install.md index 51893f7509..76b0a421ce 100644 --- a/content/desktop/install/mac-install.md +++ b/content/manuals/desktop/install/mac-install.md @@ -5,6 +5,8 @@ keywords: docker for mac, install docker macos, docker mac, docker mac install, install macos, install docker on mac, install docker macbook, docker desktop for mac, how to install docker on mac, setup docker on mac title: Install Docker Desktop on Mac +linkTitle: Mac +weight: 10 aliases: - /desktop/mac/install/ - /docker-for-mac/install/ @@ -104,7 +106,7 @@ The `install` command accepts the following flags: - `--accept-license`: Accepts the [Docker Subscription Service Agreement](https://www.docker.com/legal/docker-subscription-service-agreement) now, rather than requiring it to be accepted when the application is first run. - `--allowed-org=`: Requires the user to sign in and be part of the specified Docker Hub organization when running the application - `--user=`: Performs the privileged configurations once during installation. This removes the need for the user to grant root privileges on first run. For more information, see [Privileged helper permission requirements](../mac/permission-requirements.md#permission-requirements). To find the username, enter `ls /Users` in the CLI. -- `--admin-settings`: Automatically creates an `admin-settings.json` file which is used by administrators to control certain Docker Desktop settings on client machines within their organization. For more information, see [Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md). +- `--admin-settings`: Automatically creates an `admin-settings.json` file which is used by administrators to control certain Docker Desktop settings on client machines within their organization. For more information, see [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md). - It must be used together with the `--allowed-org=` flag. - For example: `--allowed-org= --admin-settings='{"configurationFileVersion": 2, "enhancedContainerIsolation": {"value": true, "locked": false}}'` diff --git a/content/desktop/install/msi/_index.md b/content/manuals/desktop/install/msi/_index.md similarity index 96% rename from content/desktop/install/msi/_index.md rename to content/manuals/desktop/install/msi/_index.md index 88f49103b5..ca528c4f36 100644 --- a/content/desktop/install/msi/_index.md +++ b/content/manuals/desktop/install/msi/_index.md @@ -1,5 +1,7 @@ --- title: Deploy with Microsoft installer +linkTitle: Use the MSI installer +weight: 30 description: If you're an IT admin, learn how to deploy Docker Desktop with Microsoft installer keywords: msi, docker desktop, windows, installation --- diff --git a/content/desktop/install/msi/faq.md b/content/manuals/desktop/install/msi/faq.md similarity index 100% rename from content/desktop/install/msi/faq.md rename to content/manuals/desktop/install/msi/faq.md diff --git a/content/desktop/install/msi/install-and-configure.md b/content/manuals/desktop/install/msi/install-and-configure.md similarity index 98% rename from content/desktop/install/msi/install-and-configure.md rename to content/manuals/desktop/install/msi/install-and-configure.md index 082cb1b316..f96de559fd 100644 --- a/content/desktop/install/msi/install-and-configure.md +++ b/content/manuals/desktop/install/msi/install-and-configure.md @@ -180,7 +180,7 @@ msiexec /x "DockerDesktop.msi" /quiet | :--- | :--- | :--- | | `ENABLEDESKTOPSHORTCUT` | Creates a desktop shortcut. | 1 | | `INSTALLFOLDER` | Specifies a custom location where Docker Desktop will be installed. | C:\Program Files\Docker | -| `ADMINSETTINGS` | Automatically creates an `admin-settings.json` file which is used to [control certain Docker Desktop settings](/security/for-admins/hardened-desktop/settings-management/_index.md) on client machines within organizations. It must be used together with the `ALLOWEDORG` property. | None | +| `ADMINSETTINGS` | Automatically creates an `admin-settings.json` file which is used to [control certain Docker Desktop settings](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md) on client machines within organizations. It must be used together with the `ALLOWEDORG` property. | None | | `ALLOWEDORG` | Requires the user to sign in and be part of the specified Docker Hub organization when running the application. This creates a registry key called `allowedOrgs` in `HKLM\Software\Policies\Docker\Docker Desktop`. | None | | `ALWAYSRUNSERVICE` | Lets users switch to Windows containers without needing admin rights | 0 | | `DISABLEWINDOWSCONTAINERS` | Disables the Windows containers integration | 0 | diff --git a/content/desktop/install/msi/use-intune.md b/content/manuals/desktop/install/msi/use-intune.md similarity index 100% rename from content/desktop/install/msi/use-intune.md rename to content/manuals/desktop/install/msi/use-intune.md diff --git a/content/desktop/install/rhel.md b/content/manuals/desktop/install/rhel.md similarity index 99% rename from content/desktop/install/rhel.md rename to content/manuals/desktop/install/rhel.md index 3daeed64eb..60e0dc16bc 100644 --- a/content/desktop/install/rhel.md +++ b/content/manuals/desktop/install/rhel.md @@ -4,6 +4,8 @@ keywords: red hat, red hat enterprise linux, rhel, rpm, update install, uninstall, upgrade, update, linux, desktop, docker desktop, docker desktop for linux, dd4l title: Install Docker Desktop on RHEL +linkTitle: RHEL +weight: 90 toc_max: 4 download-url-base: https://download.docker.com/linux/rhel --- diff --git a/content/desktop/install/ubuntu.md b/content/manuals/desktop/install/ubuntu.md similarity index 96% rename from content/desktop/install/ubuntu.md rename to content/manuals/desktop/install/ubuntu.md index 28cb706d01..b6161161b4 100644 --- a/content/desktop/install/ubuntu.md +++ b/content/manuals/desktop/install/ubuntu.md @@ -6,6 +6,8 @@ keywords: install docker ubuntu, ubuntu install docker, install docker on ubuntu installation on ubuntu, docker ubuntu install, docker installing ubuntu, installing docker on ubuntu, docker desktop for ubuntu title: Install Docker Desktop on Ubuntu +linkTitle: Ubuntu +weight: 50 toc_max: 4 aliases: - /desktop/linux/install/ubuntu/ @@ -39,7 +41,7 @@ To install Docker Desktop successfully, you must: Recommended approach to install Docker Desktop on Ubuntu: 1. Set up Docker's package repository. - See step one of [Install using the `apt` repository](../../engine/install/ubuntu.md#install-using-the-repository). + See step one of [Install using the `apt` repository](/manuals/engine/install/ubuntu.md#install-using-the-repository). 2. Download the latest [DEB package](https://desktop.docker.com/linux/main/amd64/docker-desktop-amd64.deb?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-linux-amd64). For checksums, see the [Release notes](../release-notes.md). diff --git a/content/desktop/install/windows-install.md b/content/manuals/desktop/install/windows-install.md similarity index 99% rename from content/desktop/install/windows-install.md rename to content/manuals/desktop/install/windows-install.md index 8979a72485..e754ae53d9 100644 --- a/content/desktop/install/windows-install.md +++ b/content/manuals/desktop/install/windows-install.md @@ -5,6 +5,8 @@ keywords: docker for windows, docker windows, docker desktop for windows, docker windows, install docker windows, install docker on windows, docker windows 10, docker run on windows, installing docker for windows, windows containers, wsl, hyper-v title: Install Docker Desktop on Windows +linkTitle: Windows +weight: 20 aliases: - /desktop/windows/install/ - /docker-ee-for-windows/install/ @@ -213,7 +215,7 @@ The `install` command accepts the following flags: - `--allowed-org=`: Requires the user to sign in and be part of the specified Docker Hub organization when running the application - `--backend=`: Selects the default backend to use for Docker Desktop, `hyper-v`, `windows` or `wsl-2` (default) - `--installation-dir=`: Changes the default installation location (`C:\Program Files\Docker\Docker`) -- `--admin-settings`: Automatically creates an `admin-settings.json` file which is used by admins to control certain Docker Desktop settings on client machines within their organization. For more information, see [Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md). +- `--admin-settings`: Automatically creates an `admin-settings.json` file which is used by admins to control certain Docker Desktop settings on client machines within their organization. For more information, see [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md). - It must be used together with the `--allowed-org=` flag. - For example: diff --git a/content/desktop/kubernetes.md b/content/manuals/desktop/kubernetes.md similarity index 100% rename from content/desktop/kubernetes.md rename to content/manuals/desktop/kubernetes.md diff --git a/content/desktop/linux/Makefile b/content/manuals/desktop/linux/Makefile similarity index 100% rename from content/desktop/linux/Makefile rename to content/manuals/desktop/linux/Makefile diff --git a/content/desktop/linux/images/diagnose-support.png b/content/manuals/desktop/linux/images/diagnose-support.png similarity index 100% rename from content/desktop/linux/images/diagnose-support.png rename to content/manuals/desktop/linux/images/diagnose-support.png diff --git a/content/desktop/linux/images/menu/prefs.png b/content/manuals/desktop/linux/images/menu/prefs.png similarity index 100% rename from content/desktop/linux/images/menu/prefs.png rename to content/manuals/desktop/linux/images/menu/prefs.png diff --git a/content/desktop/mac/Makefile b/content/manuals/desktop/mac/Makefile similarity index 100% rename from content/desktop/mac/Makefile rename to content/manuals/desktop/mac/Makefile diff --git a/content/manuals/desktop/mac/_index.md b/content/manuals/desktop/mac/_index.md new file mode 100644 index 0000000000..05ac165ff6 --- /dev/null +++ b/content/manuals/desktop/mac/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Docker Desktop for Mac +--- diff --git a/content/desktop/mac/images/menu/prefs.png b/content/manuals/desktop/mac/images/menu/prefs.png similarity index 100% rename from content/desktop/mac/images/menu/prefs.png rename to content/manuals/desktop/mac/images/menu/prefs.png diff --git a/content/desktop/mac/images/menu/troubleshoot.png b/content/manuals/desktop/mac/images/menu/troubleshoot.png similarity index 100% rename from content/desktop/mac/images/menu/troubleshoot.png rename to content/manuals/desktop/mac/images/menu/troubleshoot.png diff --git a/content/desktop/mac/images/whale-x.svg b/content/manuals/desktop/mac/images/whale-x.svg similarity index 100% rename from content/desktop/mac/images/whale-x.svg rename to content/manuals/desktop/mac/images/whale-x.svg diff --git a/content/desktop/mac/permission-requirements.md b/content/manuals/desktop/mac/permission-requirements.md similarity index 99% rename from content/desktop/mac/permission-requirements.md rename to content/manuals/desktop/mac/permission-requirements.md index b769d75a48..5614552ed1 100644 --- a/content/desktop/mac/permission-requirements.md +++ b/content/manuals/desktop/mac/permission-requirements.md @@ -176,7 +176,7 @@ retain their original permissions. ## Enhanced Container Isolation In addition, Docker Desktop supports [Enhanced Container Isolation -mode](/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md) (ECI), +mode](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md) (ECI), available to Business customers only, which further secures containers without impacting developer workflows. diff --git a/content/desktop/networking.md b/content/manuals/desktop/networking.md similarity index 97% rename from content/desktop/networking.md rename to content/manuals/desktop/networking.md index 74383f3e4b..caa85cc2b3 100644 --- a/content/desktop/networking.md +++ b/content/manuals/desktop/networking.md @@ -181,8 +181,8 @@ container to random ports on the host. $ docker run -d -P --name webserver nginx ``` -Alternatively, you can also use [host networking](/engine/network/drivers/host.md#docker-desktop) +Alternatively, you can also use [host networking](/manuals/engine/network/drivers/host.md#docker-desktop) to give the container direct access to the network stack of the host. -See the [run command](../reference/cli/docker/container/run.md) for more details on +See the [run command](/reference/cli/docker/container/run.md) for more details on publish options used with `docker run`. diff --git a/content/desktop/previous-versions/2.x-mac.md b/content/manuals/desktop/previous-versions/2.x-mac.md similarity index 99% rename from content/desktop/previous-versions/2.x-mac.md rename to content/manuals/desktop/previous-versions/2.x-mac.md index 1bd0d69ffe..9b0c94408f 100644 --- a/content/desktop/previous-versions/2.x-mac.md +++ b/content/manuals/desktop/previous-versions/2.x-mac.md @@ -340,7 +340,7 @@ Note that you must sign in and create a Docker ID in order to download Docker De Docker Desktop Community 2.1.0.0 contains the following experimental features. * Docker App: Docker App is a CLI plugin that helps configure, share, and install applications. -* Docker Buildx: Docker Buildx is a CLI plugin for extended build capabilities with BuildKit. For more information, see the [Build page](../../build/index.md). +* Docker Buildx: Docker Buildx is a CLI plugin for extended build capabilities with BuildKit. For more information, see the [Build page](/manuals/build/index.md). ### Bug fixes and minor changes diff --git a/content/desktop/previous-versions/2.x-windows.md b/content/manuals/desktop/previous-versions/2.x-windows.md similarity index 99% rename from content/desktop/previous-versions/2.x-windows.md rename to content/manuals/desktop/previous-versions/2.x-windows.md index a6f1b342cf..7fd5cef901 100644 --- a/content/desktop/previous-versions/2.x-windows.md +++ b/content/manuals/desktop/previous-versions/2.x-windows.md @@ -468,7 +468,7 @@ Note that you must sign in and create a Docker ID in order to download Docker De Docker Desktop Community 2.1.0.0 contains the following experimental features: * Docker App: Docker App is a CLI plugin that helps configure, share, and install applications. -* Docker Buildx: Docker Buildx is a CLI plugin for extended build capabilities with BuildKit. For more information, see the [Build page](../../build/index.md). +* Docker Buildx: Docker Buildx is a CLI plugin for extended build capabilities with BuildKit. For more information, see the [Build page](/manuals/build/index.md). ### Bug fixes and minor changes diff --git a/content/desktop/previous-versions/3.x-mac.md b/content/manuals/desktop/previous-versions/3.x-mac.md similarity index 93% rename from content/desktop/previous-versions/3.x-mac.md rename to content/manuals/desktop/previous-versions/3.x-mac.md index 7f83c022c0..4a77e45ab9 100644 --- a/content/desktop/previous-versions/3.x-mac.md +++ b/content/manuals/desktop/previous-versions/3.x-mac.md @@ -28,7 +28,7 @@ This page contains release notes for Docker Desktop for Mac 3.x. - Allow setting 0 scale/replicas. - Detect new container on logs —follow. - [Go 1.16.7](https://github.com/golang/go/releases/tag/go1.16.7) -- [Docker Engine 20.10.8](../../engine/release-notes/20.10.md#20108) +- [Docker Engine 20.10.8](/manuals/engine/release-notes/20.10.md#20108) - [containerd v1.4.9](https://github.com/containerd/containerd/releases/tag/v1.4.9) - [runc v1.0.1](https://github.com/opencontainers/runc/releases/tag/v1.0.1) - [Kubernetes 1.21.3](https://github.com/kubernetes/kubernetes/releases/tag/v1.21.3) @@ -79,7 +79,7 @@ This page contains release notes for Docker Desktop for Mac 3.x. **Dev Environments Preview**: Dev Environments enable you to seamlessly collaborate with your team members without moving between Git branches to get your code onto your team members' machines. When using Dev Environments, you can share your in-progress work with your team members in just one click, and without having to deal with any merge conflicts. For more information and for instructions on how to use Dev Environments, see [Development Environments Preview](../dev-environments/index.md). -**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. +**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](/manuals/compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. ### Bug fixes and minor changes @@ -92,7 +92,7 @@ This page contains release notes for Docker Desktop for Mac 3.x. **Dev Environments Preview**: Dev Environments enable you to seamlessly collaborate with your team members without moving between Git branches to get your code onto your team members' machines. When using Dev Environments, you can share your in-progress work with your team members in just one click, and without having to deal with any merge conflicts. For more information and for instructions on how to use Dev Environments, see [Development Environments Preview](../dev-environments/index.md). -**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. +**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](/manuals/compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. ### Upgrades @@ -124,17 +124,17 @@ This page contains release notes for Docker Desktop for Mac 3.x. **Volume Management**: Docker Desktop users can now create and delete volumes using the Docker Dashboard and also see which volumes are being used. For more information, see [Explore volumes](../use-desktop/volumes.md). -**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. +**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](/manuals/compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. **Skip Docker Desktop updates**: All users can now skip an update when they are prompted to install individual Docker Desktop releases. ### Deprecation -- Docker Desktop no longer installs Notary. You can now use [Docker Content Trust](../../engine/security/trust/index.md) for image signing. +- Docker Desktop no longer installs Notary. You can now use [Docker Content Trust](/manuals/engine/security/trust/index.md) for image signing. ### Upgrades -- [Docker Engine 20.10.7](../../engine/release-notes/20.10.md#20107) +- [Docker Engine 20.10.7](/manuals/engine/release-notes/20.10.md#20107) - [Docker Compose 1.29.2](https://github.com/docker/compose/releases/tag/1.29.2) - [Docker Hub Tool v0.4.1](https://github.com/docker/hub-tool/releases/tag/v0.4.1) - [Compose CLI v1.0.16](https://github.com/docker/compose-cli/releases/tag/v1.0.16) @@ -183,7 +183,7 @@ This page contains release notes for Docker Desktop for Mac 3.x. - [Compose CLI v1.0.14](https://github.com/docker/compose-cli/tree/v1.0.14) - [Go 1.16.3](https://golang.org/doc/go1.16) - [Docker Compose 1.29.1](https://github.com/docker/compose/releases/tag/1.29.1) -- [Docker Engine 20.10.6](../../engine/release-notes/20.10.md#20106) +- [Docker Engine 20.10.6](/manuals/engine/release-notes/20.10.md#20106) ### Bug fixes and minor changes @@ -267,7 +267,7 @@ For developers in IT managed environments, who don’t have administrative acces ### Upgrades -- [Docker Engine 20.10.5](../../engine/release-notes/20.10.md#20105) +- [Docker Engine 20.10.5](/manuals/engine/release-notes/20.10.md#20105) ### Bug fixes and minor changes @@ -291,7 +291,7 @@ For developers in IT managed environments, who don’t have administrative acces ### Upgrades -- [Docker Engine 20.10.3](../../engine/release-notes/20.10.md#20103) +- [Docker Engine 20.10.3](/manuals/engine/release-notes/20.10.md#20103) - [Docker Compose 1.28.5](https://github.com/docker/compose/releases/tag/1.28.5) - [Compose CLI v1.0.9](https://github.com/docker/compose-cli/tree/v1.0.9) - [Docker Hub Tool v0.3.0](https://github.com/docker/hub-tool/releases/tag/v0.3.0) @@ -337,7 +337,7 @@ Docker Desktop can sometimes fail to start after updating to version 3.2.0. If y ### Upgrades -- [Docker Engine 20.10.2](../../engine/release-notes/20.10.md#20102) +- [Docker Engine 20.10.2](/manuals/engine/release-notes/20.10.md#20102) ### Bug fixes and minor changes @@ -404,7 +404,7 @@ Docker Desktop can sometimes fail to start after updating to version 3.2.0. If y ### Upgrades -- [Docker Engine 20.10.0](../../engine/release-notes/20.10.md#20100) +- [Docker Engine 20.10.0](/manuals/engine/release-notes/20.10.md#20100) - [Go 1.15.6](https://github.com/golang/go/issues?q=milestone%3AGo1.15.6+label%3ACherryPickApproved+) - [Compose CLI v1.0.4](https://github.com/docker/compose-cli/releases/tag/v1.0.4) - [Snyk v1.432.0](https://github.com/snyk/snyk/releases/tag/v1.432.0) diff --git a/content/desktop/previous-versions/3.x-windows.md b/content/manuals/desktop/previous-versions/3.x-windows.md similarity index 92% rename from content/desktop/previous-versions/3.x-windows.md rename to content/manuals/desktop/previous-versions/3.x-windows.md index 2d1f7f90db..3235a120f1 100644 --- a/content/desktop/previous-versions/3.x-windows.md +++ b/content/manuals/desktop/previous-versions/3.x-windows.md @@ -28,7 +28,7 @@ This page contains release notes for Docker Desktop for Windows 3.x. - Allow setting 0 scale/replicas. - Detect new container on logs —follow. - [Go 1.16.7](https://github.com/golang/go/releases/tag/go1.16.7) -- [Docker Engine 20.10.8](../../engine/release-notes/20.10.md#20108) +- [Docker Engine 20.10.8](/manuals/engine/release-notes/20.10.md#20108) - [containerd v1.4.9](https://github.com/containerd/containerd/releases/tag/v1.4.9) - [runc v1.0.1](https://github.com/opencontainers/runc/releases/tag/v1.0.1) - [Kubernetes 1.21.3](https://github.com/kubernetes/kubernetes/releases/tag/v1.21.3) @@ -86,7 +86,7 @@ This page contains release notes for Docker Desktop for Windows 3.x. **Dev Environments Preview**: Dev Environments enable you to seamlessly collaborate with your team members without moving between Git branches to get your code onto your team members' machines. When using Dev Environments, you can share your in-progress work with your team members in just one click, and without having to deal with any merge conflicts. For more information and for instructions on how to use Dev Environments, see [Development Environments Preview](../dev-environments/index.md). -**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. +**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](/manuals/compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. ### Bug fixes and minor changes @@ -100,7 +100,7 @@ This page contains release notes for Docker Desktop for Windows 3.x. **Dev Environments Preview**: Dev Environments enable you to seamlessly collaborate with your team members without moving between Git branches to get your code onto your team members' machines. When using Dev Environments, you can share your in-progress work with your team members in just one click, and without having to deal with any merge conflicts. For more information and for instructions on how to use Dev Environments, see [Development Environments Preview](../dev-environments/index.md). -**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. +**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](/manuals/compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. ### Upgrades @@ -131,7 +131,7 @@ This page contains release notes for Docker Desktop for Windows 3.x. **Volume Management**: Docker Desktop users can now create and delete volumes using the Docker Dashboard and also see which volumes are being used. For more information, see [Explore volumes](../use-desktop/volumes.md). -**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](../../compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. +**Compose V2 beta**: Docker Desktop now includes the beta version of Compose V2, which supports the `docker compose` command as part of the Docker CLI. While `docker-compose` is still supported and maintained, Compose V2 implementation relies directly on the compose-go bindings which are maintained as part of the specification. The compose command in the Docker CLI supports most of the `docker-compose` commands and flags. It is expected to be a drop-in replacement for `docker-compose`. There are a few remaining flags that have yet to be implemented, see the [docker-compose compatibility list](/manuals/compose/migrate.md) for more information about the flags that are supported in the new compose command. If you run into any problems with Compose V2, you can easily switch back to Compose v1 by either by making changes in Docker Desktop **Experimental** Settings, or by running the command `docker-compose disable-v2`. Let us know your feedback on the new ‘compose’ command by creating an issue in the [Compose-CLI](https://github.com/docker/compose-cli/issues) GitHub repository. **Skip Docker Desktop updates**: All users can now skip an update when they are prompted to install individual Docker Desktop releases. @@ -141,7 +141,7 @@ This page contains release notes for Docker Desktop for Windows 3.x. ### Upgrades -- [Docker Engine 20.10.7](../../engine/release-notes/20.10.md#20107) +- [Docker Engine 20.10.7](/manuals/engine/release-notes/20.10.md#20107) - [Docker Compose 1.29.2](https://github.com/docker/compose/releases/tag/1.29.2) - [Docker Hub Tool v0.4.1](https://github.com/docker/hub-tool/releases/tag/v0.4.1) - [Compose CLI v1.0.16](https://github.com/docker/compose-cli/releases/tag/v1.0.16) @@ -181,7 +181,7 @@ This page contains release notes for Docker Desktop for Windows 3.x. - [Compose CLI v1.0.14](https://github.com/docker/compose-cli/tree/v1.0.14) - [Go 1.16.3](https://golang.org/doc/go1.16) - [Docker Compose 1.29.1](https://github.com/docker/compose/releases/tag/1.29.1) -- [Docker Engine 20.10.6](../../engine/release-notes/20.10.md#20106) +- [Docker Engine 20.10.6](/manuals/engine/release-notes/20.10.md#20106) ### Bug fixes and minor changes @@ -245,7 +245,7 @@ For developers in IT managed environments, who don’t have administrative acces ### Upgrades -- [Docker Engine 20.10.5](../../engine/release-notes/20.10.md#20105) +- [Docker Engine 20.10.5](/manuals/engine/release-notes/20.10.md#20105) ## Docker Desktop 3.2.0 2021-03-01 @@ -263,7 +263,7 @@ For developers in IT managed environments, who don’t have administrative acces ### Upgrades -- [Docker Engine 20.10.3](../../engine/release-notes/20.10.md#20103) +- [Docker Engine 20.10.3](/manuals/engine/release-notes/20.10.md#20103) - [Docker Compose 1.28.5](https://github.com/docker/compose/releases/tag/1.28.5) - [Compose CLI v1.0.9](https://github.com/docker/compose-cli/tree/v1.0.9) - [Docker Hub Tool v0.3.0](https://github.com/docker/hub-tool/releases/tag/v0.3.0) @@ -312,7 +312,7 @@ For developers in IT managed environments, who don’t have administrative acces 2021-01-06 pgrades -- [Docker Engine 20.10.2](../../engine/release-notes/20.10.md#20102) +- [Docker Engine 20.10.2](/manuals/engine/release-notes/20.10.md#20102) ### Bug fixes and minor changes @@ -335,7 +335,7 @@ pgrades ### Upgrades -- [Docker Engine 20.10.0](../../engine/release-notes/20.10.md#20100) +- [Docker Engine 20.10.0](/manuals/engine/release-notes/20.10.md#20100) - [Go 1.15.6](https://github.com/golang/go/issues?q=milestone%3AGo1.15.6+label%3ACherryPickApproved+) - [Compose CLI v1.0.4](https://github.com/docker/compose-cli/releases/tag/v1.0.4) - [Snyk v1.432.0](https://github.com/snyk/snyk/releases/tag/v1.432.0) diff --git a/content/manuals/desktop/previous-versions/_index.md b/content/manuals/desktop/previous-versions/_index.md new file mode 100644 index 0000000000..bede2323f5 --- /dev/null +++ b/content/manuals/desktop/previous-versions/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Previous releases +--- diff --git a/content/desktop/previous-versions/archive-mac.md b/content/manuals/desktop/previous-versions/archive-mac.md similarity index 99% rename from content/desktop/previous-versions/archive-mac.md rename to content/manuals/desktop/previous-versions/archive-mac.md index f9d93517bd..28003bd6bc 100644 --- a/content/desktop/previous-versions/archive-mac.md +++ b/content/manuals/desktop/previous-versions/archive-mac.md @@ -36,7 +36,7 @@ This page contains release notes for older versions of Docker Desktop for Mac. - Re-enable raw as the default disk format for users running macOS 10.13.4 and higher. Note this change only takes effect after a "reset to factory defaults" or "remove all data" (from the Whale menu -> Preferences -> Reset). Related to [docker/for-mac#2625](https://github.com/docker/for-mac/issues/2625) * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) - OS X El Captain 10.11 is deprecated in Docker Desktop. You will not be able to install updates after Docker Desktop 18.06.x. We recommend upgrading to the latest version of macOS. - Fix bug which would cause VM logs to be written to RAM rather than disk in some cases, and the VM to hang. See [docker/for-mac#2984](https://github.com/docker/for-mac/issues/2984) - Fix network connection leak triggered by haproxy TCP health-checks [docker/for-mac#1132](https://github.com/docker/for-mac/issues/1132) diff --git a/content/desktop/previous-versions/archive-windows.md b/content/manuals/desktop/previous-versions/archive-windows.md similarity index 99% rename from content/desktop/previous-versions/archive-windows.md rename to content/manuals/desktop/previous-versions/archive-windows.md index a06c5674bd..efeb4f928e 100644 --- a/content/desktop/previous-versions/archive-windows.md +++ b/content/manuals/desktop/previous-versions/archive-windows.md @@ -50,7 +50,7 @@ This page contains release notes for older versions of Docker Desktop for Window - Kubernetes Support. You can now run a single-node Kubernetes cluster from the "Kubernetes" Pane in Docker for Windows settings and use kubectl commands as well as Docker commands. See [the Kubernetes section](../kubernetes.md) * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset the disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [backup volumes](/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset the disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [backup volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) - Fix bug which would in some cases cause virtual machine logs to be written to RAM rather than disk, and the virtual machine to hang. - Fix security issue with named pipe connection to docker service. - Fix VPNKit memory leak. Fixes [docker/for-win#2087](https://github.com/docker/for-win/issues/2087), [moby/vpnkit#371](https://github.com/moby/vpnkit/issues/371) diff --git a/content/desktop/previous-versions/edge-releases-mac.md b/content/manuals/desktop/previous-versions/edge-releases-mac.md similarity index 99% rename from content/desktop/previous-versions/edge-releases-mac.md rename to content/manuals/desktop/previous-versions/edge-releases-mac.md index d7c4379d48..fb1e85f8fc 100644 --- a/content/desktop/previous-versions/edge-releases-mac.md +++ b/content/manuals/desktop/previous-versions/edge-releases-mac.md @@ -733,7 +733,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus - Add an experimental SOCKS server to allow access to container networks, see [docker/for-mac#2670](https://github.com/docker/for-mac/issues/2670#issuecomment-372365274). Also see [docker/for-mac#2721](https://github.com/docker/for-mac/issues/2721) * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Preferences > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) - Fix startup issue with AUFS [docker/for-mac#2804](https://github.com/docker/for-mac/issues/2804) - Fix status bug which could prevent the Kubernetes cluster from starting. Fixes [docker/for-mac#2990](https://github.com/docker/for-mac/issues/2990) - Fix bug which would cause virtual machine logs to be written to RAM rather than disk in some cases, and the virtual machine to hang. See [docker/for-mac#2984](https://github.com/docker/for-mac/issues/2984) diff --git a/content/desktop/previous-versions/edge-releases-windows.md b/content/manuals/desktop/previous-versions/edge-releases-windows.md similarity index 99% rename from content/desktop/previous-versions/edge-releases-windows.md rename to content/manuals/desktop/previous-versions/edge-releases-windows.md index 38e0c67b33..8499eb8c91 100644 --- a/content/desktop/previous-versions/edge-releases-windows.md +++ b/content/manuals/desktop/previous-versions/edge-releases-windows.md @@ -954,7 +954,7 @@ This release contains a Kubernetes upgrade. Note that your local Kubernetes clus - New Kubernetes menu item allowing to switch Kubernetes context & connect to clusters other than the local one. * Bug fixes and minor changes - - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) + - AUFS storage driver is deprecated in Docker Desktop and AUFS support will be removed in the next major release. You can continue with AUFS in Docker Desktop 18.06.x, but you will need to reset disk image (in Settings > Reset menu) before updating to the next major update. You can check documentation to [save images](/reference/cli/docker/image/save/#examples) and [back up volumes](/manuals/engine/storage/volumes.md#back-up-restore-or-migrate-data-volumes) - Fix startup issue with AUFS - Fix status bug which could prevent the kubernetes cluster from starting. - Fix bug which would cause VM logs to be written to RAM rather than disk in some cases, and the VM to hang. diff --git a/content/desktop/release-notes.md b/content/manuals/desktop/release-notes.md similarity index 96% rename from content/desktop/release-notes.md rename to content/manuals/desktop/release-notes.md index 8cac9f58bc..3d1d2288e1 100644 --- a/content/desktop/release-notes.md +++ b/content/manuals/desktop/release-notes.md @@ -41,13 +41,13 @@ Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projec ### New -- [Host networking](/engine/network/drivers/host.md#docker-desktop) support on Docker Desktop is now generally available. +- [Host networking](/manuals/engine/network/drivers/host.md#docker-desktop) support on Docker Desktop is now generally available. - If you authenticate via the CLI, you can now authenticate through a browser-based flow, removing the need for manual PAT generation. -- Windows now supports automatic reclamation of disk space in Docker Desktop for WSL2 installations [using a managed virtual hard disk](/desktop/wsl/best-practices.md). -- Deploying Docker Desktop via the [MSI installer](/desktop/install/msi/_index.md) is now generally available. -- Two new methods to [enforce sign-in](/security/for-admins/enforce-sign-in/_index.md) (windows registry key and `.plist` file) are now generally available. +- Windows now supports automatic reclamation of disk space in Docker Desktop for WSL2 installations [using a managed virtual hard disk](/manuals/desktop/wsl/best-practices.md). +- Deploying Docker Desktop via the [MSI installer](/manuals/desktop/install/msi/_index.md) is now generally available. +- Two new methods to [enforce sign-in](/manuals/security/for-admins/enforce-sign-in/_index.md) (windows registry key and `.plist` file) are now generally available. - Fresh installations of Docker Desktop now use the containerd image store by default. -- [Compose Bridge](/compose/bridge/_index.md) (Experimental) is now available from the Compose file viewer. Easily convert and deploy your Compose project to a Kubernetes cluster. +- [Compose Bridge](/manuals/compose/bridge/_index.md) (Experimental) is now available from the Compose file viewer. Easily convert and deploy your Compose project to a Kubernetes cluster. ### Upgrades @@ -92,8 +92,8 @@ Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projec > [!NOTE] > Using `docker login` with an address that includes URL path segments is not a documented use case and is considered unsupported. The recommended usage is to specify only a registry hostname, and optionally a port, as the address for `docker login`. - When running `docker compose up` and Docker Desktop is in the Resource Saver mode, the command is unresponsive. As a workaround, manually exit the Resource Saving mode and Docker Compose becomes responsive again. -- When [Enhanced Container Isolation (ECI)](/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md) is enabled, Docker Desktop may not enter Resource Saver mode. This will be fixed in a future Docker Desktop release. -- The new [ECI Docker socket mount permissions for derived images](/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md#docker-socket-mount-permissions-for-derived-images) feature does not yet work when Docker Desktop is configured with the **Use containerd for pulling and storing images**. This will be fixed in the next Docker Desktop release. +- When [Enhanced Container Isolation (ECI)](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md) is enabled, Docker Desktop may not enter Resource Saver mode. This will be fixed in a future Docker Desktop release. +- The new [ECI Docker socket mount permissions for derived images](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md#docker-socket-mount-permissions-for-derived-images) feature does not yet work when Docker Desktop is configured with the **Use containerd for pulling and storing images**. This will be fixed in the next Docker Desktop release. ## 4.33.1 @@ -115,7 +115,7 @@ Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projec ### New -- [Docker Debug](../reference/cli/docker/debug.md) is now generally available. +- [Docker Debug](/reference/cli/docker/debug.md) is now generally available. - BuildKit now evaluates Dockerfile rules to inform you of potential issues. - **Resource Allocation** settings can now be accessed directly from the resource usage data displayed in the Dashboard footer. @@ -144,7 +144,7 @@ Take a look at the [Docker Public Roadmap](https://github.com/orgs/docker/projec - Docker Desktop now notifies when there is a port conflict in a host networking container. - Compose Bridge command line option is now available via Experimental features. When enabled, run `compose-bridge` to convert your Compose configuration to Kubernetes resources. - Builds view: - - Added [build checks](../build/checks.md) to the build details' **Source** tab. + - Added [build checks](/manuals/build/checks.md) to the build details' **Source** tab. - Added build tags to the build details' **Info** tab under the **Source details** section. - Newly imported builds are now highlighted. - Improved performance of error message handling. @@ -207,7 +207,7 @@ For more information, see [microsoft/WSL#11794](https://github.com/microsoft/WSL - Improved instructions for `watch` in the Compose File Viewer - Added support for Golang projects that don't have dependencies in Docker Init. Addresses [docker/roadmap#611](https://github.com/docker/roadmap/issues/611) -- [Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md) now lets admins set the default value to `ProxyEnableKerberosNTLM`. +- [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md) now lets admins set the default value to `ProxyEnableKerberosNTLM`. - Removed a temporary compatibility fix for older versions of Visual Studio Code. - Builds view: - Changed icon for imported build record to a "files" icon. @@ -270,7 +270,7 @@ For more information, see [microsoft/WSL#11794](https://github.com/microsoft/WSL ### New -- [Air-Gapped Containers](/security/for-admins/hardened-desktop/air-gapped-containers.md) is now generally available. +- [Air-Gapped Containers](/manuals/security/for-admins/hardened-desktop/air-gapped-containers.md) is now generally available. - Docker Compose File Viewer shows your Compose YAML with syntax highlighting and contextual links to relevant docs (Beta, progressive rollout). - New Sidebar user experience. @@ -294,12 +294,12 @@ For more information, see [microsoft/WSL#11794](https://github.com/microsoft/WSL - Added `proxyEnableKerberosNTLM` config to `settings.json` to enable fallback to basic proxy authentication if Kerberos/NTLM environment is not properly set up. - Fixed a bug where Docker Debug was not working properly with Enhanced Container Isolation enabled. - Fixed a bug where UDP responses were not truncated properly. -- Fixed a bug where the **Update** screen was hidden when using [Settings Management](/security/for-admins/hardened-desktop/settings-management/_index.md). +- Fixed a bug where the **Update** screen was hidden when using [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md). - Fixed a bug where proxy settings defined in `admin-settings.json` were not applied correctly on startup. - Fixed a bug where the **Manage Synchronized file shares with Compose** toggle did not correctly reflect the value with the feature. - Fixed a bug where a bind mounted file modified on host is not updated after the container restarts, when gRPC FUSE file sharing is used on macOS and on Windows with Hyper-V. Fixes [docker/for-mac#7274](https://github.com/docker/for-mac/issues/7274), [docker/for-win#14060](https://github.com/docker/for-win/issues/14060). - Builds view: - - New [Import builds](use-desktop/builds.md#import-builds) feature that lets you import build records for builds by other people, or [builds in a CI environment](../build/ci/github-actions/build-summary.md). + - New [Import builds](use-desktop/builds.md#import-builds) feature that lets you import build records for builds by other people, or [builds in a CI environment](/manuals/build/ci/github-actions/build-summary.md). - Fixed missing OpenTelemetry traces in build results for failed builds. - Fixed `default-load` appearing as invalid driver-opt for the container driver. - Fixed deep link to build details. @@ -359,7 +359,7 @@ For more information, see [microsoft/WSL#11794](https://github.com/microsoft/WSL #### For all platforms - Docker Desktop now supports [SOCKS5 proxies](networking.md#socks5-proxy-support). Requires a Business subscription. -- Added a new setting to manage the onboarding survey in [Settings Management](/security/for-admins/hardened-desktop/settings-management/_index.md). +- Added a new setting to manage the onboarding survey in [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/_index.md). #### For Windows @@ -369,7 +369,7 @@ For more information, see [microsoft/WSL#11794](https://github.com/microsoft/WSL - [Docker Compose v2.27.0](https://github.com/docker/compose/releases/tag/v2.27.0) - [Docker Engine v26.1.1](https://docs.docker.com/engine/release-notes/26.1/#2611) -- [Wasm](../desktop/wasm/_index.md) runtimes: +- [Wasm](/manuals/desktop/wasm/_index.md) runtimes: - Updated `runwasi` shims to `v0.4.0` - Updated `deislabs` shims to `v0.11.1` - Updated `spin` shim to `v0.13.1` @@ -438,15 +438,15 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New -- You can now enforce Rosetta usage via [Settings Management](/security/for-admins/hardened-desktop/settings-management/configure.md). -- [Docker socket mount restrictions](/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md) with ECI is now generally available. +- You can now enforce Rosetta usage via [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md). +- [Docker socket mount restrictions](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md) with ECI is now generally available. - Docker Engine and CLI updated to [Moby 26.0](https://github.com/moby/moby/releases/tag/v26.0.0). This includes Buildkit 0.13, sub volumes mounts, networking updates, and improvements to the containerd multi-platform image store UX. - New and improved Docker Desktop error screens: swift troubleshooting, easy diagnostics uploads, and actionable remediation. - Compose supports [Synchronized file shares (experimental)](synchronized-file-sharing.md). -- New [interactive Compose CLI (experimental)](../compose/environment-variables/envvars.md#compose_menu). +- New [interactive Compose CLI (experimental)](/manuals/compose/environment-variables/envvars.md#compose_menu). - Beta release of: - - Air-Gapped Containers with [Settings Management](/security/for-admins/hardened-desktop/air-gapped-containers/_index.md). - - [Host networking](/engine/network/drivers/host.md#docker-desktop) in Docker Desktop. + - Air-Gapped Containers with [Settings Management](/manuals/security/for-admins/hardened-desktop/air-gapped-containers/_index.md). + - [Host networking](/manuals/engine/network/drivers/host.md#docker-desktop) in Docker Desktop. - [Docker Debug](use-desktop/container.md#integrated-terminal) for running containers. - [Volumes Backup & Share extension](use-desktop/volumes.md) functionality available in the **Volumes** tab. @@ -518,7 +518,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New -- [Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md) now allows admins to set the default file-sharing implementation and specify which paths developer can add file shares to. +- [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md) now allows admins to set the default file-sharing implementation and specify which paths developer can add file shares to. - Added support for `socks5://` HTTP and HTTPS proxy URLs when the [`SOCKS` proxy support beta feature](networking.md) is enabled. - Users can now filter volumes to see which ones are in use in the **Volumes** tab. @@ -528,7 +528,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - [Docker Engine v25.0.3](https://docs.docker.com/engine/release-notes/25.0/#2503) - [Docker Scout CLI v1.5.0](https://github.com/docker/scout-cli/releases/tag/v1.5.0) - [Qemu 8.1.5](https://wiki.qemu.org/ChangeLog/8.1) -- [Wasm](../desktop/wasm/_index.md) runtimes: +- [Wasm](/manuals/desktop/wasm/_index.md) runtimes: - Updated runwasi shims to `v0.4.0`, including: - wasmtime `v17.0`, with initial support for WASI preview 2 - wasmedge `v0.13.5` @@ -643,10 +643,10 @@ This can be resolved by adding the user to the **docker-users** group. Before st - Docker init now supports Java and is generally available to all users. - [Synchronized File Shares](synchronized-file-sharing.md) provides fast and flexible host-to-VM file sharing within Docker Desktop. Utilizing the technology behind [Docker’s acquisition of Mutagen](https://www.docker.com/blog/mutagen-acquisition/), this feature provides an alternative to virtual bind mounts that uses synchronized filesystem caches, improving performance for developers working with large codebases. -- Organization admins can now [configure Docker socket mount permissions](/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md) when ECI is enabled. +- Organization admins can now [configure Docker socket mount permissions](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md) when ECI is enabled. - [Containerd Image Store](containerd.md) support is now generally available to all users. -- Get a debug shell into any container or image with the new [`docker debug` command](../reference/cli/docker/debug.md) (Beta). -- Organization admins, with a Docker Business subscription, can now configure a custom list of extensions with [Private Extensions Marketplace](extensions/private-marketplace.md) enabled (Beta) +- Get a debug shell into any container or image with the new [`docker debug` command](/reference/cli/docker/debug.md) (Beta). +- Organization admins, with a Docker Business subscription, can now configure a custom list of extensions with [Private Extensions Marketplace](/manuals/extensions/private-marketplace.md) enabled (Beta) ### Upgrades @@ -664,7 +664,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st #### For all platforms -- The `docker scan` command has been removed. To continue learning about the vulnerabilities of your images, and many other features, use the [`docker scout` command](../reference/cli/docker/scout/_index.md). +- The `docker scan` command has been removed. To continue learning about the vulnerabilities of your images, and many other features, use the [`docker scout` command](/reference/cli/docker/scout/_index.md). - Fixed a bug where automatic updates would not download when the **Always download updates** checkbox was selected. - Fixed typo in the dashboard tooltip. Fixes [docker/for-mac#7132](https://github.com/docker/for-mac/issues/7132) - Improved signal handling behavior (e.g. when pressing Ctrl-C in the terminal while running a `docker` command). @@ -748,7 +748,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New -- Administrators can now control access to beta and experimental features in the **Features in development** tab with [Settings Management](/security/for-admins/hardened-desktop/settings-management/configure.md). +- Administrators can now control access to beta and experimental features in the **Features in development** tab with [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md). - Introduced four new version update states in the footer. - `docker init` (Beta) now supports PHP with Apache + Composer. - The [**Builds** view](use-desktop/builds.md) is now GA. You can now inspect builds, troubleshoot errors, and optimize build speed. @@ -758,7 +758,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - [Compose v2.23.3](https://github.com/docker/compose/releases/tag/v2.23.3) - [Docker Scout CLI v1.2.0](https://github.com/docker/scout-cli/releases/tag/v1.2.0). - [Buildx v0.12.0](https://github.com/docker/buildx/releases/tag/v0.12.0) -- [Wasm](../desktop/wasm/_index.md) runtimes: +- [Wasm](/manuals/desktop/wasm/_index.md) runtimes: - wasmtime, wasmedge and wasmer `v0.3.1`. - lunatic, slight, spin, and wws `v0.10.0`. - Wasmtime is now based on wasmtime `v14.0` and supports wasi preview-2 components @@ -864,7 +864,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - Rosetta is now Generally Available for all users on macOS 13 or later. It provides faster emulation of Intel-based images on Apple Silicon. To use Rosetta, see [Settings](settings/mac.md). Rosetta is enabled by default on macOS 14.1 and later. - Docker Desktop now detects if a WSL version is out of date. If an out dated version of WSL is detected, you can allow Docker Desktop to automatically update the installation or you can manually update WSL outside of Docker Desktop. - New installations of Docker Desktop for Windows now require a Windows version of 19044 or later. -- Administrators now have the ability to control Docker Scout image analysis in [Settings Management](/security/for-admins/hardened-desktop/settings-management/configure.md). +- Administrators now have the ability to control Docker Scout image analysis in [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md). ### Upgrades @@ -962,7 +962,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New - The new Notification center is now available to all users so you can be notified of new releases, installation progress updates, and more. Select the bell icon in the bottom-right corner of the Docker Dashboard to access the notification center. -- Compose Watch is now available to all users. For more information, see [Use Compose Watch](../compose/file-watch.md). +- Compose Watch is now available to all users. For more information, see [Use Compose Watch](/manuals/compose/file-watch.md). - Resource Saver is now available to all users and is enabled by default. To configure this feature, navigate to the **Resources** tab in **Settings**. For more information see [Docker Desktop's Resource Saver mode](use-desktop/resource-saver.md). - You can now view and manage the Docker Engine state, with pause, stop, and resume, directly from the Docker Dashboard. @@ -970,7 +970,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - [Compose v2.22.0](https://github.com/docker/compose/releases/tag/v2.22.0) - [Go 1.21.1](https://github.com/golang/go/releases/tag/go1.21.1) -- [Wasm](../desktop/wasm.md) runtimes: +- [Wasm](/manuals/desktop/wasm.md) runtimes: - wasmtime, wasmedge `v0.2.0`. - lunatic, slight, spin, and wws`v0.9.1`. - Added wasmer wasm shims. @@ -1031,19 +1031,19 @@ This can be resolved by adding the user to the **docker-users** group. Before st - [Compose v2.21.0](https://github.com/docker/compose/releases/tag/v2.21.0) - [Docker Engine v24.0.6](https://docs.docker.com/engine/release-notes/24.0/#2406) - [Docker Scout CLI v0.24.1](https://github.com/docker/scout-cli/releases/tag/v0.24.1). -- [Wasm](../desktop/wasm.md) runtimes: +- [Wasm](/manuals/desktop/wasm.md) runtimes: - wasmtime, wasmedge revision `d0a1a1cd`. - slight and spin wasm `v0.9.0`. ### New - Added support for new Wasm runtimes: wws and lunatic. -- [`docker init`](../reference/cli/docker/init.md) now supports ASP.NET +- [`docker init`](/reference/cli/docker/init.md) now supports ASP.NET - Increased performance of exposed ports on macOS, for example with `docker run -p`. ### Removed -- Removed Compose V1 from Docker Desktop as it has stopped receiving updates. Compose V2 has replaced it and is now integrated into all current Docker Desktop versions. For more information, see [Migrate to Compose V2](../compose/migrate.md). +- Removed Compose V1 from Docker Desktop as it has stopped receiving updates. Compose V2 has replaced it and is now integrated into all current Docker Desktop versions. For more information, see [Migrate to Compose V2](/manuals/compose/migrate.md). ### Bug fixes and enhancements @@ -1125,18 +1125,18 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New - [Resource Usage](use-desktop/container.md) has moved from experimental to GA. -- You can now split large Compose projects into multiple sub-projects with [`include`](../compose/multiple-compose-files/include.md). +- You can now split large Compose projects into multiple sub-projects with [`include`](/manuals/compose/multiple-compose-files/include.md). ### Bug fixes and enhancements #### For all platforms -- [Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md) now lets you turn off Docker Extensions for your organisation. +- [Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md) now lets you turn off Docker Extensions for your organisation. - Fixed a bug where turning on Kubernetes from the UI failed when the system was paused. - Fixed a bug where turning on Wasm from the UI failed when the system was paused. - Bind mounts are now shown when you [inspect a container](use-desktop/container.md). - You can now download Wasm runtimes when the containerd image store is enabled. -- With [Quick Search](../desktop/use-desktop/_index.md/#quick-search), you can now: +- With [Quick Search](/manuals/desktop/use-desktop/_index.md#quick-search), you can now: - Find any container or Compose app residing on your local system. In addition, you can access environment variables and perform essential actions such as starting, stopping, or deleting containers. @@ -1289,7 +1289,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### Removed -- Removed `docker scan` command. To continue learning about the vulnerabilities of your images, and many other features, use the new `docker scout` command. Run `docker scout --help`, or [read the docs to learn more](../reference/cli/docker/scout/_index.md). +- Removed `docker scan` command. To continue learning about the vulnerabilities of your images, and many other features, use the new `docker scout` command. Run `docker scout --help`, or [read the docs to learn more](/reference/cli/docker/scout/_index.md). ### Upgrades @@ -1308,7 +1308,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - Added more details to dashboard errors when a `docker-compose` action fails ([docker/for-win#13378](https://github.com/docker/for-win/issues/13378)). - Added support for setting HTTP proxy configuration during installation. This can be done via the `--proxy-http-mode`, `--overrider-proxy-http`, `--override-proxy-https` and `--override-proxy-exclude` installer flags in the case of installation from the CLI on [Mac](install/mac-install.md#install-from-the-command-line) and [Windows](install/windows-install.md#install-from-the-command-line), or alternatively by setting the values in the `install-settings.json` file. - Docker Desktop now stops overriding .docker/config.json `credsStore` keys on application start. Note that if you use a custom credential helper then the CLI `docker login` and `docker logout` does not affect whether the UI is signed in to Docker or not. In general, it is better to sign into Docker via the UI since the UI supports multi-factor authentication. -- Added a warning about the [forthcoming removal of Compose V1 from Docker Desktop](../compose/migrate.md). Can be suppressed with `COMPOSE_V1_EOL_SILENT=1`. +- Added a warning about the [forthcoming removal of Compose V1 from Docker Desktop](/manuals/compose/migrate.md). Can be suppressed with `COMPOSE_V1_EOL_SILENT=1`. - In the Compose config, boolean fields in YAML should be either `true` or `false`. Deprecated YAML 1.1 values such as “on” or “no” now produce a warning. - Improved UI for image table, allowing rows to use more available space. - Fixed various bugs in port-forwarding. @@ -1434,7 +1434,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - Docker Desktop now ships with Docker Scout. Pull and view analysis for images from Docker Hub and Artifactory repositories, get base image updates and recommended tags and digests, and filter your images on vulnerability information. To learn more, see [Docker Scout](../scout/index.md). - `docker scan` has been replaced by `docker scout`. See [Docker Scout CLI](../scout/index.md#docker-scout-cli), for more information. -- You can now discover extensions that have been autonomously published in the Extensions Marketplace. For more information on self-published extensions, see [Marketplace Extensions](extensions/marketplace.md). +- You can now discover extensions that have been autonomously published in the Extensions Marketplace. For more information on self-published extensions, see [Marketplace Extensions](/manuals/extensions/marketplace.md). - **Container File Explorer** is available as an experimental feature. Debug the filesystem within your containers straight from the GUI. - You can now search for volumes in **Global Search**. @@ -1685,7 +1685,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### Updates -- [Docker Engine v20.10.21](../engine/release-notes/20.10.md#201021), +- [Docker Engine v20.10.21](/manuals/engine/release-notes/20.10.md#201021), which contains mitigations against a Git vulnerability, tracked in [CVE-2022-39253](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-39253), and updates the handling of `image:tag@digest` image references. - [Docker Compose v2.12.2](https://github.com/docker/compose/releases/tag/v2.12.2) @@ -1763,7 +1763,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New -- Two new security features have been introduced for Docker Business users, Settings Management and Enhanced Container Isolation. Read more about Docker Desktop’s new [Hardened Docker Desktop security model](/security/for-admins/hardened-desktop/index.md). +- Two new security features have been introduced for Docker Business users, Settings Management and Enhanced Container Isolation. Read more about Docker Desktop’s new [Hardened Docker Desktop security model](/manuals/security/for-admins/hardened-desktop/index.md). - Added the new Dev Environments CLI `docker dev`, so you can create, list, and run Dev Envs via command line. Now it's easier to integrate Dev Envs into custom scripts. - Docker Desktop can now be installed to any drive and folder using the `--installation-dir`. Partially addresses [docker/roadmap#94](https://github.com/docker/roadmap/issues/94). @@ -1771,7 +1771,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - [Docker Scan v0.21.0](https://github.com/docker/scan-cli-plugin/releases/tag/v0.21.0) - [Go 1.19.2](https://github.com/golang/go/releases/tag/go1.19.2) to address [CVE-2022-2879](https://www.cve.org/CVERecord?id=CVE-2022-2879), [CVE-2022-2880](https://www.cve.org/CVERecord?id=CVE-2022-2880) and [CVE-2022-41715](https://www.cve.org/CVERecord?id=CVE-2022-41715) -- Updated Docker Engine and Docker CLI to [v20.10.20](../engine/release-notes/20.10.md#201020), +- Updated Docker Engine and Docker CLI to [v20.10.20](/manuals/engine/release-notes/20.10.md#201020), which contain mitigations against a Git vulnerability, tracked in [CVE-2022-39253](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-39253), and updated handling of `image:tag@digest` image references, as well as a fix for [CVE-2022-36109](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2022-36109). - [Docker Credential Helpers v0.7.0](https://github.com/docker/docker-credential-helpers/releases/tag/v0.7.0) @@ -1869,7 +1869,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st - Compose V2 is now enabled after factory reset. - Compose V2 is now enabled by default on new installations of Docker Desktop. -- Precedence order of environment variables in Compose is more consistent, and clearly [documented](../compose/environment-variables/envvars-precedence.md). +- Precedence order of environment variables in Compose is more consistent, and clearly [documented](/manuals/compose/environment-variables/envvars-precedence.md). - Upgraded kernel to 5.10.124. - Improved overall performance issues caused by calculating disk size. Related to [docker/for-win#9401](https://github.com/docker/for-win/issues/9401). - Docker Desktop now prevents users on ARM macs without Rosetta installed from switching back to Compose V1, which has only intel binaries. @@ -1920,7 +1920,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New -- Docker Desktop is now fully supported for Docker Business customers inside VMware ESXi and Azure VMs. For more information, see [Run Docker Desktop inside a VM or VDI environment](../desktop/vm-vdi.md) +- Docker Desktop is now fully supported for Docker Business customers inside VMware ESXi and Azure VMs. For more information, see [Run Docker Desktop inside a VM or VDI environment](/manuals/desktop/vm-vdi.md) - Added two new extensions ([vcluster](https://hub.docker.com/extensions/loftsh/vcluster-dd-extension) and [PGAdmin4](https://hub.docker.com/extensions/mochoa/pgadmin4-docker-extension)) to the Extensions Marketplace. - The ability to sort extensions has been added to the Extensions Marketplace. - Fixed a bug that caused some users to be asked for feedback too frequently. You'll now only be asked for feedback twice a year. @@ -2001,7 +2001,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### Updates -- [Docker Engine v20.10.17](../engine/release-notes/20.10.md#201017) +- [Docker Engine v20.10.17](/manuals/engine/release-notes/20.10.md#201017) - [Docker Compose v2.6.1](https://github.com/docker/compose/releases/tag/v2.6.1) - [Kubernetes v1.24.1](https://github.com/kubernetes/kubernetes/releases/tag/v1.24.1) - [cri-dockerd to v0.2.1](https://github.com/Mirantis/cri-dockerd/releases/tag/v0.2.1) @@ -2082,7 +2082,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### Updates - [Compose v2.6.0](https://github.com/docker/compose/releases/tag/v2.6.0) -- [Docker Engine v20.10.16](../engine/release-notes/20.10.md#201016) +- [Docker Engine v20.10.16](/manuals/engine/release-notes/20.10.md#201016) - [containerd v1.6.4](https://github.com/containerd/containerd/releases/tag/v1.6.4) - [runc v1.1.1](https://github.com/opencontainers/runc/releases/tag/v1.1.1) - [Go 1.18.2](https://github.com/golang/go/releases/tag/go1.18.2) @@ -2139,7 +2139,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New - Released [Docker Desktop for Linux](install/linux-install.md). -- Beta release of [Docker Extensions](extensions/index.md) and Extensions SDK. +- Beta release of [Docker Extensions](/manuals/extensions/_index.md) and Extensions SDK. - Created a Docker Homepage where you can run popular images and discover how to use them. - [Compose V2 is now GA](https://www.docker.com/blog/announcing-compose-v2-general-availability/) @@ -2160,7 +2160,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### New - Released [Docker Desktop for Linux](install/linux-install.md). -- Beta release of [Docker Extensions](extensions/index.md) and Extensions SDK. +- Beta release of [Docker Extensions](/manuals/extensions/_index.md) and Extensions SDK. - Created a Docker Homepage where you can run popular images and discover how to use them. - [Compose V2 is now GA](https://www.docker.com/blog/announcing-compose-v2-general-availability/) @@ -2240,7 +2240,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st ### Updates -- [Docker Engine v20.10.14](../engine/release-notes/20.10.md#201014) +- [Docker Engine v20.10.14](/manuals/engine/release-notes/20.10.md#201014) - [Compose v2.4.1](https://github.com/docker/compose/releases/tag/v2.4.1) - [Buildx 0.8.2](https://github.com/docker/buildx/releases/tag/v0.8.2) - [containerd v1.5.11](https://github.com/containerd/containerd/releases/tag/v1.5.11) @@ -2303,7 +2303,7 @@ This can be resolved by adding the user to the **docker-users** group. Before st #### For all platforms -- [Docker Engine v20.10.13](../engine/release-notes/20.10.md#201013) +- [Docker Engine v20.10.13](/manuals/engine/release-notes/20.10.md#201013) - [Compose v2.3.3](https://github.com/docker/compose/releases/tag/v2.3.3) - [Buildx 0.8.0](https://github.com/docker/buildx/releases/tag/v0.8.0) - [containerd v1.4.13](https://github.com/containerd/containerd/releases/tag/v1.4.13) @@ -2465,7 +2465,7 @@ Installing Docker Desktop 4.5.0 from scratch has a bug which defaults Docker Des ### Upgrades -- [Docker Engine v20.10.12](../engine/release-notes/20.10.md#201012) +- [Docker Engine v20.10.12](/manuals/engine/release-notes/20.10.md#201012) - [Compose v2.2.3](https://github.com/docker/compose/releases/tag/v2.2.3) - [Kubernetes 1.22.5](https://github.com/kubernetes/kubernetes/releases/tag/v1.22.5) - [docker scan v0.16.0](https://github.com/docker/scan-cli-plugin/releases/tag/v0.16.0) @@ -2556,7 +2556,7 @@ CVE-2021-44228](https://www.docker.com/blog/apache-log4j-2-cve-2021-44228/). ### Upgrades -- [Docker Engine v20.10.11](../engine/release-notes/20.10.md#201011) +- [Docker Engine v20.10.11](/manuals/engine/release-notes/20.10.md#201011) - [containerd v1.4.12](https://github.com/containerd/containerd/releases/tag/v1.4.12) - [Buildx 0.7.1](https://github.com/docker/buildx/releases/tag/v0.7.1) - [Compose v2.2.1](https://github.com/docker/compose/releases/tag/v2.2.1) @@ -2586,7 +2586,7 @@ CVE-2021-44228](https://www.docker.com/blog/apache-log4j-2-cve-2021-44228/). Docker Dashboard incorrectly displays the container memory usage as zero on Hyper-V based machines. -You can use the [`docker stats`](../reference/cli/docker/container/stats.md) +You can use the [`docker stats`](/reference/cli/docker/container/stats.md) command on the command line as a workaround to view the actual memory usage. See [docker/for-mac#6076](https://github.com/docker/for-mac/issues/6076). @@ -2614,7 +2614,7 @@ actual memory usage. See ### Upgrades -- [Docker Engine v20.10.10](../engine/release-notes/20.10.md#201010) +- [Docker Engine v20.10.10](/manuals/engine/release-notes/20.10.md#201010) - [containerd v1.4.11](https://github.com/containerd/containerd/releases/tag/v1.4.11) - [runc v1.0.2](https://github.com/opencontainers/runc/releases/tag/v1.0.2) - [Go 1.17.2](https://golang.org/doc/go1.17) diff --git a/content/manuals/desktop/settings/_index.md b/content/manuals/desktop/settings/_index.md new file mode 100644 index 0000000000..e50de94852 --- /dev/null +++ b/content/manuals/desktop/settings/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Change settings +--- diff --git a/content/desktop/settings/linux.md b/content/manuals/desktop/settings/linux.md similarity index 95% rename from content/desktop/settings/linux.md rename to content/manuals/desktop/settings/linux.md index 921af5536f..944d1e37b9 100644 --- a/content/desktop/settings/linux.md +++ b/content/manuals/desktop/settings/linux.md @@ -42,7 +42,7 @@ If you choose the integrated terminal, you can run commands in a running contain troubleshoot the application. Clear the check box to opt out. Docker may periodically prompt you for more information. -- **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](/security/for-admins/hardened-desktop/enhanced-container-isolation/index.md) +- **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/index.md) >**Note** > > This setting is only available if you are signed in to Docker Desktop and have a Docker Business subscription. @@ -136,8 +136,8 @@ File share settings are: > * Shared folders are designed to allow application code to be edited > on the host while being executed in containers. For non-code items > such as cache directories or databases, the performance will be much -> better if they are stored in the Linux VM, using a [data volume](/engine/storage/volumes.md) -> (named volume) or [data container](/engine/storage/volumes.md). +> better if they are stored in the Linux VM, using a [data volume](/manuals/engine/storage/volumes.md) +> (named volume) or [data container](/manuals/engine/storage/volumes.md). ### Proxies @@ -164,7 +164,7 @@ To set a different proxy for Docker Desktop, turn on **Manual proxy configuratio upstream proxy URL of the form `http://proxy:port` or `https://proxy:port`. To prevent developers from accidentally changing the proxy settings, see -[Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md#what-features-can-i-configure-with-settings-management). +[Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md#what-features-can-i-configure-with-settings-management). The HTTPS proxy settings used for scanning images are set using the `HTTPS_PROXY` environment variable. @@ -203,7 +203,7 @@ edit the file using your favorite text editor. > Only the **Docker Desktop** daemon uses the configuration file under `$HOME/.docker`. > If you manually install Docker Engine alongside Docker Desktop, the manually > installed instance uses a `daemon.json` configuration file in a different location. -> Refer to [Configure the daemon](/engine/daemon/_index.md) for more information +> Refer to [Configure the daemon](/manuals/engine/daemon/_index.md) for more information > about how to configure the Docker daemon on a manually installed Docker Engine. To see the full list of possible configuration options, see the @@ -255,7 +255,7 @@ Use the **Extensions** tab to: - **Allow only extensions distributed through the Docker Marketplace** - **Show Docker Extensions system containers** -For more information about Docker extensions, see [Extensions](/extensions/index.md). +For more information about Docker extensions, see [Extensions](/manuals/extensions/index.md). ## Features in development diff --git a/content/desktop/settings/mac.md b/content/manuals/desktop/settings/mac.md similarity index 97% rename from content/desktop/settings/mac.md rename to content/manuals/desktop/settings/mac.md index b8b812b705..3162df9c26 100644 --- a/content/desktop/settings/mac.md +++ b/content/manuals/desktop/settings/mac.md @@ -62,7 +62,7 @@ If you choose the integrated terminal, you can run commands in a running contain troubleshoot the application. Clear the checkbox to opt out. Docker may periodically prompt you for more information. -- **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](/security/for-admins/hardened-desktop/enhanced-container-isolation/index.md). +- **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/index.md). >**Note** > > This setting is only available if you are signed in to Docker Desktop and have a Docker Business subscription. @@ -166,8 +166,8 @@ File share settings are: > * Shared folders are designed to allow application code to be edited > on the host while being executed in containers. For non-code items > such as cache directories or databases, the performance will be much -> better if they are stored in the Linux VM, using a [data volume](/engine/storage/volumes.md) -> (named volume) or [data container](/engine/storage/volumes.md). +> better if they are stored in the Linux VM, using a [data volume](/manuals/engine/storage/volumes.md) +> (named volume) or [data container](/manuals/engine/storage/volumes.md). > * If you share the whole of your home directory into a container, MacOS may > prompt you to give Docker access to personal areas of your home directory such as > your Reminders or Downloads. @@ -210,7 +210,7 @@ To set a different proxy for Docker Desktop, turn on **Manual proxy configuratio upstream proxy URL of the form `http://proxy:port` or `https://proxy:port`. To prevent developers from accidentally changing the proxy settings, see -[Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md#what-features-can-i-configure-with-settings-management). +[Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md#what-features-can-i-configure-with-settings-management). The HTTPS proxy settings used for scanning images are set using the `HTTPS_PROXY` environment variable. @@ -295,7 +295,7 @@ Use the **Extensions** tab to: - **Allow only extensions distributed through the Docker Marketplace** - **Show Docker Extensions system containers** -For more information about Docker extensions, see [Extensions](/extensions/index.md). +For more information about Docker extensions, see [Extensions](/manuals/extensions/index.md). ## Features in development diff --git a/content/desktop/settings/windows.md b/content/manuals/desktop/settings/windows.md similarity index 96% rename from content/desktop/settings/windows.md rename to content/manuals/desktop/settings/windows.md index 8f8277a6c8..9faab506df 100644 --- a/content/desktop/settings/windows.md +++ b/content/manuals/desktop/settings/windows.md @@ -52,7 +52,7 @@ If you choose the integrated terminal, you can run commands in a running contain troubleshoot the application. Clear the check box to opt out. Docker may periodically prompt you for more information. -- **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](/security/for-admins/hardened-desktop/enhanced-container-isolation/index.md) +- **Use Enhanced Container Isolation**. Select to enhance security by preventing containers from breaching the Linux VM. For more information, see [Enhanced Container Isolation](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/index.md) >**Note** > > This setting is only available if you are signed in to Docker Desktop and have a Docker Business subscription. @@ -162,8 +162,8 @@ File share settings are: > * Shared folders are designed to allow application code to be edited > on the host while being executed in containers. For non-code items > such as cache directories or databases, the performance will be much -> better if they are stored in the Linux VM, using a [data volume](/engine/storage/volumes.md) -> (named volume) or [data container](/engine/storage/volumes.md). +> better if they are stored in the Linux VM, using a [data volume](/manuals/engine/storage/volumes.md) +> (named volume) or [data container](/manuals/engine/storage/volumes.md). > * Docker Desktop sets permissions to read/write/execute for users, groups and > others [0777 or a+rwx](https://chmodcommand.com/chmod-0777/). > This is not configurable. See [Permissions errors on data directories for shared volumes](../troubleshoot/topics.md). @@ -213,12 +213,12 @@ To set a different proxy for Docker Desktop, turn on **Manual proxy configuratio upstream proxy URL of the form `http://proxy:port` or `https://proxy:port`. To prevent developers from accidentally changing the proxy settings, see -[Settings Management](/security/for-admins/hardened-desktop/settings-management/index.md#what-features-can-i-configure-with-settings-management). +[Settings Management](/manuals/security/for-admins/hardened-desktop/settings-management/index.md#what-features-can-i-configure-with-settings-management). The HTTPS proxy settings used for scanning images are set using the `HTTPS_PROXY` environment variable. If you are running Windows containers in Docker, you can allow the Windows Docker daemon to use Docker Desktop's internal proxy, with the **Use proxy for Windows Docker daemon** setting. -This is useful when a corporate proxy that requires authentication is manually configured or set at the system level. If you are an admin for your organization and have a Docker Business subscription, you can control this setting with [Settings management](/security/for-admins/hardened-desktop/settings-management/configure.md) using the `windowsDockerdPort` parameter. +This is useful when a corporate proxy that requires authentication is manually configured or set at the system level. If you are an admin for your organization and have a Docker Business subscription, you can control this setting with [Settings management](/manuals/security/for-admins/hardened-desktop/settings-management/configure.md) using the `windowsDockerdPort` parameter. > [!NOTE] > @@ -354,7 +354,7 @@ Use the **Extensions** tab to: - **Allow only extensions distributed through the Docker Marketplace** - **Show Docker Extensions system containers** -For more information about Docker extensions, see [Extensions](/extensions/index.md). +For more information about Docker extensions, see [Extensions](/manuals/extensions/index.md). ## Features in development diff --git a/content/desktop/support.md b/content/manuals/desktop/support.md similarity index 100% rename from content/desktop/support.md rename to content/manuals/desktop/support.md diff --git a/content/desktop/synchronized-file-sharing.md b/content/manuals/desktop/synchronized-file-sharing.md similarity index 93% rename from content/desktop/synchronized-file-sharing.md rename to content/manuals/desktop/synchronized-file-sharing.md index 3c4e37a3b4..76dfed8860 100644 --- a/content/desktop/synchronized-file-sharing.md +++ b/content/manuals/desktop/synchronized-file-sharing.md @@ -1,5 +1,6 @@ --- title: Synchronized file shares +weight: 60 description: Get started with Synchronized file shares on Docker Desktop. keyword: mutagen, file sharing, docker desktop, bind mounts --- @@ -24,7 +25,7 @@ Synchronized file shares is ideal for developers who: A Synchronized file share behaves just like a virtual file share, but takes advantage of a high-performance, low-latency code synchronization engine to create a synchronized cache of the host files on an ext4 filesystem within the Docker Desktop VM. If you make filesystem changes on the host or in the VM’s containers, it propagates via bidirectional synchronization. -After creating a file share instance, any container using a bind mount that points to a location on the host filesystem matching the specified synchronized file share location, or a subdirectory within it, utilizes the Synchronized File Shares feature. Bind mounts that don't satisfy this condition are passed to the normal virtual filesystem [bind-mounting mechanism](/engine/storage/bind-mounts.md), for example VirtioFS or gRPC-FUSE. +After creating a file share instance, any container using a bind mount that points to a location on the host filesystem matching the specified synchronized file share location, or a subdirectory within it, utilizes the Synchronized File Shares feature. Bind mounts that don't satisfy this condition are passed to the normal virtual filesystem [bind-mounting mechanism](/manuals/engine/storage/bind-mounts.md), for example VirtioFS or gRPC-FUSE. > [!NOTE] > @@ -48,7 +49,7 @@ When the status indicator displays **Watching for filesystem changes**, your fil >**Note** > -> When you create a new service, setting the [bind mount option consistency](../reference/cli/docker/service/create.md#options-for-bind-mounts) to `:consistent` bypasses Synchronized file shares. +> When you create a new service, setting the [bind mount option consistency](/reference/cli/docker/service/create.md#options-for-bind-mounts) to `:consistent` bypasses Synchronized file shares. > [!TIP] > @@ -89,7 +90,7 @@ In general, use your `.syncignore` file to exclude items that aren't critical to - If you switch from WSL2 to Hyper-V on Windows, Docker Desktop needs to be fully restarted. -- POSIX-style Windows paths are not supported. Avoid setting the [`COMPOSE_CONVERT_WINDOWS_PATHS`](../compose/environment-variables/envvars.md#compose_convert_windows_paths) environment variable in Docker Compose. +- POSIX-style Windows paths are not supported. Avoid setting the [`COMPOSE_CONVERT_WINDOWS_PATHS`](/manuals/compose/environment-variables/envvars.md#compose_convert_windows_paths) environment variable in Docker Compose. ## Feedback and support diff --git a/content/manuals/desktop/troubleshoot/_index.md b/content/manuals/desktop/troubleshoot/_index.md new file mode 100644 index 0000000000..f4b3a4322d --- /dev/null +++ b/content/manuals/desktop/troubleshoot/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Troubleshoot and diagnose +--- diff --git a/content/desktop/troubleshoot/known-issues.md b/content/manuals/desktop/troubleshoot/known-issues.md similarity index 100% rename from content/desktop/troubleshoot/known-issues.md rename to content/manuals/desktop/troubleshoot/known-issues.md diff --git a/content/desktop/troubleshoot/overview.md b/content/manuals/desktop/troubleshoot/overview.md similarity index 99% rename from content/desktop/troubleshoot/overview.md rename to content/manuals/desktop/troubleshoot/overview.md index 5bf9fdd115..c0516dd8c1 100644 --- a/content/desktop/troubleshoot/overview.md +++ b/content/manuals/desktop/troubleshoot/overview.md @@ -305,7 +305,7 @@ Desktop at `$HOME/.docker/desktop/log/`. ## View the Docker daemon logs -Refer to the [Read the daemon logs](/engine/daemon/logs.md) section +Refer to the [Read the daemon logs](/manuals/engine/daemon/logs.md) section to learn how to view the Docker Daemon logs. ## Further resources diff --git a/content/desktop/troubleshoot/topics.md b/content/manuals/desktop/troubleshoot/topics.md similarity index 98% rename from content/desktop/troubleshoot/topics.md rename to content/manuals/desktop/troubleshoot/topics.md index eb6a9a1424..1da0dfc16a 100644 --- a/content/desktop/troubleshoot/topics.md +++ b/content/manuals/desktop/troubleshoot/topics.md @@ -54,7 +54,7 @@ After updating the `settings.json` file, close and restart Docker Desktop to app If you are using mounted volumes and get runtime errors indicating an application file is not found, access to a volume mount is denied, or a service -cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md), +cannot start, such as when using [Docker Compose](/manuals/compose/gettingstarted.md), you might need to turn on [file sharing](../settings/linux.md#file-sharing). Volume mounting requires shared drives for projects that live outside of the @@ -133,7 +133,7 @@ in the FAQs. If you are using mounted volumes and get runtime errors indicating an application file is not found, access is denied to a volume mount, or a service -cannot start, such as when using [Docker Compose](../../compose/gettingstarted.md), +cannot start, such as when using [Docker Compose](/manuals/compose/gettingstarted.md), you might need to turn on [shared folders](../settings/windows.md#file-sharing). With the Hyper-V backend, mounting files from Windows requires shared folders for Linux containers. From **Settings**, select **Shared Folders** and share the folder that contains the diff --git a/content/desktop/troubleshoot/workarounds.md b/content/manuals/desktop/troubleshoot/workarounds.md similarity index 100% rename from content/desktop/troubleshoot/workarounds.md rename to content/manuals/desktop/troubleshoot/workarounds.md diff --git a/content/desktop/uninstall.md b/content/manuals/desktop/uninstall.md similarity index 100% rename from content/desktop/uninstall.md rename to content/manuals/desktop/uninstall.md diff --git a/content/desktop/use-desktop/_index.md b/content/manuals/desktop/use-desktop/_index.md similarity index 99% rename from content/desktop/use-desktop/_index.md rename to content/manuals/desktop/use-desktop/_index.md index ef66559c80..c3a6697759 100644 --- a/content/desktop/use-desktop/_index.md +++ b/content/manuals/desktop/use-desktop/_index.md @@ -3,6 +3,7 @@ description: Learn how to use the Docker Dashboard within Docker Desktop, includ keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual, whale menu title: Explore Docker Desktop +weight: 30 aliases: - /desktop/dashboard/ --- diff --git a/content/desktop/use-desktop/builds.md b/content/manuals/desktop/use-desktop/builds.md similarity index 94% rename from content/desktop/use-desktop/builds.md rename to content/manuals/desktop/use-desktop/builds.md index 3997d41a0f..cde114c30d 100644 --- a/content/desktop/use-desktop/builds.md +++ b/content/manuals/desktop/use-desktop/builds.md @@ -47,7 +47,7 @@ Import builds is currently in [Beta](../../release-lifecycle.md#Beta). The **Import builds** button lets you import build records for builds by other people, or builds in a CI environment. When you've imported a build record, it gives you full access to the logs, traces, and other data for that build, -directly in Docker Desktop. The [build summary](../../build/ci/github-actions/build-summary.md) +directly in Docker Desktop. The [build summary](/manuals/build/ci/github-actions/build-summary.md) for the `docker/build-push-action` and `docker/bake-action` GitHub Actions includes a link to download the build records, for inspecting CI jobs with Docker Desktop. @@ -66,7 +66,7 @@ platform: ![Platform filter](../images/build-ui-platform-menu.webp?w=400) The **Source details** section shows information about the frontend -[frontend](../../build/buildkit/frontend.md) and, if available, +[frontend](/manuals/build/buildkit/frontend.md) and, if available, the source code repository used for the build. ### Build timing @@ -93,8 +93,8 @@ operations are defined as follows: | HTTP | Remote artifact downloads using `ADD`. | | Git | Same as **HTTP** but for Git URLs. | | Result exports | Time spent exporting the build results. | -| SBOM | Time spent generating the [SBOM attestation](../../build/metadata/attestations/sbom.md). | -| Idle | Idle time for build workers, which can happen if you have configured a [max parallelism limit](../../build/buildkit/configure.md#max-parallelism). | +| SBOM | Time spent generating the [SBOM attestation](/manuals/build/metadata/attestations/sbom.md). | +| Idle | Idle time for build workers, which can happen if you have configured a [max parallelism limit](/manuals/build/buildkit/configure.md#max-parallelism). | ### Build dependencies @@ -123,7 +123,7 @@ including image manifest details, attestations, and build traces. Attestations are metadata records attached to a container image. The metadata describes something about the image, for example how it was built or what packages it contains. -For more information about attestations, see [Build attestations](../../build/metadata/attestations/_index.md). +For more information about attestations, see [Build attestations](/manuals/build/metadata/attestations/_index.md). Build traces capture information about the build execution steps in Buildx and BuildKit. The traces are available in two formats: OTLP and Jaeger. You can @@ -161,7 +161,7 @@ Now you can analyze the build trace using the Jaeger UI: ### Dockerfile source and errors When inspecting a successful completed build or an ongoing active build, -the **Source** tab shows the [frontend](../../build/buildkit/frontend.md) +the **Source** tab shows the [frontend](/manuals/build/buildkit/frontend.md) used to create the build. If the build failed, an **Error** tab displays instead of the **Source** tab. diff --git a/content/desktop/use-desktop/container.md b/content/manuals/desktop/use-desktop/container.md similarity index 100% rename from content/desktop/use-desktop/container.md rename to content/manuals/desktop/use-desktop/container.md diff --git a/content/desktop/use-desktop/images.md b/content/manuals/desktop/use-desktop/images.md similarity index 97% rename from content/desktop/use-desktop/images.md rename to content/manuals/desktop/use-desktop/images.md index 0ae5547aee..78b7026554 100644 --- a/content/desktop/use-desktop/images.md +++ b/content/manuals/desktop/use-desktop/images.md @@ -52,8 +52,8 @@ To inspect an image, select the image row. Inspecting an image displays detailed - Vulnerabilities found - Packages inside the image -[Docker Scout](/scout/_index.md) powers this vulnerability information. -For more information about this view, see [Image details view](/scout/explore/image-details-view.md) +[Docker Scout](/manuals/scout/_index.md) powers this vulnerability information. +For more information about this view, see [Image details view](/manuals/scout/explore/image-details-view.md) ## Pull the latest image from Docker Hub diff --git a/content/desktop/use-desktop/pause.md b/content/manuals/desktop/use-desktop/pause.md similarity index 100% rename from content/desktop/use-desktop/pause.md rename to content/manuals/desktop/use-desktop/pause.md diff --git a/content/desktop/use-desktop/resource-saver.md b/content/manuals/desktop/use-desktop/resource-saver.md similarity index 100% rename from content/desktop/use-desktop/resource-saver.md rename to content/manuals/desktop/use-desktop/resource-saver.md diff --git a/content/desktop/use-desktop/volumes.md b/content/manuals/desktop/use-desktop/volumes.md similarity index 96% rename from content/desktop/use-desktop/volumes.md rename to content/manuals/desktop/use-desktop/volumes.md index 69121e1e96..478fe97598 100644 --- a/content/desktop/use-desktop/volumes.md +++ b/content/manuals/desktop/use-desktop/volumes.md @@ -5,7 +5,7 @@ title: Explore Volumes --- The **Volumes** view in Docker Dashboard lets you create, delete, and perform -other actions on your [volumes](/engine/storage/volumes.md). You can also see +other actions on your [volumes](/manuals/engine/storage/volumes.md). You can also see which volumes are being used as well as inspect the files and folders in your volumes. @@ -34,7 +34,7 @@ doing the following: ## Create a volume You use the following steps to create an empty volume. Alternatively, if you -[start a container with a volume](/engine/storage/volumes.md#start-a-container-with-a-volume) +[start a container with a volume](/manuals/engine/storage/volumes.md#start-a-container-with-a-volume) that doesn't yet exist, Docker creates the volume for you. To create a volume: @@ -43,7 +43,7 @@ To create a volume: 2. In the **New Volume** modal, specify a volume name, and then select **Create**. -To use the volume with a container, see [Use volumes](/engine/storage/volumes.md#start-a-container-with-a-volume). +To use the volume with a container, see [Use volumes](/manuals/engine/storage/volumes.md#start-a-container-with-a-volume). ## Inspect a volume @@ -118,7 +118,7 @@ To empty a volume: ## Export a volume {{% experimental title="Beta feature" %}} -The export volume feature is currently in [Beta](../../release-lifecycle.md/#beta). +The export volume feature is currently in [Beta](../../release-lifecycle.md#beta). {{% /experimental %}} You can export the content of a volume to a local file, a local image, an to an @@ -245,4 +245,4 @@ To import a volume: ## Additional resources - [Persisting container data](/get-started/docker-concepts/running-containers/persisting-container-data.md) -- [Use volumes](/engine/storage/volumes.md) +- [Use volumes](/manuals/engine/storage/volumes.md) diff --git a/content/desktop/vm-vdi.md b/content/manuals/desktop/vm-vdi.md similarity index 100% rename from content/desktop/vm-vdi.md rename to content/manuals/desktop/vm-vdi.md diff --git a/content/desktop/wasm.md b/content/manuals/desktop/wasm.md similarity index 99% rename from content/desktop/wasm.md rename to content/manuals/desktop/wasm.md index f2ad41ff68..004bd23f33 100644 --- a/content/desktop/wasm.md +++ b/content/manuals/desktop/wasm.md @@ -1,12 +1,13 @@ --- title: Wasm workloads (Beta) +weight: 50 description: How to run Wasm workloads with Docker Desktop keywords: Docker, WebAssembly, wasm, containerd, engine toc_max: 3 --- {{% experimental title="Beta" %}} -The Wasm feature is currently in [Beta](../release-lifecycle.md/#beta). +The Wasm feature is currently in [Beta](../release-lifecycle.md#beta). We recommend that you do not use this feature in production environments as this feature may change or be removed from future releases. {{% /experimental %}} diff --git a/content/desktop/windows/Makefile b/content/manuals/desktop/windows/Makefile similarity index 100% rename from content/desktop/windows/Makefile rename to content/manuals/desktop/windows/Makefile diff --git a/content/manuals/desktop/windows/_index.md b/content/manuals/desktop/windows/_index.md new file mode 100644 index 0000000000..aed88ea2bf --- /dev/null +++ b/content/manuals/desktop/windows/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Docker Desktop for Windows +--- diff --git a/content/desktop/windows/images/diagnose-support.png b/content/manuals/desktop/windows/images/diagnose-support.png similarity index 100% rename from content/desktop/windows/images/diagnose-support.png rename to content/manuals/desktop/windows/images/diagnose-support.png diff --git a/content/desktop/windows/permission-requirements.md b/content/manuals/desktop/windows/permission-requirements.md similarity index 98% rename from content/desktop/windows/permission-requirements.md rename to content/manuals/desktop/windows/permission-requirements.md index b3457156d3..8db893897f 100644 --- a/content/desktop/windows/permission-requirements.md +++ b/content/manuals/desktop/windows/permission-requirements.md @@ -52,7 +52,7 @@ you access to any files that it doesn’t already have access to. ## Enhanced Container Isolation In addition, Docker Desktop supports [Enhanced Container Isolation -mode](/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md) (ECI), +mode](/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/_index.md) (ECI), available to Business customers only, which further secures containers without impacting developer workflows. diff --git a/content/desktop/wsl/_index.md b/content/manuals/desktop/wsl/_index.md similarity index 99% rename from content/desktop/wsl/_index.md rename to content/manuals/desktop/wsl/_index.md index c0043796b9..5d2a2424da 100644 --- a/content/desktop/wsl/_index.md +++ b/content/manuals/desktop/wsl/_index.md @@ -4,6 +4,8 @@ description: Turn on the Docker WSL 2 backend and get to work using best practic keywords: wsl, wsl2, installing wsl2, wsl installation, docker wsl2, wsl docker, wsl2 tech preview, wsl install docker, install docker wsl, how to install docker in wsl title: Docker Desktop WSL 2 backend on Windows +linkTitle: WSL +weight: 70 aliases: - /docker-for-windows/wsl/ - /docker-for-windows/wsl-tech-preview/ diff --git a/content/desktop/wsl/best-practices.md b/content/manuals/desktop/wsl/best-practices.md similarity index 100% rename from content/desktop/wsl/best-practices.md rename to content/manuals/desktop/wsl/best-practices.md diff --git a/content/desktop/wsl/use-wsl.md b/content/manuals/desktop/wsl/use-wsl.md similarity index 100% rename from content/desktop/wsl/use-wsl.md rename to content/manuals/desktop/wsl/use-wsl.md diff --git a/content/docker-hub/_index.md b/content/manuals/docker-hub/_index.md similarity index 90% rename from content/docker-hub/_index.md rename to content/manuals/docker-hub/_index.md index 4307e5e2a8..cb1a6f49ae 100644 --- a/content/docker-hub/_index.md +++ b/content/manuals/docker-hub/_index.md @@ -2,6 +2,8 @@ description: Find a comprehensive overview of Docker Hub, including its features, administrative settings, how to get started quickly, and more keywords: Docker, docker, docker hub, hub, repositories, docker account title: Overview of Docker Hub +linkTitle: Docker Hub +weight: 100 grid: - title: Quickstart description: Step-by-step instructions on getting started on Docker Hub. @@ -49,8 +51,8 @@ GitHub and Bitbucket and push them to Docker Hub. * Set up [SSO](../security/for-admins/single-sign-on/index.md) and [SCIM](../security/for-admins/provisioning/scim.md) * Use [Group mapping](group-mapping.md) * [Carry out domain audits](domain-audit.md) -* [Use Image Access Management](/security/for-admins/hardened-desktop/image-access-management.md) to control developers' access to certain types of images -* [Turn on Registry Access Management](/security/for-admins/hardened-desktop/registry-access-management.md) +* [Use Image Access Management](/manuals/security/for-admins/hardened-desktop/image-access-management.md) to control developers' access to certain types of images +* [Turn on Registry Access Management](/manuals/security/for-admins/hardened-desktop/registry-access-management.md) {{< /tab >}} {{< /tabs >}} diff --git a/content/docker-hub/builds/_index.md b/content/manuals/docker-hub/builds/_index.md similarity index 98% rename from content/docker-hub/builds/_index.md rename to content/manuals/docker-hub/builds/_index.md index 2ffc922c01..653711586e 100644 --- a/content/docker-hub/builds/_index.md +++ b/content/manuals/docker-hub/builds/_index.md @@ -2,6 +2,8 @@ description: Set up Automated builds keywords: automated, build, images, Docker Hub title: Set up Automated Builds +linkTitle: Automated builds +weight: 60 aliases: - /docker-hub/builds/automated-build/ - /docker-hub/builds/classic/ @@ -67,7 +69,7 @@ when the tests succeed. 9. For each branch or tag, enable or disable the **Build Caching** toggle. - [Build caching](../../build/building/best-practices.md#leverage-build-cache) + [Build caching](/manuals/build/building/best-practices.md#leverage-build-cache) can save time if you are building a large image frequently or have many dependencies. Leave the build caching disabled to make sure all of your dependencies are resolved at build time, or if @@ -225,7 +227,7 @@ sources. For example, you might have Autobuilds use the BuildKit build system by default. If you want to use the legacy Docker build system, add the [environment variable](index.md#environment-variables-for-builds) -`DOCKER_BUILDKIT=0`. Refer to the [BuildKit](../../build/buildkit/index.md) +`DOCKER_BUILDKIT=0`. Refer to the [BuildKit](/manuals/build/buildkit/index.md) page for more information on BuildKit. ## Autobuild for teams diff --git a/content/docker-hub/builds/advanced.md b/content/manuals/docker-hub/builds/advanced.md similarity index 98% rename from content/docker-hub/builds/advanced.md rename to content/manuals/docker-hub/builds/advanced.md index e1372a28e2..e827d9e595 100644 --- a/content/docker-hub/builds/advanced.md +++ b/content/manuals/docker-hub/builds/advanced.md @@ -115,7 +115,7 @@ $ docker build --build-arg CUSTOM=$VAR -f $DOCKERFILE_PATH -t $IMAGE_NAME . > A `hooks/build` file overrides the basic `docker build` command used by the builder, so you must include a similar build command in the hook or the automated build fails. -Refer to the [docker build documentation](../../reference/cli/docker/buildx/build.md#build-arg) +Refer to the [docker build documentation](/reference/cli/docker/buildx/build.md#build-arg) to learn more about Docker build-time variables. #### Push to multiple repositories diff --git a/content/docker-hub/builds/automated-testing.md b/content/manuals/docker-hub/builds/automated-testing.md similarity index 100% rename from content/docker-hub/builds/automated-testing.md rename to content/manuals/docker-hub/builds/automated-testing.md diff --git a/content/docker-hub/builds/how-builds-work.md b/content/manuals/docker-hub/builds/how-builds-work.md similarity index 100% rename from content/docker-hub/builds/how-builds-work.md rename to content/manuals/docker-hub/builds/how-builds-work.md diff --git a/content/docker-hub/builds/images/authorize-builder.png b/content/manuals/docker-hub/builds/images/authorize-builder.png similarity index 100% rename from content/docker-hub/builds/images/authorize-builder.png rename to content/manuals/docker-hub/builds/images/authorize-builder.png diff --git a/content/docker-hub/builds/images/build-cancelicon.png b/content/manuals/docker-hub/builds/images/build-cancelicon.png similarity index 100% rename from content/docker-hub/builds/images/build-cancelicon.png rename to content/manuals/docker-hub/builds/images/build-cancelicon.png diff --git a/content/docker-hub/builds/images/index-active.png b/content/manuals/docker-hub/builds/images/index-active.png similarity index 100% rename from content/docker-hub/builds/images/index-active.png rename to content/manuals/docker-hub/builds/images/index-active.png diff --git a/content/docker-hub/builds/images/index-dashboard.png b/content/manuals/docker-hub/builds/images/index-dashboard.png similarity index 100% rename from content/docker-hub/builds/images/index-dashboard.png rename to content/manuals/docker-hub/builds/images/index-dashboard.png diff --git a/content/docker-hub/builds/images/index-report.png b/content/manuals/docker-hub/builds/images/index-report.png similarity index 100% rename from content/docker-hub/builds/images/index-report.png rename to content/manuals/docker-hub/builds/images/index-report.png diff --git a/content/docker-hub/builds/images/retry-build.png b/content/manuals/docker-hub/builds/images/retry-build.png similarity index 100% rename from content/docker-hub/builds/images/retry-build.png rename to content/manuals/docker-hub/builds/images/retry-build.png diff --git a/content/docker-hub/builds/link-source.md b/content/manuals/docker-hub/builds/link-source.md similarity index 100% rename from content/docker-hub/builds/link-source.md rename to content/manuals/docker-hub/builds/link-source.md diff --git a/content/docker-hub/builds/manage-builds.md b/content/manuals/docker-hub/builds/manage-builds.md similarity index 100% rename from content/docker-hub/builds/manage-builds.md rename to content/manuals/docker-hub/builds/manage-builds.md diff --git a/content/docker-hub/builds/troubleshoot.md b/content/manuals/docker-hub/builds/troubleshoot.md similarity index 100% rename from content/docker-hub/builds/troubleshoot.md rename to content/manuals/docker-hub/builds/troubleshoot.md diff --git a/content/docker-hub/download-rate-limit.md b/content/manuals/docker-hub/download-rate-limit.md similarity index 98% rename from content/docker-hub/download-rate-limit.md rename to content/manuals/docker-hub/download-rate-limit.md index 23ddc72f48..9ff90cf95b 100644 --- a/content/docker-hub/download-rate-limit.md +++ b/content/manuals/docker-hub/download-rate-limit.md @@ -2,6 +2,8 @@ description: Learn about usage and rate limits for Docker Hub. keywords: Docker Hub, pulls, download, limit, usage title: Docker Hub usage and rate limits +linkTitle: Usage and rate limits +weight: 30 --- Understanding your Docker Hub usage and rate limits helps you manage your and @@ -185,15 +187,15 @@ the on-screen instructions to complete the sign-in process. If you're using a standalone version of Docker Engine, run the `docker login` command from a terminal to authenticate with Docker Hub. For information on how -to use the command, see [docker login](../reference/cli/docker/login.md). +to use the command, see [docker login](/reference/cli/docker/login.md). ### Docker Swarm If you're running Docker Swarm, you must use the `--with-registry-auth` flag to authenticate with Docker Hub. For more information, see [Create a -service](../reference/cli/docker/service/create.md#with-registry-auth). If you +service](/reference/cli/docker/service/create.md#with-registry-auth). If you are using a Docker Compose file to deploy an application stack, see [docker -stack deploy](../reference/cli/docker/stack/deploy.md). +stack deploy](/reference/cli/docker/stack/deploy.md). ### GitHub Actions @@ -223,4 +225,4 @@ If you're using any third-party platforms, follow your provider’s instructions - [Drone.io](https://docs.drone.io/pipeline/docker/syntax/images/#pulling-private-images) - [GitLab](https://docs.gitlab.com/ee/user/packages/container_registry/#authenticate-with-the-container-registry) - [LayerCI](https://layerci.com/docs/advanced-workflows#logging-in-to-docker) -- [TeamCity](https://www.jetbrains.com/help/teamcity/integrating-teamcity-with-docker.html#Conforming+with+Docker+download+rate+limits) \ No newline at end of file +- [TeamCity](https://www.jetbrains.com/help/teamcity/integrating-teamcity-with-docker.html#Conforming+with+Docker+download+rate+limits) diff --git a/content/docker-hub/images/azure-create-connection.png b/content/manuals/docker-hub/images/azure-create-connection.png similarity index 100% rename from content/docker-hub/images/azure-create-connection.png rename to content/manuals/docker-hub/images/azure-create-connection.png diff --git a/content/docker-hub/images/create-connection.png b/content/manuals/docker-hub/images/create-connection.png similarity index 100% rename from content/docker-hub/images/create-connection.png rename to content/manuals/docker-hub/images/create-connection.png diff --git a/content/docker-hub/images/docker-hub-repo-settings-menu.png b/content/manuals/docker-hub/images/docker-hub-repo-settings-menu.png similarity index 100% rename from content/docker-hub/images/docker-hub-repo-settings-menu.png rename to content/manuals/docker-hub/images/docker-hub-repo-settings-menu.png diff --git a/content/docker-hub/images/index-report.png b/content/manuals/docker-hub/images/index-report.png similarity index 100% rename from content/docker-hub/images/index-report.png rename to content/manuals/docker-hub/images/index-report.png diff --git a/content/docker-hub/images/index-tag.webp b/content/manuals/docker-hub/images/index-tag.webp similarity index 100% rename from content/docker-hub/images/index-tag.webp rename to content/manuals/docker-hub/images/index-tag.webp diff --git a/content/docker-hub/images/oci-artifact.png b/content/manuals/docker-hub/images/oci-artifact.png similarity index 100% rename from content/docker-hub/images/oci-artifact.png rename to content/manuals/docker-hub/images/oci-artifact.png diff --git a/content/docker-hub/images/oci-helm-tagview.png b/content/manuals/docker-hub/images/oci-helm-tagview.png similarity index 100% rename from content/docker-hub/images/oci-helm-tagview.png rename to content/manuals/docker-hub/images/oci-helm-tagview.png diff --git a/content/docker-hub/images/oci-helm.png b/content/manuals/docker-hub/images/oci-helm.png similarity index 100% rename from content/docker-hub/images/oci-helm.png rename to content/manuals/docker-hub/images/oci-helm.png diff --git a/content/docker-hub/images/oci-volume.png b/content/manuals/docker-hub/images/oci-volume.png similarity index 100% rename from content/docker-hub/images/oci-volume.png rename to content/manuals/docker-hub/images/oci-volume.png diff --git a/content/docker-hub/images/saml-create-connection.png b/content/manuals/docker-hub/images/saml-create-connection.png similarity index 100% rename from content/docker-hub/images/saml-create-connection.png rename to content/manuals/docker-hub/images/saml-create-connection.png diff --git a/content/docker-hub/images/vuln-scan-details.png b/content/manuals/docker-hub/images/vuln-scan-details.png similarity index 100% rename from content/docker-hub/images/vuln-scan-details.png rename to content/manuals/docker-hub/images/vuln-scan-details.png diff --git a/content/docker-hub/images/vuln-scan-report.png b/content/manuals/docker-hub/images/vuln-scan-report.png similarity index 100% rename from content/docker-hub/images/vuln-scan-report.png rename to content/manuals/docker-hub/images/vuln-scan-report.png diff --git a/content/docker-hub/mirror.md b/content/manuals/docker-hub/mirror.md similarity index 97% rename from content/docker-hub/mirror.md rename to content/manuals/docker-hub/mirror.md index c026d3dcdd..501c0ad7dd 100644 --- a/content/docker-hub/mirror.md +++ b/content/manuals/docker-hub/mirror.md @@ -3,6 +3,8 @@ description: Setting-up a local mirror for Docker Hub images keywords: registry, on-prem, images, tags, repository, distribution, mirror, Hub, recipe, advanced title: Registry as a pull through cache +linkTitle: Mirroring +weight: 80 aliases: - /engine/admin/registry_mirror/ - /registry/recipes/mirror/ @@ -110,7 +112,7 @@ proxy: ### Configure the Docker daemon Either pass the `--registry-mirror` option when starting `dockerd` manually, -or edit [`/etc/docker/daemon.json`](../../reference/cli/dockerd.md#daemon-configuration-file) +or edit [`/etc/docker/daemon.json`](/reference/cli/dockerd.md#daemon-configuration-file) and add the `registry-mirrors` key and value, to make the change persistent. ```json diff --git a/content/docker-hub/oci-artifacts.md b/content/manuals/docker-hub/oci-artifacts.md similarity index 97% rename from content/docker-hub/oci-artifacts.md rename to content/manuals/docker-hub/oci-artifacts.md index b1d9f4b87e..8688ac1687 100644 --- a/content/docker-hub/oci-artifacts.md +++ b/content/manuals/docker-hub/oci-artifacts.md @@ -1,9 +1,9 @@ --- title: OCI artifacts on Docker Hub +linkTitle: OCI artifacts +weight: 100 keywords: oci, artifacts, docker hub -description: 'You can use Docker Hub to store software artifacts packaged as OCI artifacts. - - ' +description: You can use Docker Hub to store software artifacts packaged as OCI artifacts. --- You can use Docker Hub to store any kind of software artifact, not just diff --git a/content/docker-hub/quickstart.md b/content/manuals/docker-hub/quickstart.md similarity index 96% rename from content/docker-hub/quickstart.md rename to content/manuals/docker-hub/quickstart.md index 58e04e318c..e389fc63ae 100644 --- a/content/docker-hub/quickstart.md +++ b/content/manuals/docker-hub/quickstart.md @@ -3,6 +3,8 @@ description: Learn how to get started using Docker Hub keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, accounts, organizations, repositories, groups, teams title: Docker Hub quickstart +linkTitle: Quickstart +weight: 10 --- The following section contains step-by-step instructions on how to get started with Docker Hub. @@ -33,7 +35,7 @@ You've created your first repository. You need to download Docker Desktop to build, push, and pull container images. -1. Download and install [Docker Desktop](../desktop/index.md). +1. Download and install [Docker Desktop](/manuals/desktop/index.md). 2. Sign in to Docker Desktop using the Docker ID you created in step one. @@ -79,7 +81,7 @@ You need to download Docker Desktop to build, push, and pull container images. ### Step 5: Build and push a container image to Docker Hub from your computer -1. Start by creating a [Dockerfile](../reference/dockerfile.md) to specify your application as shown below: +1. Start by creating a [Dockerfile](/reference/dockerfile.md) to specify your application as shown below: ```dockerfile # syntax=docker/dockerfile:1 diff --git a/content/docker-hub/release-notes.md b/content/manuals/docker-hub/release-notes.md similarity index 97% rename from content/docker-hub/release-notes.md rename to content/manuals/docker-hub/release-notes.md index 1f699aa51e..d6752c579f 100644 --- a/content/docker-hub/release-notes.md +++ b/content/manuals/docker-hub/release-notes.md @@ -1,5 +1,7 @@ --- title: Docker Hub release notes +linkTitle: Release notes +weight: 999 description: Learn about the new features, bug fixes, and breaking changes for Docker Hub keywords: docker hub, whats new, release notes @@ -78,7 +80,7 @@ Take a look at the [Docker Public Roadmap](https://github.com/docker/roadmap/pro ### Bug fixes and enhancements -- You can now [export a CSV file of members](../admin/organization//members.md/#export-members) from organizations that you own. +- You can now [export a CSV file of members](../admin/organization//members.md#export-members) from organizations that you own. ## 2022-07-22 @@ -102,7 +104,7 @@ Take a look at the [Docker Public Roadmap](https://github.com/docker/roadmap/pro ### New -- [Registry Access Management](/security/for-admins/hardened-desktop/registry-access-management.md) is now available for all Docker Business subscriptions. When enabled, your users can access specific registries in Docker Hub. +- [Registry Access Management](/manuals/security/for-admins/hardened-desktop/registry-access-management.md) is now available for all Docker Business subscriptions. When enabled, your users can access specific registries in Docker Hub. ## 2022-05-03 diff --git a/content/docker-hub/repos/_index.md b/content/manuals/docker-hub/repos/_index.md similarity index 99% rename from content/docker-hub/repos/_index.md rename to content/manuals/docker-hub/repos/_index.md index e97f9dcead..868bbfb897 100644 --- a/content/docker-hub/repos/_index.md +++ b/content/manuals/docker-hub/repos/_index.md @@ -3,6 +3,7 @@ description: Learn how to manage repositories on Docker Hub keywords: Docker, docker, trusted, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation, manage, repos title: Manage repositories +weight: 20 aliases: - /engine/tutorials/dockerrepos/ --- diff --git a/content/docker-hub/repos/access.md b/content/manuals/docker-hub/repos/access.md similarity index 100% rename from content/docker-hub/repos/access.md rename to content/manuals/docker-hub/repos/access.md diff --git a/content/docker-hub/repos/categories.md b/content/manuals/docker-hub/repos/categories.md similarity index 100% rename from content/docker-hub/repos/categories.md rename to content/manuals/docker-hub/repos/categories.md diff --git a/content/docker-hub/repos/create.md b/content/manuals/docker-hub/repos/create.md similarity index 100% rename from content/docker-hub/repos/create.md rename to content/manuals/docker-hub/repos/create.md diff --git a/content/docker-hub/service-accounts.md b/content/manuals/docker-hub/service-accounts.md similarity index 99% rename from content/docker-hub/service-accounts.md rename to content/manuals/docker-hub/service-accounts.md index 18e3a2ea34..0e393b9452 100644 --- a/content/docker-hub/service-accounts.md +++ b/content/manuals/docker-hub/service-accounts.md @@ -2,6 +2,7 @@ description: Docker Service accounts keywords: Docker, service, accounts, Docker Hub title: Service accounts +weight: 50 --- > [!NOTE] diff --git a/content/docker-hub/vulnerability-scanning.md b/content/manuals/docker-hub/vulnerability-scanning.md similarity index 97% rename from content/docker-hub/vulnerability-scanning.md rename to content/manuals/docker-hub/vulnerability-scanning.md index 79ba5fddb2..da0d280496 100644 --- a/content/docker-hub/vulnerability-scanning.md +++ b/content/manuals/docker-hub/vulnerability-scanning.md @@ -2,6 +2,7 @@ description: Static vulnerability scanning in Docker Hub keywords: scanning, vulnerabilities, Hub, static title: Static vulnerability scanning +weight: 70 --- > [!NOTE] @@ -84,7 +85,7 @@ repository for which you have turned on scanning: 1. Ensure you have installed Docker locally. See [Get Docker](/get-started/get-docker.md) to download and install Docker on your local machine. 2. Use the command line to log into your Docker account. See - [`docker login`](../reference/cli/docker/login.md) for more + [`docker login`](/reference/cli/docker/login.md) for more information. 3. Tag the image to scan. For example, to tag a Redis image, run: @@ -123,7 +124,7 @@ To view the vulnerability report: ![Vulnerability scan details](images/vuln-scan-details.png) For more information on this view, see -[Image details view](/scout/explore/image-details-view.md). +[Image details view](/manuals/scout/explore/image-details-view.md). ### Inspect vulnerabilities diff --git a/content/docker-hub/webhooks.md b/content/manuals/docker-hub/webhooks.md similarity index 99% rename from content/docker-hub/webhooks.md rename to content/manuals/docker-hub/webhooks.md index 4322048692..7eed021aee 100644 --- a/content/docker-hub/webhooks.md +++ b/content/manuals/docker-hub/webhooks.md @@ -2,6 +2,7 @@ description: Docker Hub Webhooks keywords: Docker, webhooks, hub, builds title: Webhooks +weight: 40 --- You can use webhooks to cause an action in another service in response to a push event in the repository. Webhooks are POST requests sent to a URL you define in Docker Hub. diff --git a/content/engine/_index.md b/content/manuals/engine/_index.md similarity index 98% rename from content/engine/_index.md rename to content/manuals/engine/_index.md index e5e9a0218b..689e64f4fe 100644 --- a/content/engine/_index.md +++ b/content/manuals/engine/_index.md @@ -1,7 +1,9 @@ --- +title: Docker Engine overview +linkTitle: Docker Engine +weight: 100 description: Find a comprehensive overview of Docker Engine, including how to install, storage details, networking, and more keywords: Engine -title: Docker Engine overview grid: - title: Install Docker Engine description: Learn how to install the open source Docker Engine for your distribution. diff --git a/content/manuals/engine/cli/_index.md b/content/manuals/engine/cli/_index.md new file mode 100644 index 0000000000..38620c9e7f --- /dev/null +++ b/content/manuals/engine/cli/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: CLI +weight: 50 +--- diff --git a/content/engine/cli/completion.md b/content/manuals/engine/cli/completion.md similarity index 99% rename from content/engine/cli/completion.md rename to content/manuals/engine/cli/completion.md index d3edd45bd8..6c0f2c5916 100644 --- a/content/engine/cli/completion.md +++ b/content/manuals/engine/cli/completion.md @@ -1,5 +1,6 @@ --- -title: CLI completion +title: Completion +weight: 10 description: Set up your shell to get autocomplete for Docker commands and flags keywords: cli, shell, fish, bash, zsh, completion, options aliases: diff --git a/content/engine/cli/filter.md b/content/manuals/engine/cli/filter.md similarity index 97% rename from content/engine/cli/filter.md rename to content/manuals/engine/cli/filter.md index 317cf61f9d..e51fb63347 100644 --- a/content/engine/cli/filter.md +++ b/content/manuals/engine/cli/filter.md @@ -1,5 +1,6 @@ --- title: Filter commands +weight: 30 description: | Use the filtering function in the CLI to selectively include resources that match the pattern you define. @@ -72,7 +73,7 @@ busybox glibc 7338d0c72c65 2 hours ago 6.09MB ### Multiple negated filters -Some commands support negated filters on [labels](/engine/manage-resources/labels.md). +Some commands support negated filters on [labels](/manuals/engine/manage-resources/labels.md). Negated filters only consider results that don't match the specified patterns. The following command prunes all containers that aren't labeled `foo`. diff --git a/content/engine/cli/formatting.md b/content/manuals/engine/cli/formatting.md similarity index 99% rename from content/engine/cli/formatting.md rename to content/manuals/engine/cli/formatting.md index 09a475f940..e7b0c27934 100644 --- a/content/engine/cli/formatting.md +++ b/content/manuals/engine/cli/formatting.md @@ -2,6 +2,7 @@ description: CLI and log output formatting reference keywords: format, formatting, output, templates, log title: Format command and log output +weight: 40 aliases: - /engine/admin/formatting/ - /config/formatting/ diff --git a/content/engine/cli/otel.md b/content/manuals/engine/cli/otel.md similarity index 100% rename from content/engine/cli/otel.md rename to content/manuals/engine/cli/otel.md diff --git a/content/engine/cli/proxy.md b/content/manuals/engine/cli/proxy.md similarity index 94% rename from content/engine/cli/proxy.md rename to content/manuals/engine/cli/proxy.md index d3f132792a..54a1e1972b 100644 --- a/content/engine/cli/proxy.md +++ b/content/manuals/engine/cli/proxy.md @@ -1,5 +1,7 @@ --- title: Use a proxy server with the Docker CLI +linkTitle: Proxy configuration +weight: 20 description: How to configure the Docker client CLI to use a proxy server keywords: network, networking, proxy, client aliases: @@ -11,12 +13,12 @@ environment variables in containers. This page doesn't describe how to configure proxies for the Docker daemon. For instructions on configuring Docker Desktop to use HTTP/HTTPS proxies, see -[proxies on Mac](/desktop/settings/mac.md#proxies), -[proxies on Windows](/desktop/settings/windows.md#proxies), and -[proxies on Linux](/desktop/settings/linux.md#proxies). +[proxies on Mac](/manuals/desktop/settings/mac.md#proxies), +[proxies on Windows](/manuals/desktop/settings/windows.md#proxies), and +[proxies on Linux](/manuals/desktop/settings/linux.md#proxies). If you're running Docker Engine without Docker Desktop, refer to -[Configure the Docker daemon to use a proxy](/engine/daemon/proxy.md) +[Configure the Docker daemon to use a proxy](/manuals/engine/daemon/proxy.md) to learn how to configure a proxy server for the Docker daemon (`dockerd`) itself. If your container needs to use an HTTP, HTTPS, or FTP proxy server, you can @@ -80,7 +82,7 @@ These settings are used to configure proxy environment variables for containers only, and not used as proxy settings for the Docker CLI or the Docker Engine itself. Refer to the [environment variables](/reference/cli/docker/#environment-variables) -and [configure the Docker daemon to use a proxy server](/engine/daemon/proxy.md) +and [configure the Docker daemon to use a proxy server](/manuals/engine/daemon/proxy.md) sections for configuring proxy settings for the CLI and daemon. ### Run containers with a proxy configuration diff --git a/content/manuals/engine/containers/_index.md b/content/manuals/engine/containers/_index.md new file mode 100644 index 0000000000..17bc97237e --- /dev/null +++ b/content/manuals/engine/containers/_index.md @@ -0,0 +1,6 @@ +--- +title: Containers +build: + render: never +weight: 40 +--- diff --git a/content/engine/containers/multi-service_container.md b/content/manuals/engine/containers/multi-service_container.md similarity index 99% rename from content/engine/containers/multi-service_container.md rename to content/manuals/engine/containers/multi-service_container.md index c99fbd4202..5a2007ba2c 100644 --- a/content/engine/containers/multi-service_container.md +++ b/content/manuals/engine/containers/multi-service_container.md @@ -2,6 +2,7 @@ description: Learn how to run more than one process in a single container keywords: docker, supervisor, process management title: Run multiple processes in a container +weight: 20 aliases: - /articles/using_supervisord/ - /engine/admin/multi-service_container/ diff --git a/content/engine/containers/resource_constraints.md b/content/manuals/engine/containers/resource_constraints.md similarity index 99% rename from content/engine/containers/resource_constraints.md rename to content/manuals/engine/containers/resource_constraints.md index ddbc45e2fa..09e04a4a37 100644 --- a/content/engine/containers/resource_constraints.md +++ b/content/manuals/engine/containers/resource_constraints.md @@ -1,5 +1,6 @@ --- -title: Runtime options with Memory, CPUs, and GPUs +title: Resource constraints +weight: 30 description: Specify the runtime options for a container keywords: docker, daemon, configuration, runtime aliases: @@ -15,7 +16,7 @@ on when you should set such limits and the possible implications of setting them Many of these features require your kernel to support Linux capabilities. To check for support, you can use the -[`docker info`](../../reference/cli/docker/system/info.md) command. If a capability +[`docker info`](/reference/cli/docker/system/info.md) command. If a capability is disabled in your kernel, you may see a warning at the end of the output like the following: @@ -60,7 +61,7 @@ You can mitigate the risk of system instability due to OOME by: - Be mindful when configuring swap on your Docker hosts. Swap is slower than memory but can provide a buffer against running out of system memory. - Consider converting your container to a - [service](../../engine/swarm/services.md), and using service-level constraints + [service](/manuals/engine/swarm/services.md), and using service-level constraints and node labels to ensure that the application runs only on hosts with enough memory diff --git a/content/engine/containers/runmetrics.md b/content/manuals/engine/containers/runmetrics.md similarity index 99% rename from content/engine/containers/runmetrics.md rename to content/manuals/engine/containers/runmetrics.md index 911cfafe86..d16b06be93 100644 --- a/content/engine/containers/runmetrics.md +++ b/content/manuals/engine/containers/runmetrics.md @@ -2,6 +2,7 @@ description: Learn how to measure running containers, and about the different metrics keywords: docker, metrics, CPU, memory, disk, IO, run, runtime, stats title: Runtime metrics +weight: 50 aliases: - /articles/runmetrics/ - /engine/articles/run_metrics/ @@ -26,7 +27,7 @@ redis1 0.07% 796 KB / 64 MB 1.21% redis2 0.07% 2.746 MB / 64 MB 4.29% 1.266 KB / 648 B 12.4 MB / 0 B ``` -The [`docker stats`](../../reference/cli/docker/container/stats.md) reference +The [`docker stats`](/reference/cli/docker/container/stats.md) reference page has more details about the `docker stats` command. ## Control groups diff --git a/content/engine/containers/start-containers-automatically.md b/content/manuals/engine/containers/start-containers-automatically.md similarity index 98% rename from content/engine/containers/start-containers-automatically.md rename to content/manuals/engine/containers/start-containers-automatically.md index 771dc907f5..213ae635c5 100644 --- a/content/engine/containers/start-containers-automatically.md +++ b/content/manuals/engine/containers/start-containers-automatically.md @@ -2,6 +2,7 @@ description: How to start containers automatically keywords: containers, restart, policies, automation, administration title: Start containers automatically +weight: 10 aliases: - /engine/articles/host_integration/ - /engine/admin/host_integration/ @@ -9,7 +10,7 @@ aliases: - /config/containers/start-containers-automatically/ --- -Docker provides [restart policies](/engine/containers/run.md#restart-policies---restart) +Docker provides [restart policies](/manuals/engine/containers/run.md#restart-policies---restart) to control whether your containers start automatically when they exit, or when Docker restarts. Restart policies start linked containers in the correct order. Docker recommends that you use restart policies, and avoid using process diff --git a/content/engine/daemon/_index.md b/content/manuals/engine/daemon/_index.md similarity index 86% rename from content/engine/daemon/_index.md rename to content/manuals/engine/daemon/_index.md index ced09ab099..d1536cfb2b 100644 --- a/content/engine/daemon/_index.md +++ b/content/manuals/engine/daemon/_index.md @@ -2,6 +2,8 @@ description: Configuring the Docker daemon keywords: docker, daemon, configuration title: Docker daemon configuration overview +linkTitle: Daemon +weight: 60 aliases: - /articles/chef/ - /articles/configuring/ @@ -33,9 +35,9 @@ This page shows you how to customize the Docker daemon, `dockerd`. > This page is for users who've installed Docker Engine manually. If you're > using Docker Desktop, refer to the following pages instead: > -> - [Change preferences on Mac](../../desktop/settings/mac#docker-engine) -> - [Change preferences on Windows](../../desktop/settings/windows#docker-engine) -> - [Change preferences on Linux](../../desktop/settings/linux#docker-engine) +> - [Change preferences on Mac](/desktop/settings/mac#docker-engine) +> - [Change preferences on Windows](/desktop/settings/windows#docker-engine) +> - [Change preferences on Linux](/desktop/settings/linux#docker-engine) ## Configure the Docker daemon @@ -124,8 +126,8 @@ to troubleshoot. Many specific configuration options are discussed throughout the Docker documentation. Some places to go next include: -- [Automatically start containers](/engine/containers/start-containers-automatically.md) -- [Limit a container's resources](/engine/containers/resource_constraints.md) -- [Configure storage drivers](/engine/storage/drivers/select-storage-driver.md) -- [Container security](/engine/security/_index.md) +- [Automatically start containers](/manuals/engine/containers/start-containers-automatically.md) +- [Limit a container's resources](/manuals/engine/containers/resource_constraints.md) +- [Configure storage drivers](/manuals/engine/storage/drivers/select-storage-driver.md) +- [Container security](/manuals/engine/security/_index.md) - [Configure the Docker daemon to use a proxy](./proxy.md) diff --git a/content/engine/daemon/alternative-runtimes.md b/content/manuals/engine/daemon/alternative-runtimes.md similarity index 98% rename from content/engine/daemon/alternative-runtimes.md rename to content/manuals/engine/daemon/alternative-runtimes.md index 088159d9bf..0cde0c7cfb 100644 --- a/content/engine/daemon/alternative-runtimes.md +++ b/content/manuals/engine/daemon/alternative-runtimes.md @@ -175,7 +175,7 @@ plus the added sandboxing provided by the Wasm runtime environment. To add Wasmtime as a container runtime, follow these steps: -1. Turn on the [containerd image store](/engine/storage/containerd.md) +1. Turn on the [containerd image store](/manuals/engine/storage/containerd.md) feature in the daemon configuration file. > [!NOTE] diff --git a/content/engine/daemon/images/prometheus-graph_idle.webp b/content/manuals/engine/daemon/images/prometheus-graph_idle.webp similarity index 100% rename from content/engine/daemon/images/prometheus-graph_idle.webp rename to content/manuals/engine/daemon/images/prometheus-graph_idle.webp diff --git a/content/engine/daemon/images/prometheus-graph_load.webp b/content/manuals/engine/daemon/images/prometheus-graph_load.webp similarity index 100% rename from content/engine/daemon/images/prometheus-graph_load.webp rename to content/manuals/engine/daemon/images/prometheus-graph_load.webp diff --git a/content/engine/daemon/images/prometheus-targets.webp b/content/manuals/engine/daemon/images/prometheus-targets.webp similarity index 100% rename from content/engine/daemon/images/prometheus-targets.webp rename to content/manuals/engine/daemon/images/prometheus-targets.webp diff --git a/content/engine/daemon/ipv6.md b/content/manuals/engine/daemon/ipv6.md similarity index 98% rename from content/engine/daemon/ipv6.md rename to content/manuals/engine/daemon/ipv6.md index d7b61ac6f2..1ed5ca00b0 100644 --- a/content/engine/daemon/ipv6.md +++ b/content/manuals/engine/daemon/ipv6.md @@ -1,5 +1,6 @@ --- -title: Enable IPv6 support +title: Use IPv6 networking +weight: 20 description: How to enable IPv6 support in the Docker daemon keywords: daemon, network, networking, ipv6 aliases: @@ -192,4 +193,4 @@ Engine. ## Next steps -- [Networking overview](/engine/network/_index.md) +- [Networking overview](/manuals/engine/network/_index.md) diff --git a/content/engine/containers/live-restore.md b/content/manuals/engine/daemon/live-restore.md similarity index 99% rename from content/engine/containers/live-restore.md rename to content/manuals/engine/daemon/live-restore.md index 92ec56e68e..264afacf5c 100644 --- a/content/engine/containers/live-restore.md +++ b/content/manuals/engine/daemon/live-restore.md @@ -2,6 +2,7 @@ description: Learn how to keep containers running when the daemon isn't available keywords: docker, upgrade, daemon, dockerd, live-restore, daemonless container title: Live restore +weight: 40 aliases: - /engine/admin/live-restore/ - /config/containers/live-restore/ diff --git a/content/engine/daemon/logs.md b/content/manuals/engine/daemon/logs.md similarity index 100% rename from content/engine/daemon/logs.md rename to content/manuals/engine/daemon/logs.md diff --git a/content/engine/daemon/prometheus.md b/content/manuals/engine/daemon/prometheus.md similarity index 100% rename from content/engine/daemon/prometheus.md rename to content/manuals/engine/daemon/prometheus.md diff --git a/content/engine/daemon/proxy.md b/content/manuals/engine/daemon/proxy.md similarity index 97% rename from content/engine/daemon/proxy.md rename to content/manuals/engine/daemon/proxy.md index 5ef502cecc..2166665e9b 100644 --- a/content/engine/daemon/proxy.md +++ b/content/manuals/engine/daemon/proxy.md @@ -1,7 +1,8 @@ --- description: Learn how to configure the Docker daemon to use an HTTP proxy keywords: dockerd, daemon, configuration, proxy, networking, http_proxy, https_proxy, no_proxy, systemd, environment variables -title: Configure the daemon to use a proxy +title: Daemon proxy configuration +weight: 30 aliases: - /articles/host_integration/ - /articles/systemd/ @@ -20,7 +21,7 @@ and to reach other nodes in a Docker swarm. This page describes how to configure a proxy for the Docker daemon. For instructions on configuring proxy settings for the Docker CLI, see [Configure -Docker CLI to use a proxy server](/engine/cli/proxy.md). +Docker CLI to use a proxy server](/manuals/engine/cli/proxy.md). There are two ways you can configure these settings: @@ -71,7 +72,7 @@ systemd drop-in file that sets the variables for the `docker` service. > **Note for rootless mode** > > The location of systemd configuration files are different when running Docker -> in [rootless mode](../../engine/security/rootless.md). When running in +> in [rootless mode](/manuals/engine/security/rootless.md). When running in > rootless mode, Docker is started as a user-mode systemd service, and uses > files stored in each users' home directory in > `~/.config/systemd//docker.service.d/`. In addition, `systemctl` must diff --git a/content/engine/daemon/remote-access.md b/content/manuals/engine/daemon/remote-access.md similarity index 98% rename from content/engine/daemon/remote-access.md rename to content/manuals/engine/daemon/remote-access.md index 45bffbba40..7219904986 100644 --- a/content/engine/daemon/remote-access.md +++ b/content/manuals/engine/daemon/remote-access.md @@ -25,7 +25,7 @@ as the Unix socket. > > Remote access without TLS is **not recommended**, and will require explicit opt-in in a future release. > For more information on how to use TLS certificates to secure this connection, see -> [Protect the Docker daemon socket](../../engine/security/protect-access.md). +> [Protect the Docker daemon socket](/manuals/engine/security/protect-access.md). ## Enable remote access diff --git a/content/engine/daemon/start.md b/content/manuals/engine/daemon/start.md similarity index 87% rename from content/engine/daemon/start.md rename to content/manuals/engine/daemon/start.md index 80a1de4a93..b653419c57 100644 --- a/content/engine/daemon/start.md +++ b/content/manuals/engine/daemon/start.md @@ -1,5 +1,6 @@ --- title: Start the daemon +weight: 10 description: Starting the Docker daemon manually keywords: docker, daemon, configuration, troubleshooting aliases: @@ -15,7 +16,7 @@ manually by a user. This makes it easier to automatically start Docker when the machine reboots. The command to start Docker depends on your operating system. Check the correct -page under [Install Docker](../../engine/install/index.md). +page under [Install Docker](/manuals/engine/install/index.md). ### Start with systemd @@ -27,7 +28,7 @@ $ sudo systemctl start docker ``` If you want Docker to start at boot, see -[Configure Docker to start on boot](../../engine/install/linux-postinstall.md#configure-docker-to-start-on-boot-with-systemd). +[Configure Docker to start on boot](/manuals/engine/install/linux-postinstall.md#configure-docker-to-start-on-boot-with-systemd). ## Start the daemon manually diff --git a/content/engine/daemon/troubleshoot.md b/content/manuals/engine/daemon/troubleshoot.md similarity index 100% rename from content/engine/daemon/troubleshoot.md rename to content/manuals/engine/daemon/troubleshoot.md diff --git a/content/engine/install/_index.md b/content/manuals/engine/install/_index.md similarity index 95% rename from content/engine/install/_index.md rename to content/manuals/engine/install/_index.md index d2819f861c..69c73c8ab7 100644 --- a/content/engine/install/_index.md +++ b/content/manuals/engine/install/_index.md @@ -1,5 +1,7 @@ --- title: Install Docker Engine +linkTitle: Install +weight: 10 description: Learn how to choose the best method for you to install Docker Engine. This client-server application is available on Linux, Mac, Windows, and as a static binary. keywords: install engine, docker engine install, install docker engine, docker engine @@ -35,9 +37,9 @@ This section describes how to install Docker Engine on Linux, also known as Docker CE. Docker Engine is also available for Windows, macOS, and Linux, through Docker Desktop. For instructions on how to install Docker Desktop, see: -- [Docker Desktop for Linux](../../desktop/install/linux-install.md) -- [Docker Desktop for Mac (macOS)](../../desktop/install/mac-install.md) -- [Docker Desktop for Windows](../../desktop/install/windows-install.md) +- [Docker Desktop for Linux](/manuals/desktop/install/linux-install.md) +- [Docker Desktop for Mac (macOS)](/manuals/desktop/install/mac-install.md) +- [Docker Desktop for Windows](/manuals/desktop/install/windows-install.md) ## Supported platforms diff --git a/content/engine/install/binaries.md b/content/manuals/engine/install/binaries.md similarity index 97% rename from content/engine/install/binaries.md rename to content/manuals/engine/install/binaries.md index f6bee97d45..4d870ed0ae 100644 --- a/content/engine/install/binaries.md +++ b/content/manuals/engine/install/binaries.md @@ -2,6 +2,8 @@ description: Learn how to install Docker as a binary. These instructions are most suitable for testing purposes. keywords: binaries, installation, docker, documentation, linux, install docker engine title: Install Docker Engine from binaries +linkTitle: Binaries +weight: 80 aliases: - /engine/installation/binaries/ - /engine/installation/linux/docker-ce/binaries/ @@ -26,7 +28,7 @@ aliases: > Also, static binaries may not include all functionalities provided by the dynamic > packages. > -> On Windows and Mac, we recommend that you install [Docker Desktop](../../desktop/index.md) +> On Windows and Mac, we recommend that you install [Docker Desktop](/manuals/desktop/index.md) > instead. For Linux, we recommend that you follow the instructions specific for > your distribution. @@ -145,7 +147,7 @@ You have now successfully installed and started Docker Engine. > The following instructions are mostly suitable for testing purposes. The macOS > binary includes the Docker client only. It does not include the `dockerd` daemon > which is required to run containers. Therefore, we recommend that you install -> [Docker Desktop](../../desktop/index.md) instead. +> [Docker Desktop](/manuals/desktop/index.md) instead. The binaries for Mac also do not contain: @@ -205,7 +207,7 @@ To install client binaries, perform the following steps: > Server which allows you to run Windows containers only. When you install the > Docker daemon on Windows Server, the daemon doesn't contain Docker components > such as `buildx` and `compose`. If you're running Windows 10 or 11, -> we recommend that you install [Docker Desktop](../../desktop/index.md) instead. +> we recommend that you install [Docker Desktop](/manuals/desktop/index.md) instead. Binary packages on Windows include both `dockerd.exe` and `docker.exe`. On Windows, these binaries only provide the ability to run native Windows containers (not diff --git a/content/engine/install/centos.md b/content/manuals/engine/install/centos.md similarity index 99% rename from content/engine/install/centos.md rename to content/manuals/engine/install/centos.md index 357fbccadc..61ecd8296b 100644 --- a/content/engine/install/centos.md +++ b/content/manuals/engine/install/centos.md @@ -3,6 +3,8 @@ description: Learn how to install Docker Engine on CentOS. These instructions co the different installation methods, how to uninstall, and next steps. keywords: requirements, yum, installation, centos, install, uninstall, docker engine, upgrade, update title: Install Docker Engine on CentOS +linkTitle: CentOS +weight: 60 toc_max: 4 aliases: - /ee/docker-ee/centos/ diff --git a/content/engine/install/debian.md b/content/manuals/engine/install/debian.md similarity index 96% rename from content/engine/install/debian.md rename to content/manuals/engine/install/debian.md index e3264847ef..ea97a30a2d 100644 --- a/content/engine/install/debian.md +++ b/content/manuals/engine/install/debian.md @@ -3,6 +3,8 @@ description: Learn how to install Docker Engine on Debian. These instructions co the different installation methods, how to uninstall, and next steps. keywords: requirements, apt, installation, debian, install, uninstall, install debian, docker engine, install docker engine, upgrade, update title: Install Docker Engine on Debian +linkTitle: Debian +weight: 20 toc_max: 4 aliases: - /engine/installation/debian/ @@ -28,12 +30,12 @@ To get started with Docker Engine on Debian, make sure you - If you use ufw or firewalld to manage firewall settings, be aware that when you expose container ports using Docker, these ports bypass your firewall rules. For more information, refer to - [Docker and ufw](/engine/network/packet-filtering-firewalls.md#docker-and-ufw). + [Docker and ufw](/manuals/engine/network/packet-filtering-firewalls.md#docker-and-ufw). - Docker is only compatible with `iptables-nft` and `iptables-legacy`. Firewall rules created with `nft` are not supported on a system with Docker installed. Make sure that any firewall rulesets you use are created with `iptables` or `ip6tables`, and that you add them to the `DOCKER-USER` chain, - see [Packet filtering and firewalls](/engine/network/packet-filtering-firewalls.md). + see [Packet filtering and firewalls](/manuals/engine/network/packet-filtering-firewalls.md). ### OS requirements @@ -84,7 +86,7 @@ clean installation, and prefer to clean up any existing data, read the You can install Docker Engine in different ways, depending on your needs: - Docker Engine comes bundled with - [Docker Desktop for Linux](../../desktop/install/linux-install.md). This is + [Docker Desktop for Linux](/manuals/desktop/install/linux-install.md). This is the easiest and quickest way to get started. - Set up and install Docker Engine from diff --git a/content/engine/install/fedora.md b/content/manuals/engine/install/fedora.md similarity index 99% rename from content/engine/install/fedora.md rename to content/manuals/engine/install/fedora.md index a4472d72d1..5e3b501c37 100644 --- a/content/engine/install/fedora.md +++ b/content/manuals/engine/install/fedora.md @@ -4,6 +4,8 @@ description: Learn how to install Docker Engine on Fedora. These instructions co keywords: requirements, apt, installation, fedora, install fedora, install docker engine, rpm, install, uninstall, upgrade, update title: Install Docker Engine on Fedora +linkTitle: Fedora +weight: 40 toc_max: 4 aliases: - /engine/installation/fedora/ diff --git a/content/engine/install/linux-postinstall.md b/content/manuals/engine/install/linux-postinstall.md similarity index 91% rename from content/engine/install/linux-postinstall.md rename to content/manuals/engine/install/linux-postinstall.md index 927b7f7bad..2b8c462625 100644 --- a/content/engine/install/linux-postinstall.md +++ b/content/manuals/engine/install/linux-postinstall.md @@ -5,6 +5,8 @@ keywords: run docker without sudo, docker running as root, docker post install, post installation, run docker as non root, docker non root user, how to run docker in linux, how to run docker linux, how to start docker in linux, run docker on linux title: Linux post-installation steps for Docker Engine +linkTitle: Post-installation steps +weight: 90 aliases: - /engine/installation/linux/docker-ee/linux-postinstall/ - /engine/installation/linux/linux-postinstall/ @@ -116,11 +118,11 @@ $ sudo systemctl disable containerd.service You can use systemd unit files to configure the Docker service on startup, for example to add an HTTP proxy, set a different directory or partition for the Docker runtime files, or other customizations. For an example, see -[Configure the daemon to use a proxy](/engine/daemon/proxy.md#systemd-unit-file). +[Configure the daemon to use a proxy](/manuals/engine/daemon/proxy.md#systemd-unit-file). ## Configure default logging driver -Docker provides [logging drivers](/engine/logging/_index.md) for +Docker provides [logging drivers](/manuals/engine/logging/_index.md) for collecting and viewing log data from all containers running on a host. The default logging driver, `json-file`, writes log data to JSON-formatted files on the host filesystem. Over time, these log files expand in size, leading to @@ -130,10 +132,10 @@ To avoid issues with overusing disk for log data, consider one of the following options: - Configure the `json-file` logging driver to turn on - [log rotation](/engine/logging/drivers/json-file.md). + [log rotation](/manuals/engine/logging/drivers/json-file.md). - Use an - [alternative logging driver](/engine/logging/configure.md#configure-the-default-logging-driver) - such as the ["local" logging driver](/engine/logging/drivers/local.md) + [alternative logging driver](/manuals/engine/logging/configure.md#configure-the-default-logging-driver) + such as the ["local" logging driver](/manuals/engine/logging/drivers/local.md) that performs log rotation by default. - Use a logging driver that sends logs to a remote logging aggregator. diff --git a/content/engine/install/raspberry-pi-os.md b/content/manuals/engine/install/raspberry-pi-os.md similarity index 96% rename from content/engine/install/raspberry-pi-os.md rename to content/manuals/engine/install/raspberry-pi-os.md index 68f8e22451..5393727207 100644 --- a/content/engine/install/raspberry-pi-os.md +++ b/content/manuals/engine/install/raspberry-pi-os.md @@ -4,6 +4,8 @@ description: Learn how to install Docker Engine on a 32-bit Raspberry Pi OS syst keywords: requirements, apt, installation, install docker engine, Raspberry Pi OS, install, uninstall, upgrade, update title: Install Docker Engine on Raspberry Pi OS (32-bit) +linkTitle: Raspberry Pi OS (32-bit) +weight: 50 toc_max: 4 aliases: - /engine/installation/linux/raspbian/ @@ -33,12 +35,12 @@ To get started with Docker Engine on Raspberry Pi OS, make sure you - If you use ufw or firewalld to manage firewall settings, be aware that when you expose container ports using Docker, these ports bypass your firewall rules. For more information, refer to - [Docker and ufw](/engine/network/packet-filtering-firewalls.md#docker-and-ufw). + [Docker and ufw](/manuals/engine/network/packet-filtering-firewalls.md#docker-and-ufw). - Docker is only compatible with `iptables-nft` and `iptables-legacy`. Firewall rules created with `nft` are not supported on a system with Docker installed. Make sure that any firewall rulesets you use are created with `iptables` or `ip6tables`, and that you add them to the `DOCKER-USER` chain, - see [Packet filtering and firewalls](/engine/network/packet-filtering-firewalls.md). + see [Packet filtering and firewalls](/manuals/engine/network/packet-filtering-firewalls.md). ### OS requirements @@ -85,7 +87,7 @@ clean installation, and prefer to clean up any existing data, read the You can install Docker Engine in different ways, depending on your needs: - Docker Engine comes bundled with - [Docker Desktop for Linux](../../desktop/install/linux-install.md). This is + [Docker Desktop for Linux](/manuals/desktop/install/linux-install.md). This is the easiest and quickest way to get started. - Set up and install Docker Engine from diff --git a/content/engine/install/rhel.md b/content/manuals/engine/install/rhel.md similarity index 99% rename from content/engine/install/rhel.md rename to content/manuals/engine/install/rhel.md index 6ff058f9f8..3928f85904 100644 --- a/content/engine/install/rhel.md +++ b/content/manuals/engine/install/rhel.md @@ -4,6 +4,8 @@ description: Learn how to install Docker Engine on RHEL. These instructions cove keywords: requirements, apt, installation, rhel, rpm, install, install docker engine, uninstall, upgrade, update title: Install Docker Engine on RHEL +linkTitle: RHEL +weight: 30 toc_max: 4 aliases: - /ee/docker-ee/rhel/ diff --git a/content/engine/install/sles.md b/content/manuals/engine/install/sles.md similarity index 99% rename from content/engine/install/sles.md rename to content/manuals/engine/install/sles.md index 2d3a237793..b0735454a2 100644 --- a/content/engine/install/sles.md +++ b/content/manuals/engine/install/sles.md @@ -4,6 +4,8 @@ description: Learn how to install Docker Engine on SLES. These instructions cove keywords: requirements, apt, installation, install docker engine, centos, rpm, sles, install, uninstall, upgrade, update, s390x, ibm-z title: Install Docker Engine on SLES (s390x) +linkTitle: SLES (s390x) +weight: 70 toc_max: 4 aliases: - /ee/docker-ee/sles/ diff --git a/content/engine/install/ubuntu.md b/content/manuals/engine/install/ubuntu.md similarity index 96% rename from content/engine/install/ubuntu.md rename to content/manuals/engine/install/ubuntu.md index d0d6351527..7778a1ccab 100644 --- a/content/engine/install/ubuntu.md +++ b/content/manuals/engine/install/ubuntu.md @@ -5,6 +5,8 @@ keywords: docker install script, ubuntu docker server, ubuntu server docker, ins docker engine ubuntu, install docker on ubuntu server, ubuntu 22.04 docker-ce, install docker engine on ubuntu, ubuntu install docker ce, ubuntu install docker engine title: Install Docker Engine on Ubuntu +linkTitle: Ubuntu +weight: 10 toc_max: 4 aliases: - /ee/docker-ee/ubuntu/ @@ -36,12 +38,12 @@ To get started with Docker Engine on Ubuntu, make sure you - If you use ufw or firewalld to manage firewall settings, be aware that when you expose container ports using Docker, these ports bypass your firewall rules. For more information, refer to - [Docker and ufw](/engine/network/packet-filtering-firewalls.md#docker-and-ufw). + [Docker and ufw](/manuals/engine/network/packet-filtering-firewalls.md#docker-and-ufw). - Docker is only compatible with `iptables-nft` and `iptables-legacy`. Firewall rules created with `nft` are not supported on a system with Docker installed. Make sure that any firewall rulesets you use are created with `iptables` or `ip6tables`, and that you add them to the `DOCKER-USER` chain, - see [Packet filtering and firewalls](/engine/network/packet-filtering-firewalls.md). + see [Packet filtering and firewalls](/manuals/engine/network/packet-filtering-firewalls.md). ### OS requirements @@ -94,7 +96,7 @@ clean installation, and prefer to clean up any existing data, read the You can install Docker Engine in different ways, depending on your needs: - Docker Engine comes bundled with - [Docker Desktop for Linux](../../desktop/install/linux-install.md). This is + [Docker Desktop for Linux](/manuals/desktop/install/linux-install.md). This is the easiest and quickest way to get started. - Set up and install Docker Engine from diff --git a/content/engine/logging/_index.md b/content/manuals/engine/logging/_index.md similarity index 96% rename from content/engine/logging/_index.md rename to content/manuals/engine/logging/_index.md index beb1cff715..e949460036 100644 --- a/content/engine/logging/_index.md +++ b/content/manuals/engine/logging/_index.md @@ -2,6 +2,8 @@ description: Learn how to write to, view, and configure a container's logs keywords: docker, logging title: View container logs +linkTitle: Logs and metrics +weight: 70 aliases: - /engine/admin/logging/ - /engine/admin/logging/view_container_logs/ @@ -51,4 +53,4 @@ its errors to `/proc/self/fd/2` (which is `STDERR`). See the ## Next steps - Configure [logging drivers](configure.md). -- Write a [Dockerfile](../../../reference/dockerfile.md). +- Write a [Dockerfile](/reference/dockerfile.md). diff --git a/content/engine/logging/configure.md b/content/manuals/engine/logging/configure.md similarity index 100% rename from content/engine/logging/configure.md rename to content/manuals/engine/logging/configure.md diff --git a/content/manuals/engine/logging/drivers/_index.md b/content/manuals/engine/logging/drivers/_index.md new file mode 100644 index 0000000000..8c8e1b8219 --- /dev/null +++ b/content/manuals/engine/logging/drivers/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Logging drivers +--- diff --git a/content/engine/logging/drivers/awslogs.md b/content/manuals/engine/logging/drivers/awslogs.md similarity index 99% rename from content/engine/logging/drivers/awslogs.md rename to content/manuals/engine/logging/drivers/awslogs.md index 35751ffa2d..42cdb8f55e 100644 --- a/content/engine/logging/drivers/awslogs.md +++ b/content/manuals/engine/logging/drivers/awslogs.md @@ -21,7 +21,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `awslogs` and sets the `awslogs-region` option. diff --git a/content/engine/logging/drivers/etwlogs.md b/content/manuals/engine/logging/drivers/etwlogs.md similarity index 100% rename from content/engine/logging/drivers/etwlogs.md rename to content/manuals/engine/logging/drivers/etwlogs.md diff --git a/content/engine/logging/drivers/fluentd.md b/content/manuals/engine/logging/drivers/fluentd.md similarity index 98% rename from content/engine/logging/drivers/fluentd.md rename to content/manuals/engine/logging/drivers/fluentd.md index 5e65ca25ce..4f44382aff 100644 --- a/content/engine/logging/drivers/fluentd.md +++ b/content/manuals/engine/logging/drivers/fluentd.md @@ -36,7 +36,7 @@ To use the `fluentd` driver as the default logging driver, set the `log-driver` and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about -configuring Docker using `daemon.json`, see [daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +configuring Docker using `daemon.json`, see [daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `fluentd` and sets the `fluentd-address` option. diff --git a/content/engine/logging/drivers/gcplogs.md b/content/manuals/engine/logging/drivers/gcplogs.md similarity index 98% rename from content/engine/logging/drivers/gcplogs.md rename to content/manuals/engine/logging/drivers/gcplogs.md index cac4f674c7..cb574c3e4a 100644 --- a/content/engine/logging/drivers/gcplogs.md +++ b/content/manuals/engine/logging/drivers/gcplogs.md @@ -18,7 +18,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `gcplogs` and sets the `gcp-meta-name` option. diff --git a/content/engine/logging/drivers/gelf.md b/content/manuals/engine/logging/drivers/gelf.md similarity index 98% rename from content/engine/logging/drivers/gelf.md rename to content/manuals/engine/logging/drivers/gelf.md index f5eec31be1..7676fe4f18 100644 --- a/content/engine/logging/drivers/gelf.md +++ b/content/manuals/engine/logging/drivers/gelf.md @@ -26,7 +26,7 @@ To use the `gelf` driver as the default logging driver, set the `log-driver` and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `gelf` and sets the `gelf-address` option. diff --git a/content/engine/logging/drivers/journald.md b/content/manuals/engine/logging/drivers/journald.md similarity index 98% rename from content/engine/logging/drivers/journald.md rename to content/manuals/engine/logging/drivers/journald.md index aaeecbb095..8bd75043a5 100644 --- a/content/engine/logging/drivers/journald.md +++ b/content/manuals/engine/logging/drivers/journald.md @@ -32,7 +32,7 @@ and `log-opts` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `journald`: diff --git a/content/engine/logging/drivers/json-file.md b/content/manuals/engine/logging/drivers/json-file.md similarity index 98% rename from content/engine/logging/drivers/json-file.md rename to content/manuals/engine/logging/drivers/json-file.md index 089a37656d..b275f61886 100644 --- a/content/engine/logging/drivers/json-file.md +++ b/content/manuals/engine/logging/drivers/json-file.md @@ -35,7 +35,7 @@ and `log-opts` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\` on Windows Server. If the file does not exist, create it first. For more information about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `json-file` and sets the `max-size` and `max-file` options to enable automatic log-rotation. diff --git a/content/engine/logging/drivers/local.md b/content/manuals/engine/logging/drivers/local.md similarity index 97% rename from content/engine/logging/drivers/local.md rename to content/manuals/engine/logging/drivers/local.md index a3a86b22e7..ba3292d4a8 100644 --- a/content/engine/logging/drivers/local.md +++ b/content/manuals/engine/logging/drivers/local.md @@ -30,7 +30,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `local` and sets the `max-size` option. diff --git a/content/engine/logging/drivers/splunk.md b/content/manuals/engine/logging/drivers/splunk.md similarity index 99% rename from content/engine/logging/drivers/splunk.md rename to content/manuals/engine/logging/drivers/splunk.md index c9e1e7e766..97373d1198 100644 --- a/content/engine/logging/drivers/splunk.md +++ b/content/manuals/engine/logging/drivers/splunk.md @@ -35,7 +35,7 @@ configuration file and restart Docker. For example: The daemon.json file is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). > [!NOTE] > diff --git a/content/engine/logging/drivers/syslog.md b/content/manuals/engine/logging/drivers/syslog.md similarity index 99% rename from content/engine/logging/drivers/syslog.md rename to content/manuals/engine/logging/drivers/syslog.md index 803ca29b4e..2cabe82bcd 100644 --- a/content/engine/logging/drivers/syslog.md +++ b/content/manuals/engine/logging/drivers/syslog.md @@ -39,7 +39,7 @@ and `log-opt` keys to appropriate values in the `daemon.json` file, which is located in `/etc/docker/` on Linux hosts or `C:\ProgramData\docker\config\daemon.json` on Windows Server. For more about configuring Docker using `daemon.json`, see -[daemon.json](../../../reference/cli/dockerd.md#daemon-configuration-file). +[daemon.json](/reference/cli/dockerd.md#daemon-configuration-file). The following example sets the log driver to `syslog` and sets the `syslog-address` option. The `syslog-address` options supports both UDP and TCP; diff --git a/content/engine/logging/dual-logging.md b/content/manuals/engine/logging/dual-logging.md similarity index 100% rename from content/engine/logging/dual-logging.md rename to content/manuals/engine/logging/dual-logging.md diff --git a/content/engine/logging/log_tags.md b/content/manuals/engine/logging/log_tags.md similarity index 100% rename from content/engine/logging/log_tags.md rename to content/manuals/engine/logging/log_tags.md diff --git a/content/engine/logging/plugins.md b/content/manuals/engine/logging/plugins.md similarity index 96% rename from content/engine/logging/plugins.md rename to content/manuals/engine/logging/plugins.md index ee975c6036..59a99ea051 100644 --- a/content/engine/logging/plugins.md +++ b/content/manuals/engine/logging/plugins.md @@ -11,7 +11,7 @@ aliases: Docker logging plugins allow you to extend and customize Docker's logging capabilities beyond those of the [built-in logging drivers](configure.md). A logging service provider can -[implement their own plugins](../../../engine/extend/plugins_logging.md) and make them +[implement their own plugins](/manuals/engine/extend/plugins_logging.md) and make them available on Docker Hub, or a private registry. This topic shows how a user of that logging service can configure Docker to use the plugin. diff --git a/content/manuals/engine/manage-resources/_index.md b/content/manuals/engine/manage-resources/_index.md new file mode 100644 index 0000000000..19e42e086e --- /dev/null +++ b/content/manuals/engine/manage-resources/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Manage resources +weight: 60 +--- diff --git a/content/engine/manage-resources/contexts.md b/content/manuals/engine/manage-resources/contexts.md similarity index 100% rename from content/engine/manage-resources/contexts.md rename to content/manuals/engine/manage-resources/contexts.md diff --git a/content/engine/manage-resources/labels.md b/content/manuals/engine/manage-resources/labels.md similarity index 100% rename from content/engine/manage-resources/labels.md rename to content/manuals/engine/manage-resources/labels.md diff --git a/content/engine/manage-resources/pruning.md b/content/manuals/engine/manage-resources/pruning.md similarity index 100% rename from content/engine/manage-resources/pruning.md rename to content/manuals/engine/manage-resources/pruning.md diff --git a/content/engine/network/_index.md b/content/manuals/engine/network/_index.md similarity index 99% rename from content/engine/network/_index.md rename to content/manuals/engine/network/_index.md index 487947d59f..0ffc841b59 100644 --- a/content/engine/network/_index.md +++ b/content/manuals/engine/network/_index.md @@ -1,5 +1,7 @@ --- title: Networking overview +linkTitle: Networking +weight: 30 description: Learn how networking works from the container's point of view keywords: networking, container, standalone, IP address, DNS resolution aliases: @@ -194,4 +196,4 @@ container hosts file](/reference/cli/docker/container/run.md#add-host) in the ## Proxy server If your container needs to use a proxy server, see -[Use a proxy server](/engine/daemon/proxy.md). +[Use a proxy server](/manuals/engine/daemon/proxy.md). diff --git a/content/engine/network/drivers/_index.md b/content/manuals/engine/network/drivers/_index.md similarity index 90% rename from content/engine/network/drivers/_index.md rename to content/manuals/engine/network/drivers/_index.md index 5318ca402b..7177011634 100644 --- a/content/engine/network/drivers/_index.md +++ b/content/manuals/engine/network/drivers/_index.md @@ -1,5 +1,6 @@ --- -title: Network drivers overview +title: Network drivers +weight: 20 description: Learn the basics of Docker network drivers keywords: networking, drivers, bridge, routing, routing mesh, overlay, ports --- @@ -70,7 +71,7 @@ exist by default, and provide core networking functionality: Now that you understand the basics about Docker networks, deepen your understanding using the following tutorials: -- [Standalone networking tutorial](/engine/network/tutorials/standalone.md) -- [Host networking tutorial](/engine/network/tutorials/host.md) -- [Overlay networking tutorial](/engine/network/tutorials/overlay.md) -- [Macvlan networking tutorial](/engine/network/tutorials/macvlan.md) +- [Standalone networking tutorial](/manuals/engine/network/tutorials/standalone.md) +- [Host networking tutorial](/manuals/engine/network/tutorials/host.md) +- [Overlay networking tutorial](/manuals/engine/network/tutorials/overlay.md) +- [Macvlan networking tutorial](/manuals/engine/network/tutorials/macvlan.md) diff --git a/content/engine/network/drivers/bridge.md b/content/manuals/engine/network/drivers/bridge.md similarity index 98% rename from content/engine/network/drivers/bridge.md rename to content/manuals/engine/network/drivers/bridge.md index 8bdac7aaeb..03d3c40220 100644 --- a/content/engine/network/drivers/bridge.md +++ b/content/manuals/engine/network/drivers/bridge.md @@ -92,8 +92,8 @@ network.** compose file can define the shared variables. - You can use swarm services instead of standalone containers, and take - advantage of shared [secrets](/engine/swarm/secrets.md) and - [configs](/engine/swarm/configs.md). + advantage of shared [secrets](/manuals/engine/swarm/secrets.md) and + [configs](/manuals/engine/swarm/configs.md). Containers connected to the same user-defined bridge network effectively expose all ports to each other. For a port to be accessible to containers or non-Docker hosts on @@ -312,7 +312,7 @@ configured the IP address for the bridge. ## Next steps -- Go through the [standalone networking tutorial](/engine/network/tutorials/standalone.md) +- Go through the [standalone networking tutorial](/manuals/engine/network/tutorials/standalone.md) - Learn about [networking from the container's point of view](../_index.md) - Learn about [overlay networks](./overlay.md) - Learn about [Macvlan networks](./macvlan.md) diff --git a/content/engine/network/drivers/host.md b/content/manuals/engine/network/drivers/host.md similarity index 97% rename from content/engine/network/drivers/host.md rename to content/manuals/engine/network/drivers/host.md index 82d8376d6d..704fe5f095 100644 --- a/content/engine/network/drivers/host.md +++ b/content/manuals/engine/network/drivers/host.md @@ -105,7 +105,7 @@ network contradict each other. ## Next steps -- Go through the [host networking tutorial](/engine/network/tutorials/host.md) +- Go through the [host networking tutorial](/manuals/engine/network/tutorials/host.md) - Learn about [networking from the container's point of view](../_index.md) - Learn about [bridge networks](./bridge.md) - Learn about [overlay networks](./overlay.md) diff --git a/content/engine/network/drivers/images/ipvlan-l3.gliffy b/content/manuals/engine/network/drivers/images/ipvlan-l3.gliffy similarity index 100% rename from content/engine/network/drivers/images/ipvlan-l3.gliffy rename to content/manuals/engine/network/drivers/images/ipvlan-l3.gliffy diff --git a/content/engine/network/drivers/images/ipvlan-l3.webp b/content/manuals/engine/network/drivers/images/ipvlan-l3.webp similarity index 100% rename from content/engine/network/drivers/images/ipvlan-l3.webp rename to content/manuals/engine/network/drivers/images/ipvlan-l3.webp diff --git a/content/engine/network/drivers/images/ipvlan_l2_simple.gliffy b/content/manuals/engine/network/drivers/images/ipvlan_l2_simple.gliffy similarity index 100% rename from content/engine/network/drivers/images/ipvlan_l2_simple.gliffy rename to content/manuals/engine/network/drivers/images/ipvlan_l2_simple.gliffy diff --git a/content/engine/network/drivers/images/ipvlan_l2_simple.png b/content/manuals/engine/network/drivers/images/ipvlan_l2_simple.png similarity index 100% rename from content/engine/network/drivers/images/ipvlan_l2_simple.png rename to content/manuals/engine/network/drivers/images/ipvlan_l2_simple.png diff --git a/content/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.gliffy b/content/manuals/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.gliffy similarity index 100% rename from content/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.gliffy rename to content/manuals/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.gliffy diff --git a/content/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.webp b/content/manuals/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.webp similarity index 100% rename from content/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.webp rename to content/manuals/engine/network/drivers/images/macvlan-bridge-ipvlan-l2.webp diff --git a/content/engine/network/drivers/images/vlans-deeper-look.gliffy b/content/manuals/engine/network/drivers/images/vlans-deeper-look.gliffy similarity index 100% rename from content/engine/network/drivers/images/vlans-deeper-look.gliffy rename to content/manuals/engine/network/drivers/images/vlans-deeper-look.gliffy diff --git a/content/engine/network/drivers/images/vlans-deeper-look.webp b/content/manuals/engine/network/drivers/images/vlans-deeper-look.webp similarity index 100% rename from content/engine/network/drivers/images/vlans-deeper-look.webp rename to content/manuals/engine/network/drivers/images/vlans-deeper-look.webp diff --git a/content/engine/network/drivers/ipvlan.md b/content/manuals/engine/network/drivers/ipvlan.md similarity index 99% rename from content/engine/network/drivers/ipvlan.md rename to content/manuals/engine/network/drivers/ipvlan.md index ac604ba972..f33e779d9f 100644 --- a/content/engine/network/drivers/ipvlan.md +++ b/content/manuals/engine/network/drivers/ipvlan.md @@ -12,7 +12,7 @@ The IPvlan driver gives users total control over both IPv4 and IPv6 addressing. The VLAN driver builds on top of that in giving operators complete control of layer 2 VLAN tagging and even IPvlan L3 routing for users interested in underlay network integration. For overlay deployments that abstract away physical constraints -see the [multi-host overlay](/engine/network/tutorials/overlay.md) driver. +see the [multi-host overlay](/manuals/engine/network/tutorials/overlay.md) driver. IPvlan is a new twist on the tried and true network virtualization technique. The Linux implementations are extremely lightweight because rather than using diff --git a/content/engine/network/drivers/macvlan.md b/content/manuals/engine/network/drivers/macvlan.md similarity index 96% rename from content/engine/network/drivers/macvlan.md rename to content/manuals/engine/network/drivers/macvlan.md index 7d0023e69f..3817c01137 100644 --- a/content/engine/network/drivers/macvlan.md +++ b/content/manuals/engine/network/drivers/macvlan.md @@ -108,7 +108,7 @@ $ docker network create -d ipvlan \ ## Use IPv6 -If you have [configured the Docker daemon to allow IPv6](/engine/daemon/ipv6.md), +If you have [configured the Docker daemon to allow IPv6](/manuals/engine/daemon/ipv6.md), you can use dual-stack IPv4/IPv6 `macvlan` networks. ```console @@ -123,4 +123,4 @@ $ docker network create -d macvlan \ ## Next steps Learn how to use the Macvlan driver in the -[Macvlan networking tutorial](/engine/network/tutorials/macvlan.md). +[Macvlan networking tutorial](/manuals/engine/network/tutorials/macvlan.md). diff --git a/content/engine/network/drivers/none.md b/content/manuals/engine/network/drivers/none.md similarity index 93% rename from content/engine/network/drivers/none.md rename to content/manuals/engine/network/drivers/none.md index 65d058cecb..9a42ca3cb3 100644 --- a/content/engine/network/drivers/none.md +++ b/content/manuals/engine/network/drivers/none.md @@ -32,7 +32,7 @@ $ docker run --rm --network none --name no-net-alpine alpine:latest ip addr show ## Next steps -- Go through the [host networking tutorial](/engine/network/tutorials/host.md) +- Go through the [host networking tutorial](/manuals/engine/network/tutorials/host.md) - Learn about [networking from the container's point of view](../_index.md) - Learn about [bridge networks](bridge.md) - Learn about [overlay networks](overlay.md) diff --git a/content/engine/network/drivers/overlay.md b/content/manuals/engine/network/drivers/overlay.md similarity index 97% rename from content/engine/network/drivers/overlay.md rename to content/manuals/engine/network/drivers/overlay.md index ccbaeef540..043e2ddc3e 100644 --- a/content/engine/network/drivers/overlay.md +++ b/content/manuals/engine/network/drivers/overlay.md @@ -27,7 +27,7 @@ Swarm mode to establish a connection between the hosts. This page describes overlay networks in general, and when used with standalone containers. For information about overlay for Swarm services, see -[Manage Swarm service networks](/engine/swarm/networking.md). +[Manage Swarm service networks](/manuals/engine/swarm/networking.md). ## Create an overlay network @@ -124,7 +124,7 @@ For more information about this limitation, see ## Next steps -- Go through the [overlay networking tutorial](/engine/network/tutorials/overlay.md) +- Go through the [overlay networking tutorial](/manuals/engine/network/tutorials/overlay.md) - Learn about [networking from the container's point of view](../_index.md) - Learn about [standalone bridge networks](bridge.md) - Learn about [Macvlan networks](macvlan.md) diff --git a/content/engine/network/links.md b/content/manuals/engine/network/links.md similarity index 100% rename from content/engine/network/links.md rename to content/manuals/engine/network/links.md diff --git a/content/engine/network/packet-filtering-firewalls.md b/content/manuals/engine/network/packet-filtering-firewalls.md similarity index 99% rename from content/engine/network/packet-filtering-firewalls.md rename to content/manuals/engine/network/packet-filtering-firewalls.md index 63bcbc4071..b770419658 100644 --- a/content/engine/network/packet-filtering-firewalls.md +++ b/content/manuals/engine/network/packet-filtering-firewalls.md @@ -1,5 +1,6 @@ --- title: Packet filtering and firewalls +weight: 10 description: How Docker works with packet filtering, iptables, and firewalls keywords: network, iptables, firewall aliases: diff --git a/content/manuals/engine/network/tutorials/_index.md b/content/manuals/engine/network/tutorials/_index.md new file mode 100644 index 0000000000..9b3fccaf42 --- /dev/null +++ b/content/manuals/engine/network/tutorials/_index.md @@ -0,0 +1,6 @@ +--- +build: + render: never +title: Tutorials +weight: 30 +--- diff --git a/content/engine/network/tutorials/host.md b/content/manuals/engine/network/tutorials/host.md similarity index 85% rename from content/engine/network/tutorials/host.md rename to content/manuals/engine/network/tutorials/host.md index ef2111045a..3c8548aeca 100644 --- a/content/engine/network/tutorials/host.md +++ b/content/manuals/engine/network/tutorials/host.md @@ -8,7 +8,7 @@ aliases: This series of tutorials deals with networking standalone containers which bind directly to the Docker host's network, with no network isolation. For other -networking topics, see the [overview](/engine/network/_index.md). +networking topics, see the [overview](/manuals/engine/network/_index.md). ## Goal @@ -26,7 +26,7 @@ host. [documentation for the `nginx` image](https://hub.docker.com/_/nginx/) - The `host` networking driver only works on Linux hosts, but is available as a - [beta feature](/release-lifecycle.md#beta) on Docker Desktop version 4.29 + [beta feature](/manuals/release-lifecycle.md#beta) on Docker Desktop version 4.29 and later for Mac, Windows, and Linux. To enable this feature, navigate to the **Features in development** tab in **Settings**, and then select **Enable host networking**. @@ -65,6 +65,6 @@ host. ## Other networking tutorials -- [Standalone networking tutorial](/engine/network/tutorials/standalone.md) -- [Overlay networking tutorial](/engine/network/tutorials/overlay.md) -- [Macvlan networking tutorial](/engine/network/tutorials/macvlan.md) +- [Standalone networking tutorial](/manuals/engine/network/tutorials/standalone.md) +- [Overlay networking tutorial](/manuals/engine/network/tutorials/overlay.md) +- [Macvlan networking tutorial](/manuals/engine/network/tutorials/macvlan.md) diff --git a/content/engine/network/tutorials/macvlan.md b/content/manuals/engine/network/tutorials/macvlan.md similarity index 96% rename from content/engine/network/tutorials/macvlan.md rename to content/manuals/engine/network/tutorials/macvlan.md index d8c0f7a9a3..9b8bdf6280 100644 --- a/content/engine/network/tutorials/macvlan.md +++ b/content/manuals/engine/network/tutorials/macvlan.md @@ -11,7 +11,7 @@ This series of tutorials deals with networking standalone containers which connect to `macvlan` networks. In this type of network, the Docker host accepts requests for multiple MAC addresses at its IP address, and routes those requests to the appropriate container. For other networking topics, see the -[overview](/engine/network/_index.md). +[overview](/manuals/engine/network/_index.md). ## Goal @@ -220,6 +220,6 @@ be physically attached to the network. ## Other networking tutorials -- [Standalone networking tutorial](/engine/network/tutorials/standalone.md) -- [Overlay networking tutorial](/engine/network/tutorials/overlay.md) -- [Host networking tutorial](/engine/network/tutorials/host.md) +- [Standalone networking tutorial](/manuals/engine/network/tutorials/standalone.md) +- [Overlay networking tutorial](/manuals/engine/network/tutorials/overlay.md) +- [Host networking tutorial](/manuals/engine/network/tutorials/host.md) diff --git a/content/engine/network/tutorials/overlay.md b/content/manuals/engine/network/tutorials/overlay.md similarity index 97% rename from content/engine/network/tutorials/overlay.md rename to content/manuals/engine/network/tutorials/overlay.md index 1a4bed7b88..0fbcc7d2ae 100644 --- a/content/engine/network/tutorials/overlay.md +++ b/content/manuals/engine/network/tutorials/overlay.md @@ -10,8 +10,8 @@ aliases: This series of tutorials deals with networking for swarm services. For networking with standalone containers, see -[Networking with standalone containers](/engine/network/tutorials/standalone.md). If you need to -learn more about Docker networking in general, see the [overview](/engine/network/_index.md). +[Networking with standalone containers](/manuals/engine/network/tutorials/standalone.md). If you need to +learn more about Docker networking in general, see the [overview](/manuals/engine/network/_index.md). This page includes the following tutorials. You can run each of them on Linux, Windows, or a Mac, but for the last one, you need a second Docker @@ -60,7 +60,7 @@ If you don't have three hosts handy, an easy solution is to set up three Ubuntu hosts on a cloud provider such as Amazon EC2, all on the same network with all communications allowed to all hosts on that network (using a mechanism such as EC2 security groups), and then to follow the -[installation instructions for Docker Engine - Community on Ubuntu](/engine/install/ubuntu.md). +[installation instructions for Docker Engine - Community on Ubuntu](/manuals/engine/install/ubuntu.md). ### Walkthrough @@ -437,6 +437,6 @@ example also uses Linux hosts, but the same commands work on Windows. ## Other networking tutorials -- [Host networking tutorial](/engine/network/tutorials/host.md) -- [Standalone networking tutorial](/engine/network/tutorials/standalone.md) -- [Macvlan networking tutorial](/engine/network/tutorials/macvlan.md) +- [Host networking tutorial](/manuals/engine/network/tutorials/host.md) +- [Standalone networking tutorial](/manuals/engine/network/tutorials/standalone.md) +- [Macvlan networking tutorial](/manuals/engine/network/tutorials/macvlan.md) diff --git a/content/engine/network/tutorials/standalone.md b/content/manuals/engine/network/tutorials/standalone.md similarity index 97% rename from content/engine/network/tutorials/standalone.md rename to content/manuals/engine/network/tutorials/standalone.md index c9eeb3cdb9..f9ee9490bc 100644 --- a/content/engine/network/tutorials/standalone.md +++ b/content/manuals/engine/network/tutorials/standalone.md @@ -8,7 +8,7 @@ aliases: This series of tutorials deals with networking for standalone Docker containers. For networking with swarm services, see -[Networking with swarm services](/engine/network/tutorials/overlay.md). If you need to +[Networking with swarm services](/manuals/engine/network/tutorials/overlay.md). If you need to learn more about Docker networking in general, see the [overview](_index.md). This topic includes two different tutorials. You can run each of them on @@ -24,9 +24,9 @@ host running elsewhere. running on the same Docker host. This is recommended for standalone containers running in production. -Although [overlay networks](/engine/network/drivers/overlay.md) are generally used for swarm services, +Although [overlay networks](/manuals/engine/network/drivers/overlay.md) are generally used for swarm services, you can also use an overlay network for standalone containers. That's covered as -part of the [tutorial on using overlay networks](/engine/network/tutorials/overlay.md#use-an-overlay-network-for-standalone-containers). +part of the [tutorial on using overlay networks](/manuals/engine/network/tutorials/overlay.md#use-an-overlay-network-for-standalone-containers). ## Use the default bridge network @@ -617,6 +617,6 @@ connected to both networks. ## Other networking tutorials -- [Host networking tutorial](/engine/network/tutorials/host.md) -- [Overlay networking tutorial](/engine/network/tutorials/overlay.md) -- [Macvlan networking tutorial](/engine/network/tutorials/macvlan.md) +- [Host networking tutorial](/manuals/engine/network/tutorials/host.md) +- [Overlay networking tutorial](/manuals/engine/network/tutorials/overlay.md) +- [Macvlan networking tutorial](/manuals/engine/network/tutorials/macvlan.md) diff --git a/content/engine/release-notes/17.03.md b/content/manuals/engine/release-notes/17.03.md similarity index 100% rename from content/engine/release-notes/17.03.md rename to content/manuals/engine/release-notes/17.03.md diff --git a/content/engine/release-notes/17.04.md b/content/manuals/engine/release-notes/17.04.md similarity index 100% rename from content/engine/release-notes/17.04.md rename to content/manuals/engine/release-notes/17.04.md diff --git a/content/engine/release-notes/17.05.md b/content/manuals/engine/release-notes/17.05.md similarity index 100% rename from content/engine/release-notes/17.05.md rename to content/manuals/engine/release-notes/17.05.md diff --git a/content/engine/release-notes/17.06.md b/content/manuals/engine/release-notes/17.06.md similarity index 100% rename from content/engine/release-notes/17.06.md rename to content/manuals/engine/release-notes/17.06.md diff --git a/content/engine/release-notes/17.07.md b/content/manuals/engine/release-notes/17.07.md similarity index 100% rename from content/engine/release-notes/17.07.md rename to content/manuals/engine/release-notes/17.07.md diff --git a/content/engine/release-notes/17.09.md b/content/manuals/engine/release-notes/17.09.md similarity index 100% rename from content/engine/release-notes/17.09.md rename to content/manuals/engine/release-notes/17.09.md diff --git a/content/engine/release-notes/17.10.md b/content/manuals/engine/release-notes/17.10.md similarity index 100% rename from content/engine/release-notes/17.10.md rename to content/manuals/engine/release-notes/17.10.md diff --git a/content/engine/release-notes/17.11.md b/content/manuals/engine/release-notes/17.11.md similarity index 88% rename from content/engine/release-notes/17.11.md rename to content/manuals/engine/release-notes/17.11.md index 9248dc5359..3d057ab5af 100644 --- a/content/engine/release-notes/17.11.md +++ b/content/manuals/engine/release-notes/17.11.md @@ -7,15 +7,14 @@ toc_max: 2 ## 17.11.0-ce 2017-11-20 -> [!IMPORTANT]: Docker CE 17.11 is the first Docker release based on -[containerd 1.0 beta](https://github.com/containerd/containerd/releases/tag/v1.0.0-beta.2). -Docker CE 17.11 and later don't recognize containers started with -previous Docker versions. If using -[Live Restore](/engine/containers/live-restore.md), -you must stop all containers before upgrading to Docker CE 17.11. -If you don't, any containers started by Docker versions that predate -17.11 aren't recognized by Docker after the upgrade and keep -running, un-managed, on the system. +> [!IMPORTANT] +> Docker CE 17.11 is the first Docker release based on +> [containerd 1.0 beta](https://github.com/containerd/containerd/releases/tag/v1.0.0-beta.2). +> Docker CE 17.11 and later don't recognize containers started with previous +> Docker versions. If you use Live Restore, you must stop all containers before +> upgrading to Docker CE 17.11. If you don't, any containers started by Docker +> versions that predate 17.11 aren't recognized by Docker after the upgrade and +> keep running, un-managed, on the system. ### Builder diff --git a/content/engine/release-notes/17.12.md b/content/manuals/engine/release-notes/17.12.md similarity index 100% rename from content/engine/release-notes/17.12.md rename to content/manuals/engine/release-notes/17.12.md diff --git a/content/engine/release-notes/18.01.md b/content/manuals/engine/release-notes/18.01.md similarity index 100% rename from content/engine/release-notes/18.01.md rename to content/manuals/engine/release-notes/18.01.md diff --git a/content/engine/release-notes/18.02.md b/content/manuals/engine/release-notes/18.02.md similarity index 100% rename from content/engine/release-notes/18.02.md rename to content/manuals/engine/release-notes/18.02.md diff --git a/content/engine/release-notes/18.03.md b/content/manuals/engine/release-notes/18.03.md similarity index 100% rename from content/engine/release-notes/18.03.md rename to content/manuals/engine/release-notes/18.03.md diff --git a/content/engine/release-notes/18.04.md b/content/manuals/engine/release-notes/18.04.md similarity index 100% rename from content/engine/release-notes/18.04.md rename to content/manuals/engine/release-notes/18.04.md diff --git a/content/engine/release-notes/18.05.md b/content/manuals/engine/release-notes/18.05.md similarity index 100% rename from content/engine/release-notes/18.05.md rename to content/manuals/engine/release-notes/18.05.md diff --git a/content/engine/release-notes/18.06.md b/content/manuals/engine/release-notes/18.06.md similarity index 99% rename from content/engine/release-notes/18.06.md rename to content/manuals/engine/release-notes/18.06.md index 49611cc410..78d3990212 100644 --- a/content/engine/release-notes/18.06.md +++ b/content/manuals/engine/release-notes/18.06.md @@ -184,7 +184,7 @@ toc_max: 2 * Set item-type for ExecIDs. [moby/moby#37121](https://github.com/moby/moby/pull/37121) * Use go-systemd const instead of magic string in Linux version of dockerd. [moby/moby#37136](https://github.com/moby/moby/pull/37136) * Use stdlib TLS dialer. [moby/moby#36687](https://github.com/moby/moby/pull/36687) -* Warn when an engine label using a reserved namespace (com.docker.\*, io.docker.\*, or org.dockerproject.\*) is configured, as per [Docker object labels](/engine/manage-resources/labels.md). [moby/moby#36921](https://github.com/moby/moby/pull/36921) +* Warn when an engine label using a reserved namespace (com.docker.\*, io.docker.\*, or org.dockerproject.\*) is configured, as per [Docker object labels](/manuals/engine/manage-resources/labels.md). [moby/moby#36921](https://github.com/moby/moby/pull/36921) - Fix missing plugin name in message. [moby/moby#37052](https://github.com/moby/moby/pull/37052) - Fix link anchors in CONTRIBUTING.md. [moby/moby#37276](https://github.com/moby/moby/pull/37276) - Fix link to Docker Toolbox. [moby/moby#37240](https://github.com/moby/moby/pull/37240) diff --git a/content/engine/release-notes/18.09.md b/content/manuals/engine/release-notes/18.09.md similarity index 99% rename from content/engine/release-notes/18.09.md rename to content/manuals/engine/release-notes/18.09.md index 994a4078c8..5bb651a77b 100644 --- a/content/engine/release-notes/18.09.md +++ b/content/manuals/engine/release-notes/18.09.md @@ -374,7 +374,7 @@ Update your configuration if this command prints a non-empty value for `MountFla - Docker has deprecated support for Device Mapper as a storage driver. It will continue to be supported at this time, but support will be removed in a future release. - The [Overlay2 storage driver](/engine/storage/drivers/overlayfs-driver.md) is now the default for Docker Engine implementations. + The [Overlay2 storage driver](/manuals/engine/storage/drivers/overlayfs-driver.md) is now the default for Docker Engine implementations. For more information on the list of deprecated flags and APIs, have a look at the [deprecation information](/engine/deprecated/) where you can find the target removal dates. diff --git a/content/engine/release-notes/19.03.md b/content/manuals/engine/release-notes/19.03.md similarity index 100% rename from content/engine/release-notes/19.03.md rename to content/manuals/engine/release-notes/19.03.md diff --git a/content/engine/release-notes/20.10.md b/content/manuals/engine/release-notes/20.10.md similarity index 99% rename from content/engine/release-notes/20.10.md rename to content/manuals/engine/release-notes/20.10.md index 7895aad5e3..bf45f736aa 100644 --- a/content/engine/release-notes/20.10.md +++ b/content/manuals/engine/release-notes/20.10.md @@ -405,7 +405,7 @@ to learn how to use the `docker scan` command to check if images are vulnerable. > longer used for TLS (`https://`) connections. Make sure you also set an `$HTTPS_PROXY` > environment variable for handling requests to `https://` URLs. > -> Refer to [Configure the daemon to use a proxy](/engine/daemon/proxy.md) +> Refer to [Configure the daemon to use a proxy](/manuals/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. @@ -434,7 +434,7 @@ to learn how to use the `docker scan` command to check if images are vulnerable. > longer used for TLS (`https://`) connections. Make sure you also set an `$HTTPS_PROXY` > environment variable for handling requests to `https://` URLs. > -> Refer to the [HTTP/HTTPS proxy section](/engine/daemon/proxy.md) +> Refer to the [HTTP/HTTPS proxy section](/manuals/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. @@ -474,7 +474,7 @@ well as updated versions of the containerd.io package. > longer used for TLS (`https://`) connections. Make sure you also set an `$HTTPS_PROXY` > environment variable for handling requests to `https://` URLs. > -> Refer to the [HTTP/HTTPS proxy section](/engine/daemon/proxy.md) +> Refer to the [HTTP/HTTPS proxy section](/manuals/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. ### Client @@ -518,7 +518,7 @@ well as updated versions of the containerd.io package. > longer used for TLS (`https://`) connections. Make sure you also set an `$HTTPS_PROXY` > environment variable for handling requests to `https://` URLs. > -> Refer to the [HTTP/HTTPS proxy section](/engine/daemon/proxy.md) +> Refer to the [HTTP/HTTPS proxy section](/manuals/engine/daemon/proxy.md) > to learn how to configure the Docker Daemon to use a proxy server. ### Deprecation diff --git a/content/engine/release-notes/23.0.md b/content/manuals/engine/release-notes/23.0.md similarity index 99% rename from content/engine/release-notes/23.0.md rename to content/manuals/engine/release-notes/23.0.md index 4c339e84b2..7bea92c6dd 100644 --- a/content/engine/release-notes/23.0.md +++ b/content/manuals/engine/release-notes/23.0.md @@ -215,7 +215,7 @@ For a full list of pull requests and changes in this release, refer to the relev - Alias `docker build` to `docker buildx build`. [docker/cli#3314](https://github.com/docker/cli/pull/3314) - The legacy builder can still be used by explicitly setting `DOCKER_BUILDKIT=0`. - There are differences in how BuildKit and the legacy builder handle multi-stage builds. For more information, see - [Multi-stage builds](../../build/building/multi-stage.md#differences-between-legacy-builder-and-buildkit). + [Multi-stage builds](/manuals/build/building/multi-stage.md#differences-between-legacy-builder-and-buildkit). - Add support for pulling `zstd` compressed layers. [moby/moby#41759](https://github.com/moby/moby/pull/41759), [moby/moby#42862](https://github.com/moby/moby/pull/42862) - Add support for alternate OCI runtimes on Linux, compatible with the containerd runtime v2 API. [moby/moby#43887](https://github.com/moby/moby/pull/43887), [moby/moby#43993](https://github.com/moby/moby/pull/43993) - Add support for the containerd `runhcs` shim on Windows (off by default). [moby/moby#42089](https://github.com/moby/moby/pull/42089) @@ -468,7 +468,7 @@ To mitigate this, the previous build cache must be discarded. `docker builder pr #### ipvlan networks ([tracking issue](https://github.com/moby/moby/issues/44925)) -When upgrading to the 23.0 branch, the existence of any [ipvlan](/engine/network/drivers/ipvlan.md) networks will prevent the daemon from starting: +When upgrading to the 23.0 branch, the existence of any [ipvlan](/manuals/engine/network/drivers/ipvlan.md) networks will prevent the daemon from starting: ``` panic: interface conversion: interface {} is nil, not string diff --git a/content/engine/release-notes/24.0.md b/content/manuals/engine/release-notes/24.0.md similarity index 100% rename from content/engine/release-notes/24.0.md rename to content/manuals/engine/release-notes/24.0.md diff --git a/content/engine/release-notes/25.0.md b/content/manuals/engine/release-notes/25.0.md similarity index 99% rename from content/engine/release-notes/25.0.md rename to content/manuals/engine/release-notes/25.0.md index 1d6a2b8bd1..2c745eb5e2 100644 --- a/content/engine/release-notes/25.0.md +++ b/content/manuals/engine/release-notes/25.0.md @@ -200,7 +200,7 @@ For a full list of pull requests and changes in this release, refer to the relev > > This option isn't supported with the `-v` or `--volume` flag. > For more information, see -> [Recursive mounts](/engine/storage/bind-mounts.md#recursive-mounts). +> [Recursive mounts](/manuals/engine/storage/bind-mounts.md#recursive-mounts). ### New diff --git a/content/engine/release-notes/26.0.md b/content/manuals/engine/release-notes/26.0.md similarity index 100% rename from content/engine/release-notes/26.0.md rename to content/manuals/engine/release-notes/26.0.md diff --git a/content/engine/release-notes/26.1.md b/content/manuals/engine/release-notes/26.1.md similarity index 100% rename from content/engine/release-notes/26.1.md rename to content/manuals/engine/release-notes/26.1.md diff --git a/content/engine/release-notes/27.md b/content/manuals/engine/release-notes/27.md similarity index 100% rename from content/engine/release-notes/27.md rename to content/manuals/engine/release-notes/27.md diff --git a/content/manuals/engine/release-notes/_index.md b/content/manuals/engine/release-notes/_index.md new file mode 100644 index 0000000000..e49434db68 --- /dev/null +++ b/content/manuals/engine/release-notes/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: Release notes +--- diff --git a/content/engine/release-notes/prior-releases.md b/content/manuals/engine/release-notes/prior-releases.md similarity index 100% rename from content/engine/release-notes/prior-releases.md rename to content/manuals/engine/release-notes/prior-releases.md diff --git a/content/engine/security/_index.md b/content/manuals/engine/security/_index.md similarity index 97% rename from content/engine/security/_index.md rename to content/manuals/engine/security/_index.md index 0f4f01dbb4..197ce706d9 100644 --- a/content/engine/security/_index.md +++ b/content/manuals/engine/security/_index.md @@ -1,7 +1,9 @@ --- description: Review of the Docker Daemon attack surface keywords: Docker, Docker documentation, security -title: Docker security +title: Docker Engine security +linkTitle: Security +weight: 80 aliases: - /articles/security/ - /engine/articles/security/ @@ -37,7 +39,7 @@ of another container. Of course, if the host system is setup accordingly, containers can interact with each other through their respective network interfaces — just like they can interact with external hosts. When you specify public ports for your containers or use -[links](/engine/network/links.md) +[links](/manuals/engine/network/links.md) then IP traffic is allowed between containers. They can ping each other, send/receive UDP packets, and establish TCP connections, but that can be restricted if necessary. From a network architecture point of view, all @@ -257,7 +259,7 @@ to a non uid-0 user outside the container, which can help to mitigate the risks of container breakout. This facility is available but not enabled by default. -Refer to the [daemon command](../../reference/cli/dockerd.md#daemon-user-namespace-options) +Refer to the [daemon command](/reference/cli/dockerd.md#daemon-user-namespace-options) in the command line reference for more information on this feature. Additional information on the implementation of User Namespaces in Docker can be found in @@ -280,4 +282,4 @@ pull requests, or comments on the Docker community forums. * [Seccomp security profiles for Docker](seccomp.md) * [AppArmor security profiles for Docker](apparmor.md) * [On the Security of Containers (2014)](https://medium.com/@ewindisch/on-the-security-of-containers-2c60ffe25a9e) -* [Docker swarm mode overlay network security model](/engine/network/drivers/overlay.md) +* [Docker swarm mode overlay network security model](/manuals/engine/network/drivers/overlay.md) diff --git a/content/engine/security/antivirus.md b/content/manuals/engine/security/antivirus.md similarity index 100% rename from content/engine/security/antivirus.md rename to content/manuals/engine/security/antivirus.md diff --git a/content/engine/security/apparmor.md b/content/manuals/engine/security/apparmor.md similarity index 100% rename from content/engine/security/apparmor.md rename to content/manuals/engine/security/apparmor.md diff --git a/content/engine/security/certificates.md b/content/manuals/engine/security/certificates.md similarity index 100% rename from content/engine/security/certificates.md rename to content/manuals/engine/security/certificates.md diff --git a/content/engine/security/https/Dockerfile b/content/manuals/engine/security/https/Dockerfile similarity index 100% rename from content/engine/security/https/Dockerfile rename to content/manuals/engine/security/https/Dockerfile diff --git a/content/engine/security/https/Makefile b/content/manuals/engine/security/https/Makefile similarity index 100% rename from content/engine/security/https/Makefile rename to content/manuals/engine/security/https/Makefile diff --git a/content/engine/security/https/README.md b/content/manuals/engine/security/https/README.md similarity index 100% rename from content/engine/security/https/README.md rename to content/manuals/engine/security/https/README.md diff --git a/content/engine/security/https/make_certs.sh b/content/manuals/engine/security/https/make_certs.sh similarity index 100% rename from content/engine/security/https/make_certs.sh rename to content/manuals/engine/security/https/make_certs.sh diff --git a/content/engine/security/https/parsedocs.sh b/content/manuals/engine/security/https/parsedocs.sh similarity index 100% rename from content/engine/security/https/parsedocs.sh rename to content/manuals/engine/security/https/parsedocs.sh diff --git a/content/engine/security/non-events.md b/content/manuals/engine/security/non-events.md similarity index 100% rename from content/engine/security/non-events.md rename to content/manuals/engine/security/non-events.md diff --git a/content/engine/security/protect-access.md b/content/manuals/engine/security/protect-access.md similarity index 99% rename from content/engine/security/protect-access.md rename to content/manuals/engine/security/protect-access.md index 410abec42c..015897c815 100644 --- a/content/engine/security/protect-access.md +++ b/content/manuals/engine/security/protect-access.md @@ -19,7 +19,7 @@ optionally communicate using SSH or a TLS (HTTPS) socket. > remote machine. Refer to [manage Docker as a non-root user](../install/linux-postinstall.md#manage-docker-as-a-non-root-user) > to learn how to give a non-root user access to the docker socket. -The following example creates a [`docker context`](/engine/manage-resources/contexts.md) +The following example creates a [`docker context`](/manuals/engine/manage-resources/contexts.md) to connect with a remote `dockerd` daemon on `host1.example.com` using SSH, and as the `docker-user` user on the remote machine: diff --git a/content/engine/security/rootless.md b/content/manuals/engine/security/rootless.md similarity index 99% rename from content/engine/security/rootless.md rename to content/manuals/engine/security/rootless.md index 738996e67d..54247d6a26 100644 --- a/content/engine/security/rootless.md +++ b/content/manuals/engine/security/rootless.md @@ -1,7 +1,8 @@ --- description: Run the Docker daemon as a non-root user (Rootless mode) keywords: security, namespaces, rootless -title: Run the Docker daemon as a non-root user (Rootless mode) +title: Rootless mode +weight: 10 --- Rootless mode allows running the Docker daemon and containers as a non-root @@ -379,7 +380,7 @@ Or add `net.ipv4.ip_unprivileged_port_start=0` to `/etc/sysctl.conf` (or Limiting resources with cgroup-related `docker run` flags such as `--cpus`, `--memory`, `--pids-limit` is supported only when running with cgroup v2 and systemd. -See [Changing cgroup version](/engine/containers/runmetrics.md) to enable cgroup v2. +See [Changing cgroup version](/manuals/engine/containers/runmetrics.md) to enable cgroup v2. If `docker info` shows `none` as `Cgroup Driver`, the conditions are not satisfied. When these conditions are not satisfied, rootless mode ignores the cgroup-related `docker run` flags. diff --git a/content/engine/security/seccomp.md b/content/manuals/engine/security/seccomp.md similarity index 100% rename from content/engine/security/seccomp.md rename to content/manuals/engine/security/seccomp.md diff --git a/content/engine/security/trust/_index.md b/content/manuals/engine/security/trust/_index.md similarity index 100% rename from content/engine/security/trust/_index.md rename to content/manuals/engine/security/trust/_index.md diff --git a/content/engine/security/trust/deploying_notary.md b/content/manuals/engine/security/trust/deploying_notary.md similarity index 95% rename from content/engine/security/trust/deploying_notary.md rename to content/manuals/engine/security/trust/deploying_notary.md index 29d496723c..5294b61523 100644 --- a/content/engine/security/trust/deploying_notary.md +++ b/content/manuals/engine/security/trust/deploying_notary.md @@ -4,7 +4,7 @@ keywords: trust, security, notary, deployment title: Deploy Notary Server with Compose --- -The easiest way to deploy Notary Server is by using Docker Compose. To follow the procedure on this page, you must have already [installed Docker Compose](../../../compose/install/index.md). +The easiest way to deploy Notary Server is by using Docker Compose. To follow the procedure on this page, you must have already [installed Docker Compose](/manuals/compose/install/index.md). 1. Clone the Notary repository. diff --git a/content/engine/security/trust/images/tag_signing.png b/content/manuals/engine/security/trust/images/tag_signing.png similarity index 100% rename from content/engine/security/trust/images/tag_signing.png rename to content/manuals/engine/security/trust/images/tag_signing.png diff --git a/content/engine/security/trust/images/trust_.gliffy b/content/manuals/engine/security/trust/images/trust_.gliffy similarity index 100% rename from content/engine/security/trust/images/trust_.gliffy rename to content/manuals/engine/security/trust/images/trust_.gliffy diff --git a/content/engine/security/trust/images/trust_components.gliffy b/content/manuals/engine/security/trust/images/trust_components.gliffy similarity index 100% rename from content/engine/security/trust/images/trust_components.gliffy rename to content/manuals/engine/security/trust/images/trust_components.gliffy diff --git a/content/engine/security/trust/images/trust_components.png b/content/manuals/engine/security/trust/images/trust_components.png similarity index 100% rename from content/engine/security/trust/images/trust_components.png rename to content/manuals/engine/security/trust/images/trust_components.png diff --git a/content/engine/security/trust/images/trust_signing.gliffy b/content/manuals/engine/security/trust/images/trust_signing.gliffy similarity index 100% rename from content/engine/security/trust/images/trust_signing.gliffy rename to content/manuals/engine/security/trust/images/trust_signing.gliffy diff --git a/content/engine/security/trust/images/trust_view.gliffy b/content/manuals/engine/security/trust/images/trust_view.gliffy similarity index 100% rename from content/engine/security/trust/images/trust_view.gliffy rename to content/manuals/engine/security/trust/images/trust_view.gliffy diff --git a/content/engine/security/trust/images/trust_view.png b/content/manuals/engine/security/trust/images/trust_view.png similarity index 100% rename from content/engine/security/trust/images/trust_view.png rename to content/manuals/engine/security/trust/images/trust_view.png diff --git a/content/engine/security/trust/trust_automation.md b/content/manuals/engine/security/trust/trust_automation.md similarity index 100% rename from content/engine/security/trust/trust_automation.md rename to content/manuals/engine/security/trust/trust_automation.md diff --git a/content/engine/security/trust/trust_delegation.md b/content/manuals/engine/security/trust/trust_delegation.md similarity index 100% rename from content/engine/security/trust/trust_delegation.md rename to content/manuals/engine/security/trust/trust_delegation.md diff --git a/content/engine/security/trust/trust_key_mng.md b/content/manuals/engine/security/trust/trust_key_mng.md similarity index 100% rename from content/engine/security/trust/trust_key_mng.md rename to content/manuals/engine/security/trust/trust_key_mng.md diff --git a/content/engine/security/trust/trust_sandbox.md b/content/manuals/engine/security/trust/trust_sandbox.md similarity index 99% rename from content/engine/security/trust/trust_sandbox.md rename to content/manuals/engine/security/trust/trust_sandbox.md index d1e56f93d5..f62a1344f5 100644 --- a/content/engine/security/trust/trust_sandbox.md +++ b/content/manuals/engine/security/trust/trust_sandbox.md @@ -23,7 +23,7 @@ This sandbox requires you to install two Docker tools: Docker Engine >= 1.10.0 and Docker Compose >= 1.6.0. To install the Docker Engine, choose from the [list of supported platforms](../../install/index.md). To install Docker Compose, see the -[detailed instructions here](../../../compose/install/index.md). +[detailed instructions here](/manuals/compose/install/index.md). ## What is in the sandbox? diff --git a/content/engine/security/userns-remap.md b/content/manuals/engine/security/userns-remap.md similarity index 100% rename from content/engine/security/userns-remap.md rename to content/manuals/engine/security/userns-remap.md diff --git a/content/engine/storage/_index.md b/content/manuals/engine/storage/_index.md similarity index 97% rename from content/engine/storage/_index.md rename to content/manuals/engine/storage/_index.md index 151bd6c31d..255d796dbf 100644 --- a/content/engine/storage/_index.md +++ b/content/manuals/engine/storage/_index.md @@ -1,6 +1,7 @@ --- description: Overview of persisting data in containers -title: Manage data in Docker +title: Storage +weight: 20 keywords: storage, persistence, data persistence, volumes, mounts, bind mounts, tmpfs aliases: - /engine/admin/volumes/ @@ -113,7 +114,7 @@ You can't use Docker CLI commands to directly manage bind mounts. > [!TIP] > > Working with large repositories or monorepos, or with virtual file systems that are no longer scaling with your codebase? -> Check out [Synchronized file shares](/desktop/synchronized-file-sharing.md). It provides fast and flexible host-to-VM file sharing by enhancing bind mount performance through the use of synchronized filesystem caches. +> Check out [Synchronized file shares](/manuals/desktop/synchronized-file-sharing.md). It provides fast and flexible host-to-VM file sharing by enhancing bind mount performance through the use of synchronized filesystem caches. ### tmpfs @@ -121,7 +122,7 @@ A `tmpfs` mount isn't persisted on disk, either on the Docker host or within a container. It can be used by a container during the lifetime of the container, to store non-persistent state or sensitive information. For instance, internally, Swarm services use `tmpfs` mounts to mount -[secrets](/engine/swarm/secrets.md) into a service's containers. +[secrets](/manuals/engine/swarm/secrets.md) into a service's containers. ### Named pipes diff --git a/content/engine/storage/bind-mounts.md b/content/manuals/engine/storage/bind-mounts.md similarity index 97% rename from content/engine/storage/bind-mounts.md rename to content/manuals/engine/storage/bind-mounts.md index 5db714e75d..8681bada27 100644 --- a/content/engine/storage/bind-mounts.md +++ b/content/manuals/engine/storage/bind-mounts.md @@ -1,6 +1,7 @@ --- description: Using bind mounts title: Bind mounts +weight: 20 keywords: storage, persistence, data persistence, mounts, bind mounts aliases: - /engine/admin/volumes/bind-mounts/ @@ -27,7 +28,7 @@ manage bind mounts. > [!TIP] > > Working with large repositories or monorepos, or with virtual file systems that are no longer scaling with your codebase? -> Check out [Synchronized file shares](/desktop/synchronized-file-sharing.md). It provides fast and flexible host-to-VM file sharing by enhancing bind mount performance through the use of synchronized filesystem caches. +> Check out [Synchronized file shares](/manuals/desktop/synchronized-file-sharing.md). It provides fast and flexible host-to-VM file sharing by enhancing bind mount performance through the use of synchronized filesystem caches. ## Choose the -v or --mount flag @@ -99,7 +100,7 @@ on your development host. Use the following command to bind-mount the `target/` directory into your container at `/app/`. Run the command from within the `source` directory. The `$(pwd)` sub-command expands to the current working directory on Linux or macOS hosts. -If you're on Windows, see also [Path conversions on Windows](/desktop/troubleshoot/topics.md). +If you're on Windows, see also [Path conversions on Windows](/manuals/desktop/troubleshoot/topics.md). The `--mount` and `-v` examples below produce the same result. You can't run them both unless you remove the `devtest` container after running the diff --git a/content/engine/storage/containerd.md b/content/manuals/engine/storage/containerd.md similarity index 89% rename from content/engine/storage/containerd.md rename to content/manuals/engine/storage/containerd.md index 7a2feb9efe..e77858c4e5 100644 --- a/content/engine/storage/containerd.md +++ b/content/manuals/engine/storage/containerd.md @@ -1,5 +1,7 @@ --- title: containerd image store with Docker Engine +linkTitle: containerd image store +weight: 50 keywords: containerd, snapshotters, image store, docker engine description: Learn how to enable the containerd image store on Docker Engine aliases: @@ -10,7 +12,7 @@ aliases: > > The containerd image store is an experimental feature of Docker Engine. > If you're using Docker Desktop, refer to the instructions on the -> [containerd image store with Docker Desktop page](/desktop/containerd.md). +> [containerd image store with Docker Desktop page](/manuals/desktop/containerd.md). containerd, the industry-standard container runtime, uses snapshotters instead of the classic storage drivers for storing image and container data. @@ -18,7 +20,7 @@ While the `overlay2` driver still remains the default driver for Docker Engine, you can opt in to using containerd snapshotters as an experimental feature. To learn more about the containerd image store and its benefits, refer to -[containerd image store on Docker Desktop](/desktop/containerd.md). +[containerd image store on Docker Desktop](/manuals/desktop/containerd.md). ## Enable containerd image store on Docker Engine diff --git a/content/engine/storage/drivers/_index.md b/content/manuals/engine/storage/drivers/_index.md similarity index 98% rename from content/engine/storage/drivers/_index.md rename to content/manuals/engine/storage/drivers/_index.md index aeaea1e86b..07ad123cfa 100644 --- a/content/engine/storage/drivers/_index.md +++ b/content/manuals/engine/storage/drivers/_index.md @@ -1,7 +1,8 @@ --- description: Learn the technologies that support storage drivers. keywords: container, storage, driver, btrfs, overlayfs, vfs, zfs -title: About storage drivers +title: Storage drivers +weight: 40 aliases: - /storage/storagedriver/imagesandcontainers/ - /storage/storagedriver/ @@ -60,8 +61,8 @@ Each layer is only a set of differences from the layer before it. Note that both _adding_, and _removing_ files will result in a new layer. In the example above, the `$HOME/.cache` directory is removed, but will still be available in the previous layer and add up to the image's total size. Refer to the -[Best practices for writing Dockerfiles](/build/building/best-practices.md) -and [use multi-stage builds](/build/building/multi-stage.md) +[Best practices for writing Dockerfiles](/manuals/build/building/best-practices.md) +and [use multi-stage builds](/manuals/build/building/multi-stage.md) sections to learn how to optimize your Dockerfiles for efficient images. The layers are stacked on top of each other. When you create a new container, @@ -127,7 +128,7 @@ these containers would be SUM (`size` of containers) plus one image size This also doesn't count the following additional ways a container can take up disk space: -- Disk space used for log files stored by the [logging-driver](/engine/logging/_index.md). +- Disk space used for log files stored by the [logging-driver](/manuals/engine/logging/_index.md). This can be non-trivial if your container generates a large amount of logging data and log rotation isn't configured. - Volumes and bind mounts used by the container. @@ -326,7 +327,7 @@ layers are the same. the ID of that image. BuildKit uses its own caching mechanism, and no longer requires intermediate - images for caching. Refer to [BuildKit](/build/buildkit/_index.md) + images for caching. Refer to [BuildKit](/manuals/build/buildkit/_index.md) to learn more about other enhancements made in BuildKit. 9. Check out the layers for each image @@ -368,7 +369,7 @@ layers are the same. > extract and format specific information from the output, without requiring > additional tools such as `awk` or `sed`. To learn more about formatting > the output of docker commands using the `--format` flag, refer to the - > [format command and log output section](/engine/cli/formatting.md). + > [format command and log output section](/manuals/engine/cli/formatting.md). > We also pretty-printed the JSON output using the [`jq` utility](https://stedolan.github.io/jq/) > for readability. diff --git a/content/engine/storage/drivers/aufs-driver.md b/content/manuals/engine/storage/drivers/aufs-driver.md similarity index 99% rename from content/engine/storage/drivers/aufs-driver.md rename to content/manuals/engine/storage/drivers/aufs-driver.md index 36368fb073..dccad394e9 100644 --- a/content/engine/storage/drivers/aufs-driver.md +++ b/content/manuals/engine/storage/drivers/aufs-driver.md @@ -1,7 +1,7 @@ --- description: Learn how to optimize your use of AUFS driver. keywords: 'container, storage, driver, AUFS ' -title: Use the AUFS storage driver +title: AUFS storage driver sitemap: false aliases: - /storage/storagedriver/aufs-driver/ diff --git a/content/engine/storage/drivers/btrfs-driver.md b/content/manuals/engine/storage/drivers/btrfs-driver.md similarity index 99% rename from content/engine/storage/drivers/btrfs-driver.md rename to content/manuals/engine/storage/drivers/btrfs-driver.md index 91d46af949..720f6d59be 100644 --- a/content/engine/storage/drivers/btrfs-driver.md +++ b/content/manuals/engine/storage/drivers/btrfs-driver.md @@ -1,7 +1,7 @@ --- description: Learn how to optimize your use of Btrfs driver. keywords: container, storage, driver, Btrfs -title: Use the BTRFS storage driver +title: BTRFS storage driver aliases: - /storage/storagedriver/btrfs-driver/ --- diff --git a/content/engine/storage/drivers/device-mapper-driver.md b/content/manuals/engine/storage/drivers/device-mapper-driver.md similarity index 99% rename from content/engine/storage/drivers/device-mapper-driver.md rename to content/manuals/engine/storage/drivers/device-mapper-driver.md index f3c1bc0950..d87da68950 100644 --- a/content/engine/storage/drivers/device-mapper-driver.md +++ b/content/manuals/engine/storage/drivers/device-mapper-driver.md @@ -1,14 +1,14 @@ --- description: Learn how to optimize your use of device mapper driver. keywords: container, storage, driver, device mapper -title: Use the Device Mapper storage driver (deprecated) +title: Device Mapper storage driver (deprecated) aliases: - /storage/storagedriver/device-mapper-driver/ --- > **Deprecated** > -> The Device Mapper driver [has been deprecated](../../../engine/deprecated.md#device-mapper-storage-driver), +> The Device Mapper driver [has been deprecated](/manuals/engine/deprecated.md#device-mapper-storage-driver), > and is removed in Docker Engine v25.0. If you are using Device Mapper, > you must migrate to a supported storage driver before upgrading to Docker > Engine v25.0. Read the [Docker storage drivers](select-storage-driver.md) @@ -836,7 +836,7 @@ storage driver. by default `/var/lib/docker`. If your containers generate lots of log messages, this may lead to increased disk usage or the inability to manage your system due to a full disk. You can configure a - [log driver](/engine/logging/configure.md) to store your container + [log driver](/manuals/engine/logging/configure.md) to store your container logs externally. ## Related Information diff --git a/content/engine/storage/drivers/images/aufs_layers.webp b/content/manuals/engine/storage/drivers/images/aufs_layers.webp similarity index 100% rename from content/engine/storage/drivers/images/aufs_layers.webp rename to content/manuals/engine/storage/drivers/images/aufs_layers.webp diff --git a/content/engine/storage/drivers/images/btfs_container_layer.webp b/content/manuals/engine/storage/drivers/images/btfs_container_layer.webp similarity index 100% rename from content/engine/storage/drivers/images/btfs_container_layer.webp rename to content/manuals/engine/storage/drivers/images/btfs_container_layer.webp diff --git a/content/engine/storage/drivers/images/btfs_pool.webp b/content/manuals/engine/storage/drivers/images/btfs_pool.webp similarity index 100% rename from content/engine/storage/drivers/images/btfs_pool.webp rename to content/manuals/engine/storage/drivers/images/btfs_pool.webp diff --git a/content/engine/storage/drivers/images/btfs_snapshots.webp b/content/manuals/engine/storage/drivers/images/btfs_snapshots.webp similarity index 100% rename from content/engine/storage/drivers/images/btfs_snapshots.webp rename to content/manuals/engine/storage/drivers/images/btfs_snapshots.webp diff --git a/content/engine/storage/drivers/images/btfs_subvolume.webp b/content/manuals/engine/storage/drivers/images/btfs_subvolume.webp similarity index 100% rename from content/engine/storage/drivers/images/btfs_subvolume.webp rename to content/manuals/engine/storage/drivers/images/btfs_subvolume.webp diff --git a/content/engine/storage/drivers/images/container-layers.webp b/content/manuals/engine/storage/drivers/images/container-layers.webp similarity index 100% rename from content/engine/storage/drivers/images/container-layers.webp rename to content/manuals/engine/storage/drivers/images/container-layers.webp diff --git a/content/engine/storage/drivers/images/dm_container.webp b/content/manuals/engine/storage/drivers/images/dm_container.webp similarity index 100% rename from content/engine/storage/drivers/images/dm_container.webp rename to content/manuals/engine/storage/drivers/images/dm_container.webp diff --git a/content/engine/storage/drivers/images/overlay_constructs.webp b/content/manuals/engine/storage/drivers/images/overlay_constructs.webp similarity index 100% rename from content/engine/storage/drivers/images/overlay_constructs.webp rename to content/manuals/engine/storage/drivers/images/overlay_constructs.webp diff --git a/content/engine/storage/drivers/images/sharing-layers.webp b/content/manuals/engine/storage/drivers/images/sharing-layers.webp similarity index 100% rename from content/engine/storage/drivers/images/sharing-layers.webp rename to content/manuals/engine/storage/drivers/images/sharing-layers.webp diff --git a/content/engine/storage/drivers/images/two_dm_container.webp b/content/manuals/engine/storage/drivers/images/two_dm_container.webp similarity index 100% rename from content/engine/storage/drivers/images/two_dm_container.webp rename to content/manuals/engine/storage/drivers/images/two_dm_container.webp diff --git a/content/engine/storage/drivers/images/zfs_clones.webp b/content/manuals/engine/storage/drivers/images/zfs_clones.webp similarity index 100% rename from content/engine/storage/drivers/images/zfs_clones.webp rename to content/manuals/engine/storage/drivers/images/zfs_clones.webp diff --git a/content/engine/storage/drivers/images/zfs_zpool.webp b/content/manuals/engine/storage/drivers/images/zfs_zpool.webp similarity index 100% rename from content/engine/storage/drivers/images/zfs_zpool.webp rename to content/manuals/engine/storage/drivers/images/zfs_zpool.webp diff --git a/content/engine/storage/drivers/images/zpool_blocks.webp b/content/manuals/engine/storage/drivers/images/zpool_blocks.webp similarity index 100% rename from content/engine/storage/drivers/images/zpool_blocks.webp rename to content/manuals/engine/storage/drivers/images/zpool_blocks.webp diff --git a/content/engine/storage/drivers/overlayfs-driver.md b/content/manuals/engine/storage/drivers/overlayfs-driver.md similarity index 99% rename from content/engine/storage/drivers/overlayfs-driver.md rename to content/manuals/engine/storage/drivers/overlayfs-driver.md index 03a925a9f6..2d28af9308 100644 --- a/content/engine/storage/drivers/overlayfs-driver.md +++ b/content/manuals/engine/storage/drivers/overlayfs-driver.md @@ -1,7 +1,7 @@ --- description: Learn how to optimize your use of OverlayFS driver. keywords: container, storage, driver, OverlayFS, overlay2, overlay -title: Use the OverlayFS storage driver +title: OverlayFS storage driver aliases: - /storage/storagedriver/overlayfs-driver/ --- @@ -13,7 +13,7 @@ storage driver as `overlay2`. > [!NOTE] > -> For `fuse-overlayfs` driver, check [Rootless mode documentation](/engine/security/rootless.md). +> For `fuse-overlayfs` driver, check [Rootless mode documentation](/manuals/engine/security/rootless.md). ## Prerequisites diff --git a/content/engine/storage/drivers/select-storage-driver.md b/content/manuals/engine/storage/drivers/select-storage-driver.md similarity index 97% rename from content/engine/storage/drivers/select-storage-driver.md rename to content/manuals/engine/storage/drivers/select-storage-driver.md index 6e72d0210e..b0f5dc38c1 100644 --- a/content/engine/storage/drivers/select-storage-driver.md +++ b/content/manuals/engine/storage/drivers/select-storage-driver.md @@ -1,5 +1,6 @@ --- -title: Docker storage drivers +title: Select a storage driver +weight: 10 description: Learn how to select the proper storage driver for your container. keywords: container, storage, driver, btrfs, zfs, overlay, overlay2 aliases: @@ -23,7 +24,7 @@ The Docker Engine provides the following storage drivers on Linux: | Driver | Description | | :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `overlay2` | `overlay2` is the preferred storage driver for all currently supported Linux distributions, and requires no extra configuration. | -| `fuse-overlayfs` | `fuse-overlayfs`is preferred only for running Rootless Docker on an old host that does not provide support for rootless `overlay2`. The `fuse-overlayfs` driver does not need to be used since Linux kernel 5.11, and `overlay2` works even in rootless mode. Refer to the [rootless mode documentation](/engine/security/rootless.md) for details. | +| `fuse-overlayfs` | `fuse-overlayfs`is preferred only for running Rootless Docker on an old host that does not provide support for rootless `overlay2`. The `fuse-overlayfs` driver does not need to be used since Linux kernel 5.11, and `overlay2` works even in rootless mode. Refer to the [rootless mode documentation](/manuals/engine/security/rootless.md) for details. | | `btrfs` and `zfs` | The `btrfs` and `zfs` storage drivers allow for advanced options, such as creating "snapshots", but require more maintenance and setup. Each of these relies on the backing filesystem being configured correctly. | | `vfs` | The `vfs` storage driver is intended for testing purposes, and for situations where no copy-on-write filesystem can be used. Performance of this storage driver is poor, and is not generally recommended for production use. | @@ -52,10 +53,10 @@ the final decision. > > Modifying the storage driver by editing the daemon configuration file isn't > supported on Docker Desktop. Only the default `overlay2` driver or the -> [containerd storage](/desktop/containerd.md) are supported. The +> [containerd storage](/manuals/desktop/containerd.md) are supported. The > following table is also not applicable for the Docker Engine in rootless > mode. For the drivers available in rootless mode, see the [Rootless mode -> documentation](/engine/security/rootless.md). +> documentation](/manuals/engine/security/rootless.md). Your operating system and kernel may not support every storage driver. For example, `btrfs` is only supported if your system uses `btrfs` as storage. In diff --git a/content/engine/storage/drivers/vfs-driver.md b/content/manuals/engine/storage/drivers/vfs-driver.md similarity index 99% rename from content/engine/storage/drivers/vfs-driver.md rename to content/manuals/engine/storage/drivers/vfs-driver.md index 406798251c..154463745d 100644 --- a/content/engine/storage/drivers/vfs-driver.md +++ b/content/manuals/engine/storage/drivers/vfs-driver.md @@ -1,7 +1,7 @@ --- description: Learn how to optimize your use of VFS driver. keywords: container, storage, driver, vfs -title: Use the VFS storage driver +title: VFS storage driver aliases: - /storage/storagedriver/vfs-driver/ --- diff --git a/content/engine/storage/drivers/zfs-driver.md b/content/manuals/engine/storage/drivers/zfs-driver.md similarity index 99% rename from content/engine/storage/drivers/zfs-driver.md rename to content/manuals/engine/storage/drivers/zfs-driver.md index da0fd8f1f6..cf22f58348 100644 --- a/content/engine/storage/drivers/zfs-driver.md +++ b/content/manuals/engine/storage/drivers/zfs-driver.md @@ -1,7 +1,7 @@ --- description: Learn how to optimize your use of ZFS driver. keywords: 'container, storage, driver, ZFS ' -title: Use the ZFS storage driver +title: ZFS storage driver aliases: - /storage/storagedriver/zfs-driver/ --- diff --git a/content/engine/storage/images/types-of-mounts-bind.webp b/content/manuals/engine/storage/images/types-of-mounts-bind.webp similarity index 100% rename from content/engine/storage/images/types-of-mounts-bind.webp rename to content/manuals/engine/storage/images/types-of-mounts-bind.webp diff --git a/content/engine/storage/images/types-of-mounts-tmpfs.webp b/content/manuals/engine/storage/images/types-of-mounts-tmpfs.webp similarity index 100% rename from content/engine/storage/images/types-of-mounts-tmpfs.webp rename to content/manuals/engine/storage/images/types-of-mounts-tmpfs.webp diff --git a/content/engine/storage/images/types-of-mounts-volume.webp b/content/manuals/engine/storage/images/types-of-mounts-volume.webp similarity index 100% rename from content/engine/storage/images/types-of-mounts-volume.webp rename to content/manuals/engine/storage/images/types-of-mounts-volume.webp diff --git a/content/engine/storage/images/types-of-mounts.webp b/content/manuals/engine/storage/images/types-of-mounts.webp similarity index 100% rename from content/engine/storage/images/types-of-mounts.webp rename to content/manuals/engine/storage/images/types-of-mounts.webp diff --git a/content/engine/storage/images/volumes-shared-storage.webp b/content/manuals/engine/storage/images/volumes-shared-storage.webp similarity index 100% rename from content/engine/storage/images/volumes-shared-storage.webp rename to content/manuals/engine/storage/images/volumes-shared-storage.webp diff --git a/content/engine/storage/tmpfs.md b/content/manuals/engine/storage/tmpfs.md similarity index 99% rename from content/engine/storage/tmpfs.md rename to content/manuals/engine/storage/tmpfs.md index 04355affc5..7c124a371a 100644 --- a/content/engine/storage/tmpfs.md +++ b/content/manuals/engine/storage/tmpfs.md @@ -1,6 +1,7 @@ --- description: Using tmpfs mounts title: tmpfs mounts +weight: 30 keywords: storage, persistence, data persistence, tmpfs aliases: - /engine/admin/volumes/tmpfs/ diff --git a/content/engine/storage/volumes.md b/content/manuals/engine/storage/volumes.md similarity index 99% rename from content/engine/storage/volumes.md rename to content/manuals/engine/storage/volumes.md index 038d36661b..d682e4300e 100644 --- a/content/engine/storage/volumes.md +++ b/content/manuals/engine/storage/volumes.md @@ -2,6 +2,7 @@ description: Learn how to create, manage, and use volumes instead of bind mounts for persisting data generated and used by Docker. title: Volumes +weight: 10 keywords: docker compose volumes, docker volumes, docker compose volume, docker volume mount, docker mount volume, docker volume create, docker volume location aliases: diff --git a/content/engine/swarm/_index.md b/content/manuals/engine/swarm/_index.md similarity index 88% rename from content/engine/swarm/_index.md rename to content/manuals/engine/swarm/_index.md index 11229e344c..3676283245 100644 --- a/content/engine/swarm/_index.md +++ b/content/manuals/engine/swarm/_index.md @@ -1,7 +1,8 @@ --- description: Docker Engine Swarm mode overview keywords: docker, container, cluster, swarm, docker engine -title: Swarm mode overview +title: Swarm mode +weight: 80 aliases: - /api/swarm-api/ - /engine/userguide/networking/overlay-standalone-swarm/ @@ -129,12 +130,12 @@ roll back to a previous version of the service. * Learn Swarm mode [key concepts](key-concepts.md). * Get started with the [Swarm mode tutorial](swarm-tutorial/index.md). * Explore Swarm mode CLI commands - * [swarm init](../../reference/cli/docker/swarm/init.md) - * [swarm join](../../reference/cli/docker/swarm/join.md) - * [service create](../../reference/cli/docker/service/create.md) - * [service inspect](../../reference/cli/docker/service/inspect.md) - * [service ls](../../reference/cli/docker/service/ls.md) - * [service rm](../../reference/cli/docker/service/rm.md) - * [service scale](../../reference/cli/docker/service/scale.md) - * [service ps](../../reference/cli/docker/service/ps.md) - * [service update](../../reference/cli/docker/service/update.md) + * [swarm init](/reference/cli/docker/swarm/init.md) + * [swarm join](/reference/cli/docker/swarm/join.md) + * [service create](/reference/cli/docker/service/create.md) + * [service inspect](/reference/cli/docker/service/inspect.md) + * [service ls](/reference/cli/docker/service/ls.md) + * [service rm](/reference/cli/docker/service/rm.md) + * [service scale](/reference/cli/docker/service/scale.md) + * [service ps](/reference/cli/docker/service/ps.md) + * [service update](/reference/cli/docker/service/update.md) diff --git a/content/engine/swarm/admin_guide.md b/content/manuals/engine/swarm/admin_guide.md similarity index 99% rename from content/engine/swarm/admin_guide.md rename to content/manuals/engine/swarm/admin_guide.md index cec2e725c5..d63579a844 100644 --- a/content/engine/swarm/admin_guide.md +++ b/content/manuals/engine/swarm/admin_guide.md @@ -395,5 +395,5 @@ down to the original scale. You can use `docker service ps` to assess the curren balance of your service across nodes. See also -[`docker service scale`](../../reference/cli/docker/service/scale.md) and -[`docker service ps`](../../reference/cli/docker/service/ps.md). +[`docker service scale`](/reference/cli/docker/service/scale.md) and +[`docker service ps`](/reference/cli/docker/service/ps.md). diff --git a/content/engine/swarm/configs.md b/content/manuals/engine/swarm/configs.md similarity index 98% rename from content/engine/swarm/configs.md rename to content/manuals/engine/swarm/configs.md index 8a6de6aa91..7d2d5acba8 100644 --- a/content/engine/swarm/configs.md +++ b/content/manuals/engine/swarm/configs.md @@ -113,10 +113,10 @@ those remaining after a `docker service update --config-rm`. Use these links to read about specific commands, or continue to the [example about using configs with a service](#advanced-example-use-configs-with-a-nginx-service). -- [`docker config create`](../../reference/cli/docker/config/create.md) -- [`docker config inspect`](../../reference/cli/docker/config/inspect.md) -- [`docker config ls`](../../reference/cli/docker/config/ls.md) -- [`docker config rm`](../../reference/cli/docker/config/rm.md) +- [`docker config create`](/reference/cli/docker/config/create.md) +- [`docker config inspect`](/reference/cli/docker/config/inspect.md) +- [`docker config ls`](/reference/cli/docker/config/ls.md) +- [`docker config rm`](/reference/cli/docker/config/rm.md) ## Examples diff --git a/content/manuals/engine/swarm/how-swarm-mode-works/_index.md b/content/manuals/engine/swarm/how-swarm-mode-works/_index.md new file mode 100644 index 0000000000..085b81ba0f --- /dev/null +++ b/content/manuals/engine/swarm/how-swarm-mode-works/_index.md @@ -0,0 +1,5 @@ +--- +build: + render: never +title: How swarm works +--- diff --git a/content/engine/swarm/how-swarm-mode-works/nodes.md b/content/manuals/engine/swarm/how-swarm-mode-works/nodes.md similarity index 94% rename from content/engine/swarm/how-swarm-mode-works/nodes.md rename to content/manuals/engine/swarm/how-swarm-mode-works/nodes.md index c7a90868f0..7640f59171 100644 --- a/content/engine/swarm/how-swarm-mode-works/nodes.md +++ b/content/manuals/engine/swarm/how-swarm-mode-works/nodes.md @@ -2,6 +2,7 @@ description: How swarm nodes work keywords: docker, container, cluster, swarm mode, node title: How nodes work +weight: 10 aliases: - /engine/swarm/how-swarm-mode-works/ --- @@ -67,17 +68,17 @@ gracefully stops tasks on nodes in `Drain` mode and schedules the tasks on an `Active` node. The scheduler does not assign new tasks to nodes with `Drain` availability. -Refer to the [`docker node update`](../../../reference/cli/docker/node/update.md) +Refer to the [`docker node update`](/reference/cli/docker/node/update.md) command line reference to see how to change node availability. ## Change roles You can promote a worker node to be a manager by running `docker node promote`. For example, you may want to promote a worker node when you -take a manager node offline for maintenance. See [node promote](../../../reference/cli/docker/node/promote.md). +take a manager node offline for maintenance. See [node promote](/reference/cli/docker/node/promote.md). You can also demote a manager node to a worker node. See -[node demote](../../../reference/cli/docker/node/demote.md). +[node demote](/reference/cli/docker/node/demote.md). ## Learn more diff --git a/content/engine/swarm/how-swarm-mode-works/pki.md b/content/manuals/engine/swarm/how-swarm-mode-works/pki.md similarity index 96% rename from content/engine/swarm/how-swarm-mode-works/pki.md rename to content/manuals/engine/swarm/how-swarm-mode-works/pki.md index 8dd4ab3708..d0ba71f22a 100644 --- a/content/engine/swarm/how-swarm-mode-works/pki.md +++ b/content/manuals/engine/swarm/how-swarm-mode-works/pki.md @@ -14,7 +14,7 @@ as a manager node. By default, the manager node generates a new root Certificate Authority (CA) along with a key pair, which are used to secure communications with other nodes that join the swarm. If you prefer, you can specify your own externally-generated root CA, using the `--external-ca` flag of the -[docker swarm init](../../../reference/cli/docker/swarm/init.md) command. +[docker swarm init](/reference/cli/docker/swarm/init.md) command. The manager node also generates two tokens to use when you join additional nodes to the swarm: one worker token and one manager token. Each token @@ -55,7 +55,7 @@ By default, each node in the swarm renews its certificate every three months. You can configure this interval by running the `docker swarm update --cert-expiry