Public | Automated Build

Last pushed: 2 days ago
Short Description
Dockerized version of ReadTheDocs
Full Description

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:

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
Docker Pull Command
Owner
gyzpunk
Source Repository

Comments (4)
crania
4 months ago

Similar issue.

martip07
8 months ago

Hi, currently with gunicorn flag I am getting this after start a container:

django.core.exceptions.ImproperlyConfigured: Error importing module privacy.backends.syncers.DoubleRemotePuller: "No module named privacy.backends.syncers

steffenbrem
a year ago

You can login with:

user: docbuilder
pass: docbuilder

elpatron68
2 years ago

How to log into the admin account (http://<my server ip address>:8000/admin)?