Need help with docker-registry-ui?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Joxit
770 Stars 123 Forks GNU Affero General Public License v3.0 335 Commits 18 Opened issues

Description

The simplest and most complete UI for your private registry

Services available

!
?

Need anything else?

Contributors list

# 84,836
HTML
golang
React
Applica...
240 commits
# 214,276
aws-s3
s3
CSS
HTML
29 commits
# 41,320
gitlab
golang
Telegra...
riotjs
11 commits
# 275,184
HTML
Shell
riotjs
Docker
2 commits
# 521,229
CSS
HTML
Shell
riotjs
1 commit
# 35,980
Terrafo...
Ruby
Rails
rubocop
1 commit
# 145,814
C++
asio
Shell
C
1 commit
# 494,114
CSS
HTML
Shell
riotjs
1 commit
# 517,318
CSS
HTML
riotjs
Docker
1 commit
# 190,444
C++
C
Shell
angular...
1 commit
# 512,447
CSS
HTML
Shell
riotjs
1 commit
# 525,895
CSS
HTML
Shell
riotjs
1 commit
# 340,730
C++
C
Shell
riotjs
1 commit

title: Docker Registry User Interface

Docker Registry UI

Stars Pulls

Overview

:warning:

joxit/docker-registry-ui:master
and
joxit/docker-registry-ui:main
tags contains unreleased v2.0.0 version!

This project aims to provide a simple and complete user interface for your private docker registry. You can customize the interface with various options. The major option is

SINGLE_REGISTRY
which allows you to disable the dynamic selection of docker registeries (same behavior as the old static tag).

You may need the migration guide from 1.x to 2.x or the 1.x readme

This web user interface uses Riot the react-like user interface micro-library and riot-mui components.

Project Page, Live Demo, Examples

preview

