Skip to content

Small edits to Self-hosted documentation page #433

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 13, 2025
Merged

Small edits to Self-hosted documentation page #433

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions fern/products/docs/pages/enterprise/self-hosted.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Self-Hosted Documentation
title: Self-hosted documentation
description: 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
## 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.

Expand All @@ -17,7 +17,7 @@ When you self-host, you're responsible for server setup, security, maintenance,
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
### 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.

Expand All @@ -27,7 +27,7 @@ However, features requiring external connections aren't supported, including [As
**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
## Setup process

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

Expand All @@ -37,7 +37,7 @@ Fern provides your documentation site as a ready-to-run Docker container that yo
1. **Configure hosting** - Set up your server environment and decide how to publish/share the documentation
1. **Receive updated Docker images** - Fern releases new versions of the Docker image that your team can evaluate and deploy when ready.

### Architecture Diagram
### Architecture diagram

```mermaid
sequenceDiagram
Expand All @@ -46,12 +46,12 @@ sequenceDiagram
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
C->>S: Uploads fern folder
C->>S: Runs Docker command
S->>S: Hosts documentation locally
F->>C: Releases updated Docker image
C->>C: Evaluate new version
C->>S: Deploy updated image
C->>S: Deploys updated image
```


Expand Down