Installation instructions

deb

Begin by refreshing your package cache by running

sudo apt-get update

If you are running Debian, install debian-archive-keyring so that official Debian repositories will be verified (Ubuntu users can skip this)

sudo apt-get install debian-archive-keyring

Ensure the required tools (curl, gpg, apt-transport-https) are installed before proceeding:

sudo apt-get install curl gnupg apt-transport-https

In order to install a deb repo, first you need to install the GPG key that used to sign repository metadata. This will change depending on whether or not your apt version is >= v.1.1. You can check this by running:

apt -v

For apt version >= v1.1:

(Equivalent to or later than Debian/Raspbian Stretch, Ubuntu Xenial, Linux Mint Sarah, Elementary OS Loki)

1. Create the directory to import the GPG key:

2. From apt v2.4.0, /etc/apt/keyrings/ is the designated directory for administrator imported keys. We will be using that for the following instructions, but you can replace /etc/apt/keyrings/ with any path of your choosing. If you need to create the directory, run:

   mkdir -p /etc/apt/keyrings/

3. Then add the GPG key:

   curl -fsSL https://packagecloud.io/citusdata/community/gpgkey | gpg --dearmor > /etc/apt/keyrings/citusdata_community-archive-keyring.gpg

4. Create a file named /etc/apt/sources.list.d/citusdata_community.list that contains the repository configuration below.

   Make sure to replace ubuntu and trusty in the config below with your Linux distribution and version:

       deb [signed-by=/etc/apt/keyrings/citusdata_community-archive-keyring.gpg] https://packagecloud.io/citusdata/community/ubuntu trusty main
       deb-src [signed-by=/etc/apt/keyrings/citusdata_community-archive-keyring.gpg] https://packagecloud.io/citusdata/community/ubuntu trusty main

For apt version < v1.1:

(Equivalent to or older than Debian/Raspbian Jessie, Ubuntu Wily, Linux Mint Rosa, Elementary OS Freya)

1. Add the GPG key:

   curl -fsSL https://packagecloud.io/citusdata/community/gpgkey | gpg --dearmor > /etc/apt/trusted.gpg.d/citusdata_community.gpg

2. Create a file named /etc/apt/sources.list.d/citusdata_community.list that contains the repository configuration below.

   Make sure to replace ubuntu and trusty in the config below with your Linux distribution and version:

       deb https://packagecloud.io/citusdata/community/ubuntu trusty main
       deb-src https://packagecloud.io/citusdata/community/ubuntu trusty main

Valid options for os and dist parameters can be found in our support OS list in the docs.

Run this command update your local APT cache:

sudo apt-get update

You can now install packages from your repository.

rpm

Install pygpgme, a package which allows yum to handle gpg signatures, and a package called yum-utils which contains the tools you need for installing source RPMs.

sudo yum install pygpgme yum-utils

You may need to install the EPEL repository for your system to install these packages. If you do not install pygpgme, GPG verification will not work.

Create a file named /etc/yum.repos.d/citusdata_community.repo that contains the repository configuration below.

Make sure to replace el and 6 in the config below with your Linux distribution and version:

[citusdata_community]
name=citusdata_community
baseurl=https://packagecloud.io/citusdata/community/el/6/$basearch
repo_gpgcheck=1
gpgcheck=0
enabled=1
gpgkey=https://packagecloud.io/citusdata/community/gpgkey
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
metadata_expire=300

[citusdata_community-source]
name=citusdata_community-source
baseurl=https://packagecloud.io/citusdata/community/el/6/SRPMS
repo_gpgcheck=1
gpgcheck=0
enabled=1
gpgkey=https://packagecloud.io/citusdata/community/gpgkey
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
metadata_expire=300

Valid options for os and dist parameters can be found in our supported OS list in the docs.

Update your local yum cache by running

sudo yum -q makecache -y --disablerepo='*' --enablerepo='citusdata_community'

You can now install packages from your repository.

Node.js

Add the repository as an npm registry

To install node packages from this repository, you'll need to configure it as a registry.

npm config set registry https://packagecloud.io/citusdata/community/npm/

Using Yarn?

After a repository is configured as an npm registry it can be used by yarn to resolve packages. Once configured, add packages to a project using yarn add.

Verify a repository is configured correctly by running yarn config list and making sure the registry url is set correctly.

...
info npm config
{ registry: 'https://packagecloud.io/citusdata/community/npm/' }

Transparent auto-proxying

When you install a package using npm install, the npm program will automatically attempt to install any dependencies required by the package. If those dependencies are not found in your packagecloud repository, packagecloud will automatically forward requests for those missing dependencies to the official npm public registry.

This is the default behavior and is recommended for most users.

To learn more about this behavior and how to disable it, take a look at our documentation.

zypper

Create a file named /etc/zypp/repos.d/citusdata_community.repo that contains the repository configuration below.

Make sure to replace el and 6 in the config below with your Linux distribution and version:

[citusdata_community]
name=citusdata_community
baseurl=https://packagecloud.io/citusdata/community/opensuse/13.2/$basearch
enabled=1
repo_gpgcheck=1
pkg_gpgcheck=0
gpgkey=https://packagecloud.io/citusdata/community/gpgkey
autorefresh=1
type=rpm-md

[citusdata_community-source]
name=citusdata_community-source
baseurl=https://packagecloud.io/citusdata/community/opensuse/13.2/SRPMS
enabled=1
repo_gpgcheck=1
pkg_gpgcheck=0
gpgkey=https://packagecloud.io/citusdata/community/gpgkey
autorefresh=1
type=rpm-md

Valid options for os and dist parameters can be found in our supported OS list in the docs.

Update your local zypper cache by running

zypper --gpg-auto-import-keys refresh citusdata_community
zypper --gpg-auto-import-keys refresh citusdata_community-source

You can now install packages from your repository.

rubygems

Add the repository as a source

To install gems from this repository, you'll need to add the repository as a source.

gem source --add https://packagecloud.io/citusdata/community/

Using Bundler?

Add the repository to your Gemfile

To install gems from this repository, you'll need to add it as a source to your Gemfile.

Bundler 1.7.0 and above

In newer bundler versions, you can scope specific gems to a source, like so:

# Gemfile

# Note: It's recommended you add the official https://rubygems.org source, unless your
#       packagecloud repository can meet all of the dependency requirements in the Gemfile.

source "https://rubygems.org"
source "https://packagecloud.io/citusdata/community" do
  gem "my-gem"
  gem "another-gem"
end

Legacy versions of Bundler

Older versions of Bundler have several bugs around scoping gems to a single source using blocks, so you'll have to add the source globally at the top of the Gemfile.

# Gemfile

source "https://rubygems.org"
source "https://packagecloud.io/citusdata/community"

python

To install python packages from this repository, you'll need to add the repository as a source to pip.

Add the repository to pip

Add the repository to the [global] section in your ~/.pip/pip.conf

[global]
extra-index-url=https://packagecloud.io/citusdata/community/pypi/simple

Note: if you would like pip to use only this repository as a source, replace extra-index-url with index-url

VirtualEnv / requirements.txt

Add the repository to your VirtualEnv

Ensure you are running the latest version of pip inside your virtualenv:

my_virtualenv/bin/pip install --upgrade pip

Add this to the bottom of your requirements.txt

--extra-index-url=https://packagecloud.io/citusdata/community/pypi/simple

Note: if you would like pip to use only this repository as a source, replace extra-index-url with index-url