-
Notifications
You must be signed in to change notification settings - Fork 236
Add custom developer portals doc #6724
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
ecaaf36
0e7dde0
2f70c7e
7c664b6
c6ca2ca
a803715
79cee7c
c577c59
4b98a49
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,80 @@ | ||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||
| title: "Custom developer portals" | ||||||||||||||||||||||||||||||||||||||||||
| description: "Ship a fully custom presentation layer and developer portal on top of a self-hosted Mintlify deployment, built and maintained by Mintlify." | ||||||||||||||||||||||||||||||||||||||||||
| keywords: ["developer portal", "custom presentation layer", "API marketplace", "self-host", "on-prem", "white label", "enterprise"] | ||||||||||||||||||||||||||||||||||||||||||
| --- | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| <Info> | ||||||||||||||||||||||||||||||||||||||||||
| Custom portals are scoped engagements on an [Enterprise plan](https://mintlify.com/pricing?ref=custom-portal), built on a [self-hosted deployment](/deploy/self-host). Reach out to your account team to scope one. | ||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
| </Info> | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| For some platforms, documentation is one surface of a larger product: an API marketplace, a partner portal, a developer experience with sign-in, credentials, and support built in. For those cases, Mintlify goes beyond hosting your docs. We design, build, and maintain a complete custom presentation layer that replaces your existing portal front end, while your team authors everything through the Mintlify CMS. | ||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
tell all my haters the emdash will never die |
||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| You keep your backend. The portal integrates with your existing APIs, gateway, and downstream systems, which stay owned and operated by your team. | ||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| ## Features | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| | Feature | What ships | Backed by | | ||||||||||||||||||||||||||||||||||||||||||
| | --- | --- | --- | | ||||||||||||||||||||||||||||||||||||||||||
| | Custom presentation layer | A full front-end application in your design system, deployed inside your environment. Not a themed template, a bespoke build | Mintlify, alongside the self-hosted platform | | ||||||||||||||||||||||||||||||||||||||||||
| | Product and catalog pages | Marketplace, product discovery, and documentation surfaces | Mintlify CMS content | | ||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
| | Sign-in | Authenticated sessions across the portal | Your identity provider | | ||||||||||||||||||||||||||||||||||||||||||
| | Applications and credentials | Application registration and credential management | Your backend APIs | | ||||||||||||||||||||||||||||||||||||||||||
| | Subscriptions | Product and plan subscriptions | Your backend APIs | | ||||||||||||||||||||||||||||||||||||||||||
| | Profiles and notifications | User profiles and notification centers | Your backend APIs | | ||||||||||||||||||||||||||||||||||||||||||
| | Support | Support ticket creation and tracking | Your backend APIs | | ||||||||||||||||||||||||||||||||||||||||||
| | Search | Login-aware search scoped to what the user can access | Mintlify platform | | ||||||||||||||||||||||||||||||||||||||||||
| | Personalized content | Entitlement and group-based filtering applied server-side at render time, so users only see the products and pages they have access to | Mintlify platform and your identity provider | | ||||||||||||||||||||||||||||||||||||||||||
| | Ongoing releases | Versioned releases with upgrade guides, the same operating model as any [self-hosted deployment](/deploy/self-host#updates) | Mintlify | | ||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+19
to
+28
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| ## Authoring stays a CMS flow | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| The custom front end doesn't change how content gets written. Non-technical authors use the web editor; engineers work in git-backed Markdown with pull-request review. Every change flows through your repository's review process with a full audit trail, and publishing triggers builds that update the portal automatically. No front-end deploy is needed to change content. | ||||||||||||||||||||||||||||||||||||||||||
|
Check warning on line 32 in deploy/custom-portal.mdx
|
||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+30
to
+32
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| ## Architecture | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| The presentation layer sits between your users and two backends: the Mintlify platform for content, search, and personalization, and your own services for everything transactional. | ||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| ```mermaid | ||||||||||||||||||||||||||||||||||||||||||
| flowchart TD | ||||||||||||||||||||||||||||||||||||||||||
| U[Users] --> CDN[CDN and WAF] | ||||||||||||||||||||||||||||||||||||||||||
| CDN --> PORTAL[Custom presentation layer] | ||||||||||||||||||||||||||||||||||||||||||
| PORTAL --> PLAT[Mintlify platform<br/>content, search, personalization] | ||||||||||||||||||||||||||||||||||||||||||
| PORTAL --> GW[Your API gateway] | ||||||||||||||||||||||||||||||||||||||||||
| GW --> BE[Your backend services<br/>applications, subscriptions, support] | ||||||||||||||||||||||||||||||||||||||||||
| PORTAL --> IDP[Your identity provider] | ||||||||||||||||||||||||||||||||||||||||||
| W[Writers] --> ED[Editor and Git workflow] | ||||||||||||||||||||||||||||||||||||||||||
| ED --> PLAT | ||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| Everything runs inside your network boundary on the platforms described in [self-host](/deploy/self-host): your cluster, your data stores, your observability stack, no third-party egress. Your downstream systems of record are untouched; the portal consumes them through the APIs you already expose. | ||||||||||||||||||||||||||||||||||||||||||
|
Check warning on line 50 in deploy/custom-portal.mdx
|
||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| ## How the engagement runs | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| <Steps> | ||||||||||||||||||||||||||||||||||||||||||
| <Step title="Scope and design"> | ||||||||||||||||||||||||||||||||||||||||||
| Your account team maps the portal surfaces, your design system, and the backend APIs the portal will consume, and agrees on an integration contract with your platform team. | ||||||||||||||||||||||||||||||||||||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||||||||||
| <Step title="Public surfaces first"> | ||||||||||||||||||||||||||||||||||||||||||
| The engagement typically lands design system parity and public content surfaces first, so you can validate the experience against your existing portal before switching anything over. | ||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+58
to
+59
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||||||||||
| <Step title="Authenticated surfaces"> | ||||||||||||||||||||||||||||||||||||||||||
| Sign-in, credential management, subscriptions, and other logged-in experiences follow, integrated with your identity provider and backend APIs. | ||||||||||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||||||||||
| <Step title="Search, personalization, and AI"> | ||||||||||||||||||||||||||||||||||||||||||
| Login-aware search and server-side personalization complete the experience. AI features ship disabled and turn on only after your security or AI governance review. | ||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+64
to
+65
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||
| </Step> | ||||||||||||||||||||||||||||||||||||||||||
| </Steps> | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| Throughout, your team reviews releases in non-production environments and controls every cutover. | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| ## Next steps | ||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||
| <Columns cols={2}> | ||||||||||||||||||||||||||||||||||||||||||
| <Card title="Talk to your account team" icon="messages-square" href="https://www.mintlify.com/enterprise"> | ||||||||||||||||||||||||||||||||||||||||||
| Scope a custom portal engagement and plan your launch. | ||||||||||||||||||||||||||||||||||||||||||
| </Card> | ||||||||||||||||||||||||||||||||||||||||||
| <Card title="Self-host" icon="server" href="/deploy/self-host"> | ||||||||||||||||||||||||||||||||||||||||||
| The deployment foundation a custom portal runs on. | ||||||||||||||||||||||||||||||||||||||||||
| </Card> | ||||||||||||||||||||||||||||||||||||||||||
| </Columns> | ||||||||||||||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| --- | ||
| title: "Self-host" | ||
| description: "Run Mintlify inside your own cloud or on-premises environment, on AWS or any Kubernetes platform including Azure, Google Cloud, Oracle Cloud, and OpenShift." | ||
| keywords: ["self-host", "self-hosted", "on-prem", "deploy", "AWS", "CDK", "Helm", "Kubernetes", "OpenShift", "air gap", "enterprise"] | ||
| --- | ||
|
|
||
| <Info> | ||
| Self-hosting requires an [Enterprise plan](https://mintlify.com/pricing?ref=self-host). Reach out to your account team to scope a deployment. | ||
| </Info> | ||
|
|
||
| Self-hosting runs Mintlify inside your own cloud account or data center, so your documentation, build pipeline, analytics, and logs stay within your network boundary. It's designed for teams with data-residency, compliance, or air-gap requirements that a cloud-hosted deployment can't meet. | ||
|
|
||
| Every self-hosted deployment is a scoped engagement with your account team, not a self-serve install. This page describes what you provision, how the deployment runs, and the tradeoffs against cloud hosting so you can evaluate self-hosting before committing to it. | ||
|
|
||
| ## Platform support | ||
|
|
||
| | Platform | Method | | ||
| | --- | --- | | ||
| | <Icon icon="/images/logos/aws-mark.svg" /> Amazon Web Services | AWS Cloud Development Kit (CDK) app | | ||
| | <Icon icon="/images/logos/azure.svg" /> Microsoft Azure | Helm chart on Azure Kubernetes Service (AKS) | | ||
| | <Icon icon="/images/logos/gcp.svg" /> Google Cloud | Helm chart on Google Kubernetes Engine (GKE) | | ||
| | <Icon icon="/images/logos/oracle-mark.svg" /> Oracle Cloud | Helm chart on Oracle Container Engine for Kubernetes (OKE) | | ||
| | <Icon icon="/images/logos/openshift.svg" /> Red Hat OpenShift | Helm chart | | ||
| | <Icon icon="/images/logos/kubernetes.svg" /> Any Kubernetes | Helm chart | | ||
|
|
||
| ## How self-hosting compares to cloud hosting | ||
|
|
||
| Authoring works the same way in both models: writers use the web editor or their Git workflow, and every change flows through your repository's review process. What changes is who operates the platform and where data lives. | ||
|
|
||
| | Area | Cloud-hosted | Self-hosted | | ||
| | --- | --- | --- | | ||
| | Time to launch | Same day | Scoped engagement, typically weeks | | ||
| | Infrastructure | Mintlify operates everything | You operate the cluster, network, and data stores. Mintlify ships versioned releases with upgrade guides and supports the application tier | | ||
| | Platform updates | Continuous, automatic | Versioned releases that you review and deploy on your own schedule | | ||
| | Data boundary | Processed in Mintlify's cloud | Content, builds, analytics, and logs stay inside your network with no third-party egress | | ||
| | AI features | On by default | Ship disabled until your security or AI governance team approves them. Can run against your own model endpoint, your own API key, or Mintlify cloud | | ||
| | Integrations | Full catalog | Integrations that depend on Mintlify cloud services are unavailable | | ||
| | Monitoring | Managed by Mintlify | You connect your own observability stack | | ||
|
|
||
| Self-hosted deployments usually start narrow and expand. A common path is public documentation first, then authenticated content, the web editor, and AI features as your security reviews complete. | ||
|
|
||
| ## Features | ||
|
|
||
| Everything core to authoring, building, and serving documentation ships in a self-hosted deployment: | ||
|
|
||
| | Feature | Availability | Notes | | ||
| | --- | :---: | --- | | ||
| | Documentation site | <Icon icon="circle-check" color="#16a34a" /> | Full rendering, components, and theming | | ||
| | Web editor | <Icon icon="circle-check" color="#16a34a" /> | Browser-based authoring for non-technical writers | | ||
| | Git-backed workflow | <Icon icon="circle-check" color="#16a34a" /> | GitHub, GitHub Enterprise Server, GitLab including self-managed, Bitbucket, or an internally owned proxy API | | ||
| | Search | <Icon icon="circle-check" color="#16a34a" /> | Runs inside your deployment. The index rebuilds on publish | | ||
| | Authenticated content | <Icon icon="circle-check" color="#16a34a" /> | Access control through your identity provider | | ||
| | Dashboard SSO | <Icon icon="circle-check" color="#16a34a" /> | OIDC or SAML | | ||
| | Analytics | <Icon icon="circle-check" color="#16a34a" /> | Collected and stored inside your network | | ||
| | Third-party analytics and support widgets | <Icon icon="circle-check" color="#16a34a" /> | Configured with your own keys, served from the docs site | | ||
| | Static export | <Icon icon="circle-check" color="#16a34a" /> | Self-contained bundles for air-gapped serving | | ||
| | Versioned releases and rollback | <Icon icon="circle-check" color="#16a34a" /> | Each release pins image versions. Roll back by redeploying the previous version | | ||
| | AI assistant and agent | <Icon icon="minus" color="#9ca3af" /> Optional | Ships disabled. Runs against your own model endpoint, your own API key, or Mintlify cloud | | ||
|
|
||
| Only smaller surfaces that depend on Mintlify-operated services stay cloud-only: the Slack app, the Discord app, third-party connectors for agent workflows, and SDK generation integrations. | ||
|
|
||
| ## Architecture | ||
|
|
||
| A self-hosted deployment is a set of services with clear dependencies. Provision the data stores first, then the services that depend on them, then the edge. | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| U[Users] --> CDN[CDN and WAF] | ||
| CDN --> ING[Load balancer or ingress] | ||
| ING --> WEB[Docs site] | ||
| ING --> API[Dashboard and API] | ||
| API --> BUILD[Build workers] | ||
| BUILD --> GIT[Git source] | ||
| WEB --> OBJ[(Object storage)] | ||
| BUILD --> OBJ | ||
| API --> MONGO[(MongoDB)] | ||
| API --> PG[(PostgreSQL)] | ||
| API --> REDIS[(Redis)] | ||
| API --> SEARCH[Search and indexing] | ||
| API --> IDP[Identity provider] | ||
| API -. optional .-> AI[AI assistant services] | ||
| ``` | ||
|
|
||
| | Resource | Purpose | Required | | ||
| | --- | --- | :---: | | ||
| | Load balancer or ingress | TLS termination and routing | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | Docs site | Serves rendered documentation | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | Dashboard and API | Admin, auth, and build orchestration | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | Build workers | Build and publish documentation sites | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | MongoDB | Content store | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | PostgreSQL | Deployment and user metadata | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | Redis | Build queue and caching | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | Object storage | Built site bundles and static exports | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | Search and indexing | Docs search. The index rebuilds on publish | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | Identity provider | OIDC or SAML SSO for the dashboard and authenticated content | <Icon icon="circle-check" color="#16a34a" /> | | ||
| | AI assistant services | Assistant and agent features | <Icon icon="minus" color="#9ca3af" /> Optional | | ||
|
|
||
| Your documentation source can be GitHub, GitHub Enterprise Server, GitLab (including self-managed), or Bitbucket. Organizations that can't grant repository credentials to a third-party service can instead front their Git hosting with an internally owned proxy API, and fully air-gapped environments use [static export](/api/static-export/overview) with no Git connection at all. | ||
|
|
||
| ### Sizing | ||
|
|
||
| As a starting point, a production deployment runs on roughly 45 to 60 vCPU, 160 to 220 GB of memory, and about 1 TB of solid-state storage across services, with non-production environments at about half that. Your account team sizes the deployment with you based on page count, traffic, and which features you enable. | ||
|
|
||
| ## Set up your platform | ||
|
|
||
| <Tabs> | ||
| <Tab title="AWS" icon="/images/logos/aws-mark.svg"> | ||
| AWS deployments use an AWS CDK app that provisions and updates the full stack in your account. The CDK app pins container images to specific versions, so every deployment is reproducible and reviewable. | ||
|
|
||
| ### What you provide | ||
|
|
||
| | Component | Requirement | Notes | | ||
| | --- | --- | --- | | ||
| | Compute | Amazon ECS cluster | Runs the Mintlify services | | ||
| | Content store | Amazon DocumentDB | MongoDB-compatible | | ||
| | Metadata store | Amazon RDS for PostgreSQL | Deployment and user metadata | | ||
| | Cache and queue | Amazon ElastiCache for Redis | Build queue and caching | | ||
| | Object storage | Amazon S3 | Built site bundles and static exports | | ||
| | CDN | Amazon CloudFront | Serves the docs site at the edge | | ||
| | Networking | VPC with public and private subnets, Application Load Balancer | Isolates workloads | | ||
| | TLS and DNS | AWS Certificate Manager, Amazon Route 53 | HTTPS and routing for your domain | | ||
| | Secrets | AWS Secrets Manager | Database credentials and signing secrets | | ||
| | Identity | OIDC or SAML provider | Dashboard SSO | | ||
|
|
||
| ### Setup | ||
|
|
||
| <Steps> | ||
| <Step title="Scope the deployment"> | ||
| Your account team reviews your network topology, Git hosting, identity provider, and compliance requirements, then delivers the CDK app and access to versioned container images. | ||
| </Step> | ||
| <Step title="Configure and deploy"> | ||
| Set your domain, certificate, and networking in the CDK context, review the change set, and deploy. | ||
|
|
||
| ```bash | ||
| cdk diff | ||
| cdk deploy --all | ||
| ``` | ||
| </Step> | ||
| <Step title="Connect Git and SSO"> | ||
| Grant the deployment access to your documentation repositories and connect your identity provider. | ||
| </Step> | ||
| <Step title="Cut over"> | ||
| Verify builds and search on your staging domain, then point your production DNS at the deployment. | ||
| </Step> | ||
| </Steps> | ||
| </Tab> | ||
|
|
||
| <Tab title="Kubernetes" icon="/images/logos/kubernetes.svg"> | ||
| Kubernetes deployments use the Mintlify enterprise Helm chart and run on any certified Kubernetes cluster. The same chart covers managed Kubernetes on any cloud and on-premises clusters: | ||
|
|
||
| - **Azure**: AKS, with Microsoft Entra ID for SSO and Azure managed data services. | ||
| - **Google Cloud**: GKE, with Cloud SQL, Memorystore, and Cloud Storage. | ||
| - **Oracle Cloud**: OKE, with OCI managed databases and OCI Object Storage. | ||
| - **OpenShift**: ships OpenShift-compatible security contexts and uses Routes for ingress. | ||
|
|
||
| ### What you provide | ||
|
|
||
| | Component | Requirement | Notes | | ||
| | --- | --- | --- | | ||
| | Cluster | Kubernetes or OpenShift cluster | Hosts the Helm release | | ||
| | Content store | MongoDB | Managed or in-cluster | | ||
| | Metadata store | PostgreSQL | Managed or in-cluster | | ||
| | Cache and queue | Redis | Build queue and caching | | ||
| | Object storage | S3-compatible bucket | Built site bundles and static exports | | ||
| | Ingress | Ingress controller or OpenShift Route with TLS | Serves HTTPS. A WAF in front is recommended | | ||
| | Registry | Private container registry | Hosts the delivered images | | ||
| | Identity | OIDC or SAML provider | Dashboard SSO | | ||
|
|
||
| ### Setup | ||
|
|
||
| <Steps> | ||
| <Step title="Scope the deployment"> | ||
| Your account team reviews your cluster, Git hosting, identity provider, and compliance requirements, then delivers the Helm chart, a values template, and versioned container images for your registry. | ||
| </Step> | ||
| <Step title="Provision data stores"> | ||
| Stand up MongoDB, PostgreSQL, Redis, and object storage, managed by your cloud provider or in-cluster. | ||
| </Step> | ||
| <Step title="Configure and install"> | ||
| Point the values file at your data stores, ingress, and registry, then install the release. | ||
|
|
||
| ```bash | ||
| helm upgrade --install mintlify ./mintlify-enterprise \ | ||
| --namespace mintlify --create-namespace -f values.yaml | ||
| ``` | ||
| </Step> | ||
| <Step title="Connect Git and SSO, then cut over"> | ||
| Grant the deployment access to your documentation repositories, connect your identity provider, verify on staging, and point production DNS at the deployment. | ||
| </Step> | ||
| </Steps> | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Updates | ||
|
|
||
| Platform updates and content updates move independently. You control when the platform changes, and your documentation stays current on its own. | ||
|
|
||
| ### Platform updates | ||
|
|
||
| Mintlify ships versioned releases with upgrade guides and release notes from your account team. Each release pins specific image versions, so you can test a release in a non-production environment before deploying it and roll back to the previous version if needed. | ||
|
|
||
| <CodeGroup> | ||
|
|
||
| ```bash AWS (CDK) | ||
| # review the change set for the new release, then roll it out | ||
| cdk diff | ||
| cdk deploy --all | ||
| ``` | ||
|
|
||
| ```bash Kubernetes (Helm) | ||
| # upgrade to a delivered release, or roll back | ||
| helm upgrade mintlify ./mintlify-enterprise \ | ||
| --namespace mintlify -f values.yaml | ||
| helm rollback mintlify | ||
| ``` | ||
|
|
||
| </CodeGroup> | ||
|
|
||
| Updates roll out with no downtime: new tasks or pods start, pass health checks, and replace the old ones. | ||
|
|
||
| ### Content updates | ||
|
|
||
| Content flows through your Git source, not through platform releases. When you push to your documentation repository, the build workers rebuild the site and publish it to object storage automatically. Content changes never require a platform deploy. | ||
|
|
||
| ## Air-gapped deployments | ||
|
|
||
| Environments with no Git webhook path serve documentation as [static export bundles](/api/static-export/overview): self-contained builds of your site published to object storage and served through your CDN. Regenerate the bundle when content changes, or automate the loop with the GitHub Action on that page. AI features that require outbound network access are disabled in air-gapped deployments. | ||
|
|
||
| ## Next steps | ||
|
|
||
| <Columns cols={2}> | ||
| <Card title="Talk to your account team" icon="messages-square" href="https://www.mintlify.com/enterprise"> | ||
| Scope a self-hosted deployment on your platform and plan your launch. | ||
| </Card> | ||
| <Card title="Static export" icon="package" href="/api/static-export/overview"> | ||
| Generate self-contained bundles of your documentation for air-gapped serving. | ||
| </Card> | ||
| </Columns> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.