diff --git a/README.md b/README.md index 6817356d..7b0df8a1 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Examples of config files are available in [examples/](examples/) dir. The [Dockerfile](./Dockerfile) in this repo can be used to build a container image that runs _zot_. -To build the image: +To build the image with ref `zot:latest`: ``` make image @@ -69,25 +69,21 @@ Then run the image with your preferred container runtime: ``` # with podman -podman run --rm -p 5000:5000 \ - -v $(pwd)/registry:/var/lib/registry \ - zot:latest +podman run --rm -p 5000:5000 -v $(pwd)/registry:/var/lib/registry zot:latest # with docker -docker run --rm -p 5000:5000 \ - -v $(pwd)/registry:/var/lib/registry \ - zot:latest +docker run --rm -p 5000:5000 -v $(pwd)/registry:/var/lib/registry zot:latest ``` -By default, the server will use no auth, listen on port 5000, -and store content at `/var/lib/registry`. +This will run a registry at http://localhost:5000, storing content at `./registry` +(bind mounted to `/var/lib/registry` in the container). By default, auth is disabled. If you wish use custom configuration settings, you can override the YAML config file located at `/etc/zot/config.yml`: ``` # Example: using a local file "custom-config.yml" that -# listens on port 8080 and uses /tmp/zot for storage +# listens on port 8080 and uses /tmp/zot for storage root podman run --rm -p 8080:8080 \ -v $(pwd)/custom-config.yml:/etc/zot/config.yml \ -v $(pwd)/registry:/tmp/zot \