ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Setting Custom Domain & SSL

Custom Domain

Found under Documentation > Configure > Custom Domain


We will automatically generate an SSL certificate on your behalf using Let’s Encrypt

Let's Encrypt is a certificate authority which can be used to generate totally free X.509 (SSL/TLS) certificates. All you need to do to benefit from this is to setup a CNAME to our SSL server, "".

This will automatically force all users to https

To allow users to not use SSL, click General Settings > Custom Domain > Advanced Options and uncheck the Force SSL box.

CAA Record

If you decide to have a CAA record set, make sure you use "" instead of "".

Setting Custom Domain & SSL

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.