Merge pull request #72 from cetic/main

Add Docker Compose deployment

.github/workflows/docker-compose.yml

@@ -0,0 +1,20 @@
+name: Test Docker image
+
+on:
+  push:
+    branches:
+      - 'main'
+    tags:
+      - '*'
+
+jobs:
+  docker-compose:
+    # run docker-compose file and clean up before action finished
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Launch Attack Flow using Docker Compose
+        uses: isbang/[email protected]
+        with:
+          compose-file: "docker-compose.yml"

docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3.8'
+
+services:
+  attack-flow:
+    image: ghcr.io/center-for-threat-informed-defense/attack-flow:main
+    ## Uncomment this to use the local Dockerfile instead of the official image
+    #build:
+    #  context: .
+    #  dockerfile: ./Dockerfile
+    ports:
+      - 8081:80
+    restart: always

docs/builder.rst

@@ -177,6 +177,17 @@ If building the image completes successfully, then use this command to run the i
    /docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh
    ...
 
+Alternatively, you can run the Attack Flow Builder with Docker Compose:
+
+* `install Docker <https://docs.docker.com/engine/install>`_
+* run the following commands in a terminal:
+.. code:: shell
+
+   $ curl https://raw.githubusercontent.com/center-for-threat-informed-defense/attack-flow/main/docker-compose.yml
+   $ docker compose up
+
+This will launch a container with Attack Flow Builder accessible at `http://localhost:8081 <http://localhost:8081>`_ . You can customize the provided docker-compose.yml sample file (volumes, ports, ...).
+
 Download
 --------