Merge pull request #13 from dfarrow0/dev

enable local development

Author: undefx

deploy.json

@@ -10,13 +10,6 @@
       "dst": "/var/www/html/cc-test/.htaccess",
       "add-header-comment": false
     },
-    "// service worker",
-    {
-      "type": "move",
-      "src": "site/sw.js",
-      "dst": "/var/www/html/cc-test/sw.js",
-      "add-header-comment": true
-    },
     "// web sources",
     {
       "type": "move",
@@ -36,7 +29,7 @@
       "type": "move",
       "src": "site/css/",
       "dst": "/var/www/html/cc-test/css/",
-      "match": "^.*\\.(css|php)$",
+      "match": "^.*\\.(php)$",
       "add-header-comment": true
     },
     {

dev/docker/database/epicast/Dockerfile

@@ -0,0 +1,16 @@
+# start with the `delphi_database` image
+FROM delphi_database
+
+# create the `epicast2` database
+ENV MYSQL_DATABASE epicast2
+
+# create the `epi` user account with a development-only password
+ENV MYSQL_USER user
+ENV MYSQL_PASSWORD pass
+
+# provide DDL which will create empty tables at container startup
+# note that files are executed in order of filename alphabetically, so here
+# destination files are named such that table definitions are executed prior to
+# data insertions
+COPY repos/delphi/www-epicast/src/ddl/epicast2.sql /docker-entrypoint-initdb.d/0_epicast2.sql
+COPY repos/delphi/www-epicast/src/ddl/development_data.sql /docker-entrypoint-initdb.d/1_development_data.sql

dev/docker/database/epicast/README.md

@@ -0,0 +1,27 @@
+# `delphi_database_epicast`
+
+This image extends Delphi's database by:
+
+- adding the `epi` user account
+- adding the `epicast2` database
+- creating and minimally populating tables in `epicast2`
+
+To start a container from this image, run:
+
+```bash
+docker run --rm -p 13306:3306 \
+  --network delphi-net --name delphi_database_epicast \
+  delphi_database_epicast
+```
+
+For debugging purposes, you can interactively connect to the database inside
+the container using a `mysql` client (either installed locally or supplied via
+a docker image) like this:
+
+```bash
+mysql --user=user --password=pass --port 13306 --host 127.0.0.1 epicast2
+```
+
+Note that using host `localhost` may fail on some platforms as mysql will
+attempt, and fail, to use a Unix socket. Using `127.0.0.1`, which implies
+TCP/IP, works instead.

dev/docker/web/epicast/Dockerfile

@@ -0,0 +1,27 @@
+# start with the `delphi_web` image
+FROM delphi_web
+
+# enable mod_rewrite, aka RewriteEngine
+RUN a2enmod rewrite
+
+# enable mod_headers
+RUN a2enmod headers
+
+# create an empty htpasswd file
+RUN touch /var/www/passwords
+
+# deploy the Epicast website (see `www-epicast/deploy.json`)
+# deploy files in an order that tries to take advantage of build caching
+
+COPY repos/delphi/www-epicast/site/images/* /var/www/html/images/
+COPY repos/delphi/www-epicast/site/images/flags/* /var/www/html/images/flags/
+COPY repos/delphi/www-epicast/site/data/* /var/www/html/data/
+
+COPY repos/delphi/www-epicast/site/css/* /var/www/html/css/
+COPY repos/delphi/www-epicast/site/js/*.js /var/www/html/js/
+COPY repos/delphi/www-epicast/site/js/us-map /var/www/html/js/us-map
+COPY repos/delphi/www-epicast/site/common/* /var/www/html/common/
+COPY repos/delphi/www-epicast/site/*.php /var/www/html/
+
+# point to the local development database (overwrites `common/settings.php`)
+COPY repos/delphi/www-epicast/dev/docker/web/epicast/assets/settings.php /var/www/html/common/

dev/docker/web/epicast/README.md

@@ -0,0 +1,24 @@
+# `delphi_web_epicast`
+
+This image starts with Delphi's web server and adds the sources necessary for
+hosting the Epicast website. It further extends Delphi's web server by:
+
+- enabling the `mod_rewrite` extension
+- enabling the `mod_headers` extension
+- creating an empty `htpasswd` file
+
+This image includes the file
+[`settings.php`](assets/settings.php), which points to a local
+container running the
+[`delphi_database_epicast` image](../../database/epicast/README.md).
+
+To start a container from this image, run:
+
+```bash
+docker run --rm -p 10080:80 \
+  --network delphi-net --name delphi_web_epicast \
+  delphi_web_epicast
+```
+
+You should be able to login and interact with the website (e.g. submitting
+predictions) by visiting `http://localhost:10080/` in a web browser.

dev/docker/web/epicast/assets/settings.php

@@ -0,0 +1,15 @@
+<?php
+
+/* Settings and secrets for local development of the Epicast website. */
+
+$dbHost = 'delphi_database_epicast';
+$dbPort = 3306;
+$dbUser = 'user';
+$dbPass = 'pass';
+$dbName = 'epicast2';
+
+$epicastAdmin = array(
+   'name' => 'Delphi Developer',
+   'email' => 'fake_email_address',
+);
+?>

site/.htaccess

@@ -1,12 +1,13 @@
 RewriteEngine On
 
-## Resrtict access to known users ##
+## Restrict access to known users or docker development ##
 AuthType Basic
 AuthName "Restricted Site: Crowdcast"
 AuthBasicProvider file
 AuthUserFile /var/www/passwords
 Require user cctest
-## Resrtict access to known users ##
+Require ip 172.16.0.0/12
+## Restrict access to known users or docker development ##
 
 ## Compress Files ##
 <IfModule mod_deflate.c>