瀏覽代碼

Updated README

Joeri Exelmans 2 年之前
父節點
當前提交
2db366cd1b
共有 1 個文件被更改,包括 8 次插入17 次删除
  1. 8 17
      backend/README.md

+ 8 - 17
backend/README.md

@@ -49,28 +49,19 @@ https://msdl.uantwerpen.be/git/jexelmans/drawio/src/master/src/main/webapp/
 
 ### Using the service monitor script
 
-The file `service-monitor.nix` contains a recipe for a service monitor script (and its dependencies), that will start, monitor, and cleanly stop the following services:
+Included in this project is a service monitor script (based on [supervisord](http://supervisord.org/)) that will start, monitor, restart, and cleanly stop the following services:
 
   - The dtdesign-backend script (TCP port 5000) from this repository 
   - Fuseki (TCP port 3030)
   - Lighttpd (TCP port 8700), statically serving drawio with the dtdesign-plugin
+  - Workflow Enactment Engine (WEE) (TCP port 8081)
 
 This allows running the DTDesign demo as if it were a single application.
 
-#### Building
-
-To use the script, first build it:
-
-```
-nix-build service-monitor.nix
-```
-
-#### Running
-
-This places a symlink `result` in the current directory, that can be run. The only configuration parameter needed by this script is the `PROJECTDIR` environment variable, which should point to `PATH/TO/SDO2L`:
+To use the script:
 
 ```
-PROJECTDIR=PATH/TO/SDO2L ./result
+PROJECTDIR=/PATH/TO/SDO2L nix run .#serviceMonitor
 ```
 
 To end the script, hit Ctrl+C in the same terminal and all services will be cleanly shut down.
@@ -84,10 +75,10 @@ A Docker container that contains the service monitor script and all its dependen
 To build the container:
 
 ```
-nix-build docker.nix
+nix build #.dockerContainer
 ```
 
-This places a symlink `result` in the current directory, pointing at a Docker container image file.
+This places a symlink `result` in the current directory, pointing at the created Docker container image file.
 
 #### Pre-built containers
 
@@ -103,11 +94,11 @@ To run the container, load the container image, then create and start an instanc
 
 ```
 docker load < container.tar.gz # load the image
-docker run --network host dtdesign:XXX # create and start an instance - replace XXX by the hash printed by the previous command
+docker run -p "8081:8081" -p "5000:5000" -p "3030:3030" -p "8700:8700" # create and start an instance - replace XXX by the hash printed by the previous command
 ```
 
 ## Using the backend
 
 Once the backend, Fuseki and drawio web server are running, navigate to the following URL:
 
-http://localhost:8700/?p=ftgpm;dtdesign&dev=1&stealth=1#
+http://localhost:8700/?p=ftgpm;dtdesign&dev=1&stealth=1