Info about custom installs

Read the Docs is open source, which means you can run your own version of it. There are many reasons to do this, the main one being if you want a private instance. If you have to keep everything behind a firewall or VPN, this is for you.

If your main reasons for considering a custom installation are to connect to private repositories or to have fine grained access control over your documentation, please consider Read the Docs for Business. It has those features and more!

警告

These documents are maintained by the community, and might not be up to date. Read the Docs developers do not support custom installs of our software, as mentioned in our Read the Docs Open Source Philosophy.

• Customizing your install
  • Have a local settings file
  • Adding your own title to pages
• Local VM Install
  • Assumptions and Prerequisites
  • Local RTD Setup
  • Tips