YAML Configuration Generator

The generator starts from the default configuration shipped in the image. Turn on only what your environment needs, such as TLS, firewall rulesets, persisted storage or clustering, and see what each choice implies before you deploy it.

Starts from the default configuration. Enable only what your deployment needs: a key is written to config.yaml only when it differs from its default. Everything runs in your browser, and the URL is shareable.

Deployment
Decides the file paths in the config and the deployment commands.
Optional. Sets a base_url per registry. Each registry answers on <name>.<domain>, so point a wildcard record at this host.
Listeners and TLS
Leave empty to serve HTTPS only.
Use staging until the DNS records are confirmed: production rate limits are strict.
Emits a scheme-only base_url so redirects keep the client's scheme.
Artifacts to cache

One virtual_registry entry per selection. Anything not listed here can be added as a private registry below the Virtual Registry proxies and caches any HTTP(S) registry, including Artifactory and Nexus.

Answers requests that match no other registry subdomain.
Anonymous pulls then count against this account's rate limit, not the shared anonymous quota. Use a read-only token.
Private and third-party registries
Caching policy

Empty fields keep their default and are left out of the config.

HTTP probes need a path each remote actually answers check expected_response.
Serve stale while refreshing: keeps builds moving when a remote is down.
Empty revalidates every request. A short window cuts upstream metadata traffic hard.
Caps every TTL, packages included, so an artifact replaced upstream is revalidated. Content-addressed objects are exempt.
Sets fast_304: false. Only for a remote whose 304 carries an updated Cache-Control or Vary.
Addresses or CIDR ranges allowed to send PURGE /purgez, besides localhost.
Premium. Per-user authorization cache, applied to the private registries above.
Buffered POST size for cacheable git-upload-pack.
Sets disable_cache: requests are still proxied and policed, nothing is stored.
Premium. Survives restarts, so a cold start does not re-pull every layer.
Includes the book (5G) and 3% (at least 1G) for filesystem metadata.
Puts the book on a fast device of its own. Store size then covers the store alone.
Artifact Firewall
Premium. Adds enable_firewall to every registry below and a top-level firewall block.
Start in report, read the audit log, then enforce.
Blocks versions published within this window: the main defence against a fresh malicious release.
Between the two thresholds a match resolves to hide.
Pulls varnish/osv-rules for every selected ecosystem that has one.
Pin a tag or commit if rulesets must be reviewed before they take effect.
Your own allow/deny rules, evaluated alongside the OSV set.
Every decision, with enforced_action. A file path, stderr or otel.
preserve_manifest. Keeps upstream signatures intact (RPM repomd.xml), downloads are still authorized per version.
Bytes. Manifests above the limit are rejected rather than parsed.
Keeps cloned rulesets across restarts and caps their growth.
Hardening
Rejects push and delete. A caching proxy has no reason to accept writes.
Refuses /redirectz and transparent redirects to hosts outside the configured remotes.
HMAC on /redirectz, so clients cannot craft their own fetch URLs.
Comma separated. Needed when a remote hands out downloads on another host.
Required for the firewall, clustering, persisted storage and auth_ttl.
Clustering
Premium. Coalesces package fetches across nodes, so one upstream download serves the cluster.
Every node, including itself.
A name that resolves to every node, such as a Kubernetes headless Service.
Peers are the running instances in this group. Needs ec2:DescribeInstances on the instance profile.
1 pools every node's disk into one cache; higher keeps that many copies.
Identical on every node. Replace the placeholder with a generated secret.
Observability and logging
On by default once an endpoint is set.
Premium, needs the vmod-otel license addon.
Varnish tuning

Empty fields keep the Varnish default.

Registry manifests carry large headers; 128k leaves room.
Large layers on a slow upstream trip the default.
Caps how many remotes a single fetch walks through.

config.yaml

Deploy it

Client endpoints

Every key it emits is documented in this section and in the Artifact Firewall configuration: start with virtual_registry and remotes for routing and caching, varnish for listeners and storage, and cluster for request coalescing across nodes.


®Varnish Software, Wallingatan 12, 111 60 Stockholm, Organization nr. 556805-6203