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