{"id":22533045,"url":"https://github.com/docker/setup-docker-action","last_synced_at":"2025-04-09T17:54:27.519Z","repository":{"id":148251313,"uuid":"398780917","full_name":"docker/setup-docker-action","owner":"docker","description":"GitHub Action to set up (download and install) Docker CE","archived":false,"fork":false,"pushed_at":"2025-03-18T11:23:39.000Z","size":20207,"stargazers_count":48,"open_issues_count":3,"forks_count":6,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-29T19:34:43.508Z","etag":null,"topics":["actions","docker","engine","github-actions"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/docker-setup-docker","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},"funding":{"github":"crazy-max","custom":"https://www.paypal.me/crazyws"}},"created_at":"2021-08-22T11:18:27.000Z","updated_at":"2025-03-18T11:23:44.000Z","dependencies_parsed_at":"2024-01-26T11:46:12.813Z","dependency_job_id":"29f8fee3-8dc8-42bd-a54e-2455fd7fe722","html_url":"https://github.com/docker/setup-docker-action","commit_stats":{"total_commits":126,"total_committers":4,"mean_commits":31.5,"dds":0.2857142857142857,"last_synced_commit":"3e94cecda00758920ea0047844815d7c4ff8cc32"},"previous_names":["docker/setup-docker-action"],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-docker-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-docker-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-docker-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docker%2Fsetup-docker-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docker","download_url":"https://codeload.github.com/docker/setup-docker-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248083560,"owners_count":21045122,"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":["actions","docker","engine","github-actions"],"created_at":"2024-12-07T09:06:27.716Z","updated_at":"2025-04-09T17:54:27.502Z","avatar_url":"https://github.com/docker.png","language":"TypeScript","readme":"[![GitHub release](https://img.shields.io/github/release/docker/setup-docker-action.svg?style=flat-square)](https://github.com/docker/setup-docker-action/releases/latest)\n[![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--setup--docker-blue?logo=github\u0026style=flat-square)](https://github.com/marketplace/actions/docker-setup-docker)\n[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-docker-action/ci.yml?branch=master\u0026label=ci\u0026logo=github\u0026style=flat-square)](https://github.com/docker/setup-docker-action/actions?workflow=ci)\n[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/setup-docker-action/test.yml?branch=master\u0026label=test\u0026logo=github\u0026style=flat-square)](https://github.com/docker/setup-docker-action/actions?workflow=test)\n[![Codecov](https://img.shields.io/codecov/c/github/docker/setup-docker-action?logo=codecov\u0026style=flat-square)](https://codecov.io/gh/docker/setup-docker-action)\n\n## About\n\nGitHub Action to set up (download and install) [Docker CE](https://docs.docker.com/engine/).\nWorks on Linux, macOS and Windows.\n\n\u003e [!NOTE]\n\u003e This action is useful if you want to pin against a specific Docker version or\n\u003e set up a custom daemon configuration or if Docker is not available on your\n\u003e runner. If you're using [GitHub-hosted runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources)\n\u003e on Linux or Windows, Docker is already up and running, so it might not be\n\u003e necessary to use this action.\n\n\u003e [!WARNING]\n\u003e Does not work on macOS runners with ARM architecture (no nested virtualization):\n\u003e * https://github.com/crazy-max/ghaction-setup-docker/pull/53\n\u003e * https://github.com/docker/actions-toolkit/issues/317\n\n![Screenshot](.github/setup-docker-action.png)\n\n___\n\n* [Usage](#usage)\n  * [Quick start](#quick-start)\n  * [Daemon configuration](#daemon-configuration)\n  * [Define custom `limactl start` arguments (macOS)](#define-custom-limactl-start-arguments-macos)\n* [Customizing](#customizing)\n  * [inputs](#inputs)\n  * [inputs.version](#inputsversion)\n  * [outputs](#outputs)\n* [Contributing](#contributing)\n* [License](#license)\n\n## Usage\n\n### Quick start\n\n```yaml\nname: ci\n\non:\n  push:\n\njobs:\n  docker:\n    runs-on: ubuntu-latest\n    steps:\n      -\n        name: Set up Docker\n        uses: docker/setup-docker-action@v4\n```\n\n### Daemon configuration\n\nYou can [configure the Docker daemon](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file)\nusing the `daemon-config` input. In the following example, we configure the\nDocker daemon to enable debug and the [containerd image store](https://docs.docker.com/storage/containerd/)\nfeature:\n\n```yaml\nname: ci\n\non:\n  push:\n\njobs:\n  docker:\n    runs-on: ubuntu-latest\n    steps:\n      -\n        name: Set up Docker\n        uses: docker/setup-docker-action@v4\n        with:\n          daemon-config: |\n            {\n              \"debug\": true,\n              \"features\": {\n                \"containerd-snapshotter\": true\n              }\n            }\n```\n\n### Define custom `limactl start` arguments (macOS)\n\nYou can define custom [`limactl start` arguments](https://lima-vm.io/docs/reference/limactl_start/)\nusing the `LIMA_START_ARGS` environment variable to customize the VM:\n\n```yaml\nname: ci\n\non:\n  push:\n\njobs:\n  docker:\n    runs-on: macos-latest\n    steps:\n      -\n        name: Set up Docker\n        uses: docker/setup-docker-action@v4\n        env:\n          LIMA_START_ARGS: --cpus 4 --memory 8\n```\n\n## Customizing\n\n### inputs\n\nThe following inputs can be used as `step.with` keys\n\n| Name            | Type   | Default               | Description                                                                                                                 |\n|-----------------|--------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `version`       | String | `latest`              | Docker version to use. See [inputs.version](#inputs.version).                                                               |\n| `channel`       | String | `stable`              | Docker CE [channel](https://download.docker.com/linux/static/) (`stable` or `test`). Only applicable to `type=archive`      |\n| `daemon-config` | String |                       | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |\n| `tcp-port`      | Number |                       | TCP port to expose the Docker API locally                                                                                   |\n| `context`       | String | `setup-docker-action` | Docker context name.                                                                                                        |\n| `set-host`      | Bool   | `false`               | Set `DOCKER_HOST` environment variable to docker socket path.                                                               |\n| `rootless`      | Bool   | `false`               | Start daemon in rootless mode                                                                                               |\n\n### inputs.version\n\nBy default, the latest stable version of Docker is fetched from download.docker.com.\n\nYou can specify a specific version number (e.g. `v27.4.0`).\nWhich is a shorthand for the full comma separated value:\n\n`type=archive,channel=stable,version=v27.4.0`\n\nYou can also use this full csv format instead.\n\nCurrently supported source types are:\n- `archive`\n- `image`\n\n#### `type=archive`\n| Key       |  Default   | Description                                                                          |\n|-----------|------------|--------------------------------------------------------------------------------------| \n| `type`    | `archive`  | The source type of the Docker binaries. Possible values are `archive` and `image`.   | \n| `channel` | `stable`   | The download.docker.com channel (`stable` or `test`).                                | \n| `version` | `latest`   | The Docker version to use.                                                           | \n\nExamples:\n```yaml\n# last stable released version\nversion: latest\nversion: type=archive                 # same as above\nversion: version=latest               # same as above\nversion: type=archive,version=latest  # same as above\n```\n\n```yaml\n# v27.3.0-rc.1 from test channel\nversion: type=archive,version=27.3.0-rc.1,channel=test\n```\n\n#### `type=image`\n\nOther possible source type is `image` which will pull the Docker binaries from the `moby/moby-bin` and\n`dockereng/cli-bin` Docker Hub repositories.\nThe advantage of using this source type is that these images are built by the Moby and Docker CI pipelines\nfor each branch and PR, so you can use the `tag` input to install a specific version or branch (e.g. `master`).\n\n| Key       |  Default   | Description                                                                          |\n|-----------|------------|--------------------------------------------------------------------------------------|\n| `tag`     | `latest`   | The image tag to use.                                                                |\n\nSee https://hub.docker.com/r/moby/moby-bin/tags and https://hub.docker.com/r/dockereng/cli-bin/tags for available tags.\n\nExamples:\n```yaml\n# install last stable released version from bin images\nversion: type=image\nversion: type=image,tag=latest        # same as above\n```\n\n```yaml\n# a cutting-edge version from the `master` branch\nversion: type=image,tag=master\n```\n\n```yaml\n# install v27.4.0 from bin images\nversion: type=image,tag=27.4.0\n```\n\n### outputs\n\nThe following outputs are available\n\n| Name   | Type   | Description                           |\n|--------|--------|---------------------------------------|\n| `sock` | String | Docker socket path                    |\n| `tcp`  | String | Docker TCP address if tcp-port is set |\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\n## License\n\nApache-2.0. See `LICENSE` for more details.\n","funding_links":["https://github.com/sponsors/crazy-max","https://www.paypal.me/crazyws"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocker%2Fsetup-docker-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocker%2Fsetup-docker-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocker%2Fsetup-docker-action/lists"}