Skip to main content
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:
For a full list of configuration options, see the Gateway configuration reference.

Step 2: Create a folder for API definitions (Linux only)

The Gateway saves the APIs that you create through the Gateway API in the apps folder. The Gateway container runs as user 65532. On Linux, create the folder and give it to this user before you start the Gateway. If you do not, the Gateway cannot save your APIs:
On macOS and Windows, skip this step. Docker Desktop creates the folder when the Gateway starts.

Step 3: Create a Docker Compose file

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

Step 4: Start Tyk Gateway

Verify the Installation

Check that the Gateway is running:
Expected response:

Next Steps