Features

  • List all your repositories/images.
  • List all tags for a image.
  • Sort the tag list with number compatibility (see #46).
  • Use a secured docker registry.
  • Display image size (see #30).
  • Multi arch supports, Alpine and Debian based images with supports for arm32v7 and arm64v8.
  • Copy
    docker pull
    command to clipboard (see #42).
  • Show sha256 for specific tag (hover image tag).
  • Display image creation date (see #49)
  • Display image history (see #58 & #61).
  • Image aggregation (see #56).
  • Display image/tag count (see #56 issue comment).
  • Select multiple tags to delete (see #29).
  • Select all tags with ALT + Click to delete (see #80).
  • One interface for many registries (when
    SINGLE_REGISTRY=false
    ).
  • Share your docker registry with query parameter
    url
    (e.g.
    https://joxit.dev/docker-registry-ui/demo?url=https://registry.example.com
    ) (when
    SINGLE_REGISTRY=false
    ).
  • Use the UI as reverse proxy (with
    REGISTRY_URL
    environment variable) to your docker registry (This will avoid CORS).
  • Add Title when using
    REGISTRY_URL
    (see #28).
  • Customise docker pull command on static registry UI (see #71).
  • Add custom header via environment variable and file via
    NGINX_PROXY_HEADER_*
    (see #89)
  • Show/Hide content digest in taglist via
    SHOW_CONTENT_DIGEST
    (values are: [
    true
    ,
    false
    ], default:
    true
    ) (see #126).
  • Limit the number of elements in the image list via
    CATALOG_ELEMENTS_LIMIT
    (see #127).
  • Multi arch support in history page (see #130 and #134)

FAQ

  • What is the difference between
    SINGLE_REGISTRY=false
    and
    SINGLE_REGISTRY=true
    options ?
    • When
      SINGLE_REGISTRY
      is set to false, a menu appears on the interface allowing you to dynamically change docker registry URLs.
  • Why, when I delete all tags of an image, the image is still in the UI ?
    • This is a limitation of docker registry, the garbage collector don't remove empty images. If you want to delete dangling images, you will need to delete the folder in your registry data. (see #77)
  • Why the image size in the UI is not the same as displayed during
    docker images
    ?
    • The UI displays the compressed size of the image and not the extracted size version.
  • Can I use HTTPS on the UI ?
    • Yes, put your favourite reverse proxy on the front of the UI. Your reverse proxy will take care of HTTPS connection.
  • Does the UI support authentication ?
    • Yes, but it supports only basic auth. It's a simple standalone frontend, it will use your browser window for authentication.
  • Can I use the UI and docker client with an insecure registry (registry url without https) ?
    • Yes you can, you must first configure your docker client. (see #76)
  • What does Mixed Content error mean ?
    • This means you are using a UI with HTTPS and your registry is using HTTP (unsecured). When you are on a HTTPS site, you can't get HTTP content. Upgrade you registry with a HTTPS connection.
  • Why the default nginx
    Host
    is set to
    $http_host
    ?
    • This fixes the issue #88. More about this in #113.
  • Why DELETE fails with 401 status code (using Basic Auth) ?
    • This is caused by a bug in docker registry, I suggest to have your UI on the same domain than your registry e.g. registry.example.com/ui/. (see #104).
  • Can I use the docker registry ui as a standalone application (with Electron) ?
    • Yes, check out the example here. (see #129)
  • I deleted images through the UI, but they are still present on the server. How can I delete them?
    • When you delete an image with the UI, only the reference is deleted and not the content. To remove dangling images, you need to run the garbage collector of the registry with the command
      registry garbage-collect config.yml
      or
      docker exec registry registry garbage-collect config.yml
      . (see #77 #147)
  • Why when I delete one tag, all tags with the same SHA are deleted ?
    • This a docker registry API limitation, there is only one way to delete images with tag, it's by its
      name
      and its
      manifest
      (it's a sha of the content). So when you delete a tag, this will delete all tags of this image with the same SHA/manifest.

Need more informations ? Try my examples or open an issue.

Available options

Some env options are available for use this interface for only one server.

  • REGISTRY_URL
    : The default url of your docker registry. You may need CORS configuration on your registry. (default: derived from the hostname of your UI).
  • REGISTRY_TITLE
    : Set a custom title for your user interface. (default: value derived from
    REGISTRY_URL
    ).
  • PULL_URL
    : Set a custom url when you copy the
    docker pull
    command. (default: value derived from
    REGISTRY_URL
    ).
  • DELETE_IMAGES
    : Set if we can delete images from the UI. (default:
    false
    )
  • SHOW_CONTENT_DIGEST
    : Show content digest in docker tag list. (default:
    true
    )
  • CATALOG_ELEMENTS_LIMIT
    : Limit the number of elements in the catalog page. (default:
    100000
    ).
  • SINGLE_REGISTRY
    : Remove the menu that show the dialogs to add, remove and change the endpoint of your docker registry. (default
    false
    )
  • NGINX_PROXY_PASS_URL
    : Update the default Nginx configuration and set the proxy_pass to your backend docker registry (this avoid CORS configuration).
  • NGINX_PROXY_HEADER_*
    : Update the default Nginx configuration and set custom headers for your backend docker registry. Only when
    NGINX_PROXY_PASS_URL
    is used.

There are some examples with docker-compose and docker-registry-ui as proxy here or docker-registry-ui as standalone here.

Using CORS

Your server should be configured to accept CORS.

If your docker registry does not need credentials, you will need to send this HEADER:

Access-Control-Allow-Origin: ['*']

If your docker registry need credentials, you will need to send these HEADERS:

http:
  headers:
    Access-Control-Allow-Origin: ['']
    Access-Control-Allow-Credentials: [true]
    Access-Control-Allow-Headers: ['Authorization', 'Accept']
    Access-Control-Allow-Methods: ['HEAD', 'GET', 'OPTIONS'] # Optional

An alternative for CORS issues is a plugin on your browser, more info here (thank you xmontero).

Using delete

For deleting images, you need to activate the delete feature in your registry:

storage:
    delete:
      enabled: true

And you need to add these HEADERS:

http:
  headers:
    Access-Control-Allow-Methods: ['HEAD', 'GET', 'OPTIONS', 'DELETE']
    Access-Control-Expose-Headers: ['Docker-Content-Digest']

If you are running the static interface don't forget the environment variable

DELETE_IMAGES
.

Registry example

Example of docker registry configuration file:

version: 0.1
log:
  fields:
    service: registry
storage:
  delete:
    enabled: true
  cache:
    blobdescriptor: inmemory
  filesystem:
    rootdirectory: /var/lib/registry
http:
  addr: :5000
  headers:
    X-Content-Type-Options: [nosniff]
    Access-Control-Allow-Origin: ['http://127.0.0.1:8000']
    Access-Control-Allow-Methods: ['HEAD', 'GET', 'OPTIONS', 'DELETE']
    Access-Control-Allow-Headers: ['Authorization', 'Accept']
    Access-Control-Max-Age: [1728000]
    Access-Control-Allow-Credentials: [true]
    Access-Control-Expose-Headers: ['Docker-Content-Digest']
auth:
  htpasswd:
    realm: basic-realm
    path: /etc/docker/registry/htpasswd

Standalone Application

If you do not want to install the docker-registry-ui on your server, you may check out the Electron standalone application.

All examples

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.