gyzpunk/readthedocs repository overview

⁠Docker build for ReadTheDocs (RTD)

This repository provides Dockerfile for Read The Docs⁠

⁠Status

Built images are uploaded to index.docker.io⁠

⁠Tags

There are currently two tags available depending of the way to distribute content:

• latest: Which rely on the django-manage runserver command⁠, this should not be used for production
• gunicorn: Which serve python files through the Gunicorn⁠ WSGI HTTP server. If you are choosing this option, as per documentation⁠, you'll need to use a proxy server in front of Gunicorn workers.

⁠Quickstart:

• Install Docker: http://docs.docker.io/⁠
• Execute docker run -d -p 8000:8000 gyzpunk/readthedocs
• Browse http://:8000/⁠A

⁠Docker configuration

Those images will expose the port 8000 for the web application (to proxify behind a real webserver in case of gunicorn usage) as well as the /usr/src/app volume which contains all the django project.

You can also use the following environment variables while building Docker image :

• RTD_PRODUCTION_DOMAIN: Stands for PRODUCTION_DOMAINin readthedocs settings (can be formed like "{host}:{port}")
• RTD_SLUMBER_PASSWORD: Stands for SLUMBER_PASSWORDin readthedocs settings (will be used as "docbuilder" account password)
• DJANGO_SETTINGS_MODULE: Django settings module to be used
• DJANGO_DB_ENGINE
• DJANGO_DB_NAME
• DJANGO_DB_USER
• DJANGO_DB_PASSWORD
• DJANGO_DB_HOST
• DJANGO_DB_PORT