Sign inSign up

antonmatyunin/readme-to-dockerhub

By antonmatyunin

•Updated over 4 years ago

https://github.com/SISheogorath/readme-to-dockerhub

Image
0

132

antonmatyunin/readme-to-dockerhub repository overview

⁠README to Docker Hub

Matrix channel #sheogorath:shivering-isles.com Mastodon at microblog.shivering-isles.com Twitter @SISheogorath

This is a quick hack to push README.md files to Docker hub.

⁠How to use?

Simply build the image using docker build -t readme-to-hub .

and run it with all needed parameter:

docker run --rm \
    -v /path/to/readme.md:/data/README.md \
    -e DOCKERHUB_USERNAME=myhubuser \
    -e DOCKERHUB_PASSWORD=myhubpassword \
    -e DOCKERHUB_REPO_PREFIX=myorga \
    -e DOCKERHUB_REPO_NAME=myrepo \
     readme-to-hub

That's it.

⁠Environment variables

This image uses environment variables for configuration.

Available variablesDefault valueDescription
DOCKERHUB_USERNAMEno defaultThe Username (not mail address) used to authenticate
DOCKERHUB_PASSWORDno defaultPassword of the DOCKERHUB_USERNAME-user
DOCKERHUB_REPO_PREFIX$DOCKERHUB_USERNAMEOrganization or username for the repository
DOCKERHUB_REPO_NAMEno defaultName of the repository you want to push to
README_PATH/data/README.mdPath to the README.me to push
SHORT_DESCRIPTIONno defaultShort description for the Dockerhub repo

⁠Mount the README.md

By default, if the README_PATH 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/.

If your description is not named README.md mount the file directory using -v /path/to/description.md:/data/README.md.

Notice that the filename is case sensitive. If your readme is called readme.md you have to mount the file directly, not the directory

⁠Additional Information

The user you use to push the README.md need to be admin of the repository.

⁠Implementations and references of this image

⁠Updates and updating

To update your setup simply pull the newest image version from docker hub and run it.

⁠Deprecated features

We provide information about features we remove in future.

  • DOCKERHUB_REPO - is renamed to DOCKERHUB_REPO_NAME to be not mixed up with DOCKERHUB_REPO_PREFIX

⁠License

View license information⁠ for the software contained in this image.

Everything in this repository⁠ is published under GPL-3⁠.

⁠User Feedback

⁠Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue⁠.

⁠Contributing

You are invited to contribute new features, fixes, or updates, large or small; I'm always thrilled to receive pull requests.

General guidelines for development can be found at https://shivering-isles.com/contribute⁠

Tag summary

Content type

Image

Digest

Size

76.5 MB

Last updated

over 4 years ago

docker pull antonmatyunin/readme-to-dockerhub