-
Notifications
You must be signed in to change notification settings - Fork 3
Add overview for Self-Hosted Documentation option #355
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
+60
−7
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,60 @@ | ||
| --- | ||
| 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 | ||
| 1. **Upload your fern folder** - Add your documentation source files to the container | ||
| 1. **Run the container** - Spin up your local server using standard Docker commands | ||
| 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 | ||
|
|
||
| ```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 | ||
| F->>C: Releases updated Docker image | ||
| C->>C: Evaluate new version | ||
| C->>S: Deploy updated image | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <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> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.