{"id":18497839,"url":"https://github.com/containers/shortnames","last_synced_at":"2025-04-05T14:03:40.195Z","repository":{"id":39608429,"uuid":"306375275","full_name":"containers/shortnames","owner":"containers","description":"Shortnames project is collecting registry alias names for shortnames to fully specified container image names.","archived":false,"fork":false,"pushed_at":"2025-03-19T13:10:49.000Z","size":79,"stargazers_count":76,"open_issues_count":0,"forks_count":38,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-03-29T13:04:51.156Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/containers.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-22T15:08:23.000Z","updated_at":"2025-03-20T13:40:01.000Z","dependencies_parsed_at":"2024-12-31T10:13:03.227Z","dependency_job_id":"30589d3c-b760-499b-98c0-3eb57fa9851c","html_url":"https://github.com/containers/shortnames","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/containers%2Fshortnames","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/containers%2Fshortnames/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/containers%2Fshortnames/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/containers%2Fshortnames/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/containers","download_url":"https://codeload.github.com/containers/shortnames/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247345850,"owners_count":20924102,"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":[],"created_at":"2024-11-06T13:36:12.953Z","updated_at":"2025-04-05T14:03:40.172Z","avatar_url":"https://github.com/containers.png","language":"Python","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# containers/shortnames\n\n# Short-Name Aliasing\n\n## What is a short name\n\nWhen tools like [Podman][podman-gh] or [Docker][docker-cli-gh] pull container images, users prefer to use\nshort names like `fedora` or `alpine` rather then fully specified image names\n`registry.fedoraproject.org/fedora` and `docker.io/alpine`, respectively. In\ncontainer engines that allow you to specify more then a single registry for\nstoring container images, using short names can lead to ambiguity.\n\nImagine that I have two registries defined and both contain an image named\n\"foobar\". Now if I specify `foobar`, I am not sure which image I will\nget. There is potential for malicious parties to take advantage of this by\nspoofing images and tricking users into pulling them.\n\nWe are building into these container engine tools the ability to use short name\naliases to help mitigate the risk of pulling the wrong image, especially when\nthe image is a well known short name.\n\nSimilar to aliases in shells such as Bash, a short-name alias has a left-hand name that is\nbeing replaced with a right-hand value. Short-name aliases can now be\nconfigured in the 'registries.conf' file as follows:\n\n```\nunqualified-search-registries=[\"registry.fedoraproject.org\", \"docker.io\"]\n\n[aliases]\n\"fedora\"=\"registry.fedoraproject.org/fedora\"\n```\n\nAll aliases must be specified in the new “aliases” table. Using the above\n'registries.conf' file, Podman will resolve “fedora” immediately and securely to\n“registry.fedoraproject.org/fedora”. We are currently assembling a public list\nof short-name aliases that can be used across the community. Multiple Linux\ndistributions and companies have expressed interest in collaborating with the\ncontainer engines, to help registry their images.\n\n## Goal\n\nThe goal of this REPO is to gather a list of shortnames from the community, to\nallow distributions to ship them in their distributions. The idea is this list\ncould be added to the default 'registries.conf' file shipped by a distro.\n\nThis list is in the open to guarantee fairness. We do not want this to be a\nfree for all land grab, so we will base the list of images on images\nat well known registries and distributions.\n\nIn the case of a conflicts, we will base the shortname on the original source of\nthe image. For example if the Fedora image is available at 'docker.io' as well\nas at 'registry.fedoraproject.org', we will grab it from fedoraproject.\n\nI am sure over time their might be further rules designed if this turns out to\nbe a problem.\n\nOf course distributions are always free to make changes to this list if/when\nthey ship it.\n\n## Contributing\n\nPlease verify that you are not conflicting with existing shortnames, or state\nyour case on why your shortname should replace the existing short names.\n\n## Shipping and Packaging Short-Name Aliases\n\nThe configuration file is intended to be shipped in the `/etc/containers/registries.conf.d` directory. This directory allows for supporting drop-in `registries.conf` configuration files that are loaded in alpha-numerical order. Users can easily add new files manually or via config managers such as Ansible or Salt. Please refer to the [upstream documentation of the containers/image library](https://github.com/containers/image/tree/master/docs) to read more about the `registries.conf` format, and the loading behavior.\n\n## Contact\n\n- IRC: #[containers](ircs://irc.libera.chat:6697/#containers) on libera.chat ([Webchat](https://web.libera.chat/))\n\n[podman-gh]:      https://github.com/containers/podman  \"GitHub: containers/podman\"\n[docker-cli-gh]:  https://github.com/docker/cli         \"GitHub: docker/cli\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainers%2Fshortnames","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcontainers%2Fshortnames","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcontainers%2Fshortnames/lists"}