repo_layout.md

Repository Layout Guidelines

We recommend laying out your source git repository in the following way, to enable you to use all the features of the container.

It's important to note code will always be checked out to /var/www/html/ this is for historic reasons and we may improve this in the future with a user configurable variable. If you just wish to check code out into a container and not do anything special simply put all your files in the root directory of your repository like so:

- repo root (/var/www/html)
 - index.html
 - more code here

However if you wish to use scripting support you'll want to split code and scripts up to ensure your scripts are not in the public part of your site.

 - repo root (/var/www/html)
  - src
    - your code here
  - conf
    - nginx
      - default-site.conf
      - default-site-ssl.conf
  - scripts
    - 00-firstscript.sh
    - 01-second.sh
    - ......

src

If you use an alternative directory for your application root like the previous example of src/, you can use the WEBROOT variable to instruct nginx that that is where the code should be served from.

docker run -e 'WEBROOT=/var/www/html/src/' -e OTHER_VARS ........

One example would be, if you are running craft CMS you'll end up with a repo structure like this:

- repo root (/var/www/html)
 - craft
   - core craft
 - public
   - index.php
   -    other public files

In this case WEBROOT would be set as /var/www/html/public

conf

This directory is where you can put config files you call from your scripts. It is also home to the nginx folder where you can include custom nginx config files.

scripts

Scripts are executed in order so its worth numbering them 00,01,..,99 to control their run order. Bash scripts are supported but, of course, you could install other run times in the first script then write your scripts in your preferred language.