Tyk API Gateway and API Management
Tyk YouTube tyk.io Community 24/7 SupportCloud Login Install
Home
Deployment and Operations
API Management
Product Stack
Developer Support
APIM Best Practice
Home
Deployment and Operations
API Management
Product Stack
Developer Support
APIM Best Practice
  • Overview
  • Tyk Gateway (Open Source)
    • Overview
    • Key concepts
      • Overview
      • What is an API Definition?
      • Tyk OAS Concepts
        • Overview
        • Servers
        • Authentication
        • Paths
        • Versioning
        • Tyk OAS Maturity
        • OAS Glossary
      • Tyk Classic Concepts
        • Authentication Type Flags
        • CORS
        • Custom Analytics Tags using HTTP Headers
        • Events
        • API Definition GraphQL
        • JSON Web Tokens (JWT)
        • Other Root Objects
        • Proxy Transport Settings
        • API Level Rate Limits
        • Uptime Tests
        • Tyk Classic API Versioning
        • Versioning and Endpoint Handling
      • GraphQL
        • Overview
        • Federation
          • GraphQL Federation Overview
          • GraphQL Entities
          • GraphQL Extension Orphans
        • Graphql Proxy Only
      • How to manage multiple Tyk environments
        • Manage Multiple Environments
        • Move APIs Between Environments
        • Move Keys Between Environments
        • Move Policies Between Environments
        • Gateway Sharding
        • Tyk Self-Managed
      • How to secure your APIs in Tyk
      • Request Middleware Chain
      • What is Rate Limiting?
      • What is a Security Policy?
      • What is a Session Object?
      • What is Session Metadata?
      • What is Internal Looping?
    • Basic config and security
      • Overview
      • Security
        • Authentication and authorization
          • Overview
          • Authorization Code Grant Type
          • Client Credentials Grant Type
          • Refresh Token Grant Type
          • Username and Password Grant Type
          • Basic Authentication
          • Bearer Tokens
          • External OAuth Middleware
          • Go Plugin Authentication
          • HMAC Signatures
          • JSON Web Tokens
          • JWT and Auth0 with Tyk
          • Split Token
          • Multiple Auth
          • OAuth 2.0
          • Open (Keyless)
          • OpenID Connect
          • Key Expiry and Deletion
          • Python CoProcess and JSVM Plugin Authentication
          • Revoke OAuth Tokens
          • JWT and Keycloak with Tyk
        • MTLS
          • Concepts
          • Mutual TLS
          • Client mTLS
          • Upstream mTLS
        • Security policies
          • Overview
          • Policies Guide
          • Secure your APIs by Method and Path
          • Partitioned Policies
        • Gateway
        • Key Hashing
        • Key Level Security
        • Tyk and OWASP Top Ten Threats
        • TLS and SSL
        • Certificate Pinning
        • Blocking Client IPs
        • Allowing Client IPs
      • Control and limit traffic
        • Overview
        • Key Expiry
        • Rate Limits
        • Request Quotas
        • Request Size Limits
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Request Throttling
      • Reduce latency
        • Overview
        • Caching
          • Overview
          • Basic (Global) Caching
          • Endpoint Caching
            • Overview
            • Tyk OAS configuration
            • Tyk Classic configuration
          • Upstream Cache Control
          • Invalidating the Cache
          • Optimizing the Cache Storage
      • Log traffic
        • Overview
        • Detailed recording
        • Do Not Track
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
      • Gateway events
        • Overview
        • Event types
        • Event metadata
        • Event handling with webhooks
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Logging events
        • Custom event handlers
        • Advanced quota monitoring
    • Advanced configurations
      • Overview
      • Transform traffic
        • Overview
        • Allow List
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Block List
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Ignore Authentication
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Internal Endpoint
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Request Method
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Request Body
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Request Headers
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Response Body
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Response Headers
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Use case: SOAP to REST
        • Request Validation
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Mock Response
          • Overview
          • Tyk OAS key concepts
          • Tyk OAS configuration
          • Tyk Classic configuration
        • URL Rewriting
          • Overview of URL Rewriting
          • URL Rewrite middleware
          • URL Rewriting with Tyk OAS
          • URL Rewriting with Tyk Classic
        • Virtual Endpoints
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
          • Examples
        • Go Templates
        • JQ Transforms
      • Integration options
        • Overview
        • 3rd Party identity providers
          • 3rd Party Identity Providers
          • Custom
          • Login into the Dashboard using LDAP - Guide
          • LDAP
          • Social Provider
          • Log into an APP with Google
          • Log into Dashboard with Google
        • API authentication mode
          • API Authentication Mode
      • Observability
        • Overview
        • Metrics
        • System logs
        • OpenTelemetry
          • Overview
          • Datadog
          • Dynatrace
          • Elasticsearch
          • Jaeger
            • Docker
            • Kubernetes
          • New Relic
        • OpenTracing
          • Overview
          • Jaeger
          • New Relic
          • Zipkin
      • Custom plugins
        • Overview
        • Quickstarts
          • Go
            • Overview
            • Dashboard
            • Open source
        • Plugins Hub
        • API Configuration
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
        • Plugin Types
          • Overview
          • Request Plugins
          • Authentication Plugins
          • Authentication Plugin Caching
          • Response Plugins
          • Analytics Plugins
          • Per-endpoint Plugins
            • Overview
            • Tyk OAS configuration
            • Tyk Classic configuration
        • Plugin bundles
          • Overview
          • Tyk OAS configuration
          • Tyk Classic configuration
          • Bundle CLI tool
        • Supported Languages
          • Overview
          • Golang
            • Overview
            • Writing Go Plugins
            • Go Plugin Development Flow
            • Go Plugin Compiler
            • Loading Go Plugins
            • Go Plugin Examples
          • Javascript
            • Overview
            • JS Scripting Guide
            • JavaScript API
            • Using JS plugins with Tyk Self-Managed
            • Using JS plugins with Tyk Hybrid
            • Using JS plugins with Tyk OSS
            • WAF (OSS) ModSecurity Plugin example
          • Rich Plugins
          • Rich Plugins - How do They work?
          • Rich Plugins - Data Structures
          • Rich Plugin - Python
            • Overview
            • Tutorial- Custom Authentication Plugin
            • Tutorial - Add Python Plugin To Your Gateway
            • Tyk Python API methods
            • Performance
          • Rich Plugin - gRPC
            • Overview
            • Key Concepts
            • Getting Started
            • Tutorials
              • Create Java Request Transformation Plugin
              • Create .NET Custom Authentication Plugin
              • Create NodeJS Custom Authentication Plugin
              • Create Python Custom Authentication Plugin
            • Performance
          • Rich Plugin - Lua
            • LuaJIT
            • Requirements
            • Lua Plugin Tutorial
        • OpenTelemetry Instrumentation
        • CICD Plugin Build
      • Error Templates
      • Non-HTTP Protocols
        • Overview
        • gRPC Proxy
        • TCP Proxy
        • SSE Proxy
        • WebSocket Proxy
      • Request Context Variables
      • Securing System Payloads
    • API documentation
      • Gateway API Overview
      • Tyk Gateway Open API Documentation
      • Tyk OAS API Definition Object
      • Tyk Classic API Definition Object
      • Token Session Object
    • Environment variables
      • Tyk Gateway configuration options
    • Troubleshooting
      • Add Custom Certificates to Trusted Storage of Docker Images
      • API definition URL case sensitive
      • How to change the logging output location
      • How to Check Your Gateway Version
      • How to clear / invalidate API cache
      • How to find the Gateway logging output
      • How to import existing keys into Tyk CE
      • Redis persistence using containers
      • 499 Errors
      • 502 error in Tyk Gateway
      • proxy error: context canceled
      • DRL not ready, skipping this notification
      • “Index out of range“ error in logs
      • “Invalid memory address or nil pointer dereference“ error
      • “Key object validation failed“ error when updating a key
      • “There was a problem proxying the request“
      • Tyk Gateway Profiling
      • Support Information
      • Hot restart a Tyk Gateway Process
      • Error Response Status Codes
    • Release notes
      • Overview
      • Tyk Gateway v5.4
      • Tyk Gateway v5.3
      • Tyk Gateway v5.2
      • Tyk Gateway v5.1
      • Tyk Gateway v5.0
      • Tyk Gateway v4.3
      • Tyk Gateway v4.2
      • Tyk Gateway v4.1
      • Tyk Gateway v4.0
      • Tyk Gateway v3.2
      • Tyk Gateway v3.1
      • Tyk Gateway v3.0
      • Archived releases
        • Tyk Gateway v2.9
        • Tyk Gateway v2.8
        • Tyk Gateway v2.7
        • Tyk Gateway v2.6
        • Tyk Gateway v2.5
        • Tyk Gateway v2.4
        • Upgrading to v2.3 from v2.2
    • Important Prerequisites
  • Tyk Dashboard
    • Overview
    • Tyk Classic Endpoint Designer
    • Advanced configurations
      • User Management
        • Overview
        • User Permissions
        • Managing Users
        • Managing User Groups
        • Search Users
        • Password Policy
        • API Ownership
      • Dashboard Administration
        • Overview
        • Organisations
      • Analytics
        • Overview
        • Traffic Overview
        • Activity logs
        • Activity by API
        • Activity by Key
        • Activity by endpoint
        • Activity by location
        • Activity by errors
        • Traffic per OAuth Client
      • Open Policy Agent (OPA)
        • Overview
        • Dashboard OPA rules
        • OPA Worked Example
      • Storage
        • Supported Databases
        • Configuring Data Storage
      • API Templates
        • Overview
        • Using the Template Designer
        • Using the Dashboard API
      • API Categories
      • Dashboard audit logs
    • API documentation
      • Dashboard API
        • Overview
        • Pagination
        • Manage APIs
        • Data Graph APIs
        • Dashboard Analytics
        • Manage Users
        • Manage User Groups
        • Manage Additional User Permissions
        • Manage Access Keys
        • Manage Basic Auth
        • Manage OAuth
        • Setup Single Sign On
        • Manage Webhooks
        • Open Policy Agent API
        • Classic Portal
          • Portal Key Requests
          • Portal Policies
        • Dashboard API Reference
      • Dashboard Admin API
        • Manage Organisations
        • Manage Users
        • Setup SSO
        • Dashboard URL Reload
        • Export Tyk assets
        • Import Tyk assets
        • Admin API reference
    • Environment variables
      • Tyk Dashboard Configuration Options
    • Troubleshooting
      • Capping analytics data storage
      • Dashboard bootstrap error
      • How to find the policy ID for a created policy
      • Gateway detected 0 APIs
      • How to Connect to DocumentDB with X.509 client cert
      • How to disable an API
      • How to Setup CORS
      • No Key information on the Dashboard
      • How to rename or move existing headers in a request
      • How to run the Dashboard and portal on different ports
      • How to run two Gateways with docker-compose
      • “Can't update policy. Please ensure at least one access rights setting is set“
      • Dashboard not showing any analytics data
      • Fatal - Dashboard and portal domains cannot be the same
      • Internal TIB SSO User unable to log in
      • Key object validation failed, most likely malformed input error
      • Port 5000 Errors in the Browser Console
      • “There was a problem updating your CNAME“ error in the Dashboard
      • “runtime error invalid memory address or nil pointer dereference“
      • “ValueError No JSON object could be decoded" when running Dashboard Bootstrap script
      • “Payload signature is invalid!“ error
      • MongoDB X.509 Client Authentication
    • Release notes
      • Overview
      • Tyk Dashboard v5.4
      • Tyk Dashboard v5.3
      • Tyk Dashboard v5.2
      • Tyk Dashboard v5.1
      • Tyk Dashboard v5.0
      • Tyk Dashboard v4.3
      • Tyk Dashboard v4.2
      • Tyk Dashboard v4.1
      • Tyk Dashboard v4.0
      • Tyk Dashboard v3.2
      • Tyk Dashboard v3.1
      • Tyk Dashboard v3.0
      • Archived releases
        • Tyk Dashboard v2.9
        • Tyk Dashboard v2.8
        • Tyk Dashboard v2.7
        • Tyk Dashboard v2.6
        • Tyk Dashboard v2.5
        • Tyk Dashboard v2.4
    • Tyk Classic Developer Portal
      • Overview
      • Portal Concepts
      • Portal API Catalogue
      • Publish an API
      • Advanced configurations
        • Key Requests
        • Developer Profiles
        • Dynamic Client Registration (DCR)
          • Overview
          • Step by step guide using Gluu
          • Step by step guide using Keycloak
          • Step by step guide using Okta
          • Step by step guide using Curity
        • Portal OAuth Clients
        • GraphQL with Classic Portal
        • Monetising your APIs
        • Events and Notifications
        • Outbound Email Configuration
      • Portal customisation
        • Overview
        • Customising API Visibility
        • Customise the Portal Menus
        • Creating a Custom Developer Portal
        • Swap out Swagger UI for ReDoc
        • Customise Pages with CSS and JavaScript
        • Customising using jQuery
        • Customise the Developer Signup Form
        • Customise Page Templates
      • API documentation
        • Overview
        • Configuration
        • Developers
        • API Publishing
        • Key Requests
      • Troubleshooting
        • How to add, list or delete a developer using the API
        • Alerts on new developer key requests
        • Custom Developer Portal Options
        • “API catalogue not found“ error in the Developer Portal
        • CORS issues on developer portal
        • “Not Found” error in the Developer Portal
        • Receive a CSRF error in the Developer Portal
  • Universal Data Graph (UDG)
    • Overview
    • Key concepts
      • Concepts - Universal Data Graph
      • Concepts - Data sources
      • Concepts - Arguments
      • Concepts - Field Mappings
      • Concepts - Reusing response fields
      • Concepts - Header management
    • Connect Data Sources
      • UDG Datasources
      • GraphQL Datasource
      • Kafka Datasource
      • REST Datasource
      • Tyk Datasource
  • Tyk Enterprise Developer Portal
    • Overview
    • Deploy
      • Install Tyk Enterprise Developer Portal
      • Installation options
        • Overview
        • Docker
        • Docker Compose
        • New helm chart
        • Legacy helm chart
        • Red Hat (RHEL / CentOS)
      • Bootstrap Tyk Enterprise Developer Portal
    • Get started
      • Tyk Enterprise Portal Concepts
      • Connect to Tyk Dashboard
      • Create API Products and plans
      • Customize API Products' and plans' appearance
      • Create API consumer organisation and catalog
      • Customize the sign-up form
      • Setup email notifications
    • Manage API consumers
      • Add Organisations
      • Approve Self Registering Requests
      • Enable single sign on for admin users and developers
      • Invite Codes
      • Manage API Consumer organisations
      • Manage API Consumers
      • Manage API Users
      • Manage Catalogues
      • Managing Access
      • Developer API Consumer Portal
        • Overview
        • Register for a Portal
        • Reset Password
        • Access an API Product
    • Manage API access
      • API Access
      • Approve or reject provisioning requests
      • Manage Apps and Credentials
      • Dynamic client registration
      • Configure rate limit keys
      • Create Get started guides for your API Products
    • Customise the portal
      • Customising UI appearance
        • Quick Customisation
        • Complete customisation
          • Overview
          • Developer Workflow
            • Overview
            • File Structure and Concepts
            • Create a New Page Template
          • Email Workflow
          • Content Manager Workflow
            • Overview
            • Edit Manage Page Content
            • Menus Customisation
          • Upgrade the portal theme
      • Customize data models
      • Configure webhooks
    • Environment variables
      • Configure Tyk Enterprise Developer Portal
    • Release notes
      • Version 1.10.0
      • Version 1.9.0
      • Version 1.8.5
      • Version 1.8.4
      • Version 1.8.3
      • Version 1.8.2
      • Version 1.8.1
      • Version 1.8.0
      • Version 1.7.0
      • Version 1.6.0
      • Version 1.5.0
      • Version 1.4.0
      • Version 1.3.0
      • Version 1.2.0
      • Version 1.1.0
    • API documentation
      • OpenAPI document for the admin APIs
      • List of all endpoints
        • Version 1.9.0
  • Tyk Multi Data Centre Bridge
    • Overview
    • Getting started
      • MDCB Components
      • Minimising latency with MDCB
      • Setup MDCB Control Plane
      • Setup MDCB Data Plane
    • Advanced configurations
      • Synchroniser feature with MDCB
    • API documentation
      • MDCB API Reference
    • Environment variables
      • MDCB Configuration options
    • Release notes
      • MDCB v2.6
      • MDCB v2.5
      • MDCB v2.4
      • MDCB v2.3
      • MDCB v2.2
      • MDCB v2.1
      • MDCB v2.0
  • Tyk Pump (Open Source)
    • Overview
    • Getting started
      • Tyk Pump Configuration
      • Setup Dashboard Analytics
      • Graph Pump setup
    • Environment variables
      • Tyk Pump Environment Variables
    • Advanced configurations
      • Configure data sinks
        • CSV Setup
        • Datadog Setup
        • Elasticsearch Setup
        • Logz.io Setup
        • Moesif Setup
        • Splunk Setup
        • Tyk Analytics Record Fields
      • Monitor your APIs with Prometheus
      • Setup Prometheus Pump
      • Capping Analytics Data Storage
      • Separated Analytics Storage
    • Troubleshooting
      • Capturing detailed logs
      • “Connection dropped, connecting...“
      • Data Seen in Log Browser but No Reports
      • “No Elasticsearch node available“
      • Tyk Pump Panic “stack exceeds 1000000000-byte limit“
      • “Pump overloaded“
      • Tyk Pump Graceful Shutdown
    • Supported Backends
    • Release notes
      • Pump v1.10
      • Pump v1.9
      • Pump v1.8
  • Tyk Operator (Open Source)
    • Overview
    • Key Concepts
      • Custom Resources
      • Operator Reconciliation
      • Operator User
      • Operator Context
    • Getting Started
      • Installing Tyk Operator
      • Create an API
      • Access an API
      • Secure an API
      • Publish an API
    • Advanced configurations
      • Migration to Tyk Operator
      • Configure Tyk Operator as Ingress Controller
      • Manage Multiple Organisations With OperatorContext
      • Manage API Ownership with OperatorContext
    • Troubleshooting
      • Understanding Reconciliation Status
    • Reference
      • Version compatibility
    • Release notes
      • Overview
      • Tyk Operator v0.18
      • Tyk Operator v0.17
      • Tyk Operator v0.16
  • Tyk Streams
    • Overview
    • Glossary
    • Key Concepts
    • Configuration
      • Overview
      • Inputs
        • Overview
        • Amqp_0_9
        • Amqp_1
        • Broker
        • Generate
        • Http Client
        • Http Server
        • Kafka
        • Kafka Franz
        • MQTT
        • Nats
        • NSQ
        • Redis PubSub
      • Outputs
        • Overview
        • Amqp_0_9
        • Amqp_1
        • Broker
        • Drop on
        • Fallback
        • Http Client
        • Http Server
        • Kafka
        • Kafka Franz
        • Nats
        • NSQ
        • MQTT
        • Redis PubSub
        • Reject
        • Retry
        • Sleep
        • Stdout
        • Switch
        • Sync Response
      • Processors
        • Overview
        • Avro
        • AWS Lambda
        • Bloblang
        • Branch
        • Bounds Check
        • Cache
        • Cached
        • Catch
        • Dedupe
        • For Each
        • Group By
        • Group By Value
        • Http
        • Insert Part
        • JMESPath
        • Jq
        • JSON Schema
        • Log
        • Mapping
        • Msgpack
        • Mutation
        • Noop
        • Parallel
        • Parse Log
        • Processors
        • Protobuf
        • Rate Limit
        • Redis
        • Retry
        • Schema Registry Decode
        • Schema Registry Encode
        • Select Parts
        • Split
        • Switch
        • Sync Response
        • Try
        • While
        • Workflow
      • Scanners
        • Overview
        • CSV
        • Line
        • Regular Expression Matching
        • Switch
      • Common Configurations
        • Batching
        • Error Handling
        • Field Paths
        • Interpolation
        • Processing Pipelines
        • Resources
        • Windowed Processing
    • Guides
      • Bloblang
        • Overview
        • Advanced
        • Arithmetic
        • Functions
        • Methods
          • Overview
          • General
          • Encoding and encryption
          • GeoIP
          • JSON web tokens
          • Number Manipulation
          • String Manipulation
          • Objects and Arrays
          • Regular expressions
          • Parsing
          • Timestamp Manipulation
          • Type Coercion
      • Sync Response
    • Rate Limits
      • Overview
      • Local
    • Deployment Considerations
    • Developer Portal Integration
    • Troubleshooting & FAQs
  • Tyk Sync (Open Source)
    • Overview
    • Installing and running Tyk Sync
    • Tutorials
      • Keeping and updating API Definitions locally
      • Synchronising API configurations with GitHub Actions
      • Backing up API configurations with Github Actions
    • Commands
      • Dump
      • Examples
      • Publish
      • Sync
      • Update
    • Release notes
      • Tyk Sync v1.5
      • Tyk Sync v1.4
  • Tyk Identity Broker (Open Source)
    • Overview
    • Getting started
      • Getting started with TIB
      • TIB implementation with GitHub and OAuth 2.0
    • TIB Profiles
    • API Documentation
    • Advanced config
      • Tyk Identity Broker Configuration Options
  • Tyk Helm Charts (Open Source)
    • Overview
    • Tyk Stack Chart
    • Tyk Control Plane Chart
    • Tyk Data Plane Chart
    • Tyk Open Source Chart
    • Release Notes
      • Tyk Charts 1.5
      • Tyk Charts 1.4
      • Tyk Charts 1.3
