{"id":13528279,"url":"https://github.com/docker/setup-buildx-action","last_synced_at":"2025-05-12T13:19:14.111Z","repository":{"id":37482855,"uuid":"288485773","full_name":"docker/setup-buildx-action","owner":"docker","description":"GitHub Action to set up Docker Buildx","archived":false,"fork":false,"pushed_at":"2025-04-24T09:31:01.000Z","size":26375,"stargazers_count":1110,"open_issues_count":15,"forks_count":191,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-12T13:18:58.027Z","etag":null,"topics":["buildkit","buildx","docker","github-actions","github-actions-docker"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/docker-setup-buildx","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-08-18T14:55:48.000Z","updated_at":"2025-05-11T04:57:28.000Z","dependencies_parsed_at":"2024-03-14T09:34:28.299Z","dependency_job_id":"08554998-1124-4c6e-bd33-59c49a6370b5","html_url":"https://github.com/docker/setup-buildx-action","commit_stats":{"total_commits":310,"total_committers":10,"mean_commits":31.0,"dds":0.3032258064516129,"last_synced_commit":"0f069ddc17b8eb78586b08a7fe335fd54649e2d3"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-buildx-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-buildx-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-buildx-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-buildx-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docker","download_url":"https://codeload.github.com/docker/setup-buildx-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745196,"owners_count":21957319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["buildkit","buildx","docker","github-actions","github-actions-docker"],"created_at":"2024-08-01T06:02:23.335Z","updated_at":"2025-05-12T13:19:14.061Z","avatar_url":"https://github.com/docker.png","language":"TypeScript","readme":"[![GitHub release](https://img.shields.io/github/release/docker/setup-buildx-action.svg?style=flat-square)](https://github.com/docker/setup-buildx-action/releases/latest)\n[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--buildx-blue?logo=github\u0026style=flat-square)](https://github.com/marketplace/actions/docker-setup-buildx)\n[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-buildx-action/ci.yml?branch=master\u0026label=ci\u0026logo=github\u0026style=flat-square)](https://github.com/docker/setup-buildx-action/actions?workflow=ci)\n[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-buildx-action/test.yml?branch=master\u0026label=test\u0026logo=github\u0026style=flat-square)](https://github.com/docker/setup-buildx-action/actions?workflow=test)\n[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-buildx-action?logo=codecov\u0026style=flat-square)](https://codecov.io/gh/docker/setup-buildx-action)\n\n## About\n\nGitHub Action to set up Docker [Buildx](https://github.com/docker/buildx).\n\nThis action will create and boot a builder that can be used in the following\nsteps of your workflow if you're using Buildx or the [`build-push` action](https://github.com/docker/build-push-action/).\nBy default, the [`docker-container` driver](https://docs.docker.com/build/building/drivers/docker-container/)\nwill be used to be able to build multi-platform images and export cache using\na [BuildKit](https://github.com/moby/buildkit) container.\n\n![Screenshot](.github/setup-buildx-action.png)\n\n___\n\n* [Usage](#usage)\n* [Configuring your builder](#configuring-your-builder)\n* [Customizing](#customizing)\n  * [inputs](#inputs)\n  * [outputs](#outputs)\n  * [environment variables](#environment-variables)\n* [Notes](#notes)\n  * [`nodes` output](#nodes-output)\n* [Contributing](#contributing)\n\n## Usage\n\n```yaml\nname: ci\n\non:\n  push:\n\njobs:\n  buildx:\n    runs-on: ubuntu-latest\n    steps:\n      -\n        name: Checkout\n        uses: actions/checkout@v4\n      -\n        # Add support for more platforms with QEMU (optional)\n        # https://github.com/docker/setup-qemu-action\n        name: Set up QEMU\n        uses: docker/setup-qemu-action@v3\n      -\n        name: Set up Docker Buildx\n        uses: docker/setup-buildx-action@v3\n```\n\n## Configuring your builder\n\n* [Version pinning](https://docs.docker.com/build/ci/github-actions/configure-builder/#version-pinning): Pin to a specific Buildx or BuildKit version\n* [BuildKit container logs](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs): Enable BuildKit container logs for debugging purposes\n* [BuildKit Daemon configuration](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-daemon-configuration)\n  * [Registry mirror](https://docs.docker.com/build/ci/github-actions/configure-builder/#registry-mirror): Configure a registry mirror for your builds\n  * [Max parallelism](https://docs.docker.com/build/ci/github-actions/configure-builder/#max-parallelism): Configure the maximum parallelism for your builds\n* [Append additional nodes to the builder](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder): Create additional nodes for your builder\n* [Authentication for remote builders](https://docs.docker.com/build/ci/github-actions/configure-builder/#authentication-for-remote-builders)\n  * [SSH authentication](https://docs.docker.com/build/ci/github-actions/configure-builder/#ssh-authentication): Authenticate to a remote builder using SSH\n  * [TLS authentication](https://docs.docker.com/build/ci/github-actions/configure-builder/#tls-authentication): Authenticate to a remote builder using TLS\n* [Standalone mode](https://docs.docker.com/build/ci/github-actions/configure-builder/#standalone-mode): Use Buildx as a standalone binary (without the Docker CLI)\n* [Isolated builders](https://docs.docker.com/build/ci/github-actions/configure-builder/#isolated-builders): Create isolated builders for your builds\n\n## Customizing\n\n### inputs\n\nThe following inputs can be used as `step.with` keys:\n\n\u003e `List` type is a newline-delimited string\n\u003e ```yaml\n\u003e driver-opts: |\n\u003e   image=moby/buildkit:master\n\u003e   network=host\n\u003e ```\n\n\u003e `CSV` type must be a comma-delimited string\n\u003e ```yaml\n\u003e platforms: linux/amd64,linux/arm64\n\u003e ```\n\n| Name                         | Type     | Default            | Description                                                                                                                                                                  |\n|------------------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `version`                    | String   |                    | [Buildx](https://github.com/docker/buildx) version. (eg. `v0.3.0`, `latest`, `https://github.com/docker/buildx.git#master`)                                                  |\n| `driver`                     | String   | `docker-container` | Sets the [builder driver](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver) to be used                                                             |\n| `driver-opts`                | List     |                    | List of additional [driver-specific options](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver-opt) (eg. `image=moby/buildkit:master`)              |\n| `buildkitd-flags`            | String   |                    | [BuildKit daemon flags](https://docs.docker.com/engine/reference/commandline/buildx_create/#buildkitd-flags)                                                                 |\n| `buildkitd-config` \\*        | String   |                    | [BuildKit daemon config file](https://docs.docker.com/engine/reference/commandline/buildx_create/#config)                                                                    |\n| `buildkitd-config-inline` \\* | String   |                    | Same as `buildkitd-config` but inline                                                                                                                                        |\n| `install`                    | Bool     | `false`            | Sets up `docker build` command as an alias to `docker buildx`                                                                                                                |\n| `use`                        | Bool     | `true`             | Switch to this builder instance                                                                                                                                              |\n| `endpoint`                   | String   |                    | [Optional address for docker socket](https://docs.docker.com/engine/reference/commandline/buildx_create/#description) or context from `docker context ls`                    |\n| `platforms`                  | List/CSV |                    | Fixed [platforms](https://docs.docker.com/engine/reference/commandline/buildx_create/#platform) for current node. If not empty, values take priority over the detected ones. |\n| `append`                     | YAML     |                    | [Append additional nodes](https://docs.docker.com/build/ci/github-actions/configure-builder/#append-additional-nodes-to-the-builder) to the builder                          |\n| `cache-binary`               | Bool     | `true`             | Cache buildx binary to GitHub Actions cache backend                                                                                                                          |\n| `cleanup`                    | Bool     | `true`             | Cleanup temp files and remove builder at the end of a job                                                                                                                    |\n\n\u003e [!IMPORTANT]\n\u003e If you set the `buildkitd-flags` input, the default flags (`--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host`)\n\u003e will be reset. If you want to retain the default behavior, make sure to\n\u003e include these flags in your custom `buildkitd-flags` value.\n\n\u003e [!NOTE]\n\u003e `buildkitd-config` and `buildkitd-config-inline` are mutually exclusive.\n\n### outputs\n\nThe following outputs are available:\n\n| Name        | Type   | Description                                         |\n|-------------|--------|-----------------------------------------------------|\n| `name`      | String | Builder name                                        |\n| `driver`    | String | Builder driver                                      |\n| `platforms` | String | Builder node platforms (preferred and/or available) |\n| `nodes`     | JSON   | Builder [nodes metadata](#nodes-output)             |\n\n### environment variables\n\nThe following [official docker environment variables](https://docs.docker.com/engine/reference/commandline/cli/#environment-variables) are supported:\n\n| Name            | Type   | Default     | Description                                     |\n|-----------------|--------|-------------|-------------------------------------------------|\n| `DOCKER_CONFIG` | String | `~/.docker` | The location of your client configuration files |\n\n## Notes\n\n### `nodes` output\n\n```json\n[\n  {\n     \"name\": \"builder-3820d274-502c-4498-ae24-d4c32b3023d90\",\n     \"endpoint\": \"unix:///var/run/docker.sock\",\n     \"driver-opts\": [\n       \"network=host\",\n       \"image=moby/buildkit:master\"\n     ],\n    \"status\": \"running\",\n    \"buildkitd-flags\": \"--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host\",\n    \"buildkit\": \"3fab389\",\n    \"platforms\": \"linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/386\"\n  }\n]\n```\n\n| Name              | Type   | Description                |\n|-------------------|--------|----------------------------|\n| `name`            | String | Node name                  |\n| `endpoint`        | String | Node endpoint              |\n| `driver-opts`     | List   | Options for the driver     |\n| `status`          | String | Node status                |\n| `buildkitd-flags` | String | Flags for buildkitd daemon |\n| `buildkit`        | String | BuildKit version           |\n| `platforms`       | String | Platforms available        |\n\n## Contributing\n\nWant to contribute? Awesome! You can find information about contributing to\nthis project in the [CONTRIBUTING.md](/.github/CONTRIBUTING.md)\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocker%2Fsetup-buildx-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocker%2Fsetup-buildx-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocker%2Fsetup-buildx-action/lists"}