🔄 Preview: docs: overhaul Tyk Self-Managed installation page #1291

buger · 2026-01-14T11:54:25Z

🔗 Auto-generated mirror PR for Mintlify preview

Original PR: #1290
Author: @buger

Purpose

This PR provides a Mintlify preview link for reviewing documentation changes.

Preview Link

The Mintlify preview will be available once this PR is processed.

⚠️ Important Notes

Do not merge this PR directly
This PR will be auto-merged when the original PR docs: overhaul Tyk Self-Managed installation page #1290 is merged
Make all comments and reviews on the original PR docs: overhaul Tyk Self-Managed installation page #1290

Changes

Summary

This PR completely overhauls the Tyk Self-Managed installation documentation page () to improve user experience and remove outdated information.

Key Changes

Restructured to highlight recommended methods: Docker and Kubernetes (Helm) are now prominently featured at the top with Recommended labels
Added critical GLIBC 2.31+ system requirements: Clear warning at the top specifying minimum OS versions (Ubuntu 22.04+, Debian 11+, RHEL 9+)
Removed unsupported Tyk Ansible content: All references to the unmaintained tyk-ansible repository have been removed
Updated OS support tables: Removed all EOL operating systems (Debian 9/10, Ubuntu 16/18/20, CentOS, RHEL 7/8)
De-emphasized alternatives: AWS, Azure, GCP, Heroku, and Windows options moved to collapsible accordions
Modernized examples: Updated all Ubuntu package repository examples from (18.04) to (22.04)

Results

Page reduced from ~3200 lines to ~1573 lines
Clearer path for new users to follow recommended installation methods
Outdated/unsupported information removed to prevent user confusion

Test plan

Verify page renders correctly in Mintlify preview
Verify all internal links work correctly
Verify accordion components expand/collapse properly
Verify card links navigate to correct sections
Review content accuracy with Customer Engineering team

* Update dashboard.mdx * Update gateway.mdx * Update dashboard.mdx * Update gateway.mdx * Update dashboard.mdx * Update gateway.mdx * Update gateway.mdx * Update dashboard.mdx * Update dashboard.mdx * Update dashboard.mdx * Update gateway.mdx * Update dashboard.mdx * Update gateway.mdx * Update gateway.mdx * Update dashboard.mdx * Update gateway.mdx * Update gateway.mdx * Update gateway.mdx * Update dashboard.mdx * Update overview.mdx * Update dashboard.mdx * Update gateway.mdx * Update dashboard.mdx * Update gateway.mdx * Update dashboard.mdx * Update dashboard.mdx * Update gateway.mdx * Update gateway.mdx * Update dashboard.mdx * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update gateway.mdx * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update dashboard.mdx * Update dashboard.mdx * Update dashboard.mdx * Update dashboard.mdx * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update dashboard.mdx * Update gateway.mdx * Update dashboard.mdx --------- Co-authored-by: Leonid Bugaev <leonsbox@gmail.com> Co-authored-by: Master <sharadregoti15@gmail.com> Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update pump.mdx * Update pump.mdx * Update pump.mdx * Update pump.mdx * Update developer-support/release-notes/pump.mdx * Update developer-support/release-notes/pump.mdx * Update overview.mdx * Update pump.mdx * Update pump.mdx * Update pump.mdx * Update pump.mdx * Update pump.mdx * Update pump.mdx * Update developer-support/release-notes/pump.mdx * Update pump.mdx --------- Co-authored-by: Leonid Bugaev <leonsbox@gmail.com> Co-authored-by: Master <sharadregoti15@gmail.com> Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

#1231) Update gateway release notes to clarify performance improvements for JWT APIs and asynchronous organization expiry validation. Enhanced descriptions for better understanding of fixes related to OAuth client key retrieval delays and request pipeline blocking issues.

