Tyk API Gateway is fully on-premise solution, which include gateway, dashboard and analytics processing pipeline. This demo will run Tyk On-premise on your machine, which contains 5 containers: Tyk Gateway, Tyk Dashboard, Tyk Pump, Redis and Mongodb. This repo great for proof of concept and demo purpose, but if you want test performance, you need to move each component to separate machine, following our documentation https://tyk.io/docs/.

This compose file is designed to provide a quick, simple demo of the Tyk stack, this includes the gateway, the dashboard and the portal.

Set up your /etc/hosts file to include the IP of your docker daemon:

127.0.0.1 www.tyk-portal-test.com
127.0.0.1 www.tyk-test.com

Note that the IP may be different depending on your installation, Windows users may find it running on 10.x.x.x, it is important the URL stays the same because our setup.sh assumes this is the one you are using.

Open the tyk_analytics.conf file in the confs/ folder and add your license string to the "license_key": "" section.

Run docker compose:

docker-compose up

Please note that this command may take a while to complete, as Docker needs to download and provision all of the containers.

This will run in non-daemonised mode so you can see all the output. For the next step, once this step is complete, open a new shell:

Bootstrap the instance:

Open your browser to http://www.tyk-test.com:3000. You will be presented with the Bootstrap UI to create your first organisation and admin user.

Note, if you run into DNS issues with www.tyk-test.com while trying to bootstrap through the GUI, you will need to set the host_config.hostname value in tyk_analytics.conf to the public IP of your Docker daemon or simply use localhost

Please refer to docker-swarm.md for detailed instructions on running this simple deployment on the Docker Swarm with Tyk cluster. Note that in order to have more than one functional gateway node a corresponding license is required.