Getting up and Running

Inside of the repository folder, create a key folder, and inside place aprivate key (id_rsa, NOT id_rsa.pub) that your Docker instance will useto access your private repositories. You may want to set up a new githubaccount, or at, at the minimum, create a new private key for this.Alternatively, you can also bind-mount in your key to /root/.ssh/id_rsaand pull the image docker pull inanimate/rtd instead of bulding yourself.

Setup the local_settings.py file. You're welcome to copy the example fileand just bind-mount it inside the container!There are a ton knobs that can you tune, so you may want to take a moment tofamiliarize yourself with them.

Edit the docker-compose file. The only value that requires changing is theRTD_PRODUCTION_DOMAIN environment variable. It should match the domain thatyou're hosting RTD on. e.g. if you're hosting your docs athttp://docs.my-app.net, then you should set it to docs.my-app.net. It isrecommended to leave TEST_DATA=yes on first run as it will set things upfor you, and populate your install with some test projects you can use toverify the validity of the installation.

From this directory, launch RTD using docker-compose: docker-compose up -d.up reads the docker-compose file and will build the necessary images.-d starts the instance in detached mode (so you don't need to leave the ttyopen).

And that's it! Docker will automatically restart the service should it crash orif the machine goes reboots.