docs for dc11d7d7 commit

INTO-CPS-Association · Nov 17, 2023 · 917f57d · 917f57d
1 parent 5d423e2
commit 917f57d
Show file tree

Hide file tree

Showing 43 changed files with 2,458 additions and 109 deletions.
diff --git a/DTaaS-version0.3.pdf b/DTaaS-version0.3.pdf
diff --git a/version0.3/404.html b/version0.3/404.html
@@ -881,6 +881,20 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="/user/examples/drobotti-rmqfmu/index.html" class="md-nav__link">
+        Desktop Robotti and RabbitMQ
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="https://github.com/INTO-CPS-Association/DTaaS-examples" class="md-nav__link">
         Codebase

diff --git a/version0.3/FAQ.html b/version0.3/FAQ.html
@@ -9,7 +9,7 @@
 
 
 
-        <link rel="prev" href="user/examples/water_tank_swap/index.html">
+        <link rel="prev" href="user/examples/drobotti-rmqfmu/index.html">
 
 
         <link rel="next" href="developer/index.html">
@@ -892,6 +892,20 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="user/examples/drobotti-rmqfmu/index.html" class="md-nav__link">
+        Desktop Robotti and RabbitMQ
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="https://github.com/INTO-CPS-Association/DTaaS-examples" class="md-nav__link">
         Codebase
@@ -1798,7 +1812,7 @@ <h2 id="gdpr-concerns">GDPR Concerns</h2>
       <nav class="md-footer__inner md-grid" aria-label="Footer" >
 
 
-          <a href="user/examples/water_tank_swap/index.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Water Tank Model Swap" rel="prev">
+          <a href="user/examples/drobotti-rmqfmu/index.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Desktop Robotti and RabbitMQ" rel="prev">
             <div class="md-footer__button md-icon">
               <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
             </div>
@@ -1807,7 +1821,7 @@ <h2 id="gdpr-concerns">GDPR Concerns</h2>
                 Previous
               </span>
               <div class="md-ellipsis">
-                Water Tank Model Swap
+                Desktop Robotti and RabbitMQ
               </div>
             </div>
           </a>

diff --git a/version0.3/LICENSE.html b/version0.3/LICENSE.html
@@ -890,6 +890,20 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="user/examples/drobotti-rmqfmu/index.html" class="md-nav__link">
+        Desktop Robotti and RabbitMQ
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="https://github.com/INTO-CPS-Association/DTaaS-examples" class="md-nav__link">
         Codebase

diff --git a/version0.3/PUBLISH.html b/version0.3/PUBLISH.html
@@ -886,6 +886,20 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="user/examples/drobotti-rmqfmu/index.html" class="md-nav__link">
+        Desktop Robotti and RabbitMQ
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="https://github.com/INTO-CPS-Association/DTaaS-examples" class="md-nav__link">
         Codebase

diff --git a/version0.3/admin/client/CLIENT.html b/version0.3/admin/client/CLIENT.html
@@ -937,6 +937,20 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../user/examples/drobotti-rmqfmu/index.html" class="md-nav__link">
+        Desktop Robotti and RabbitMQ
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="https://github.com/INTO-CPS-Association/DTaaS-examples" class="md-nav__link">
         Codebase

diff --git a/version0.3/admin/client/auth.html b/version0.3/admin/client/auth.html
@@ -942,6 +942,20 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../../user/examples/drobotti-rmqfmu/index.html" class="md-nav__link">
+        Desktop Robotti and RabbitMQ
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="https://github.com/INTO-CPS-Association/DTaaS-examples" class="md-nav__link">
         Codebase

diff --git a/version0.3/admin/host.html b/version0.3/admin/host.html
@@ -482,11 +482,11 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#the-traefik-gateway-server" class="md-nav__link">
-    The traefik gateway server
+  <a href="#traefik-gateway-server" class="md-nav__link">
+    Traefik gateway server
   </a>
 
-    <nav class="md-nav" aria-label="The traefik gateway server">
+    <nav class="md-nav" aria-label="Traefik gateway server">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -507,18 +507,18 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#configure-lib-microservice" class="md-nav__link">
-    Configure lib microservice
+  <a href="#lib-microservice" class="md-nav__link">
+    Lib microservice
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#configure-react-client-website" class="md-nav__link">
-    Configure React Client Website
+  <a href="#react-client-website" class="md-nav__link">
+    React Client Website
   </a>
 
-    <nav class="md-nav" aria-label="Configure React Client Website">
+    <nav class="md-nav" aria-label="React Client Website">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -1025,6 +1025,20 @@
 
 
 
+    <li class="md-nav__item">
+      <a href="../user/examples/drobotti-rmqfmu/index.html" class="md-nav__link">
+        Desktop Robotti and RabbitMQ
+      </a>
+    </li>
+
+
+
+
+
+
+
+
+
     <li class="md-nav__item">
       <a href="https://github.com/INTO-CPS-Association/DTaaS-examples" class="md-nav__link">
         Codebase
