Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ navigation:
path: ./pages/customization/user-feedback.mdx
- page: Custom CSS & JS
path: ./pages/component-library/custom-components/custom-css-js.mdx
- section: Preview & Publish
- section: Deploy & Publish
collapsed: true
contents:
- page: Previewing changes locally
Expand All @@ -108,6 +108,8 @@ navigation:
path: ./pages/getting-started/publishing-your-docs.mdx
- page: Setting up your domain
path: ./pages/getting-started/setting-up-your-domain.mdx
- page: Self-hosted documentation
path: ./pages/enterprise/self-hosted.mdx
- section: Navigation
collapsed: true
contents:
Expand Down Expand Up @@ -180,11 +182,6 @@ navigation:
path: ./pages/api-references/autopopulate-api-key.mdx
- page: SSO
path: ./pages/authentication/sso.mdx
- section: Enterprise
collapsed: true
contents:
- page: Self-hosted
path: ./pages/enterprise/self-hosted.mdx
- section: Integrations
collapsed: true
contents:
Expand Down
55 changes: 52 additions & 3 deletions fern/products/docs/pages/enterprise/self-hosted.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,56 @@
---
title: Self-hosted Enterprise
title: Self-Hosted Documentation
description: Fern supports self-hosting so that you can run your docs site on your own infrastructure.
---

Fern supports self-hosting so that you can run your docs site on your own infrastructure.
<Note>Self-hosted documentation is only available for the enterprise plan.</Note>

Fern documentation websites are hosted on Fern's infrastructure by default. Self-hosting allows you to deploy your documentation site on your own infrastructure to meet specific security or compliance requirements.

## When to Use Self-Hosting

Self-hosting is typically required for organizations that operate without internet access, have strict compliance requirements, or need full control over their documentation servers.

When you self-host, you're responsible for server setup, security, maintenance, and deciding how to make the documentation accessible to your users.

<Warning>
Unless you have specific requirements that prevent using Fern's default hosting, we recommend **using our managed hosting solution** for easier setup and maintenance.
</Warning>

### Feature Support

Self-hosted deployments include core Fern documentation website features like auto-generated API references, interactive documentation, SDK code snippets, search, and customizable branding.

However, features requiring external connections aren't supported, including [Ask Fern](/ask-fern/getting-started/what-is-ask-fern) (AI chat), [analytics](/integrations/overview), [live API key population](/docs/authentication/api-key-injection), and [SSO integrations](/docs/authentication/sso).

<Info title="Extended feature support">
**PDF export** and **offline AI chat functionality** are in development for self-hosted deployments. [Email us](mailto:[email protected]) if you're interested in these features.
</Info>

## Setup Process

Fern provides your documentation site as a ready-to-run Docker container that you can deploy on your own infrastructure.

1. **Download the Docker image** - Fern provides the location of the most up-to-date Docker image containing the documentation frontend
2. **Upload your fern folder** - Add your documentation source files to the container
3. **Run the container** - Spin up your local server using standard Docker commands
4. **Configure hosting** - Set up your server environment and decide how to publish/share the documentation

### Architecture Diagram

```mermaid
sequenceDiagram
participant F as Fern
participant C as Customer
participant S as Customer Server
F->>C: Provides Docker image
C->>S: Upload fern folder
C->>S: Run Docker command
S->>S: Host documentation locally
```





<Warning>Docs are coming soon for this page.<br/><br/>Please [book a demo](https://buildwithfern.com/book-demo) or [reach out to us](https://buildwithfern.com/book-demo) to get set up with this feature. </Warning>