Quick Start: Tyk Open Source Gateway

Get Tyk Open Source Gateway running locally with Docker in a few steps. For other deployment options, see the installation options page.

Prerequisites

Docker Engine 24.0 or later
Docker Compose v2.20 or later

Instructions

Step 1: Create a Gateway configuration file

Create a file named tyk.conf with the following content:

{
  "listen_port": 8080,
  "secret": "your-secret",
  "template_path": "/opt/tyk-gateway/templates",
  "app_path": "/opt/tyk-gateway/apps",
  "storage": {
    "type": "redis",
    "host": "tyk-redis",
    "port": 6379
  }
}

For a full list of configuration options, see the Gateway configuration reference.

Step 2: Create a Docker Compose file

Create a file named docker-compose.yml with the following content:

services:
  tyk-gateway:
    image: tykio/tyk-gateway:v5.8.13
    ports:
      - "8080:8080"
    volumes:
      - ./tyk.conf:/opt/tyk-gateway/tyk.conf
    depends_on:
      - tyk-redis
  tyk-redis:
    image: redis:7.2.0
    ports:
      - "6379:6379"

v5.8.13 is the current LTS release. Always check the Gateway release notes for the latest stable version before deploying.

Step 3: Start Tyk Gateway

docker compose up -d

Verify the Installation

Check that the Gateway is running:

curl localhost:8080/hello

Expected response:

{"status": "pass", "version": "v5.x.x", "description": "Tyk GW"}

Next Steps

Tyk Gateway Open Source (OSS)

Installation Options for Tyk Gateway

⌘I

​Prerequisites

​Instructions

​Step 1: Create a Gateway configuration file

​Step 2: Create a Docker Compose file

​Step 3: Start Tyk Gateway

​Verify the Installation

​Next Steps

Prerequisites

Instructions

Step 1: Create a Gateway configuration file

Step 2: Create a Docker Compose file

Step 3: Start Tyk Gateway

Verify the Installation

Next Steps