docker/setup-docker-action
3
0
Fork 0
mirror of https://github.com/docker/setup-docker-action.git synced 2025-06-23 19:37:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

daemon-config input

Browse Source
This commit is contained in:
CrazyMax
2023-08-27 14:43:03 +02:00
parent d298db0f7d
commit e5467b74ef
6 changed files with 80 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -14,6 +14,8 @@ Works on Linux, macOS and Windows.
___
* [Usage](#usage)
* [Quick start](#quick-start)
* [Daemon configuration](#daemon-configuration)
* [Customizing](#customizing)
* [inputs](#inputs)
* [Notes](#notes)
@ -22,6 +24,8 @@ ___
## Usage
### Quick start
```yaml
name: ci
@ -37,17 +41,48 @@ jobs:
uses: crazy-max/ghaction-setup-docker@v1
```
### Daemon configuration
You can [configure the Docker daemon](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file)
using the `daemon-config` input. In the following example, we configure the
Docker daemon to enable debug and the [containerd image store](https://docs.docker.com/storage/containerd/)
feature:
```yaml
name: ci
on:
push:
jobs:
docker:
runs-on: ubuntu-latest
steps:
-
name: Set up Docker
uses: crazy-max/ghaction-setup-docker@v1
with:
daemon-config: |
{
"debug": true,
"features": {
"containerd-snapshotter": true
}
}
```
## Customizing
### inputs
Following inputs can be used as `step.with` keys
| Name | Type | Default | Description |
|-----------|--------|-----------------------|---------------------------------------------------------------------------------------------------|
| `version` | String | `latest` | Docker CE version (e.g., `v23.0.1`). |
| `channel` | String | `stable` | Docker CE [channel](https://download.docker.com/linux/static/) (e.g, `stable`, `edge` or `test`). |
| `context` | String | `setup-docker-action` | Docker context name. |
| Name | Type | Default | Description |
|-----------------|--------|-----------------------|-----------------------------------------------------------------------------------------------------------------------------|
| `version` | String | `latest` | Docker CE version (e.g., `v23.0.1`). |
| `channel` | String | `stable` | Docker CE [channel](https://download.docker.com/linux/static/) (e.g, `stable`, `edge` or `test`). |
| `daemon-config` | String | | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
| `context` | String | `setup-docker-action` | Docker context name. |
## Notes