Skip to content

chore: small updates for self-hosted #732

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
Sep 9, 2025
Merged

chore: small updates for self-hosted #732

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
21 changes: 16 additions & 5 deletions fern/products/docs/pages/enterprise/self-hosted-set-up.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Before setting up self-hosted documentation, ensure you have:

The self-hosted documentation runs on a private Docker image: `fernapi/fern-self-hosted`

**Contact Fern Support** and provide your Docker Hub username to the Fern team. Fern will allowlist your account to download the private image
**Contact Fern Support** and provide your Docker Hub username to the Fern team. Fern will allowlist your account to download the private image, and provide you with the latest tag.

</Step>
<Step title="Download the Docker Image">
Expand Down Expand Up @@ -57,7 +57,13 @@ Replace `<latest-tag>` with the actual tag used in the previous step.
Build your custom Docker image using the Dockerfile:

```bash
docker build -f <your-docker-file-name> -t <your-image-name> .
docker build -f <your-docker-file-name> -t <your-image-name> <path-to-dockerfile>
```

Example:

```bash
docker build -f Dockerfile -t self-hosted-docs .
```

</Step>
Expand All @@ -66,10 +72,10 @@ docker build -f <your-docker-file-name> -t <your-image-name> .
Start your self-hosted documentation:

```bash
docker run -it <your-image-name>
docker run -p <port-number>:3000 <your-image-name>
```

The documentation will be available at the domain specified in your `docs.yml` configuration.
The documentation will be available at `localhost:<port-number>`.

</Step>
<Step title="Configure Custom Domain">
Expand All @@ -79,8 +85,13 @@ Your documentation will be published to the domain specified in your `docs.yml`
```yaml
instances:
- url: example-org.docs.buildwithfern.com
custom-domain: plantstore.dev
custom-domain: docs.plantstore.dev
```
</Step>
<Step title="Deploy the Documentation">

You can now deploy the image to your own infrastructure, allowing you to host the documentation on your own domain.

</Step>
</Steps>