github/docker-registry-ui
1
0
Fork 1
mirror of https://github.com/Quiq/docker-registry-ui.git synced 2025-07-18 00:01:20 +00:00
Code Issues Projects Releases Wiki Activity

Add a quick start section in the README file

Browse Source
This commit is contained in:
Enrique Hernández Bello 2024-12-06 17:26:41 +00:00
parent 1ddb55e88f
commit 9368d74b92
No known key found for this signature in database
GPG Key ID: 420F5E083412F1D5
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -23,6 +23,23 @@ Assuming you will put it behind nginx, oauth2_proxy or similar.
Docker images [quiq/registry-ui](https://hub.docker.com/r/quiq/registry-ui/tags/)
### Quick start
Run a Docker registry in your host (if you don't already had one):
docker run -d --network host \
--name registry registry:2
Run registry UI directly connected to it:
docker run -d --network host \
-e REGISTRY_HOSTNAME=127.0.0.1:5000 \
-e REGISTRY_INSECURE=true \
--name registry-ui quiq/registry-ui
Push any Docker image to 127.0.0.1:5000/owner/name and go into http://127.0.0.1:8000 with
your web browser.
### Configuration
The configuration is stored in `config.yml` and the options are self-descriptive.
@ -30,7 +47,7 @@ The configuration is stored in `config.yml` and the options are self-descriptive
You can override any config option via environment variables using SECTION_KEY_NAME syntax,
e.g. `LISTEN_ADDR`, `PERFORMANCE_TAGS_COUNT_REFRESH_INTERVAL`, `REGISTRY_HOSTNAME` etc.
### Run UI
Passing the full config file through:
docker run -d -p 8000:8000 -v /local/config.yml:/opt/config.yml:ro quiq/registry-ui