feat(#157): documentation with docker-compose.yml

distance-oracle/README.md

@@ -21,16 +21,7 @@ This feature is organized in multiple parts:
 
 ## Usage (with Docker)
 
-Exemple for GDev:
-
-> Supposes that you have a Docker host with a `/data/duniter-v2s` folder that is used as a mounted volume for a duniter-v2s validator node to `/var/lib/duniter`.
-
-```bash
-docker run --rm -it --entrypoint docker-distance-entrypoint \
-    -v /data/duniter-v2s/chains/gdev/distance/:/distance \
-    -e ORACLE_RPC_URL=wss://gdev.cgeek.fr:443 \
-    duniter/duniter-v2s-gdev:latest
-```
+See [docker-compose.yml](../docker-compose.yml) for an example of how to run the distance oracle with Docker.
 
 Output:
 

docker-compose.yml

@@ -22,6 +22,19 @@ services:
       DUNITER_CHAIN_NAME: "gdev"
     volumes:
       - duniter-local-data:/var/lib/duniter
+  distance-oracle:
+    container_name: distance-oracle
+    # choose the version of the image here
+    image: duniter/duniter-v2s:latest
+    entrypoint: docker-distance-entrypoint
+    environment:
+      ORACLE_RPC_URL: "ws://duniter-v2s:9944"
+      ORACLE_RESULT_DIR: "/var/lib/duniter/chains/gdev/distance/"
+      ORACLE_EXECUTION_INTERVAL: "10"
+      ORACLE_MAX_DEPTH: "5"
+      ORACLE_LOG_LEVEL: "info"
+    volumes:
+      - duniter-local-data:/var/lib/duniter
 
 volumes:
   duniter-local-data: