This page assumes you are familiar with the concept of repositories in general.
If you are not, please refer to Configuring Repositories for general information about repositories before continuing.
Artifactory fully supports RubyGems repositories providing the following:
All RubyGems commands, including
For example, if you are using Artifactory standalone or as a local service, you would access your RubyGems repositories using the following URL:
Or, if you are using Artifactory Online the URL would be:
Setting up a Proxy
A remote RubyGems repository serves as a caching proxy for a repository managed at a remote URL such as http://rubygems.org.
Once requested, artifacts (Gems) are cached on demand. They can then be removed, but you cannot manually deploy anything into a remote repository.
You can proxy a remote RubyGems repository, such as http://rubygems.org as follows:
In order to allow the integration with the gem command line tool, you must add the relevant source URL to your RubyGems configuration.
Local RubyGems repositories are physical, locally-managed repositories into which you can deploy and manage your in-house Gems.
You can set up a local RubyGems repository as follows:
First, setup the appropriate credentials for the gem tool: either include the API key in the
In order to push gems to the local repository, you can set the global variable
To get this value, in the Artifacts tab, select your repository in the Repository Browser and select the General tab.
Alternatively you could use the
A Virtual RubyGems repository (or "repository group") can aggregate multiple local and remote RubyGems repositories, seamlessly exposing them under a single URL.
The repository is virtual in that you can resolve and retrieve artifacts from it but you cannot deploy anything to it.
For more information on virtual repositories please refer to Virtual Repositories.
The procedure for setting up a virtual repository is very similar to setting up a local or remote repository, however as a last step, you need to select the repositories that will be included in the virtual repository you are creating.
Using a virtual RubyGems repository you can aggregate both your local and remote repositories.
You need to set the right repository source URL, in the same way as described in Usage for a local RubyGems repository, just with the appropriate repository key as follows:
source: http://localhost:8081/artifactory/api/gems/<repository key>/
target: http://localhost:8081/artifactory/api/gems/<repository key> (no slash at the end!)
Using the REST API
The REST API provides access to the Gems Add-on through the repository key using the following URL:
In addition to the basic binary repository operations, such as download, deploy, delete etc., the following RubyGems.org API Gem commands are supported:
Indexing is done automatically by Artifactory in the background, however if you still need to recreate or update the spec index files, the following REST API commands are also available:
For full details please refer to Artifactory REST API.
Viewing RubyGems Artifact Information
In the Artifacts tab under Browse | Tree Browser you can view a list of your repositories. If you select a RubyGems artifact within the repository tree you can select the RubyGems tab to view detailed information on the selected artifact.
The screencast below shows how to use RubyGems with Artifactory: