Skip to content

Commit ae241db

Browse files
committed
chore: small updates for self-hosted
1 parent 5ee5331 commit ae241db

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

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

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Before setting up self-hosted documentation, ensure you have:
1717

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

20-
**Contact Fern Support** and provide your Docker Hub username to the Fern team. Fern will allowlist your account to download the private image
20+
**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.
2121

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

5959
```bash
60-
docker build -f <your-docker-file-name> -t <your-image-name> .
60+
docker build -f <your-docker-file-name> -t <your-image-name> <path-to-dockerfile>
61+
```
62+
63+
Example:
64+
65+
```bash
66+
docker build -f Dockerfile -t self-hosted-docs .
6167
```
6268

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

6874
```bash
69-
docker run -it <your-image-name>
75+
docker run -p <port-number>:3000 <your-image-name>
7076
```
7177

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

7480
</Step>
7581
<Step title="Configure Custom Domain">
@@ -79,8 +85,13 @@ Your documentation will be published to the domain specified in your `docs.yml`
7985
```yaml
8086
instances:
8187
- url: example-org.docs.buildwithfern.com
82-
custom-domain: plantstore.dev
88+
custom-domain: docs.plantstore.dev
8389
```
90+
</Step>
91+
<Step title="Deploy the Documentation">
92+
93+
You can now deploy the image to your own infrastructure, allowing you to host the documentation on your own domain.
94+
8495
</Step>
8596
</Steps>
8697

0 commit comments

Comments
 (0)