build: release 2.5.0 🚀

CONTRIBUTORS.md

@@ -15,6 +15,7 @@
 - Murad [@muradheydarov](https://github.com/muradheydarov)
 - Giacomo Mazzamuto [@gmazzamuto](https://github.com/gmazzamuto)
 - Joe Bureau [@jabstone](https://github.com/jabstone)
+- Artur Mostowski [@Vulwsztyn](https://github.com/Vulwsztyn)
 
 ## Because committers are not the only contributors
 
@@ -44,3 +45,11 @@
 - [@JKDingwall](https://github.com/JKDingwall)
 - Martin Herren [@MartinHerren](https://github.com/MartinHerren)
 - John Daktylidis [@Greek64](https://github.com/Greek64)
+- Philipp Staiger [@lippl](https://github.com/lippl)
+- [@mexaniksmirnov](https://github.com/mexaniksmirnov)
+- [@HighOnMikey](https://github.com/HighOnMikey)
+- [@logopk](https://github.com/logopk)
+- Gustaf Järgren [@GoryMoon](https://github.com/GoryMoon)
+- [@ArwynFr](https://github.com/ArwynFr)
+- Nikita Matushkin [@yourh3ro](https://github.com/yourh3ro)
+- Michael Grote [@quotengrote](https://github.com/quotengrote)

README.md

@@ -4,6 +4,7 @@
 [![Pulls](https://img.shields.io/docker/pulls/joxit/docker-registry-ui.svg?maxAge=86400)](https://hub.docker.com/r/joxit/docker-registry-ui)
 [![Sponsor](https://joxit.dev/images/sponsor.svg)](https://github.com/sponsors/Joxit)
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/joxit)](https://artifacthub.io/packages/search?repo=joxit)
+[![Version](https://img.shields.io/github/release/joxit/docker-registry-ui?display_name=tag&sort=semver)](https://github.com/Joxit/docker-registry-ui/releases)
 
 ## Overview
 
@@ -15,6 +16,16 @@ This web user interface uses [Riot](https://github.com/Riot/riot) the react-like
 
 If you like my work and want to support it, don't hesitate to [sponsor me](https://github.com/sponsors/Joxit).
 
+## Supported Docker tags
+
+* `latest`: image with the latest release of Docker Registry UI based on `nginx:alpine`
+* `latest-debian`: image with the latest release of Docker Registry UI based on `nginx:debian`
+* `main`, `master`: image with the beta version of  Docker Registry UI based on `nginx:alpine`
+* `main-debian`, `master-debian`: image with the beta version of  Docker Registry UI based on `nginx:debian`
+* `2`: image with the latest release of Docker Registry UI v2 (includes latest minor and patch version)
+* `2.x`: image with the latest release of Docker Registry UI v2.x (includes latest patch version)
+* `2.x.y`: image with the specific release of Docker Registry UI v2.x.y
+
 ## [Project Page](https://joxit.dev/docker-registry-ui), [Live Demo](https://joxit.dev/docker-registry-ui/demo/), [Examples](https://github.com/Joxit/docker-registry-ui/tree/main/examples), [Helm Chart](https://helm.joxit.dev/)
 
 ![preview](https://raw.github.com/Joxit/docker-registry-ui/main/docker-registry-ui.gif "Preview of Docker Registry UI")
@@ -34,6 +45,7 @@ If you like my work and want to support it, don't hesitate to [sponsor me](https
   - You can select the search bar with the shortcut `CRTL + F` or `F3`. When the search bar is already focused, the shortcut will fallback to the default behavior (see [#213](https://github.com/Joxit/docker-registry-ui/issues/213)). Since 2.1.0
 - Multi arch support in history page (see [#130](https://github.com/Joxit/docker-registry-ui/issues/130) and [#134](https://github.com/Joxit/docker-registry-ui/pull/134)). Since 1.5.0
 - Show the content of the dockerfile (see [#286](https://github.com/Joxit/docker-registry-ui/pull/286)). Since 2.4.0
+- The UI will cache requests from your registry, such as blobs and some manifets (URL with `sha256:`).
 
 Checkout all options in [Available options](#available-options) section.
 
@@ -93,7 +105,7 @@ Some env options are available for use this interface for **only one server** (w
 - `NGINX_LISTEN_PORT`: Listen on a port other than 80, you can also change the default user and set to nginx `--user nginx` (see [#224](https://github.com/Joxit/docker-registry-ui/issues/224) and [#234](https://github.com/Joxit/docker-registry-ui/pull/234)). (default: `80` when the user is root, `8080` otherwise). Since 2.2.0
 - `DEFAULT_REGISTRIES`: List of comma separated registry URLs (e.g `http://registry.example.com,http://registry:5000`), available only when `SINGLE_REGISTRY=false` (see [#219](https://github.com/Joxit/docker-registry-ui/pull/219)). (default: ` `). Since 2.1.0
 - `READ_ONLY_REGISTRIES`: Deactivate dialog for remove and add new registries, available only when `SINGLE_REGISTRY=false` (see [#219](https://github.com/Joxit/docker-registry-ui/pull/219)). (default: `false`). Since 2.1.0
-- `SHOW_CATALOG_NB_TAGS`: Show number of tags per images on catalog page. This will produce + nb images requests, not recommended on large registries (see [#161](https://github.com/Joxit/docker-registry-ui/issues/161) and [#239](https://github.com/Joxit/docker-registry-ui/pull/239)). (default: `false`). Since 2.2.0
+- `SHOW_CATALOG_NB_TAGS`: Show number of tags per images on catalog page and hide images with 0 tags. This will produce + nb images requests, **not recommended on large registries** (see [#161](https://github.com/Joxit/docker-registry-ui/issues/161) and [#239](https://github.com/Joxit/docker-registry-ui/pull/239)). (default: `false`). Since 2.2.0
 - `HISTORY_CUSTOM_LABELS`: Expose custom labels in history page, custom labels will be processed like maintainer label (see [#160](https://github.com/Joxit/docker-registry-ui/issues/160) and [#240](https://github.com/Joxit/docker-registry-ui/pull/240)). Since 2.2.0
 - `USE_CONTROL_CACHE_HEADER`: Use `Control-Cache` header and set to `no-store, no-cache`. This will avoid some issues on multi-arch images (see [#260](https://github.com/Joxit/docker-registry-ui/issues/260) and [#265](https://github.com/Joxit/docker-registry-ui/pull/265)). This option requires registry configuration: `Access-Control-Allow-Headers` with `Cache-Control`. (default: `false`). Since 2.3.0
 - `THEME`: Chose your default theme, could be `dark`, `light` or `auto` (see [#283](https://github.com/Joxit/docker-registry-ui/pull/283)). When auto is selected, you will have a switch to manually change from light to dark and vice-versa (see [#291](https://github.com/Joxit/docker-registry-ui/pull/291)). (default: `auto`). Since 2.4.0
@@ -124,6 +136,48 @@ This featureswas added to version 2.4.0. See more about this in [#283](https://g
 | `THEME_FOOTER_NEUTRAL_TEXT` | `#999999` | `#999999` |
 | `THEME_FOOTER_BACKGROUND` | `#555555` | `#555555` |
 
+## Recommended Docker Registry Usage
+
+Here is a simple usage of Docker Registry UI with Docker Registry Server using docker-compose. This example should work for most of your use case and your UI will be on the same domain as you registry.
+
+```yml
+version: '3.8'
+
+services:
+  registry-ui:
+    image: joxit/docker-registry-ui:main
+    restart: always
+    ports:
+      - 80:80
+    environment:
+      - SINGLE_REGISTRY=true
+      - REGISTRY_TITLE=Docker Registry UI
+      - DELETE_IMAGES=true
+      - SHOW_CONTENT_DIGEST=true
+      - NGINX_PROXY_PASS_URL=http://registry-server:5000
+      - SHOW_CATALOG_NB_TAGS=true
+      - CATALOG_MIN_BRANCHES=1
+      - CATALOG_MAX_BRANCHES=1
+      - TAGLIST_PAGE_SIZE=100
+      - REGISTRY_SECURED=false
+      - CATALOG_ELEMENTS_LIMIT=1000
+    container_name: registry-ui
+
+  registry-server:
+    image: registry:2.8.2
+    restart: always
+    environment:
+      REGISTRY_HTTP_HEADERS_Access-Control-Origin: '[http://registry.example.com]'
+      REGISTRY_HTTP_HEADERS_Access-Control-Allow-Methods: '[HEAD,GET,OPTIONS,DELETE]'
+      REGISTRY_HTTP_HEADERS_Access-Control-Credentials: '[true]'
+      REGISTRY_HTTP_HEADERS_Access-Control-Allow-Headers: '[Authorization,Accept,Cache-Control]'
+      REGISTRY_HTTP_HEADERS_Access-Control-Expose-Headers: '[Docker-Content-Digest]'
+      REGISTRY_STORAGE_DELETE_ENABLED: 'true'
+    volumes:
+      - ./registry/data:/var/lib/registry
+    container_name: registry-server
+```
+
 ## Using CORS
 
 Your server should be configured to accept CORS.