Skip to content

Commit 86fb9a6

Browse files
committed
add overview of self-hosted documentation
1 parent 85b0fd0 commit 86fb9a6

File tree

2 files changed

+53
-9
lines changed

2 files changed

+53
-9
lines changed

fern/products/docs/docs.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ navigation:
9797
path: ./pages/customization/user-feedback.mdx
9898
- page: Custom CSS & JS
9999
path: ./pages/component-library/custom-components/custom-css-js.mdx
100-
- section: Preview & Publish
100+
- section: Deploy & Publish
101101
collapsed: true
102102
contents:
103103
- page: Previewing changes locally
@@ -108,6 +108,8 @@ navigation:
108108
path: ./pages/getting-started/publishing-your-docs.mdx
109109
- page: Setting up your domain
110110
path: ./pages/getting-started/setting-up-your-domain.mdx
111+
- page: Self-hosted documentation
112+
path: ./pages/enterprise/self-hosted.mdx
111113
- section: Navigation
112114
collapsed: true
113115
contents:
@@ -180,11 +182,6 @@ navigation:
180182
path: ./pages/api-references/autopopulate-api-key.mdx
181183
- page: SSO
182184
path: ./pages/authentication/sso.mdx
183-
- section: Enterprise
184-
collapsed: true
185-
contents:
186-
- page: Self-hosted
187-
path: ./pages/enterprise/self-hosted.mdx
188185
- section: Integrations
189186
collapsed: true
190187
contents:

fern/products/docs/pages/enterprise/self-hosted.mdx

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,54 @@
11
---
2-
title: Self-hosted Enterprise
2+
title: Self-Hosted Documentation
3+
description: Fern supports self-hosting so that you can run your docs site on your own infrastructure.
34
---
45

5-
Fern supports self-hosting so that you can run your docs site on your own infrastructure.
6+
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.
7+
8+
## When to Use Self-Hosting
9+
10+
Self-hosting is typically required for organizations that operate without internet access, have strict compliance requirements, or need full control over their documentation servers.
11+
12+
When you self-host, you're responsible for server setup, security, maintenance, and deciding how to make the documentation accessible to your users.
13+
14+
<Warning>
15+
Unless you have specific requirements that prevent using Fern's default hosting, we recommend **using our managed hosting solution** for easier setup and maintenance.
16+
</Warning>
17+
18+
### Feature Support
19+
20+
Self-hosted deployments include core Fern documentation website features like auto-generated API references, interactive documentation, SDK code snippets, search, and customizable branding.
21+
22+
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).
23+
24+
<Info title="Extended feature support">
25+
**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.
26+
</Info>
27+
28+
## Setup Process
29+
30+
Fern provides your documentation site as a ready-to-run Docker container that you can deploy on your own infrastructure.
31+
32+
1. **Download the Docker image** - Fern provides the location of the most up-to-date Docker image containing the documentation frontend
33+
2. **Upload your fern folder** - Add your documentation source files to the container
34+
3. **Run the container** - Spin up your local server using standard Docker commands
35+
4. **Configure hosting** - Set up your server environment and decide how to publish/share the documentation
36+
37+
### Architecture Diagram
38+
39+
```mermaid
40+
sequenceDiagram
41+
participant F as Fern
42+
participant C as Customer
43+
participant S as Customer Server
44+
45+
F->>C: Provides Docker image
46+
C->>S: Upload fern folder
47+
C->>S: Run Docker command
48+
S->>S: Host documentation locally
49+
```
50+
51+
52+
53+
654

7-
<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>

0 commit comments

Comments
 (0)