> ## 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.

# Install Tyk

> Explore the various installation options for Tyk Self-Managed, including Docker, Kubernetes, Linux packages, Ansible, and more.

| Edition | Deployment Type |
| :- | :- |
| Enterprise | Self-Managed, Hybrid |

> [!NOTE]
>
> This page is for installing **Tyk Self-Managed**. If you are looking to use Tyk as part of **Tyk Cloud**, please refer to [the Tyk Cloud documentation](https://tyk.io/docs/getting-started/create-account.md).

## Architecture

![Tyk Self-Managed Architecture](https://mintcdn.com/tyk/9lJE7z9WW5DJIgp9/img/diagrams/tyk-selfmanaged-architecture.png?fit=max\&auto=format\&n=9lJE7z9WW5DJIgp9\&q=85\&s=e3fe4dd11ef904c6034c5abe10ffefdd)

## Requirements

**Tyk Dashboard** requires a persistent datastore for its operations. By default MongoDB is used. From Tyk v4.0, we also support PostgreSQL.

### PostgreSQL

| Tyk Version | Tested PostgreSQL Versions |
| - | - |
| From 5.X onwards | 15.x, 16.x, 17.x, 18.x |

The following managed services are expected to work as a drop-in replacement for PostgreSQL. Tyk does not test them directly:

* [Amazon RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/)
* [Amazon Aurora PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.AuroraPostgreSQL.html)
* [Azure Database for PostgreSQL](https://learn.microsoft.com/en-us/azure/postgresql/)
* [Google Cloud SQL for PostgreSQL](https://cloud.google.com/sql/docs/postgres)

> [!NOTE]
>
> [Sqlite](https://www.sqlite.org/index.html) support was previously offered for development and testing only. It reached End of Life and is no longer supported from Tyk 5.7.0 onward. Use PostgreSQL, MongoDB, or another listed compatible alternative instead.

Please check [here](https://tyk.io/docs/tyk-configuration-reference/sql.md) for production configuration.

### MongoDB

| Tyk Version | MongoDB Version |
| - | - |
| From 5.X onwards | MongoDB 7.0.x |
| From 5.9 onwards | MongoDB 8.0.x |

You can also use the following as a drop-in replacement for MongoDB:

* [Amazon DocumentDB](https://aws.amazon.com/documentdb/) 3.6 and 4 engine
* [Azure Cosmos DB for MongoDB](https://learn.microsoft.com/en-us/azure/cosmos-db/mongodb/introduction) 3.6 and 4 engine

Please check [here](https://tyk.io/docs/tyk-configuration-reference/mongodb.md) for MongoDB driver and production configuration.

### Redis

> [!WARNING]
>
> Redis is a required dependency. Tyk Gateway, Tyk Dashboard, Tyk Pump and Tyk MDCB do not work without a connection to Redis. Install and configure Redis before you deploy Tyk. In production, make Redis highly available. To see how the Gateway reports a Redis outage, refer to [Liveness Health Checks](https://tyk.io/docs/planning-for-production/ensure-high-availability/health-check.md#redis-outage).

| Tyk Version | Redis Version |
| - | - |
| From 5.0.x to 5.8.x | 6.2.x, 7.x |
| From 5.9.x to 5.11.x | 6.2.x, 7.x, 7.4.x, 8.x (up to 8.2) |
| From 5.12.x onwards | 6.2.x, 7.x, 7.4.x, 8.x (up to 8.4) |

Visit the [Configure Redis](https://tyk.io/docs/tyk-configuration-reference/redis-cluster-sentinel.md#supported-versions) page for more info.

Please check [here](https://tyk.io/docs/tyk-configuration-reference/redis-cluster-sentinel.md) for production configuration.

## Recommended Installation: Docker

For development, testing, and proof of concept purposes, we recommend using our Docker installation, which allows you to quickly spin up a full Tyk stack on your local machine.

> [card]
>
> Install with Docker
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/docker.md)

## Alternative Installation Methods

> [card]
>
> Install on K8s
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/kubernetes.md)

> [card]
>
> Install with Ansible
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/methods.md#install-with-ansible)

> [card]
>
> Install on Red Hat
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/linux.md#install-tyk-on-redhat-rhel-centos)

> [card]
>
> Install on Ubuntu
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/linux.md#install-tyk-on-debian-or-ubuntu)

> [card]
>
> Install on Amazon AWS
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/methods.md#install-on-aws-marketplace)

> [card]
>
> Install Tyk on Heroku
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/methods.md#install-on-heroku)

> [card]
>
> Install on Microsoft Azure
>
> [Open](https://tyk.io/docs/tyk-self-managed/install/methods.md#install-on-microsoft-azure)

## Air Gapped Installation

For environments with restricted network access, we provide guidance on how to deploy Tyk using private container registries and local package mirrors.

Refer to our [Air-Gapped Deployment guide](https://tyk.io/docs/api-management/air-gapped-deployment.md) for detailed instructions on how to set up Tyk in air-gapped or network-restricted environments.