@@ -1343,11 +1357,11 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#the-traefik-gateway-server" class="md-nav__link">
-    The traefik gateway server
+  <a href="#traefik-gateway-server" class="md-nav__link">
+    Traefik gateway server
   </a>
 
-    <nav class="md-nav" aria-label="The traefik gateway server">
+    <nav class="md-nav" aria-label="Traefik gateway server">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -1368,18 +1382,18 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#configure-lib-microservice" class="md-nav__link">
-    Configure lib microservice
+  <a href="#lib-microservice" class="md-nav__link">
+    Lib microservice
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#configure-react-client-website" class="md-nav__link">
-    Configure React Client Website
+  <a href="#react-client-website" class="md-nav__link">
+    React Client Website
   </a>
 
-    <nav class="md-nav" aria-label="Configure React Client Website">
+    <nav class="md-nav" aria-label="React Client Website">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
@@ -1479,8 +1493,8 @@ <h2 id="configuration">Configuration</h2>
 <p>The first step is to decide on the number of users and their usenames.
 The traefik gateway configuration has a template for two users.
 You can modify the usernames in the template to the usernames chosen by you.</p>
-<h3 id="the-traefik-gateway-server">The traefik gateway server</h3>
-<p>You can run the Run the Traefik gateway server in both
+<h3 id="traefik-gateway-server">Traefik gateway server</h3>
+<p>You can run the Traefik gateway server in both
 HTTP and HTTPS mode to experience the DTaaS application.
 The installation guide assumes that you can run the application in HTTPS mode.</p>
 <p>The Traefik gateway configuration is
@@ -1514,14 +1528,15 @@ <h4 id="authentication">Authentication</h4>
 </span></code></pre></div></td></tr></table></div>
 <p>The user credentials added in <em>deploy/config/gateway/auth</em> should
 match the usernames in <em>deploy/config/gateway/fileConfig.yml</em>.</p>
-<h2 id="configure-lib-microservice">Configure lib microservice</h2>
+<h2 id="lib-microservice">Lib microservice</h2>
 <p>The library microservice requires configuration.
 A template of this configuration file is given in <em>deploy/config/lib</em> file.
 Please modify this file as per your needs.</p>
 <p>The first step in this configuration is to prepare the a filesystem for users.
 An example file system in <code>files/</code> directory.
 You can rename the top-level user1/user2 to the usernames chosen by you.</p>
-<p>An example <code>.env</code> file is given below.
+<p>Add an environment file named <code>.env</code> in lib for the library microservice.
+An example <code>.env</code> file is given below.
 The simplest possibility is to use <code>local</code> mode with the following example.
 The filepath is the absolute filepath to <code>files/</code> directory.
 You can copy this configuration into <em>deploy/config/lib</em> file to get started.</p>
@@ -1537,7 +1552,7 @@ <h2 id="configure-lib-microservice">Configure lib microservice</h2>
 </span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5"></a>APOLLO_PATH=&#39;/lib&#39;
 </span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6"></a>GRAPHQL_PLAYGROUND=&#39;true&#39;
 </span></code></pre></div></td></tr></table></div>
-<h2 id="configure-react-client-website">Configure React Client Website</h2>
+<h2 id="react-client-website">React Client Website</h2>
 <h3 id="gitlab-oauth-application">Gitlab OAuth application</h3>
 <p>The DTaaS react website requires Gitlab OAuth provider.
 If you need more help with this step, please see
@@ -1597,7 +1612,7 @@ <h3 id="update-client-config">Update Client Config</h3>
 <span class="normal"><a href="#__codelineno-3-16">16</a></span>
 <span class="normal"><a href="#__codelineno-3-17">17</a></span>
 <span class="normal"><a href="#__codelineno-3-18">18</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1"></a><span class="nb">window</span><span class="p">.</span><span class="nx">env</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
-</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2"></a><span class="w">  </span><span class="nx">REACT_APP_ENVIRONMENT</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;dev&#39;</span><span class="p">,</span>
+</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2"></a><span class="w">  </span><span class="nx">REACT_APP_ENVIRONMENT</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;prod&#39;</span><span class="p">,</span>
 </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3"></a><span class="w">  </span><span class="nx">REACT_APP_URL</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;https://foo.com/&#39;</span><span class="p">,</span>
 </span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4"></a><span class="w">  </span><span class="nx">REACT_APP_URL_BASENAME</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;dtaas&#39;</span><span class="p">,</span>
 </span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5"></a><span class="w">  </span><span class="nx">REACT_APP_URL_DTLINK</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;/lab&#39;</span><span class="p">,</span>