Install Tyk Sync

Last updated:

Overview

Tyk Sync is a command line tool and library to manage and synchronise a Tyk installation with your version control system (VCS). It’s especially helpful for DevOps teams aiming to automate deployments and manage API configurations efficiently.

On this page, you will find instructions on how to install Tyk Sync using Docker and Packagecloud.

Installation Options

Method Description
Docker Run Tyk Sync in a container
Packagecloud Hosts packages for linux distributions

Install on Docker

  1. Pull the Docker image

    Select a specific version from Docker Hub

    SYNC_VERSION=v2.1
    docker pull tykio/tyk-sync:$SYNC_VERSION
    
  2. Run Tyk Sync

    docker run tykio/tyk-sync:$SYNC_VERSION version
    

Install via Package Manager (Packagecloud)

The below instructions are for Debian/Ubuntu systems. For other distributions, refer to the Packagecloud documentation.

  1. Add the Tyk Sync repository

    For Debian/Ubuntu systems:

    curl -s https://packagecloud.io/install/repositories/tyk/tyk-sync/script.deb.sh | sudo bash
    
  2. Install Tyk Sync

    sudo apt-get install tyk-sync
    
  3. Verification

    tyk-sync version