CONTRIBUTING.md

Running the registry

Running the registry is done via wrangler dev

$ npx wrangler --env dev dev

You can docker login locally for running a push

$ docker login localhost:8787 # Or the URL that your worker is listening in

Note: If you are running Docker desktop in MacOS/Windows, you should add the following to the docker daemon configuration:

{
  "insecure-registries": ["host.docker.internal:8787"]
}

By default in a local environment, the registry uses USERNAME=hello and PASSWORD=world. See the example wrangler config files for more details.

Tag any image that you have locally and push it:

This allows you to instead of using localhost, you are able to use host.docker.internal to access local registries.

$ docker tag my-image:local docker tag localhost:8787/my-image:local && docker push localhost:8787/my-image:local

Testing

Test the registry with unit tests by running vitest with miniflare 3.

$ pnpm test

Making a change

Fork the repository and make changes on a new branch. Then after you're done, submit a PR so the maintainers can review it.