Document simulator configuration for Web UI usage.

[e-mobility-charging-stations-simulator.git] / ui / web / README.md

diff --git a/ui/web/README.md b/ui/web/README.md
index b14f6e4e3dc9de8889436a07e6cd92c61fe717a6..5b7f5d6f3d8bdfe8a703ba70721e77f44d0597cf 100644 (file)
--- a/ui/web/README.md
+++ b/ui/web/README.md
@@ -6,6 +6,23 @@
 npm install
 ```
 
+The simulator UI server must be enabled, use WebSocket and disable authentication. The simulator main configuration file should have a `uiServer` section like this:
+
+```json
+  "uiServer": {
+    "enabled": true,
+    "type": "ws",
+    "authentication": {
+      "enabled": false,
+      "type": "basic-auth",
+      "username": "admin",
+      "password": "admin"
+    }
+  },
+```
+
+See [here](../README.md#charging-stations-simulator-configuration) for more details.
+
 ### Run
 
 For both solution you can then follow the link displayed in the terminal at the end of compilation