1. Home
  2. Tyk Pump
  3. Installation

Installation

Installing Tyk Pump is very straight forward, and can be done straight from our secure repositories.

Step 1: Set up the repository:

Our repository provider has a single-line configuration script which ensures all the dependencies are installed for the repository. For a manual guide, take a look here.

Ubuntu (Debian):

curl -s https://packagecloud.io/install/repositories/tyk/tyk-pump/script.deb.sh | sudo bash

RHEL / CentOS (RPM):

curl -s https://packagecloud.io/install/repositories/tyk/tyk-pump/script.rpm.sh | sudo bash

Step 2: Install the package:

Ubuntu (Debian):

sudo apt-get install tyk-pump

RHEL / CentOS (RPM):

sudo yum install -y tyk-pump 

Step 3. Configure Tyk Pump

We have provided a simple setup script to make 90% of setups easier – in most cases Tyk Pump will be exporting to MongoDB which is what our setup script assumes:

sudo /opt/tyk-pump/install/setup.sh --redishost=localhost --redisport=6379 --mongo=mongodb://127.0.0.1:27017/tyk_analytics

What are we doing here?

  • --redishost=localhost Use redis on the hostname: localhost
  • --redisport=6379: Use the default redis port
  • --mongo=mongodb://127.0.0.1:27017/tyk_analytics: Use this connection string to connect to the local MongoDB instance and use the tyk_analytics database

Once this command has run and you have a successful output:

Redis Host  = localhost
Redis Port  = 6379
Redis PW    =
Use Mongo   =
Mongo URL   = mongodb://tyk_portal:[email protected]:10588,aws-us-east-1-portal.13.dblayer.com:10445/tyk_experimental
==> File written to ./pump.conf
==> File copied to /opt/tyk-pump/install/../pump.conf

Then you are ready for the next step – starting Tyk Pump:

Step 4. Start the Tyk Pump service

To start Tyk Pump, simply run:

sudo service tyk-pump start

You can verify if Tyk pump is running and working by tailing the log file:

Ubuntu (Debian):

sudo tail -f /var/log/upstart/tyk-pump.log

RHEL / CentOS (RPM):

sudo tail -f /var/log/tyk-pump.log 

Tyk Pump will now be shovelling data from your Tyk Gateways into the various data sinks that you have configured, in this case, MongoDB.