…e API Products guide for Developer Portal (#1184) * [TT-15552] docs: add Direct Access Flow guide for Developer Portal Add comprehensive documentation for the Direct Access Flow feature introduced in Tyk Portal 1.16. This feature simplifies the API access request process by removing the shopping cart step. The guide covers: - Introduction to both Cart-based and Direct Access flows - Instructions for Portal admins to enable Direct Access flow - Developer experience for requesting first product and adding more - Credential compatibility rules (one credential per plan) - Plan change workflows - Backward compatibility information - Comparison table and troubleshooting section 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs(portal): enhance Direct Access Flow guide with complete structure Update the Direct Access Flow documentation with: - Proper title: "How to add API products using Direct Access Flow" - Availability section with version and edition info - Prerequisites section with required setup - "What we will do" summary section - Step-by-step instructions with numbered steps - Detailed scenarios for same-plan and different-plan credential reuse - Plan change management documentation - Administrator operations section - Cart-based flow reversion instructions - Comparison table between flow types - Troubleshooting and best practices sections This comprehensive guide addresses the requirements from TT-15552 for simplifying the access management flow documentation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs(portal): rewrite Direct Access Flow as step-by-step guide Restructure the Direct Access Flow documentation to follow the standard how-to guide format (similar to import-custom-credentials.mdx): - Remove introductory explanation section - Add proper Availability table with version info - Add numbered Prerequisites section - Add "What we will do" summary section - Rewrite all content as numbered Instructions - Cover all scenarios: enable flow, request access, reuse credentials, change plans, handle different plans, admin operations, revert This addresses feedback that the previous version was a feature explanation rather than a step-by-step guide. Jira: TT-15552 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Fixes * F * F --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Sharad Regoti <sharadregoti15@gmail.com>

@andyo-tyk

* Update approve-requests.mdx * Update dynamic-client-registration.mdx * Update approve-requests.mdx * Update approve-requests.mdx * Update approve-requests.mdx * Update approve-requests.mdx * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update api-products.mdx * Update api-products.mdx * Update api-products.mdx * Update api-products.mdx * Update api-products.mdx * Update api-products.mdx * Update approve-requests.mdx * Update concepts.mdx * Update approve-requests.mdx * Update approve-requests.mdx * Update approve-requests.mdx * Update approve-requests.mdx * Apply suggestion from @caroltyk Co-authored-by: caroltyk <97617859+caroltyk@users.noreply.github.com> * Apply suggestion from @caroltyk Co-authored-by: caroltyk <97617859+caroltyk@users.noreply.github.com> * Apply suggestion from @caroltyk Co-authored-by: caroltyk <97617859+caroltyk@users.noreply.github.com> * Apply suggestion from @caroltyk Co-authored-by: caroltyk <97617859+caroltyk@users.noreply.github.com> * Apply suggestion from @caroltyk Co-authored-by: caroltyk <97617859+caroltyk@users.noreply.github.com> * Apply suggestion from @caroltyk Co-authored-by: caroltyk <97617859+caroltyk@users.noreply.github.com> * Update portal/overview/concepts.mdx * Update tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/approve-requests.mdx * Update tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/approve-requests.mdx * Update tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/approve-requests.mdx --------- Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> Co-authored-by: caroltyk <97617859+caroltyk@users.noreply.github.com> Co-authored-by: Master <sharadregoti15@gmail.com> Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>

Add documentation for the new PORTAL_SSO_CUSTOM_LOGIN_URL environment variable introduced in portal PR #1715 (TT-15340). This setting allows redirecting the portal login page to a custom SSO login URL, enabling seamless integration with external Identity Providers. Changes: - Add PORTAL_SSO_CUSTOM_LOGIN_URL configuration entry - Update sample config files (JSON and environment variables) - Place documentation next to PORTAL_API_SECRET (related SSO setting) Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>

* Import config/docs * Remove ServerRegenerationConfig --------- Co-authored-by: sharadregoti <24411676+sharadregoti@users.noreply.github.com> Co-authored-by: Burak Sezer <burak.sezer.developer@gmail.com>

Import config/docs Co-authored-by: imogenkraak <162994391+imogenkraak@users.noreply.github.com>

* Update helm-chart.mdx * Update overview.mdx * Update developer-support/release-notes/helm-chart.mdx * Update helm-chart.mdx * Update helm-chart.mdx * Update helm-chart.mdx * Update helm-chart.mdx * Update helm-chart.mdx * Update helm-chart.mdx --------- Co-authored-by: Master <sharadregoti15@gmail.com> Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

* Update sync.mdx * Update sync.mdx * Update overview.mdx * Update developer-support/release-notes/sync.mdx * Update sync.mdx * Update sync.mdx * Update sync.mdx * Update sync.mdx * Update sync.mdx --------- Co-authored-by: Leonid Bugaev <leonsbox@gmail.com> Co-authored-by: Master <sharadregoti15@gmail.com>

Import config/docs Co-authored-by: imogenkraak <162994391+imogenkraak@users.noreply.github.com>

Tyk 5.8.10 RNs.mdx (#1220) * Update gateway.mdx * Update gateway.mdx * Update dashboard.mdx * Update overview.mdx * Update gateway.mdx * Update gateway.mdx * Update dashboard.mdx * Update gateway.mdx * Update dashboard.mdx * Update release date and version numbers in release notes Updated the release date and modified version numbers for Sync, EDP, and Pump. * Correct release date and update version recommendations Updated release date and version recommendations for Gateway 5.8.10. * Update release date and Sync version in release notes Updated the release date for version 5.8.10 and modified the recommended release for Sync. --------- (cherry picked from commit a556551) Co-authored-by: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com> Co-authored-by: Ilija Bojanovic <ilijabojanovic@gmail.com>

)

…ible (#1281)

This major overhaul of the Tyk Self-Managed installation documentation addresses the need for a clearer, more user-friendly installation guide: **Key Changes:** 1. **Restructured page to highlight recommended methods** - Docker and Kubernetes (Helm) are now prominently featured at the top - Added clear "Recommended" labels to these installation options 2. **Added critical system requirements** - Added GLIBC 2.31+ requirement warning at the top of the page - Specifies minimum OS versions: Ubuntu 22.04+, Debian 11+, RHEL 9+ - This prevents users from attempting installation on incompatible systems 3. **Removed unsupported Tyk Ansible content** - Completely removed all references to tyk-ansible repository - This method is no longer maintained and was causing user confusion 4. **Updated OS support tables** - Removed all EOL operating systems: - Debian 9 (Stretch) - EOL June 2022 - Debian 10 (Buster) - EOL August 2024 - Ubuntu 16.04, 18.04, 20.04 - CentOS 7, 8 - RHEL 7, 8 - Updated to only list currently supported versions 5. **De-emphasized alternative installation methods** - Moved AWS, Azure, GCP, Heroku, and Windows options to collapsible accordions in an "Alternative Installation Methods" section - These are still accessible but don't clutter the main page 6. **Modernized Ubuntu references** - Updated all package repository examples from `bionic` (18.04) to `jammy` (22.04) - Added notes about substituting with user's actual Ubuntu version The page was reduced from ~3200 lines to ~1573 lines while maintaining all essential installation paths. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

…ty (#1287)

yurisasuke and others added 30 commits June 19, 2025 18:50

push initial code

94d4ace

Merge pull request #79 from TykTechnologies/initial-code-push

7bb27c5

push initial code

fix get started broken link

0ff7781

Merge pull request #82 from TykTechnologies/test-release-to-branches

d4922eb

fix get started broken link

add release-bot (#84)

ead5719

* add release-bot * add release-bot --------- Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

Revert "fix get started broken link" (#88)

94f0560

remove footer (#90)

3a07377

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

Update api-catalogue-not-found-error-developer-portal.mdx (#93)

7edc5db

Update release-bot.yaml (#96)

7790ab7

Update api-catalogue-not-found-error-developer-portal.mdx (#99)

4f42a59

fix links (#102)

74025cd

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

add github actions for validation (#107)

d7e96a4

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

fix-broken-images (#111)

09cf08b

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

add merging by label (#114)

8efb7d6

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

remove unesseary redirects (#119)

06c68c1

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

fix issues (#123)

bd8d19f

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

add defsult page (#128)

815e958

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

change how snippets are created (#133)

84fcb17

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

add nav bar (#137)

03144ed

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

Update tyk-stack.mdx (#143)

3564d14

Update setup-email-notifications.mdx (#141)

0efc292

Update outbound-email-configuration.mdx (#147)

a48eff6

* Update outbound-email-configuration.mdx fix something * Create bla.mdx * Update docs.json

Update branches-config.json (#155)

055b0f2

Update bla.mdx (#163)

d7de65e

add dispatch code (#166)

3b4f744

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

add mirror pr as draft (#172)

8410908

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

Add auto merge (#179)

032eac1

* add mirror pr as draft * auto merge pull request --------- Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

Revert "Add auto merge" (#182)

5785c1f

Revert "Add auto merge (#179)" This reverts commit 032eac1.

auto-merge (#184)

d07b6f1

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

change button color (#191)

abef7a2

Co-authored-by: itachi sasuke <8012032+Keithwachira@users.noreply.github.com>

JoanCamosTyk and others added 20 commits December 18, 2025 19:49

Portal 1.16.0 RN (#1238)

e04695d

[TT-16188] Gateway Config Docs 5.11 (#1192)

cf4ccfc

* Import config/docs * Remove ServerRegenerationConfig --------- Co-authored-by: sharadregoti <24411676+sharadregoti@users.noreply.github.com> Co-authored-by: Burak Sezer <burak.sezer.developer@gmail.com>

[TT-16317] Update documentation for master (#1218)

7a37b9f

Import config/docs Co-authored-by: imogenkraak <162994391+imogenkraak@users.noreply.github.com>

[TT-16317] Update documentation for master (#1253)

7609105

Import config/docs Co-authored-by: imogenkraak <162994391+imogenkraak@users.noreply.github.com>

[TT-15683] Added docs for Dashboard API JWKS cache flush endpoint (#1021

306ad47

)

[TT-16189] Dashboard Config Docs for 5.11 (#1101)

a022bb7

Fix anchor tag of helm chart in release notes (#1269)

3714c54

Update branches-config.json

7528f56

Fix major upgrade docs (#1276)

f898e21

[DX-2186] DX-2185 Pump env variables in Docs version 5.11 are not vis…

b785484

…ible (#1281)

mintlify bot deployed to staging January 14, 2026 11:58 View deployment

sharadregoti and others added 2 commits January 16, 2026 18:36

Fix sync rns (#1296)

b378fe3

Merge main into docs/overhaul-self-managed-installation-page

26612b8

mintlify bot deployed to staging January 16, 2026 13:08 View deployment

sharadregoti and others added 2 commits January 16, 2026 19:06

[DX-2184] Update Dashboard Swagger schema link and ensure accessibili…

730b862

…ty (#1287)

Merge main into docs/overhaul-self-managed-installation-page

f73de0e

mintlify bot deployed to staging January 16, 2026 13:50 View deployment

buger added 2 commits January 19, 2026 11:50

[DX-2167] Add Audit Logs Getting Started Guide (#1285)

88f1558

Merge main into docs/overhaul-self-managed-installation-page

183ef51

mintlify bot deployed to staging January 19, 2026 06:22 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🔄 Preview: docs: overhaul Tyk Self-Managed installation page #1291

🔄 Preview: docs: overhaul Tyk Self-Managed installation page #1291

Uh oh!

buger commented Jan 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

🔄 Preview: docs: overhaul Tyk Self-Managed installation page #1291

Are you sure you want to change the base?

🔄 Preview: docs: overhaul Tyk Self-Managed installation page #1291

Uh oh!

Conversation

buger commented Jan 14, 2026

Purpose

Preview Link

⚠️ Important Notes

Changes

Summary

Key Changes

Results

Test plan

Related

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants