aemdesign/dockerhub-description repository overview

⁠CentOS 7 with Dockerhub Readme Update Script

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⁠
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:

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:

docker run --rm \
    -v $(pwd):/data/ \
    aemdesign/dockerhub-description \
    "$DOCKERHUB_USERNAME" \
    "$DOCKERHUB_PASSWORD" \
    "$DOCKERHUB_REPO" \ 
    "/path/to/parent/with/readme/"

⁠Container Debug

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

⁠Script Parameters

This image uses environment variables for configuration.

⁠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.