Alpine is the package manager of choice for Alpine Linux distributions.

The following instructions are for Alpine or compatible packages only.

To install packages, you can quickly setup the repository automatically (recommended):

sudo apk add --no-cache bash
curl -1sLf \
  'https://dl.cloudsmith.io/public/cloudsmith/examples/setup.alpine.sh' \
  | sudo -E bash

If you need to force a specific distribution, release/version, or architecture, you can also do that (e.g. if your system is compatible but not identical):

sudo apk add --no-cache bash
curl -1sLf \
  'https://dl.cloudsmith.io/public/cloudsmith/examples/setup.alpine.sh' \
  | sudo -E distro=DISTRO codename=CODENAME arch=ARCH bash

or ... you can manually configure it yourself before installing packages:

curl -1sLf 'https://dl.cloudsmith.io/public/cloudsmith/examples/rsa.0FDF8026A3EC5743.key' > /etc/apk/keys/examples@cloudsmith-0FDF8026A3EC5743.rsa.pub
curl -1sLf 'https://dl.cloudsmith.io/public/cloudsmith/examples/config.alpine.txt?distro=alpine&codename=v3.8' >> /etc/apk/repositories
apk update

Note: Please replace v3.8 above with your actual distribution version.

$EDITOR /etc/apk/repositories

Remove /alpine/v3.8/main line, save then execute:

rm -f /etc/apk/keys/examples@cloudsmith-0FDF8026A3EC5743.rsa.pub
apk update

Note: Please replace v3.8 above with your actual distribution version.

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

A fully-fledged Cargo registry, the package manager for Rust!

The following instructions are for Cargo or compatible packages only.

Assuming you have Rust and Cargo already installed (if not, see the official docs), it is straight-forward to add a Cloudsmith-based Cargo registry.

• Cargo >= 1.68 (HTTP - Sparse Registry)
• Cargo < 1.68 (Legacy - Git Registry)

Once configured as above, a crate can then depend on a crate from your registry by specifying the registry key and a value of the registry's name in that dependency's entry in Cargo.toml:

[package]
name = "my-project"
version = "0.1.0"
[dependencies]
other-crate = { version = "1.0", registry = "cloudsmith-examples" }

You can also install a crate directly by specifying the registry on the command line:

cargo install my-project --registry cloudsmith-examples

To remove a Cargo registry from your system, you need to remove it from your .cargo/config.toml or .cargo/config file.

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

Composer is the package manager of choice for the PHP language.

The following instructions are for Composer or compatible packages only.

To enable the retrieval of Cloudsmith hosted packages via Composer, the first step is to add your repository to the repositories section of your composer.json file.

Add the following JSON to your project composer.json file:

{
  "repositories": [
      {
          "type": "composer",
          "url": "https://composer.cloudsmith.io/cloudsmith/examples/",
          "options": {
              "http": {
                  "header": [
                      "X-API-KEY: YOUR-API-KEY"
                  ]
              }
          }
      },
      {
          "packagist.org": false
      }
  ]
}

After the repository is added to the composer.json file, all that is left is to specify the dependency in the require section of the project composer.json file.

To do this add the following JSON to your project composer.json file:

{
  "require": {
    "package/name": "version"
  }
}

Note: You'll need to replace package/name and version with your own uploaded package details.

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

A fully-fledged Dart package repository, the package manager for Dart and Flutter! Cloudsmith is fully compatible as a pub-like repository.

The following instructions are for Dart or compatible packages only.

Installing packages from this repository varies, depending on the version of the Dart SDK in use.

• SDK Version <= 2.14
• SDK Version >= 2.15

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

Apt/Dpkg is the package manager of choice for Debian-like systems (such as Ubuntu, Linux Mint, Raspbian, etc.)

The following instructions are for Debian or compatible packages only.

To install packages, you can quickly setup the repository automatically (recommended):

curl -1sLf \
  'https://dl.cloudsmith.io/public/cloudsmith/examples/setup.deb.sh' \
  | sudo -E bash

If you need to force a specific distribution, release/version, architecture, or component (if supported), you can also do that (e.g. if your system is compatible but not identical):

curl -1sLf \
  'https://dl.cloudsmith.io/public/cloudsmith/examples/setup.deb.sh' \
  | sudo -E distro=DISTRO codename=CODENAME arch=ARCH component=COMPONENT bash

or ... you can manually configure it yourself before installing packages:

