The Complete Docker Tyk Demo

Tyk-demo is a repository that enables you to start up locally an entire Tyk stack with all its dependencies and integrations such as SLIs and SLOs with Prometheus and Grafana or OpenTelemetry with Jaeger.

Purpose

With tyk-demo repository, using docker-compose, you can set up quickly a complete Tyk stack, including dependencies and integrations.

Minimize the amount of effort needed to start up the Tyk infrastructure and show end-to-end complete examples of how to set up various capabilities in Tyk as well as different integrations.

Key Features

• Full Tyk stack deployment
• Pre-configured demo APIs
• Analytics and monitoring tools
• Integration with common third-party services

Watch the video What Is Tyk Demo for an overview and learn about the key features from our experts -

Prerequisites

1. Docker compose

Make sure you have docker compose and that docker is running on your machine.

2. License key

This Demo deploys and runs the full Tyk platform which is a licensed product. Please sign up using the button below, to obtain a license key. In the link, choose “Get in touch” to get a guided evaluation of the Tyk Dashboard and receive your temporary license.

Quick Start

The following steps will enable you to quickly get started:

1. Clone the repository:

git clone https://github.com/TykTechnologies/tyk-demo.git

2. Navigate to the directory:

cd tyk-demo

3. Add license key to .env file:

DASHBOARD_LICENCE=<your license key>

4. Run the setup script:

./up.sh

5. Access Tyk Dashboard: http://localhost:3000

To complete the instruction above we have a tutorial video of tyk demo that covers:

• Downloading and starting tyk-demo
• Setting up your license
• Logging in to Tyk Dashboard

Getting Help

If you need assistance, please visit our Community Forum or contact our team.

What’s Next?

After exploring the demo, consider:

• Deploying Tyk in Kubernetes
• Exploring advanced features such as Python gRPC plugin and Tyk multi datacenter
• Exploring integrations, such as Dynamic Client registration in Keycloak IdP, Open Telemetry with New Relic