GitRead Docs

Features

Custom domain

Instead of the default public link you can serve your docs from your own domain. HTTPS is set up for you automatically.

Custom domains are part of some plans only. If your plan does not include one, the setting shows a note with a link to the available plans.

Before you start

  • You need a domain or subdomain that you control, for example docs.example.com.
  • You need access to the DNS settings at your domain provider.
  • A subdomain such as docs.example.com is the easiest choice.

Set it up

  1. Open Project settings and scroll to Custom domain.
  2. Enter your domain, for example docs.example.com, and click Save domain. You can type it with or without https://. GitRead cleans it up.
  3. GitRead shows a DNS record that you need to create at your domain provider. Use type A, your domain as the name, and the IP address shown in the settings as the value.
  4. Wait until DNS has propagated. This can take from a few minutes up to a few hours.
  5. Click Verify and activate.

GitRead checks that the domain points to the right address, adds it and issues the SSL certificate. This usually takes about a minute. Domain changes apply right away and do not need the Save button of the project settings.

Status

Status Meaning
Waiting for DNS The domain is saved but does not point to GitRead yet. Create the DNS record and verify.
Setting up… DNS is correct. The domain and certificate are being set up.
Active Your docs are live on your domain.
Failed Something went wrong. The settings show the reason. Fix it and click Verify and try again.

Rules

  • Each domain can be used by one project only.
  • You cannot use a domain that belongs to GitRead itself.
  • After you change the domain, the old one stops working.

Remove the domain

Click Remove domain in the project settings. The domain stops working and your docs are available at the default public link again.

If your plan changes

If your plan no longer includes custom domains, your docs are served from the default public link until you upgrade again.