Mirrors/mash-playbook
2
0
Fork 0
mirror of https://github.com/mother-of-all-self-hosting/mash-playbook synced 2024-11-10 14:24:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

add docker registry proxy docs

Browse source
This commit is contained in:
Aine 2024-03-07 00:33:42 +02:00
parent b7561cf156
commit 11ee1202ce
No known key found for this signature in database
GPG key ID: 34969C908CCA2804
2 changed files with 54 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
docs/services/docker-registry-proxy.md Normal file
View file

@ -0,0 +1,53 @@
# Docker Registry Proxy
[Docker Registry Proxy](https://gitlab.com/etke.cc/docker-registry-proxy/) is a pass-through docker registry (distribution) proxy with metadata caching, docker-compatible errors, prometheus metrics, etc.
## Dependencies
This service requires the following other services:
- a [Traefik](traefik.md) reverse-proxy server
## Configuration
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
```yaml
########################################################################
# #
# docker-registry-proxy #
# #
########################################################################
docker_registry_proxy_enabled: true
docker_registry_proxy_hostname: registry.example.com
# List of the IPs allowed to access the registry (GET, HEAD, OPTIONS requests only)
docker_registry_proxy_allowed_ips: []
# List of the User Agent names(!) allowed to access the registry (GET, HEAD, OPTIONS requests only)
docker_registry_proxy_allowed_uas:
- docker
# List of the IPs trusted to access the registry (PATCH, POST, PUT, DELETE requests only)
docker_registry_proxy_trusted_ips: []
########################################################################
# #
# /docker-registry-proxy #
# #
########################################################################
```
In the example configuration above, we configure the service to be hosted at `https://registry.example.com`.
## Usage
After installation, you should be able to go to the URL as configured via `docker_registry_proxy_hostname`.
## Recommended other services
- [Docker Registry](docker-registry.md) - a container image distribution registry developed by [Docker Inc](https://www.docker.com/), wired automatically to the proxy, just disable registry's traefik labels

1
docs/supported-services.md
View file

@ -16,6 +16,7 @@
| [Docker](https://www.docker.com/) | Open-source software for deploying containerized applications | [Link](services/docker.md) |
| [Docker Registry](https://docs.docker.com/registry/) | A container image distribution registry | [Link](services/docker-registry.md) |
| [Docker Registry Browser](https://github.com/klausmeyer/docker-registry-browser) | Web Interface for the Docker Registry HTTP API V2 written in Ruby on Rails | [Link](services/docker-registry-browser.md) |
| [Docker Registry Proxy](https://gitlab.com/etke.cc/docker-registry-proxy/) | Pass-through docker registry (distribution) proxy with metadata caching, docker-compatible errors, prometheus metrics, etc. | [Link](services/docker-registry-proxy.md) |
| [Docker Registry Purger](https://github.com/devture/docker-registry-purger) | A small tool used for purging a private Docker Registry's old tags | [Link](services/docker-registry-purger.md) |
| [Echo IP](https://github.com/mpolden/echoip) | A simple service for looking up your IP address | [Link](services/echoip.md) |
| [etcd](https://etcd.io/) | A distributed, reliable key-value store for the most critical data of a distributed system | [Link](services/etcd.md) |