Skip to content

File structure

Noah S. Roberts edited this page Nov 16, 2024 · 5 revisions

WDH expects files and folders to reside in very specific locations.

'/django/source'

The source code (this repo) should be cloned here.

'/django/term'

The home of all group folders for each term.

'/django/term/group'

Each group's folder containing the files necessary for the multi-site hosting via WDH to work.

Created when running create-group [term] [group] (usage):

  • This folder.
  • docker-compose.site.yml: the Docker Compose stack file containing the group's PostgreSQL and Gunicorn Docker containers.
  • instructions.md: instructions for each group to prepare their site for deployment with WDH.

Created automatically by running deploy prep (usage):

  • .env: file containing environment variables used by the Docker Compose stack file.
  • site/: folder containing the group's Django site source code cloned from GitHub (or another Git server).

'/django/term/group/site'

The folder containing each group's Django site source code cloned from GitHub (or another Git server). This folder must be here and have this name for deploy to work correctly.

Clone this wiki locally