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 Tyk API Definition?
      • Tyk OAS API Definition
        • Basic concepts
          • Overview
          • Tyk OAS API definition
          • OAS Glossary
          • Feature Status
        • Advanced concepts
          • Overview
          • Servers
          • Authentication
          • Mock Response
          • Request Validation
          • Paths
          • Versioning
      • Tyk Classic API definition
        • Authentication Type Flags
        • CORS
        • Custom Analytics Tags using HTTP Headers
        • Events
        • API Definition GraphQL
        • Blocking IPs
        • Allowing IPs
        • JSON Web Tokens (JWT)
        • Other Root Objects
        • Proxy Transport Settings
        • API Level Rate Limits
        • Uptime Tests
        • Versioning and Endpoint Handling
      • How to secure your APIs in Tyk
      • GraphQL
        • Overview
        • Federation
          • GraphQL Federation Overview
          • GraphQL Entities
          • GraphQL Extension Orphans
        • Graphql Proxy Only
      • Manage multiple environments
        • Manage Multiple Environments
        • Move APIs Between Environments
        • Move Keys Between Environments
        • Move Policies Between Environments
        • Gateway Sharding
        • Tyk Self-Managed
      • Request Middleware Chain
      • Rate Limiting in Tyk
      • Session Metadata
      • API Versioning
      • Security Policy
      • Session Object
      • gRPC Proxy
      • TCP Proxy
    • Basic config and security
      • Security
        • Overview
        • 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
        • Password Policy
        • TLS and SSL
        • Certificate Pinning
      • Control and limit traffic
        • Control & Limit Traffic
        • Key Expiry
        • Rate Limiting
        • Request Quotas
        • Request Size Limits
        • Request Throttling
      • Reduce latency
        • Overview
        • Caching
          • Overview
          • Basic (Global) Caching
          • Advanced Caching
          • Upstream Cache Control
          • Invalidating the Cache
          • Optimising the Cache Storage
      • Report, monitor and trigger events
        • Report, Monitor and Trigger Events
        • Custom Handlers (JavaScript)
        • Event Data
        • Event Types
        • Instrumentation
        • Monitors
        • Webhooks
    • Advanced configurations
      • Overview
      • Transform traffic
        • Overview
        • Endpoint Designer
        • Request Method Transform
        • Request Body
        • Request Headers
        • Response Body
        • Response Headers
        • Use case: SOAP to REST
        • Validate JSON
        • URL Rewriting
        • Looping
        • 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
      • Distributed Tracing
        • Overview
        • OpenTelemetry
          • Overview
          • Datadog
          • Dynatrace
          • Elasticsearch
          • Jaeger
            • Docker
            • Kubernetes
          • New Relic
        • OpenTracing
          • Overview
          • Jaeger
          • New Relic
          • Zipkin
      • Plugins
        • Custom Plugins
        • Quickstarts
          • Go
            • Overview
            • Dashboard
            • Open source
        • Plugins Hub
        • OpenTelemetry Instrumentation
        • CICD Plugin Build
        • Serving plugins
          • Serving Plugins to Tyk Gateway
          • Packaging plugins
        • Plugin Types
          • Overview
          • Request Plugins
          • Authentication Plugins
          • Authentication Plugin Caching
          • Response Plugins
          • Analytics Plugins
        • Supported Languages
          • Overview
          • Golang plugins
          • Javascript
            • JavaScript Middleware
            • Install Middleware
            • Install Middleware on Tyk OSS
            • Install Middleware on Tyk Multi-Cloud
            • Install Middleware on Tyk Pro
            • JavaScript API
            • Middleware Scripting Guide
            • 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
      • Compose APIs
        • Compose APIs
        • Virtual Endpoint Demonstration
        • Example Batch Processing Aggregate Function
        • Virtual Endpoints
      • Error Templates
      • Other Protocols
      • SSE Proxy
      • WebSockets
      • Request Context Variables
      • Log Data
      • 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 Details
    • Environment variables
      • Tyk Gateway configuration options
      • Key value secrets storage for configuration in Tyk
    • 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 cancelled
      • 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.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
    • Advanced configurations
      • User Management
        • Create User Groups
        • Create Users
        • Dashboard Admin API
        • Dashboard API Security
        • Organisations
        • Search Users
        • User Roles
      • SSO
        • Login into the Dashboard using Azure AD - Guide
        • Login into the Dashboard using Okta - Guide
        • Login into the Dashboard using Auth0 - Guide
        • Login into the Dashboard using Keycloak - Guide
      • Analytics
        • Analytics
        • Error Overview
        • Traffic Overview
        • Traffic per API
        • Traffic per OAuth Client
        • Traffic per Key
        • Capping Analytics Data Storage
        • Geographic Distribution
        • Audit Log
        • Log Browser
      • Open Policy Agent (OPA)
        • Dashboard OPA rules
        • Open Policy Agent (OPA)
        • OPA Worked Example
      • Outbound Email Configuration
      • Storage
        • Supported Databases
        • Configuring Data Storage
      • Role Based Access Control (RBAC)
    • API documentation
      • Dashboard admin API
        • Dashboard Admin API Export
        • Dashboard Admin API Import
        • Dashboard Admin API Single Sign On
        • Dashboard Admin API Users
      • Tyk Dashboard Admin API
      • Dashboard Admin API Organisations
      • Dashboard API
      • Analytics Endpoints
      • API Definitions
      • API Key Management
      • Basic Authentication
      • Dashboard URL Reload
      • Manage Key Requests
      • OAuth Key Management
      • Pagination
      • Portal Policies
      • Dashboard API Single Sign On
      • User Groups
      • Web Hooks
      • Tyk Dashboard API
      • Open Policy Agent API
      • Additional Permissions API
      • Users
      • Data Graphs API
    • Environment variables
      • Tyk Dashboard Configuration Options
    • Troubleshooting
      • How to add, list or delete a developer using the API
      • Alerts on new developer key requests
      • Capping analytics data storage
      • Custom Developer Portal Options
      • 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
      • “API catalogue not found“ error in the Developer Portal
      • “Can't update policy. Please ensure at least one access rights setting is set“
      • CORS issues on developer portal
      • 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
      • “Not Found” error in the Developer Portal
      • Port 5000 Errors in the Browser Console
      • “There was a problem updating your CNAME“ error in the Dashboard
      • Receive a CSRF error in the Developer Portal
      • “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.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
      • Advanced configurations
        • Portal API Catalogue
        • Developer Profiles
        • Dynamic Client Registration
        • Step by step guide using Gluu
        • GraphQL
        • Key Requests
        • Step by step guide using Keycloak
        • Monetise
        • Step by step guide using Okta
        • Portal Concepts
        • Portal events and notifications
        • Portal OAuth Clients
      • API documentation
        • Portal Configuration
        • Portal Developers
        • Portal Documentation
        • Portal Keys
        • Tyk Portal API
      • Portal customisation
        • 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
      • Publish an API
      • Tyk Portal Classic
      • Step by step guide using Curity
  • 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
      • 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.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
    • Environment variables
      • MDCB Configuration options
    • Release notes
      • 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
    • Troubleshooting
      • “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
      • Useful Debug Modes
    • Supported Backends
    • Separated Analytics Storage
    • Release notes
      • Pump v1.9
      • Pump v1.8
  • Tyk Operator (Open Source)
    • Overview
    • Getting Started
      • Overview
      • Installing Tyk Operator
      • Create an API
      • Access an API
      • Secure an API
      • Publish an API
      • Configure Tyk Operator as Ingress Controller
    • Tyk Operator Reconciliation
    • Migration to Tyk Operator
    • Troubleshooting
      • Understanding Reconciliation Status
    • Release notes
      • Tyk Operator v0.16
  • Tyk Sync (Open Source)
    • Overview
    • Release notes
      • 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.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