Sign inSign up

tmfalcon/dockerhub-description-updater

By tmfalcon

•Updated over 6 years ago

Image
0

1.1K

tmfalcon/dockerhub-description-updater repository overview

TMFalcon

⁠TMFalcon: DockerHub Description Updater

A docker image that can be used to update your DockerHub repository description based on README.md file.

Source code: GitHub⁠

Build Status

This page has been updated automatically by using the 'DockerHub Description Updater' tool.

⁠Tags / Versions

NameDescription
1.0.0Base build. Works as expected.

⁠Usage

# You can map the README.md file directly.
docker run --rm \
-v "$(pwd)/README.md:/tmf/README.md \
-e USER=xxxx \
-e PASSWORD=xxxx \
-e REPO_NAME=xxxx \
tmfalcon/dockerhub-description-updater

# Or make sure your current directory has the README.md file present and use:
docker run --rm \
-v "$(pwd):/tmf \
-e USER=xxxx \
-e PASSWORD=xxxx \
-e REPO_NAME=xxxx \
tmfalcon/dockerhub-description-updater

⁠Environment Variables

NameDescription
USERYour DockerHub username.
PASSWORDYour DockerHub password.
REPO_NAMEYour DockerHub repository name.

⁠Volumes

You should map your README.md file to /tmf/README.md using volume bindings. -v "$(pwd)/README.md:/tmf/README.md"

Note that sometimes you have to wrap $(pwd) in quotes.


⁠Support

Reach out to us at one of the following places!


⁠License

License

Tag summary

Content type

Image

Digest

Size

64.4 MB

Last updated

over 6 years ago

docker pull tmfalcon/dockerhub-description-updater