Custom domain

You can edit the subdomain name and configure a custom domain for your Reference project on the Custom domain page.

Reference custom domain page

Note

Custom domains are supported only in Professional and Enterprise plans.

Edit the Reference name

  1. Navigate to the Settings > Custom domain page for the Reference project you want to configure.
  2. Select the Edit (pencil) icon next to the name. This opens the Change the reference's name dialog, where you can enter a new name for the Reference project. You can exit the dialog at any time by selecting Cancel.

Reference name configuration dialog

  1. The name you enter is prepended to .redoc.ly and used as your project's subdomain. It is also used in the Workflows app to identify your project and distinguish it from other Reference projects in your organization. Allowed characters are [a-z],[0-9],-. The name must be unique, and if it already exists in your or in another Workflows organization, the dialog will warn you to change it.
  2. After entering a new name, select Change name to save your changes. This does not trigger a new Reference build.

Configure a custom domain

  1. Navigate to the Settings > Custom domain page for the Reference project you want to configure.
  2. Select the Edit (pencil) icon next to the custom domain. This opens the Change your custom domain dialog, where you can configure a custom domain for the Reference project. You can exit the dialog at any time by selecting Cancel.

Custom domain configuration dialog

  1. You must enter the custom domain without the protocol. Optionally, you can specify a path prefix to create a subdirectory in your custom domain from which the Reference docs will be served (e.g. portal.acme.com/docs, where /docs is the path prefix).
  2. After entering a custom domain, select Change domain. To complete the configuration process, you must point your domain's CNAME record to ssl.redocly.com.