apt-get install -y debian-keyring  # debian only
apt-get install -y debian-archive-keyring  # debian only
apt-get install -y apt-transport-https
# For Debian Stretch, Ubuntu 16.04 and later
keyring_location=/usr/share/keyrings/cloudsmith-examples-archive-keyring.gpg
# For Debian Jessie, Ubuntu 15.10 and earlier
keyring_location=/etc/apt/trusted.gpg.d/cloudsmith-examples.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/cloudsmith/examples/gpg.0365B910DDF4E7A4.key' |  gpg --dearmor >> ${keyring_location}
curl -1sLf 'https://dl.cloudsmith.io/public/cloudsmith/examples/config.deb.txt?distro=ubuntu&codename=xenial&component=main' > /etc/apt/sources.list.d/cloudsmith-examples.list
sudo chmod 644 ${keyring_location}
sudo chmod 644 /etc/apt/sources.list.d/cloudsmith-examples.list
apt-get update

Note: Please replace ubuntu, xenial and main above with your actual operating system (distribution and distribution release/version) and components (based on what's in this repository).

rm /etc/apt/sources.list.d/cloudsmith-examples.list
apt-get clean
rm -rf /var/lib/apt/lists/*
apt-get update

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

A fully-fledged Docker registry.

The following instructions are for Docker or compatible packages only.

For an overview an additional documentation on the Cloudsmith Docker registry, please refer to our help documentation.

As this is a public registry, you don't need to authenticate to pull images.

Pulling (downloading) an image from the Cloudsmith Docker registry can be done using the standard docker pull command:

docker pull docker.cloudsmith.io/cloudsmith/examples/your-image:latest

Note: You should replace your-image and latest in the above with your own image name and tag.

To refer to images after pulling in a Dockerfile, specify the following:

FROM docker.cloudsmith.io/cloudsmith/examples/your-image:latest

Note: As above, you can replace your-image and latest in the above with your own image name and tag.

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

Helm is the package manager of choice for managing application definitions within the Kubernetes (k8s) ecosystem.

The following instructions are for Helm or compatible packages only.

Assuming you have helm already installed, it is straight-forward to add a Cloudsmith-based chart repository:

helm repo add cloudsmith-examples \
  'https://dl.cloudsmith.io/public/cloudsmith/examples/helm/charts/' 
helm repo update

You can install a chart by using the following command:

helm install cloudsmith-examples/my-awesome-helm-chart

You can also install a chart directly by specifying the repository on the command line:

helm install my-awesome-helm-chart \
  --repo 'https://dl.cloudsmith.io/public/cloudsmith/examples/helm/charts/'

Helm provides a very clean method of removing a chart repository, simply run the following command:

helm repo remove cloudsmith-examples

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

A fully-fledged LuaRocks module repository, the package manager for Lua!

The following instructions are for LuaRocks or compatible packages only.

You can install modules directly by using the --server command-line flag when executing a luarocks command.

luarocks install your-package 1.0.0 --server https://dl.cloudsmith.io/public/cloudsmith/examples/luarocks/

To search only your Cloudsmith repository for modules use the --only-server command-line flag. Note this will force luarocks to search only the Cloudsmith repository and will result in luarocks not being able to install public modules that your private module may depend on.

luarocks install your-package 1.0.0 --only-server https://dl.cloudsmith.io/public/cloudsmith/examples/luarocks/

Note: You'll need to replace your-package and 1.0.0 with your own package and version.

For most use cases, users will probably want to persist their repository settings and not specify them every time. luarocks provides a configuration file that can be modified to persist settings, see the luarocks config file documentation for full details of available options and the location of the file for your platform.

To add your private repository, adjust the rocks_servers section of your config file. Note if you still want to be able to install packages from luarocks.org you should leave the default value in place and add your repository, otherwise you can replace the value entirely:

rocks_servers = {
  "http://luarocks.org/repositories/rocks",
  "https://dl.cloudsmith.io/public/cloudsmith/examples/luarocks/"
}

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

A repository that supports Maven-compatible projects and JARs, with support for Gradle, SBT, Leiningen, Ivy, Grape, etc.

The following instructions are for Maven or compatible packages only.

• Maven
• Gradle
• Sbt/Scala
• Leiningen/Clojure
• Grape

<repositories>
  <repository>
    <id>cloudsmith-examples</id>
    <url>https://dl.cloudsmith.io/public/cloudsmith/examples/maven/</url>
    <releases>
      <enabled>true</enabled>
      <updatePolicy>always</updatePolicy>
    </releases>
    <snapshots>
      <enabled>true</enabled>
      <updatePolicy>always</updatePolicy>
    </snapshots>
  </repository>
</repositories>

<dependency>
  <groupId>group-id</groupId>
  <artifactId>artifact-id</artifactId>
  <version>version</version>
</dependency>

repositories {
  maven {
    url "https://dl.cloudsmith.io/public/cloudsmith/examples/maven/"

  }
}

dependencies {
  implementation 'group-id:artifact-id:version'
}

resolvers += "cloudsmith-examples" at "https://dl.cloudsmith.io/public/cloudsmith/examples/maven/"

libraryDependencies += "group-id" % "artifact-id" % "version"

addMavenResolverPlugin

:repositories [["snapshots" "https://dl.cloudsmith.io/public/cloudsmith/examples/maven/"]
               ["releases" "https://dl.cloudsmith.io/public/cloudsmith/examples/maven/"]]

:dependencies [[group-id/artifact-id "version"]]

@GrabResolver(name='cloudsmith-examples', root='https://dl.cloudsmith.io/public/cloudsmith/examples/maven/')

@Grab(group='group-id', module='artifact-id', version='version')

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

Npm is the package manager of choice for the Javascript/Node ecosystem. Cloudsmith is fully compatible as an npmjs-like registry.

The following instructions are for npm or compatible packages only.

There are two ways to tell npm to use a Cloudsmith-based npm registry:

1. Set the registry as the default globally, per-user or per-project.
2. Provide the registry URL when executing npm commands.

To use/set the registry as the default for your user, execute the following:

npm config set registry https://npm.cloudsmith.io/cloudsmith/examples/

You can set it globally (with permissions) by using the -g argument.

Alternatively, you can add it directly to your user or project .npmrc file:

registry=https://npm.cloudsmith.io/cloudsmith/examples/

Note: Setting the registry globally will impact all npm commands, unless they explicitly override the registry.

You can specify the registry each time you execute npm commands, such as:

npm install lodash --registry=https://npm.cloudsmith.io/cloudsmith/examples/

For a public registry, you do not provide authentication for read-only contexts, such as installing packages:

npm install awesome-package

You can namespace your registry and packages using npm scopes.

Using a registry scope tells npm to route installs for packages in that scope to Cloudsmith.

You can set it via the command-line using:

npm config set '@cloudsmith:registry' https://npm.cloudsmith.io/cloudsmith/examples/

You can also set it directly in your user or project .npmrc file:

@cloudsmith:registry=https://npm.cloudsmith.io/cloudsmith/examples/

Note: You should replace @cloudsmith in the above with your own scope name.

Using a package scope provides a different namespace to other similarly named packages to differentiate them.

Installing packages with a scope requires putting the scope before the name:

npm install @cloudsmith/awesome-package

You can find out more about scoped packages (on npmjs.com).

Note: You should replace @cloudsmith in the above with your own scope name.

Distribution tags allow npm packages to be tagged with a mnemonic that is associated with a specific package version.

These can be used as an alternative to the package version when installing packages, such as:

npm install awesome-package@beta --registry=https://npm.cloudsmith.io/cloudsmith/examples/

Cloudsmith has full support for distribution tags and (mostly) follows the same rules for them as on npmjs.com:

1. A specific tag can point at one version of a package only.
2. A package version may have multiple unique tags.
3. Unless specified otherwise, the default tag for the last package published is latest.
4. When a package that is latest is deleted, the tag is moved to the next applicable version by semver.

You can inspect a package to see what tags it has:

npm dist-tags ls awesome-package --registry=https://npm.cloudsmith.io/cloudsmith/examples/
(out)latest: 1.0.0
(out)beta: 2.0.0

You can find out more about distribution tags (on npmjs.com).

Cloudsmith supports transparent proxying of install requests to/from npmjs.com.

When enabled, requests for packages that don't exist in the registry will be automatically proxied:

npm install lodash@4.17.11 --registry='https://npm.cloudsmith.io/cloudsmith/examples/'
(out)+ lodash@4.17.11
(out)updated 1 package in 2.743s

In this case, lodash didn't exist in the registry and was proxied. This also applies automatically when npm is installing dependencies for your package. It will load them from the registry automatically and transparently proxy them.

Warning: If transparent upstream proxying is disabled for the registry then you will need to fetch all dependencies of your packages manually. These can then be published into the registry, or you can bundle them with bundleDependencies.

Cloudsmith supports proxying of npm audit requests to detect vulnerabilities in dependencies:

npm audit
(out)                       === npm audit security report ===
(out)found 0 vulnerabilities
(out) in 1 scanned package

You can find out more about security auditing (on npmjs.com).

Assuming that you have always-auth enabled, Yarn is immediately compatible with Cloudsmith registries:

yarn add lodash@4.17.11 --registry=https://npm.cloudsmith.io/cloudsmith/examples/
(out)[1/5] Validating package.json...
(out)[2/5] Resolving packages...
(out)[3/5] Fetching packages...
(out)[4/5] Linking dependencies...
(out)[5/5] Building fresh packages...
(out)success Saved lockfile.
(out)success Saved 1 new dependency.
(out)info Direct dependencies
(out)└ lodash@4.17.11
(out)info All dependencies
(out)└ lodash@4.17.11

To enable always-auth, add it to your user or project .npmrc file:

always-auth

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

Pip/Pipenv/Poetry are package managers of choice for the Python ecosystem. Cloudsmith is fully compatible as a PyPi-like repository.

The following instructions are for Python or compatible packages only.

You can install packages directly by using the --index-url or --extra-index-url Pip configuration arguments when executing a pip command.

Note: We recommend using --index-url. As per pip's documentation: Using the --extra-index-url option to search for packages that are not in this repository (such as private packages) is unsafe, per a security vulnerability called dependency confusion: an attacker can claim the package on the public repository in a way that will ensure it gets chosen over the private package. For more detail, see our expanded documentation on the usage and dangers of extra index URL.

pip install my-awesome-package==1.0.0 --index-url https://dl.cloudsmith.io/public/cloudsmith/examples/python/simple/

Note: You'll need to replace my-awesome-package and 1.0.0 with your own awesome python packages and versions.

Similar to setup via command-line, pip needs to be passed the --index-url configuration option. To do this add --index-url to the top of your requirements.txt (or similar) file.

--index-url https://dl.cloudsmith.io/public/cloudsmith/examples/python/simple/
my-awesome-package==1.0.0

Note: You'll need to replace my-awesome-package and 1.0.0 with your own awesome python packages and versions.

Remove the following line from your $HOME/.pip/pip.conf file:

--index-url=https://dl.cloudsmith.io/public/cloudsmith/examples/python/simple/

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

A repository for RedHat-like systems (such as RHEL, CentOS, SUSE, Fedora, etc.), compatible with yum, dnf, zypper, etc.

The following instructions are for RedHat or compatible packages only.

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

Rubygems/bundler are the package managers of choice for the Ruby ecosystem. Cloudsmith is fully compatible as a Rubygems-like repository.

The following instructions are for Ruby or compatible packages only.

As stated by Bundler, "Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed."

Bundler from version 1.7 supports scoped sources, so you can install a gem from Cloudsmith using the following declaration in your Gemfile:

source 'https://dl.cloudsmith.io/public/cloudsmith/examples/ruby/' do
  gem 'awesome-gem', '~> 42.0'
end

Note: You'll need to replace awesome-gem and ~> 42.0 with your own gem name and version.

You can also add Cloudsmith as a source for the Ruby CLI instead:

gem sources --add 'https://dl.cloudsmith.io/public/cloudsmith/examples/ruby/'

gem sources -r 'https://dl.cloudsmith.io/public/cloudsmith/examples/ruby/'

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.

A repository that acts like a container for any type of files. Think DropBox, but with a pinch more awesome.

The following instructions are for Raw or compatible packages only.

The purpose of raw files depends on the content of the raw file, which Cloudsmith doesn't know, so we can't provide you with an automated setup method (yet), but it might be as simple as downloading the file.

You can download a raw file using the browser, or if you're running Linux you can use standard tools such as curl.

curl -1sLf -O 'https://dl.cloudsmith.io/public/cloudsmith/examples/raw/files/your-package.zip'

Note: You'll need to replace your-package.zip with your own equally fantastic file name.

If you couldn't find what you needed in our documentation, then you can always chat to a member of our team instead. It's our mission to be your dedicated off-site team for package management, and we mean it. Come and chat with us, anytime.