Cloudsmith Documentation Hub

Welcome to the Cloudsmith Documentation Hub. You'll find comprehensive guides and documentation to help you start working with Cloudsmith as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Upstream Proxying

Upstream proxying and caching allows you to upload and use the packages you own, while Cloudsmith fetches and caches other packages (such as dependencies).

This enables you to use Cloudsmith as a first-class cache and a central source of truth for packages, to protect you from outages of external services (which is especially important when running behind your firewall).

Supported Formats

Format

Fixed Proxy
Configurable Proxy
Caching
Dependencies Only

Debian

N/A
N/A

RedHat

N/A
N/A

Gradle

N/A
N/A

Maven

N/A
N/A

sbt

N/A
N/A

npm

N/A

Python

N/A

Cargo

πŸ“˜

All formats are on the roadmap for Configurable Proxy and Caching.

Create an Upstream Proxy

Click the green "Create Upstream" button, and then select the format you want to create an upstream for.

Create a Maven Upstream Proxy

Create Maven Upstream Form

Form Field

Description

Name

A descriptive name for this upstream source. A shortened version of this name will be used for tagging cached packages retrieved from this upstream.

Priority

The weighting of the Upstream source. Upstream sources are selected for resolving requests by descending priority (higher to lower), followed by creation date.

Upstream URL

The URL for this upstream source. This must be a fully qualified URL including any path elements required to reach the root of the repository.

Proxy Only

(Default) Proxy requests through to upstream sources in order to match assets that are not present in this repository.

Cache and Proxy

Proxy the initial request for an asset through to the upstream source and then store (cache) resolved assets in this repository for future requests.

Cache Only

Requests made for packages that aren't yet in this repository will self-redirect until available. This mode ensures that packages served are guaranteed to be signed with the associated repository signing key

Verify SSL Certificates

If enabled, SSL certificates are verified when requests are made to this upstream. We recommended leaving this enabled for all public sources to help mitigate Man-In-The-Middle (MITM) attacks.

GPG key

The source of a package signing key. When a signing key is provided, the Cloudsmith setup script will ensure this signing key is deployed to allow packages available on this upstream to be installed

Authentication (optional)

Optional credentials that can be provided if the upstream is not publicly accessible

Headers (optional)

Optional Key-Value headers that can be passed to upstreams with each request.

Create a Debian Upstream Proxy

Create Debian Upstream Form

Form Field

Description

Name

A descriptive name for this upstream source. A shortened version of this name will be used for tagging cached packages retrieved from this upstream.

Priority

The weighting of the Upstream source. Upstream sources are selected for resolving requests by descending priority (higher to lower), followed by creation date.

Upstream URL

The URL for this upstream source. This must be a fully qualified URL including any path elements required to reach the root of the repository.

Proxy Only

(Default) Proxy requests through to upstream sources in order to match assets that are not present in this repository.

Cache and Proxy

Proxy the initial request for an asset through to the upstream source and then store (cache) resolved assets in this repository for future requests.

Distribution Versions

The distribution versions to index from the upstream, such as debian/buster or ubuntu/zesty.

Binary Architectures

The system architectures to index from the upstream, such as amd64 or i386.

Component

The component this upstream source should provide

Source Packages

If selected, source packages will be available from the upstream.

Verify SSL Certificates

If enabled, SSL certificates are verified when requests are made to this upstream. We recommended leaving this enabled for all public sources to help mitigate Man-In-The-Middle (MITM) attacks.

Authentication (optional)

Optional credentials that can be provided if the upstream is not publicly accessible

Headers (optional)

Optional Key-Value headers that can be passed to upstreams with each request.

Create an RPM Upstream Proxy

Create RedHat Upstream Form

Form Field

Description

Name

A descriptive name for this upstream source. A shortened version of this name will be used for tagging cached packages retrieved from this upstream.

Weighting

The weighting of the Upstream source. Upstream sources are selected for resolving requests by descending priority (higher to lower), followed by creation date.

Upstream URL

The URL for this upstream source. This must be a fully qualified URL including any path elements required to reach the root of the repository.

Proxy Only

(Default) Proxy requests through to upstream sources in order to match assets that are not present in this repository.

Cache and Proxy

Proxy the initial request for an asset through to the upstream source and then store (cache) resolved assets in this repository for future requests.

Distribution

The distribution version to index from the upstream, such as el/8r or fedora/32.

Source Packages

If selected, source packages will be available from the upstream.

Verify SSL Certificates

If enabled, SSL certificates are verified when requests are made to this upstream. We recommended leaving this enabled for all public sources to help mitigate Man-In-The-Middle (MITM) attacks.

GPG Key

The source of a package signing key. When a signing key is provided, the Cloudsmith setup script will ensure this signing key is deployed to allow packages available on this upstream to be installed.

Authentication (optional)

Optional credentials that can be provided if the upstream is not publicly accessible

Headers (optional)

Optional Key-Value headers that can be passed to upstreams with each request.

Edit an Upstream Proxy

Click the blue "Edit Upstream" button to edit an upstream source:

Disable an Upstream Proxy

Click the orange "Disable Upstream" button to disable an upstream source:

Delete an Upstream Proxy

Click the red "Disable Upstream" button to disable an upstream source:

Updated about a month ago


Upstream Proxying


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.