1
1
This commit is contained in:
parent
7db99e0fa6
commit
4e79d98c78
5 changed files with 75 additions and 80 deletions
75
README.md
75
README.md
|
@ -1,64 +1,43 @@
|
|||
# Docker Daemon WoodpeckerCI Plugin
|
||||
|
||||
[](https://hub.docker.com/repository/docker/kokuwaio/dockerhub-metadata)
|
||||
[](https://hub.docker.com/repository/docker/kokuwaio/dockerhub-metadata)
|
||||
[](https://github.com/kokuwaio/dockerhub-metadata/blob/main/Dockerfile)
|
||||
[](https://github.com/kokuwaio/dockerhub-metadata/blob/main/LICENSE)
|
||||
[](https://github.com/kokuwaio/dockerhub-metadata/issues)
|
||||
[](https://hub.docker.com/r/kokuwaio/dockerd)
|
||||
[](https://hub.docker.com/r/kokuwaio/dockerd)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerd/src/branch/main/Dockerfile)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerd/src/branch/main/LICENSE)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerd/pulls)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerd/issues)
|
||||
|
||||
A [Woodpecker CI](https://woodpecker-ci.org) prepared docker daemon.
|
||||
A [Woodpecker I](https://woodpecker-ci.org) prepared docker daemon.
|
||||
Also usable with Gitlab, Github or locally, see examples for usage.
|
||||
|
||||
## Features
|
||||
|
||||
- set full description in repository from local file
|
||||
- set short description in repository from settings
|
||||
- set categories for repository
|
||||
- includes rootless
|
||||
- configures mirror for dockerd
|
||||
|
||||
## Example
|
||||
|
||||
Woodpecker:
|
||||
|
||||
```yaml
|
||||
|
||||
services:
|
||||
- name: dockerd
|
||||
image: kokuwaio/dockerd
|
||||
ports: [2375, 8080]
|
||||
|
||||
steps:
|
||||
dockerhub:
|
||||
image: kokuwaio/dockerhub-metadata
|
||||
depends_on: []
|
||||
settings:
|
||||
repository: kokuwaio/example-image
|
||||
description-short: This image does that!
|
||||
categories: [developer-tools, integration-and-delivery]
|
||||
username: {from_secret: DOCKERHUB_USERNAME}
|
||||
password: {from_secret: DOCKERHUB_PASSWORD}
|
||||
when:
|
||||
event: push
|
||||
branch: main
|
||||
path: README.md
|
||||
```
|
||||
|
||||
Gitlab:
|
||||
|
||||
```yaml
|
||||
dockerhub:
|
||||
stage: deploy
|
||||
needs: []
|
||||
image: kokuwaio/hadolint
|
||||
variables:
|
||||
PLUGIN_REPOSITORY: kokuwaio/example-image
|
||||
PLUGIN_DESCRIPTION_SHORT: This image does that!
|
||||
PLUGIN_CATEGORIES: developer-tools,integration-and-delivery
|
||||
rules:
|
||||
- if: $CI_PIPELINE_SOURCE == "push"
|
||||
changes: [README.md]
|
||||
info:
|
||||
image: kokuwaio/docker-cli
|
||||
commands: docker info
|
||||
environment:
|
||||
DOCKER_HOST: tcp://dockerd:2375
|
||||
```
|
||||
|
||||
## Settings
|
||||
|
||||
| Settings Name | Environment | Default | Description |
|
||||
| ------------------- | ------------------------ | ----------- | ----------------------------------------------------------- |
|
||||
| `repository` | PLUGIN_DOCKER_PORT | `none` | Repository to update with metadata, e.g. `kokuwaio/example` |
|
||||
| `description-short` | PLUGIN_DESCRIPTION_SHORT | `none` | Short description for repository. |
|
||||
| `description-file` | PLUGIN_DESCRIPTION_FILE | `README.md` | File to read full description from |
|
||||
| `categories` | PLUGIN_CATEGORIES | `[]` | List of categories to set (maximum 3) |
|
||||
| `username` | PLUGIN_USERNAME | `none` | Username for Dockerhub login |
|
||||
| `password` | PLUGIN_PASSWORD | `none` | Password for Dockerhub login, **PAT** is not supported! |
|
||||
| Environment | Default | Description |
|
||||
| ------------------------- | ------- | ---------------------------------------------------------------------------------- |
|
||||
| DOCKERD_PORT | `2375` | Specifies the port to listen on |
|
||||
| DOCKERD_SHUTDOWN_TIMEOUT | `0` | Set the default shutdown timeout |
|
||||
| DOCKERD_LOG_LEVEL | `none` | Set the [logging level](https://docs.docker.com/reference/cli/dockerd/#log-format) |
|
||||
| DOCKERD_REGISTRY_MIRROR | `none` | Specifies a list of registry mirrors. |
|
||||
| DOCKERD_INSECURE_REGISTRY | `none | Configure [insecure registry](https://docs.docker.com/reference/cli/dockerd/#insecure-registries) |
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue