Docker

We will show you two methods of installing our Community Edition Gateway on Docker.

The quickest way to get started is using docker-compose. Visit our Dockerhub to view the official images.

1. clone the docker-compose repository

$ git clone https://github.com/TykTechnologies/tyk-gateway-docker
Cloning into 'tyk-gateway-docker'...

cd into the directory

$ cd tyk-gateway-docker

Run Tyk Gateway and Redis. We can pass -d flag to run the processes in the background.

$ docker-compose up

1. Let's create a network

$ docker network create tyk
ab1084d034c7e95735e10de804fc54aa940c031d2c4bb91d984675e5de2755e7

Deploy Redis into the network, with the 6379 port open

$ docker run -itd --rm --name redis --network tyk -p 127.0.0.1:6379:6379 redis:4.0-alpine
ea54db4da4b228b7868449882062a962f75a7b2d43cdb0ac5205fb4ccdbcde23

Next, let’s download a JSON tyk.conf configuration file.

$ wget https://raw.githubusercontent.com/TykTechnologies/tyk-gateway-docker/master/tyk.standalone.conf
...
2021-01-28 13:05:22 (6.81 MB/s) - ‘tyk.standalone.conf’ saved [1563/1563]

Run the Gateway, mounting the conf file into the container:

$ docker run \
  --name tyk_gateway \
  --network tyk \
  -p 8080:8080 \
  -v $(pwd)/tyk.standalone.conf:/opt/tyk-gateway/tyk.conf \
  -v $(pwd)/apps:/opt/tyk-gateway/apps \
  docker.tyk.io/tyk-gateway/tyk-gateway:latest

You’re done! Your Tyk Gateway is configured and ready to use.

$ curl localhost:8080/hello
{"status":"pass","version":"v3.0.3","description":"Tyk GW"}

Next Steps Tutorials

Follow the Tutorials on the Community Edition tabs for the following:

Return to Top