diff --git a/fern/products/dashboard/dashboard.yml b/fern/products/dashboard/dashboard.yml index f395ce16f..7b54272d4 100644 --- a/fern/products/dashboard/dashboard.yml +++ b/fern/products/dashboard/dashboard.yml @@ -11,4 +11,6 @@ navigation: - page: Set up SSO path: ./pages/sso.mdx slug: sso + - page: Custom domains + path: ./pages/domains.mdx - changelog: ./pages/changelog diff --git a/fern/products/dashboard/pages/changelog/2026-01-07.mdx b/fern/products/dashboard/pages/changelog/2026-01-07.mdx new file mode 100644 index 000000000..abee51f47 --- /dev/null +++ b/fern/products/dashboard/pages/changelog/2026-01-07.mdx @@ -0,0 +1,5 @@ +## Set up custom domains in the dashboard + +You can now configure custom domains for your documentation site directly in the [Fern Dashboard](https://dashboard.buildwithfern.com/). The dashboard automatically displays the DNS records you need to add to your domain registrar based on your domain type. + +[Learn more](/learn/dashboard/configuration/custom-domains) about setting up your custom domain. \ No newline at end of file diff --git a/fern/products/dashboard/pages/domains.mdx b/fern/products/dashboard/pages/domains.mdx new file mode 100644 index 000000000..8ba292a17 --- /dev/null +++ b/fern/products/dashboard/pages/domains.mdx @@ -0,0 +1,64 @@ +--- +title: Set up a custom domain +description: Use the Fern Dashboard to configure your custom domain with DNS records for subdomain, subpath, or root domain hosting. +--- + +You can use the [Fern Dashboard](https://dashboard.buildwithfern.com/) to configure any of the following custom domain types: +- **Subdomain**: `docs.mydomain.com` +- **Subpath**: `mydomain.com/docs` +- **Root domain**: `mydomain.com` + +The Dashboard automatically provides the correct DNS records based on your domain type. + + + Alternatively, you can [set up your custom domain by manually configuring DNS records](/learn/docs/preview-publish/setting-up-your-domain). + + +## Setup + + + + +Navigate to the [Fern Dashboard](https://dashboard.buildwithfern.com/) and select your documentation site. + + + + +In the **Domains** section of the **Overview** tab, select **Add Custom Domain** and enter your domain. The dashboard displays the DNS records you need to configure. + +For multiple custom domains (e.g., partner or white-label deployments), repeat this step to add each domain. + + + + +Add your `custom-domain` to your `docs.yml` configuration: + +```yaml docs.yml +instances: + - url: example.docs.buildwithfern.com + custom-domain: docs.mydomain.com +``` + +For multiple custom domains, configure an array: + +```yaml docs.yml +instances: + - url: example.docs.buildwithfern.com + custom-domain: + - www.mydomain.com + - partner.otherdomain.com +``` + + + + +Log in to your domain registrar and add the DNS records shown in the Fern Dashboard. The specific records depend on your domain type (subdomain, subpath, or root domain). + + + + +Once you've added the DNS records, return to the Fern Dashboard to verify your domain. SSL is automatically provisioned for your domain, but it may take a few minutes to propagate globally. + +Check that you can access your new docs site from a mobile device or incognito browser. + + diff --git a/fern/products/dashboard/pages/overview.mdx b/fern/products/dashboard/pages/overview.mdx index 932ac8b96..324e538fa 100644 --- a/fern/products/dashboard/pages/overview.mdx +++ b/fern/products/dashboard/pages/overview.mdx @@ -9,7 +9,14 @@ The Fern Dashboard provides a central place to manage your projects, team member Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete initial setup steps: - + + + Configure your custom domain with automatic DNS record provisioning. + - Once you've set up your domain, use the [Fern Dashboard](https://dashboard.buildwithfern.com/) to manage site settings. - +Fern recommends [using the Fern Dashboard to set up custom domains](/learn/dashboard/configuration/custom-domains). The Dashboard automatically provides the correct DNS records based on your domain type. If you prefer to configure your domain manually, follow the instructions on this page. + +## Manual setup + +Expand the section below that matches your domain type: - + To host your documentation on a subdomain like `docs.mydomain.com`, you need to create a CNAME record in your DNS settings. - -### Update the domain in `docs.yml` + Add your `custom-domain` and merge your changes into `main`. [Here's an example](https://github.com/octoml/fern-config/blob/389b67679953856ba0716537981a6d749635556f/fern/docs.yml#L1-L3 ). @@ -28,14 +29,16 @@ instances: - url: example.docs.buildwithfern.com custom-domain: docs.mydomain.com ``` + -### Contact Fern + Contact Fern via your dedicated Slack channel or [email](mailto:support@buildwithfern.com) to receive: - A unique CNAME value for your site - A TXT record to verify your domain + -### Create DNS records + Log in to your domain registrar's dashboard and navigate to the DNS settings for your domain. Add the following records: @@ -58,34 +61,36 @@ Replace `docs` with any subdomain you want to use. If you are using Cloudflare, you should ensure the record isn't proxied. + -### Verify the setup + Once Fern has completed your setup, you'll be able to access your documentation at `docs.mydomain.com`. SSL will be automatically provisioned for your domain, but it may take a few minutes to propagate globally. Check that you can access your new docs site from a mobile device or incognito browser. + - + To host your documentation on a subpath like `mydomain.com/docs`, you need to edit your `docs.yml` configuration and then get provider-specific instructions for setting up the subpath. Common providers include Cloudflare, AWS Route53 and Cloudfront, Netlify, and Vercel. - -### Configure the `url` in `docs.yml` + Append that subpath to the end of the `url`. This example use `docs` for the subpath, but you can use any word you like, such as `reference` or `developer`. ```yaml -instances: +instances: - url: example.docs.buildwithfern.com/docs ``` + -### Configure the `custom-domain` + Below the `url`, add a `custom-domain` key: @@ -98,26 +103,28 @@ instances: [Here's an example.](https://github.com/fern-api/fern/blob/7d8631c6119787a8aaccb4ba49837e73c985db28/fern/docs.yml#L1-L3) + -### Contact Fern + -Contact Fern via your dedicated Slack channel or [email](mailto:support@buildwithfern.com) to set up your custom subpath. +Contact Fern via your dedicated Slack channel or [email](mailto:support@buildwithfern.com) to set up your custom subpath. + -### Verify the setup + Once Fern has completed your setup, you'll be able to access your documentation at `mydomain.com/docs`. It may take a few minutes for DNS changes to propagate globally. Check that you can access your new docs site from a mobile device or incognito browser. + - + To host your documentation on a root domain like `mydomain.com`, you need to edit your `docs.yml` configuration and then get provider-specific instructions for setting up the domain. Common providers include Cloudflare, AWS Route53 and Cloudfront, Netlify, and Vercel. - -### Configure the `url` in `docs.yml` + ```yaml @@ -128,14 +135,16 @@ instances: [Here's an example.](https://github.com/dannysheridan/katiedanny/blob/2fcf5769e2994af29e31d00904e04788b188a18b/fern/docs.yml#L3-L5) + -### Contact Fern + Contact Fern via your dedicated Slack channel or [email](mailto:support@buildwithfern.com) to receive: - A unique CNAME value for your site - A TXT record to verify your domain + -### Configure your DNS settings + You'll need the following DNS records configured for your root domain. @@ -163,20 +172,22 @@ TXT @ [TXT record value provided by Fern] This redirects `mydomain.com` to `www.mydomain.com`. After you add these records, Fern will provision a SSL certificate. + -### Verify the setup + Once Fern has completed your setup, you'll be able to access your documentation at `mydomain.com`. SSL will be automatically provisioned for your domain, but it may take a few minutes to propagate globally. Check that you can access your new docs site from a mobile device or incognito browser. + - + -## Multiple custom domains +### Multiple custom domains -To serve your documentation from multiple custom domains (e.g., for partner or white-label deployments), configure an array of domains: +To serve your documentation from multiple custom domains (e.g., for partner or white-label deployments), follow the above steps for each domain (subdomain, subpath, or root domain), then configure an array in your `docs.yml`: ```yaml docs.yml instances: @@ -186,8 +197,6 @@ instances: - partner.otherdomain.com ``` -This works with any of the above domain types (subdomain, subpath, or root domain). - After configuring multiple domains in your `docs.yml`, contact Fern via your dedicated Slack channel or [email](mailto:support@buildwithfern.com) to complete the setup. You'll receive DNS configuration details for each domain. - \ No newline at end of file +