{"id":13446695,"url":"https://github.com/christian-korneck/docker-pushrm","last_synced_at":"2025-08-14T14:31:17.155Z","repository":{"id":40893129,"uuid":"267186658","full_name":"christian-korneck/docker-pushrm","owner":"christian-korneck","description":"\"Docker Push Readme\" - a Docker CLI plugin to update container repo docs","archived":false,"fork":false,"pushed_at":"2024-06-10T21:42:09.000Z","size":340,"stargazers_count":140,"open_issues_count":5,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-12-03T10:44:24.812Z","etag":null,"topics":["container-registry","containers","docker","docker-cli-plugin","dockerhub","harbor","podman","quay"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/christian-korneck.png","metadata":{"files":{"readme":"README-containers.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2020-05-27T01:02:11.000Z","updated_at":"2024-12-01T13:34:45.000Z","dependencies_parsed_at":"2024-01-28T13:11:59.913Z","dependency_job_id":"3391d458-5aec-4d5d-afcd-ddbc25a386df","html_url":"https://github.com/christian-korneck/docker-pushrm","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fdocker-pushrm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fdocker-pushrm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fdocker-pushrm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christian-korneck%2Fdocker-pushrm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christian-korneck","download_url":"https://codeload.github.com/christian-korneck/docker-pushrm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229834455,"owners_count":18131460,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["container-registry","containers","docker","docker-cli-plugin","dockerhub","harbor","podman","quay"],"created_at":"2024-07-31T05:00:57.175Z","updated_at":"2024-12-15T15:10:36.840Z","avatar_url":"https://github.com/christian-korneck.png","language":"Go","funding_links":[],"categories":["Container Operations","Development","Projects","User Interfaces","Filesystem","Go","Build \u0026 Packaging Automation"],"sub_categories":["User Interface","Docker","Terminal"],"readme":"# Docker Push Readme\n\nThis is a container image of [`docker-pushrm`](https://github.com/christian-korneck/docker-pushrm), a tool that lets you update the README of your container repo on Dockerhub, Quay or Harbor from a local markdown file.\n\n![hello moon](https://raw.githubusercontent.com/christian-korneck/docker-pushrm/master/assets/container_registries.png)\n\n## About this tool\n\nCheck the [full docs](https://github.com/christian-korneck/docker-pushrm/blob/master/README.md) for an introduction.\n\n## How to use this container image\n\n### Examples\n\n#### Push a README file to Dockerhub\n\n```\n$ ls\nREADME.md\n\n$ docker run --rm -t \\\n-v $(pwd):/myvol \\\n-e DOCKER_USER='my-user' -e DOCKER_PASS='my-pass' \\\nchko/docker-pushrm:1 --file /myvol/README.md \\ \n--short \"My short description\" --debug my-user/my-repo\n\n...\nDEBU content validation successfull, readme successfully pushed to repo server\n```\n\nLet's dissect this a bit:\n\n- we pin to the major version (`v1`) of this image (`chko/docker-pushrm:v1`). Recommended for most use cases.\n- the README file is in the current working directory on the host. We map this dir as volume to the container (mounted at `/myvol`)\n- we tell *docker-pushrm* where to find the README file with `--file \u003cpath\u003e`\n- our destination repo on Dockerhub is `my-user/my-repo`\n- we pass the credentials for the repo as environment variables to the container (`DOCKER_USER` and `DOCKER_PASS`)\n- we set `--debug` to get additional log output (optional)\n- we set the short description for the Dockerhub repo with `--short \u003cstring\u003e` (optional)\n\n**Alternatively all params can also get set with environment variables:**\n\n```\n$ docker run --rm -t \\\n-v $(pwd):/myvol \\\n-e DOCKER_USER='my-user' -e DOCKER_PASS='my-pass' \\\n-e PUSHRM_PROVIDER=dockerhub -e PUSHRM_FILE=/myvol/README.md \\\n-e PUSHRM_SHORT='my short description' \\\n-e PUSHRM_TARGET=docker.io/my-user/my-repo -e PUSHRM_DEBUG=1 \\\nchko/docker-pushrm:1\n```\n\n#### Push a README file to a Harbor v2 registry server\n\nUse the `--provider harbor2` flag:\n\n```\n$ ls\nREADME.md\n\n$ docker run --rm -t \\\n-v $(pwd):/myvol \\\n-e DOCKER_USER='my-user' -e DOCKER_PASS='my-pass' \\\nchko/docker-pushrm:1 --file /myvol/README.md \\ \n--provider harbor2 --debug demo.goharbor.io/my-project/my-repo\n```\n\n#### Push a README file to Quay.io or a Quay registry server\n\n\n- use the `--provider quay` flag\n- use env var `APIKEY__\u003cSERVER\u003e_\u003cDOMAIN\u003e` or `DOCKER_APIKEY` for apikey credentials\n\n```\n$ ls\nREADME.md\n\n$ docker run --rm -t \\\n-v $(pwd):/myvol \\\n-e APIKEY__QUAY_IO='my-apikey' \\\nchko/docker-pushrm:1 --file /myvol/README.md \\ \n--provider quay --debug quay.io/my-user/my-repo\n```\n\n### env vars\n\n| env var                     | example value                  | description\n| --------------------------- | ------------------------------ | ----------------------------------------\n| `DOCKER_USER`               | `my-user`                      | login username\n| `DOCKER_PASS`               | `my-password`                  | login password\n| `DOCKER_APIKEY`             | `my-quay-api-key`              | quay api key\n| `APIKEY__\u003cSERVER\u003e_\u003cDOMAIN\u003e` | `my-quay-api-key`              | quay api key (alternative)\n| `PUSHRM_PROVIDER`           | `dockerhub`, `quay`, `harbor2` | repo provider type\n| `PUSHRM_SHORT`              | `my short description`         | set/update repo short description\n| `PUSHRM_FILE`               | `/myvol/README.md`             | path to the README file\n| `PUSHRM_DEBUG`              | `1`                            | enable verbose output\n| `PUSHRM_CONFIG`             | `/myvol/.docker/config.json`   | Docker config file (for credentials)\n| `PUSHRM_TARGET`             | `docker.io/my-user/my-repo`    | container repo ref\n\nPresedence:\n- Params specified with flags take precedence over env vars.\n- Login env vars take precedence over credentials from a Docker config file\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristian-korneck%2Fdocker-pushrm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristian-korneck%2Fdocker-pushrm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristian-korneck%2Fdocker-pushrm/lists"}