Skip to content

Document self-hosted base path configuration #2251

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document self-hosted base path configuration #2251

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
17 changes: 16 additions & 1 deletion 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 @@ -93,5 +93,20 @@ instances:
You can now deploy the image to your own infrastructure, allowing you to host the documentation on your own domain.

</Step>
</Steps>
<Step title="Configure Base Path (Optional)">

If you need to serve documentation from a subpath (for example, `https://example.com/docs` instead of `https://example.com`), configure the base path using the `NEXT_PUBLIC_BASE_PATH` environment variable:

```bash
docker run -p <port-number>:3000 -e NEXT_PUBLIC_BASE_PATH=/docs <your-image-name>
```

Your documentation will be available at `localhost:<port-number>/docs`.

<Warning>
The base path must start with a forward slash and should not end with one. For example, use `/docs` not `docs` or `/docs/`.
Copy link
Contributor

@github-actions github-actions bot Nov 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'shouldn't' instead of 'should not'.

</Warning>

</Step>
</Steps>