# Private gem sources for Ruby configuration

{% hint style="info" %}
**Feature availability**\
This functionality is in beta. [Contact Snyk Support](https://support.snyk.io) to have it enabled for your Organization.

This guide is relevant for Snyk UI integrations only. The CLI supports Ruby Projects with private registries without extra configuration.
{% endhint %}

You can add a configuration to tell Snyk where your private gems are hosted. This is the same information you would normally add as a Bundler environment variable.

After you have added this configuration, Snyk uses the information to access private dependencies when creating Pull/Merge Requests, by allowing Bundler to reach those dependencies in order to regenerate the lockfile.

## Configuration of private gem sources for Ruby

1. Navigate to **Settings** > **General**.
2. Find the `RubyGems Bundler environment variables` section; see the screen illustration.
3. Add environment variable names and values to define credentials for gem sources.\
   These are generally the same as the values you set on your developer machine, in your CI environments, or both.\
   Example name: `BUNDLE_GITHUB__COM`, Value: `abcd0123generatedtoken:x-oauth-basic`
4. To test the configuration, open a Pull/Merge Request on a Project that contains gems from your private registries to see a lockfile updated and included in the Snyk Fix Pull Request.

<figure><img src="https://2533899886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MdwVZ6HOZriajCf5nXH%2Fuploads%2Fgit-blob-b14055a2fc46ce2d6eb1ed5fcd98ac70b1d5dd8c%2F94445628-8fdd3980-019f-11eb-816e-2c61c5b99c5c.png?alt=media&#x26;token=6c471afa-c55f-434a-bc43-ca72412aa93e" alt="RubyGems Bundler environment variables"><figcaption><p>RubyGems Bundler environment variables</p></figcaption></figure>

## Requirements for configuration of private gem sources for Ruby

A list of requirements follows:

* Variable values must be CGI escaped.
* Gem sources must use `https` URLs.\
  Example: Supported: `gem "privvy", git: "https://github.com/testexample/ruby-gem-for-private-source"`\
  Not supporte&#x64;**:** `gem "privvy", git: "git@github.com:testexample/ruby-gem-for-private-source"`
* Gem sources must be publicly resolvable, that is, not behind a firewall.
* Variables must be configured according to the [Bundler Credentials for Gem Sources documentation](https://bundler.io/v1.16/bundle_config.html#CREDENTIALS-FOR-GEM-SOURCES).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.snyk.io/scan-with-snyk/snyk-open-source/package-repository-integrations/private-gem-sources-for-ruby-configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.