search

Joxit / docker-registry-ui

The simplest and most complete UI for your private registry
https://joxit.dev/docker-registry-ui/
GNU Affero General Public License v3.0
2.57k stars 322 forks source link

Allow adding a description for known images #365

Open lukengda opened 8 months ago

lukengda commented 8 months ago

Is your feature request related to a problem? Please describe. We have a limited set of images, that we would like to explain some details for what it does and how it works, similar to the rendered readme in docker hub: https://hub.docker.com/r/joxit/docker-registry-ui. It could be way smaller though for our use case as an MVP.

I would like to make the registry UI help exploring what images are available and what they are used for.

I think, this feature is really missing for "a complete user interface for your private docker registry".

Describe the solution you'd like I thought about providing a json file or some other form of static map, linking to either a static text (I thought about two lines of text explaining the image) or linking to a readme file that is then rendered using e.g. marked. The additional information would be rendered either on top of the tag list or in a separate tab similar to docker hub in case of a full readme.

Describe alternatives you've considered It would also be interesting to think about the image list on the main view, i really like that you get one sentence in search results on docker hub: https://hub.docker.com/search?q=docker-registry-ui

Unfortunately there will not be a cool automatic option to provide the description like docker hub is doing during the build / publish via cli.

Additional context I would personally focus on the tag list view that you get after selecting the image, but both would have their charm and would elevate docker-registry-ui to a hole new level. An MVP solution with a list of texts for known images would be a good solution imho, but we could also experiment with links to README files. I would like to provide an implementation of your recommended path that you would like to see - if you are interested.

Joxit commented 7 months ago

Hi there, I think you missed the point of the description of the project

The simplest and most complete UI for your private registry

The key words are simplest meaning it's easy to use and configure, and then most complete UI for your private registry meaning it uses docker private registry APIs only.

I understand this can be a nice to have, but this project is a UI for private registry, it's not meant to be an OpenSource version of Docker Hub or Quay.io...

Your idea with json or static map could work for small infrastructures, but the maintainability of this solution is not worth the cost of implementing it. My project is used by people with thousands of images... The best way to do it is a full API with a side server for example.

This could be an MVP, but if I'm doing it, it may not be as an OpenSource project, sorry :sweat_smile:.

ArwynFr commented 2 months ago

Perhaps the UI could have an option to list the image labels (with URL rendered as clickable links) ? Then the image author could use that feature to add a link towards the source repository or a README.