mirror of
https://github.com/Quiq/docker-registry-ui.git
synced 2025-09-23 11:02:05 +00:00
76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
## Docker Registry UI
|
|
|
|
[](https://goreportcard.com/report/github.com/quiq/docker-registry-ui)
|
|
|
|
### Overview
|
|
|
|
* Web UI for Docker Registry 2.6+
|
|
* Browse repositories and tags
|
|
* Display Docker image details by layers including both manifests v1 and v2
|
|
* Fast and small, written on Go
|
|
* Automatically discover an authentication method (basic auth, token service etc.)
|
|
* Caching the list of repositories, tag counts and refreshing in background
|
|
* Event listener of notification events coming from Registry
|
|
* CLI option to maintain the tags retention: purge tags older than X days keeping at least Y tags
|
|
|
|
No TLS or authentication implemented on the UI web server itself.
|
|
Assuming you will proxy it behind nginx, oauth2_proxy or something.
|
|
|
|
Docker images [quiq/docker-registry-ui](https://hub.docker.com/r/quiq/docker-registry-ui/tags/)
|
|
|
|
### Configuration
|
|
|
|
The configuration is stored in `config.yml` and the options are self-descriptive.
|
|
|
|
### Run UI
|
|
|
|
docker run -d -p 8000:8000 --read-only -v /local/config.yml:/opt/config.yml:ro \
|
|
--name=registry-ui quiq/docker-registry-ui
|
|
|
|
To run with your own root CA certificate, add to the command:
|
|
|
|
-v /local/rootcacerts.crt:/etc/ssl/certs/ca-certificates.crt:ro
|
|
|
|
To preserve sqlite db file with event notifications data, add to the command:
|
|
|
|
-v /local/data:/opt/data
|
|
|
|
## Configure event listener on Docker Registry
|
|
|
|
To receive events you need to configure Registry as follow:
|
|
|
|
notifications:
|
|
endpoints:
|
|
- name: docker-registry-ui
|
|
url: http://docker-registry-ui.local:8000/api/events
|
|
headers:
|
|
Authorization: [Bearer abcdefghijklmnopqrstuvwxyz1234567890]
|
|
timeout: 1s
|
|
threshold: 5
|
|
backoff: 10s
|
|
ignoredmediatypes:
|
|
- application/octet-stream
|
|
|
|
Adjust url and token as appropriate.
|
|
|
|
### Schedule a cron task for purging tags
|
|
|
|
The following example shows how to run a cron task to purge tags older than X days but also keep
|
|
at least Y tags no matter how old. Assuming container has been already running.
|
|
|
|
10 3 * * * root docker exec -t registry-ui /opt/docker-registry-ui -purge-tags
|
|
|
|
You can try to run in dry-run mode first to see what is going to be purged:
|
|
|
|
docker exec -t registry-ui /opt/docker-registry-ui -purge-tags -dry-run
|
|
|
|
### Debug mode
|
|
|
|
To increase http request verbosity, run container with `-e GOREQUEST_DEBUG=1`.
|
|
|
|
### Screenshots
|
|
|
|
|
|
|
|
|