Tyk YouTube tyk.io Community 24/7 Support

Need help from one of our engineers?

Get in contact
Book a personalised demo

Installation options

Last updated: Dec 8, 2023 1 minute read.

The Tyk Enterprise Developer Portal supports multiple installation flavors. Check out the guides below to deploy the portal on the platform that suits you best.

10 mins

Docker install Install with Docker

10 mins
Keep reading
10 mins

Docker-compose install Install with Docker Compose

10 mins
Keep reading
10 mins

Kubernetes install Install on Kubernetes

10 mins
Keep reading
10 mins

Red Hat install Install on Red Hat

10 mins
Keep reading

See also

  • Environment Variables and Configuration
  • Install Tyk Enterprise Developer Portal
  • Install Tyk Enterprise Developer Portal using Docker
  • Bootstrap Tyk Enterprise Developer Portal
  • Install Tyk Enterprise Developer Portal in Red Hat environment using RPM
Found a content problem with this page?
  • Edit the page on GitHub
  • Report the content issue
  • View the source on GitHub
Want to get more involved? See our technical contributors guide
Page forward and back image

Extra

  • About Tyk
  • Blog
  • Careers
  • Pricing

Help

  • Cloud Status
  • Raise Bug

Social

  • © Tyk Technologies, 2025
  • Terms & Conditions
  • Privacy Policy
  • GDPR
  • Responsible Disclosure
Return to Top
This website uses cookies to improve your experience. We'll assume you're ok with this, but you can opt-out if you wish.
   Tyk's Privacy Policy