Scarf Gateway redirects web traffic similar to a link shortener like bit.ly. It is compatible with various APIs used by registries, package managers, and direct internet downloads. Scarf Gateway offers three primary benefits: portability and consistency, access to metrics and usage data not provided by registries, and aggregation of download metrics from multiple distribution channels.
How it works
Scarf Gateway functions similarly to a link shortener like bit.ly, redirecting traffic as a domain gateway. However, it is specifically designed to be compatible with various APIs used by different services.
To use Scarf Gateway, create a route between it and your current packages, containers, or downloads, which directs the gateway to fulfill requests. Set up a custom domain that resolves to your gateway's location and update your documentation, readme, and other sources with the new domain. Users should then be able to use the same install, pull, or download commands as before.
Supported services include:
- Registries like Docker Hub Google Container Registry, RedHat Quay, Amazon Elastic Container Registry, and Azure Container Registry
- Package managers like Nix, homebrew, RPM, Apt, etc.
- Language specific package registries and managers like PyPI & pip, or npm
- Files coming via source control repos (GitHub or Gitlab)
- Or any file that is a direct download on the internet
Scarf Gateway is Open Source and available under the Apache 2 license on GitHub. Check out the documentation to learn more
Gain insight and freedom of choice.
Track installs by company, location, platform, versions, cloud providers, container runtimes, referral source - and anything else
Fully GDPR compliant out of the box. Scarf ensures all personally identifiable information is discarded so you'll never have to touch anything sensitive
Custom domain support for container hosting prevents vendor lock-in , even to Scarf itself
All your artifacts in one place
A static URL frees you to manage your own distribution strategy
Switch registries and hosts seamlessy with no impact to end users
Natively supports Docker/OCI containers , Python packages, file downloads , API endpoints, or any URL.
Frequently asked questions
Everything you need to know about Scarf Gateway
First, create an account on Scarf, if you haven’t already done so. Once you’ve registered, you’ll be prompted to create a new package. If you’re already using Scarf, you’ll be able to click “New Package” in the navigation bar. Scarf gateway currently supports two package types: Docker, and Files.
Hosting packages on your custom domain via Scarf has no impact on your existing users; your domain adds a new path for users to download your package. You can encourage end-users to switch their pull commands over to your new domain, but they can continue pulling directly from your registry provider with no negative impact.
Should you decide to switch registries later on, current users will have to update their pull commands to either your custom domain or to the new registry URL. If they go straight to the registry, they would need to update every time you decide to switch registries. If they use your custom domain, they will never need to update it again.
Scarf Gateway is different from the Scarf Platform. While the platform uses the gateway as part of its service, it is a fully managed service with redundancy, privacy, and security. The platform includes a user interface for setting up and tracking artifacts, reporting and analytics features, pixel tracking, and GDPR compliance.
Generally, no. Your package continues to be hosted on your current registry. Scarf Gateway is simply a thin layer on top. Since the gateway acts as a static entry point to your containers, you will always have the freedom to host your container on any registry you choose.
For enterprise customers, Scarf Gateway can cache your artifacts to improve global performance and even keep your artifacts online in the event of an outage from your origin hosting provider. Contact firstname.lastname@example.org to learn more.
No. Scarf Gateway does not store any personally identifiable information.
Scarf looks up IP address metadata, but the raw IP addresses are discarded and never exposed. IP metadata may contain:
• Coarse-grained location
• Company information, cloud providers, etc.
Additionally, Scarf sees metadata about the client and artifacts being downloaded such as:
• Container tags/versions
• Client container runtime information
• Basic device/OS information
We’d love your input to help us prioritize support for additional package types. Java, Apt, RPM, and others are planned.
Scarf Gateway is free to use! To gain access to additional features like our developer API, raw data export, integrations, availability & support SLA's contact our sales team.
Scarf Gateway is managed by the Scarf team. We plan an open-source release of the Gateway for self-hosting when it's out of beta and into general availability.