merged in a few files from feature/docker-enhancements

Author: azconger

.circleci/config.yml

@@ -12,11 +12,11 @@ workflows:
           app-id: 685847dd-0a74-4f02-b4d2-53f2396c93ed
           steps:
             - run:
-                name: Build Vulny Django
-                command: docker build -t vulny_django:latest .
+                name: Build Vulnarable Django
+                command: docker build -t vuln_django:latest .
             - run:
                 name: Create scan_net Network
                 command: docker network create scan_net
             - run:
                 name: Run Vulny Django
-                command: docker run --detach --network scan_net --name vulny-django --rm vulny_django:latest
+                command: docker run --detach --network scan_net --name vuln-django --rm vuln_django:latest

Dockerfile

@@ -3,34 +3,53 @@
 # FROM directive instructing base image to build on
 FROM python:3.7-buster
 
-RUN apt-get update && apt-get install nginx vim ssh -y --no-install-recommends
+ARG SERVER_PORT=8020
 
-COPY nginx.default /etc/nginx/sites-available/default
-RUN ln -sf /dev/stdout /var/log/nginx/access.log \
-    && ln -sf /dev/stderr /var/log/nginx/error.log
+ENV DJANGO_SUPERUSER_USERNAME=admin
+ENV DJANGO_SUPERUSER_PASSWORD=adminpassword
+ENV [email protected]
+ENV SERVER_PORT=${SERVER_PORT}
+
+EXPOSE ${SERVER_PORT}:${SERVER_PORT}
+
+RUN apt-get update && \
+	apt-get install -y --no-install-recommends \
+		nginx \
+		vim \
+		less
 
 RUN mkdir -p /opt/app \
-&& mkdir -p /opt/app/pip_cache \
-&& mkdir -p /opt/app/vuln_django \
-&& mkdir -p /app/.profile.d
+	&& mkdir -p /opt/app/pip_cache \
+	&& mkdir -p /opt/app/vuln_django \
+	&& mkdir -p /app/.profile.d
 
 COPY requirements.txt start-server.sh /opt/app/
+
 COPY vuln_django/ /opt/app/vuln_django/vuln_django
+
 COPY static/ /opt/app/vuln_django/static
+
 COPY templates/ /opt/app/vuln_django/templates
+
 COPY polls/ /opt/app/vuln_django/polls
+
 COPY manage.py /opt/app/vuln_django/
+
+COPY ./nginx.default /etc/nginx/sites-available/default
+
+RUN ln -sf /dev/stdout /var/log/nginx/access.log \
+    && ln -sf /dev/stderr /var/log/nginx/error.log
+
 WORKDIR /opt/app
+
 RUN pip install -r requirements.txt \
-&& chown -R www-data:www-data /opt/app \
-&& python vuln_django/manage.py migrate
-ENV DJANGO_SUPERUSER_USERNAME=admin
-ENV DJANGO_SUPERUSER_PASSWORD=adminpassword
-ENV [email protected]
+	&& chown -R www-data:www-data /opt/app \
+	&& python vuln_django/manage.py migrate
+
 RUN python vuln_django/manage.py createsuperuser --no-input \
-&& chown -R www-data:www-data /opt/app \
-&& python vuln_django/manage.py seed polls --number=5
+	&& chown -R www-data:www-data /opt/app \
+	&& python vuln_django/manage.py seed polls --number=5
 
-EXPOSE 8020
 STOPSIGNAL SIGTERM
+
 CMD ["/opt/app/start-server.sh"]

README.md

@@ -8,43 +8,29 @@ question, visitors can choose between a fixed number of answers.
 Based on the Django Polls tutorial, contains a few XSS/SQLi issues and
 turns off the built in protections to prevent that.
 
-Quick start - this section is old
------------
+# Build and run
 
-1. Add "polls" to your INSTALLED_APPS setting like this::
+## Using docker-compose
 
-    INSTALLED_APPS = [
-        ...
-        'polls',
-    ]
+Build and run in foreground:
+`docker-compose up --build`
 
-2. Include the polls URLconf in your project urls.py like this::
+Run as a daemon:
+`docker-compose up -d`
 
-    path('polls/', include('polls.urls')),
+Build:
+`docker-compose build`
 
-3. Run `python3 manage.py migrate` to create the polls models.
+## Using Dockerfile
 
-4. Start the development server `python3 manage.py runserver 8081` and visit http://127.0.0.1:8081/admin/
-   to create a poll (you'll need the Admin app enabled).
-
-5. Visit http://127.0.0.1:8081/polls/ to participate in the poll.
-
-
-# Now with more Docker!
-## Build the docker image
+### Build the docker image
 ```docker build -t vuln_django .```
 
-## Then run the docker container
+### Run the docker container
 ```docker run -it -p 8020:8020 vuln_django:latest```
 
-## Now browse to the polls with http://localhost:8020/polls/
-
-## Administrator user http://localhost:8020/admin/
-- admin:adminpassword
-
-# Never Name Your Docker Container with an underscore because it will make you hate yourself
-NO!
-```docker run -it -p 8020:8020 --name vuln_django --rm --network scan_net vuln_django:latest```
-YES!
-```docker run -it -p 8020:8020 --name vuln-django --rm --network scan_net vuln_django:latest
+# Usage
 
+- Browse to the polls with http://localhost:8020/polls/
+- Administrator login http://localhost:8020/admin/
+    * admin:adminpassword

docker-compose.yml

@@ -0,0 +1,17 @@
+version: '3.7'
+
+services:
+  base:
+    image: vuln_django
+    container_name: vuln-django
+    build:
+      dockerfile: Dockerfile
+      context: .
+      args:
+        - SERVER_PORT=${SERVER_PORT:-8020}
+    environment:
+      - SERVER_PORT=${SERVER_PORT:-8020}
+    ports:
+      - ${SERVER_PORT:-8020}:${SERVER_PORT:-8020}
+    entrypoint:
+      - /opt/app/start-server.sh