Update documentation

5genesis · Apr 22, 2021 · 0b9a92e · 0b9a92e
1 parent 08d901e
commit 0b9a92e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+**22/04/2021** [Version 2.4.2]
+
+ - Analytics Dashboard integration
+
 **12/01/2021** [Version 2.4.1]
 
  - Updated documentation

diff --git a/Helper/defaultConfig b/Helper/defaultConfig
@@ -18,5 +18,5 @@ EastWest:
   Remotes: {}  # One key for each remote Portal, each key containing 'Host' and 'Port' values
 Analytics:
   Enabled: False
-  URL: # External (Internet) URL of the Analytics
-  Secret: # Secret key shared with the Analytics Portal, in order to secure the created URLs
+  URL: <Internet address>/dash # External URL of the Analytics Dashboard
+  Secret: # Secret key shared with the Analytics Dashboard, used in order to create secure URLs
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@
 ### Optional integrations:
 
  - [Grafana](https://grafana.com/) (tested with version 5.4)
+ - [Analytics Dashboard](https://github.com/5genesis/Analytics) (Release B)
 
 ## Deployment
 
@@ -103,6 +104,10 @@ The Portal instance can be configured by editing the `config.yml` file.
     - Remotes: Dictionary containing the connection configuration for each remote platform's Portal, with each key
       containing 'Host' and 'Port' values in the same format as in the `ELCM` section. Defaults to an empty
       dictionary (`{}`).
+- Analytics:
+    - Enabled: Boolean value indicating if the Analytics Dashboard is available. Defaults to `False`.
+    - URL: External URL of the Analytics Dashboard
+    - Secret: Secret key shared with the Analytics Dashboard, used in order to create secure URLs
 
 #### Portal notices