Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Prerequisites

​
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