https://github.com/aem-design/docker-dockerhub-description

helper image for publishing repo readme files as image descriptions
https://github.com/aem-design/docker-dockerhub-description

devops docker docker-compose documentation

Last synced: 7 days ago
JSON representation

helper image for publishing repo readme files as image descriptions

• Host: GitHub
• URL: https://github.com/aem-design/docker-dockerhub-description
• Owner: aem-design
• License: apache-2.0
• Created: 2019-09-02T04:38:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-15T14:23:32.000Z (over 3 years ago)
• Last Synced: 2024-11-07T01:35:22.126Z (about 2 months ago)
• Topics: devops, docker, docker-compose, documentation
• Language: Shell
• Homepage: http://aem.design
• Size: 41 KB
• Stars: 2
• Watchers: 12
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
## CentOS 7 with Dockerhub Readme Update Script

[![build_status](https://travis-ci.org/aem-design/docker-dockerhub-description.svg?branch=master)](https://travis-ci.org/aem-design/docker-dockerhub-description) 

[![github license](https://img.shields.io/github/license/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) 

[![github issues](https://img.shields.io/github/issues/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) 

[![github last commit](https://img.shields.io/github/last-commit/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) 

[![github repo size](https://img.shields.io/github/repo-size/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) 

[![docker stars](https://img.shields.io/docker/stars/aemdesign/dockerhub-description)](https://hub.docker.com/r/aemdesign/dockerhub-description) 

[![docker pulls](https://img.shields.io/docker/pulls/aemdesign/dockerhub-description)](https://hub.docker.com/r/aemdesign/dockerhub-description) 

[![github release](https://img.shields.io/github/release/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description)

This is docker image based on `alpine`

# Quick Upload to Github 

## Parameters

1. DOCKERHUB_USERNAME user who has access to write to repository

2. DOCKERHUB_PASSWORD user password

3. DOCKERHUB_REPO should be in format `user/repository` ex [aemdesign/dockerhub-description](https://hub.docker.com/r/aemdesign/dockerhub-description)

4. PATH TO README is optional with default `/data/README.md`, you need to mount directory with readme into the `/data/` volume

## Commands

To upload README.md in current directory run following:

```bash

docker run --rm \

    -v $(pwd):/data/ \

    aemdesign/dockerhub-description \

    "$DOCKERHUB_USERNAME" \

    "$DOCKERHUB_PASSWORD" \

    "$DOCKERHUB_REPO"

```

If you need to specify location of readme file run:

```bash

docker run --rm \

    -v $(pwd):/data/ \

    aemdesign/dockerhub-description \

    "$DOCKERHUB_USERNAME" \

    "$DOCKERHUB_PASSWORD" \

    "$DOCKERHUB_REPO" \ 

    "/path/to/parent/with/readme/"

```

# Container Debug

```bash

`docker run -it --rm -v $(pwd):/data --entrypoint=""  aemdesign/dockerhub-description /bin/sh`

```

## Script Parameters

This image uses environment variables for configuration.

|Available variables     |Default value        |Description                                         |

|------------------------|---------------------|----------------------------------------------------|

|`USERNAME`    | no default           | Username for admin of the repo |

|`PASSWORD`    | no default           | User password |

|`REPO` | no default | Full name of repo `Organisation/Name` |

|`README`   | `/data/README.md`           | Readme filename if diffrent|

|`API_URL`           |`https://hub.docker.com/v2`    | URL for dockerhub if diffrent|

## Mount the README.md

By default, if the `README` environment variable is not set, this image always pushes the file

`/data/README.md` as full description to Docker Hub.

For GitHub repositories you can use `-v /path/to/repository:/data/` or if in same directory `-v $(pwd):/data/`.

If your description is not named `README.md` mount the file directory using `-v /path/to/description.md:/data/README.md` or pass it as `README` parameter.