{"id":18597726,"url":"https://github.com/aem-design/docker-dockerhub-description","last_synced_at":"2026-02-03T15:33:24.487Z","repository":{"id":80556454,"uuid":"205777737","full_name":"aem-design/docker-dockerhub-description","owner":"aem-design","description":"helper image for publishing repo readme files as image descriptions","archived":false,"fork":false,"pushed_at":"2021-05-15T14:23:32.000Z","size":42,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-06-22T21:42:38.535Z","etag":null,"topics":["devops","docker","docker-compose","documentation"],"latest_commit_sha":null,"homepage":"http://aem.design","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aem-design.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"maxbarrass","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-09-02T04:38:48.000Z","updated_at":"2021-05-15T14:23:34.000Z","dependencies_parsed_at":"2024-04-08T00:32:47.648Z","dependency_job_id":null,"html_url":"https://github.com/aem-design/docker-dockerhub-description","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/aem-design/docker-dockerhub-description","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aem-design%2Fdocker-dockerhub-description","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aem-design%2Fdocker-dockerhub-description/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aem-design%2Fdocker-dockerhub-description/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aem-design%2Fdocker-dockerhub-description/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aem-design","download_url":"https://codeload.github.com/aem-design/docker-dockerhub-description/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aem-design%2Fdocker-dockerhub-description/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29047911,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T15:19:55.533Z","status":"ssl_error","status_checked_at":"2026-02-03T15:13:09.723Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devops","docker","docker-compose","documentation"],"created_at":"2024-11-07T01:29:13.257Z","updated_at":"2026-02-03T15:33:24.465Z","avatar_url":"https://github.com/aem-design.png","language":"Shell","readme":"## CentOS 7 with Dockerhub Readme Update Script\n\n[![build_status](https://travis-ci.org/aem-design/docker-dockerhub-description.svg?branch=master)](https://travis-ci.org/aem-design/docker-dockerhub-description) \n[![github license](https://img.shields.io/github/license/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) \n[![github issues](https://img.shields.io/github/issues/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) \n[![github last commit](https://img.shields.io/github/last-commit/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) \n[![github repo size](https://img.shields.io/github/repo-size/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description) \n[![docker stars](https://img.shields.io/docker/stars/aemdesign/dockerhub-description)](https://hub.docker.com/r/aemdesign/dockerhub-description) \n[![docker pulls](https://img.shields.io/docker/pulls/aemdesign/dockerhub-description)](https://hub.docker.com/r/aemdesign/dockerhub-description) \n[![github release](https://img.shields.io/github/release/aem-design/dockerhub-description)](https://github.com/aem-design/dockerhub-description)\n\nThis is docker image based on `alpine`\n\n# Quick Upload to Github \n\n## Parameters\n\n1. DOCKERHUB_USERNAME user who has access to write to repository\n2. DOCKERHUB_PASSWORD user password\n3. DOCKERHUB_REPO should be in format `user/repository` ex [aemdesign/dockerhub-description](https://hub.docker.com/r/aemdesign/dockerhub-description)\n4. PATH TO README is optional with default `/data/README.md`, you need to mount directory with readme into the `/data/` volume\n\n## Commands\n\nTo upload README.md in current directory run following:\n\n```bash\ndocker run --rm \\\n    -v $(pwd):/data/ \\\n    aemdesign/dockerhub-description \\\n    \"$DOCKERHUB_USERNAME\" \\\n    \"$DOCKERHUB_PASSWORD\" \\\n    \"$DOCKERHUB_REPO\"\n```\n\nIf you need to specify location of readme file run:\n\n```bash\ndocker run --rm \\\n    -v $(pwd):/data/ \\\n    aemdesign/dockerhub-description \\\n    \"$DOCKERHUB_USERNAME\" \\\n    \"$DOCKERHUB_PASSWORD\" \\\n    \"$DOCKERHUB_REPO\" \\ \n    \"/path/to/parent/with/readme/\"\n```\n\n# Container Debug\n\n```bash\n`docker run -it --rm -v $(pwd):/data --entrypoint=\"\"  aemdesign/dockerhub-description /bin/sh`\n```\n\n\n## Script Parameters\n\nThis image uses environment variables for configuration.\n\n|Available variables     |Default value        |Description                                         |\n|------------------------|---------------------|----------------------------------------------------|\n|`USERNAME`    | no default           | Username for admin of the repo |\n|`PASSWORD`    | no default           | User password |\n|`REPO` | no default | Full name of repo `Organisation/Name` |\n|`README`   | `/data/README.md`           | Readme filename if diffrent|\n|`API_URL`           |`https://hub.docker.com/v2`    | URL for dockerhub if diffrent|\n\n## Mount the README.md\n\nBy default, if the `README` environment variable is not set, this image always pushes the file\n`/data/README.md` as full description to Docker Hub.\n\nFor GitHub repositories you can use `-v /path/to/repository:/data/` or if in same directory `-v $(pwd):/data/`.\n\nIf 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.\n","funding_links":["https://patreon.com/maxbarrass"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faem-design%2Fdocker-dockerhub-description","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faem-design%2Fdocker-dockerhub-description","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faem-design%2Fdocker-dockerhub-description/lists"}