Feat/docker compose instructions

README.md

@@ -6,12 +6,18 @@
 
 ## Installation
 
+
 1. Add "/path/to/flexmeasures-s2/flexmeasures_s2" to your FlexMeasures (>v0.7.0dev8) config file,
    using the FLEXMEASURES_PLUGINS setting (a list).
    Alternatively, if you installed this plugin as a package (e.g. via `python setup.py install`, `pip install -e` or `pip install flexmeasures_s2` should this project be on Pypi), then "flexmeasures_s2" suffices.
 
-2.  
-
+2. Or using Docker Compose, assuming your flexmeasures-s2 repo root directory lives next to your flexmeasures repo root directory, run this from either root directory:
+   ```
+   docker compose \
+     -f ../flexmeasures/docker-compose.yml \
+     -f ../flexmeasures-s2/docker-compose.override.yml \
+     up
+   ```
 
 ## Development
 

docker-compose.override.yml

@@ -0,0 +1,22 @@
+# ------------------------------------------------------------------
+# Use this to install flexmeasures-s2 in your local FlexMeasures
+# docker compose stack. Assuming your flexmeasures-s2 repo root
+# directory lives next to your flexmeasures repo root directory,
+# from either root directory, run:
+#   docker compose \
+#     -f ../flexmeasures/docker-compose.yml \
+#     -f ../flexmeasures-s2/docker-compose.override.yml \
+#     up
+# ------------------------------------------------------------------
+
+services:
+  server:
+    volumes:
+      - ../flexmeasures-s2:/plugins/flexmeasures-s2:rw
+    entrypoint: ["/bin/sh", "-c"]
+    command:
+    - |
+      python3 -m pip install --break-system-packages -e /plugins/flexmeasures-s2
+      gunicorn --bind 0.0.0.0:5000 --worker-tmp-dir /dev/shm --workers 2 --threads 4 wsgi:application
+    environment:
+      FLEXMEASURES_PLUGINS: /plugins/flexmeasures-s2/flexmeasures_s2

requirements/app.in

@@ -1,2 +1,3 @@
 flexmeasures>=0.24.0
 s2-python
+flask-sock