update installation notes

msupply-foundation · Dec 6, 2023 · ac8aa01 · ac8aa01
1 parent 75c67b5
commit ac8aa01
Show file tree

Hide file tree

Showing 47 changed files with 237 additions and 184 deletions.
diff --git a/content/docs/introduction/introduction.md b/content/docs/introduction/introduction.md
@@ -86,8 +86,25 @@ The following table outlines some of the common terms used in mSupply, and also
 
 ## Getting Started
 
-If you are running the server for the very first time, you may see this screen:
+To run Open mSupply you will require an mSupply server to operate as a central server. While we are planning to create a new open source central server, that is not yet available.
 
-![Initialisation](/docs/introduction/images/initialisation.png)
+Note that we are also currently working through testing the migration process and the integration of Open mSupply with an existing mSupply system. As such, we aren't recommending that you upgrade without talking to us first. 
+
+### Installation
+
+#### Preconditions
+1.  You need an existing mSupply system with Legacy mSupply server with web and sync server modules
+2. As of December 2023, it is not possible to migrate an existing Legacy (or Mobile) mSupply store to an Open mSupply store; only new stores can be created in Open mSupply
 
-Don't panic! This simply means that the server needs to know how to connect to the central mSupply server. If you don't know what to enter, contact support and they can help.
+#### Procedure:
+1. Any Open mSupply stores need to be created in the Legacy mSupply central server as detailed in [Creating new stores](https://docs.msupply.org.nz/other_stuff:virtual_stores#creating_new_stores).  Note that you will normally [Turn an existing customer into a store](https://docs.msupply.org.nz/other_stuff:virtual_stores#transition_a_customer_to_a_virtual_store).
+2. Users need to be created and configured for the store(s) in the Legacy mSupply central server as detailed in [Managing Users](https://docs.msupply.org.nz/admin:managing_users)
+3. The Open mSupply site needs to be created  in the Legacy mSupply central server as detailed in [Creating New Sync Sites](https://docs.msupply.org.nz/synchronisation:sync_sites#creating_new_sync_sites)
+4. The store(s) will need to be added to the Open mSupply site in the Legacy mSupply central server as detailed in [Adding stores](https://docs.msupply.org.nz/synchronisation:sync_sites#adding_stores)
+5. Deploy Open mSupply to your device from the [Open mSupply github repository](https://github.com/msupply-foundation/open-msupply).  Consult with TMF support to make sure that you are deploying the correct version
+6. Initiate Open mSupply on the device.  You should see something like the screen below.
+    - URL:  Consult with TMF support to make sure that you have the correct URL
+    - Site name:  As entered in [Creating New Sync Sites](https://docs.msupply.org.nz/synchronisation:sync_sites#creating_new_sync_sites)
+    - Password:  As entered in [Creating New Sync Sites](https://docs.msupply.org.nz/synchronisation:sync_sites#creating_new_sync_sites)
+
+![Initialisation](/docs/introduction/images/initialisation.png)
diff --git a/content/docs/sync/images/expand_qr.gif b/content/docs/sync/images/expand_qr.gif
diff --git a/content/docs/sync/images/sync_status.png b/content/docs/sync/images/sync_status.png
diff --git a/content/docs/sync/synchronisation.md b/content/docs/sync/synchronisation.md
@@ -36,4 +36,9 @@ Here is the complete process in action, with the steps slowed down. You'll notic
 
 ![sync: manual](/docs/sync/images/sync.gif)
 
-If any errors are encountered during the sync progress you will see these on this screen too. Hover over the `i` icon to see additional details.
+If any errors are encountered during the sync progress you will see these on this screen too. Hover over the `i` icon to see additional details.
+
+## Server details
+
+
+![sync: manual](/docs/sync/images/expand_qr.gif)
diff --git a/public/docs/bounty/feature-bounty/index.html b/public/docs/bounty/feature-bounty/index.html
@@ -434,7 +434,7 @@ <h3>On this page</h3>
 
         <h1>Feature Bounty</h1>
          <p><a target="_blank" href="https://msupply.foundation/about">The mSupply Foundation</a> is a non-profit organisation.</p>
-<p>We are not motified by profit. 
+<p>We are not motivated by profit. 
 Instead we are motivated by the opportunity to improve access to essential medicines and vaccines for people in low to middle income countries.</p>
 <p>We seek to do that by developing and implementing technological solutions to strengthen health supply chains in those countries. </p>
 <p>We have a <a target="_blank" href="https://msupply.foundation/team">team</a> of around 55 permanent staff who are dedicated towards this cause. </p>

diff --git a/public/docs/catalogue/items/index.html b/public/docs/catalogue/items/index.html
@@ -429,11 +429,6 @@ <h3>On this page</h3>
 
       <main class="docs-content col-lg-11 col-xl-9">
 
-        <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;catalogue&#x2F;items&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
-        </div>
-
         <div class="flagster" style="float: right; padding: 5px">
           <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;catalogue&#x2F;items&#x2F;" title="Change language to fr"
             ><img src="/icons/fr.svg" width="28"> </a>
@@ -444,6 +439,11 @@ <h3>On this page</h3>
             ><img src="/icons/es.svg" width="28"> </a>
         </div>
 
+        <div class="flagster" style="float: right; padding: 5px">
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;catalogue&#x2F;items&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
+        </div>
+
 
         <h1>Items</h1>
 

diff --git a/public/docs/distribution/customers/index.html b/public/docs/distribution/customers/index.html
@@ -417,11 +417,6 @@ <h3>On this page</h3>
 
       <main class="docs-content col-lg-11 col-xl-9">
 
-        <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;distribution&#x2F;customers&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
-        </div>
-
         <div class="flagster" style="float: right; padding: 5px">
           <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;distribution&#x2F;customers&#x2F;" title="Change language to es"
             ><img src="/icons/es.svg" width="28"> </a>
@@ -432,6 +427,11 @@ <h3>On this page</h3>
             ><img src="/icons/fr.svg" width="28"> </a>
         </div>
 
+        <div class="flagster" style="float: right; padding: 5px">
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;distribution&#x2F;customers&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
+        </div>
+
 
         <h1>Customers</h1>
 

diff --git a/public/docs/distribution/outbound-shipments/index.html b/public/docs/distribution/outbound-shipments/index.html
@@ -503,8 +503,8 @@ <h3>On this page</h3>
       <main class="docs-content col-lg-11 col-xl-9">
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;distribution&#x2F;outbound-shipments&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;distribution&#x2F;outbound-shipments&#x2F;" title="Change language to fr"
+            ><img src="/icons/fr.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
@@ -513,8 +513,8 @@ <h3>On this page</h3>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;distribution&#x2F;outbound-shipments&#x2F;" title="Change language to fr"
-            ><img src="/icons/fr.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;distribution&#x2F;outbound-shipments&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
         </div>
 
 

diff --git a/public/docs/introduction/faq/index.html b/public/docs/introduction/faq/index.html
@@ -438,13 +438,13 @@ <h3>On this page</h3>
       <main class="docs-content col-lg-11 col-xl-9">
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;introduction&#x2F;faq&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;introduction&#x2F;faq&#x2F;" title="Change language to es"
+            ><img src="/icons/es.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;introduction&#x2F;faq&#x2F;" title="Change language to es"
-            ><img src="/icons/es.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;introduction&#x2F;faq&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
         </div>
 
 

diff --git a/public/docs/introduction/introduction/index.html b/public/docs/introduction/introduction/index.html
@@ -433,6 +433,12 @@ <h3>On this page</h3>
         </ul>
 
         <li><a href="https://docs.msupply.foundation/docs/introduction/introduction/#getting-started">Getting Started</a></li>
+
+        <ul>
+
+          <li><a href="https://docs.msupply.foundation/docs/introduction/introduction/#installation">Installation</a></li>
+
+        </ul>
 
       </ul>
     </nav>
@@ -518,9 +524,30 @@ <h3 id="terminology">Terminology<a class="zola-anchor" href="#terminology" aria-
 <tr><td align="center">Internal Orders</td><td align="center">Supplier Requisitions</td><td align="left">A request for stock made for a particular supplier (facility)</td></tr>
 </tbody></table>
 <h2 id="getting-started">Getting Started<a class="zola-anchor" href="#getting-started" aria-label="Anchor link for: getting-started">🔗</a></h2>
-<p>If you are running the server for the very first time, you may see this screen:</p>
+<p>To run Open mSupply you will require an mSupply server to operate as a central server. While we are planning to create a new open source central server, that is not yet available.</p>
+<p>Note that we are also currently working through testing the migration process and the integration of Open mSupply with an existing mSupply system. As such, we aren't recommending that you upgrade without talking to us first. </p>
+<h3 id="installation">Installation<a class="zola-anchor" href="#installation" aria-label="Anchor link for: installation">🔗</a></h3>
+<h4 id="preconditions">Preconditions<a class="zola-anchor" href="#preconditions" aria-label="Anchor link for: preconditions">🔗</a></h4>
+<ol>
+<li>You need an existing mSupply system with Legacy mSupply server with web and sync server modules</li>
+<li>As of December 2023, it is not possible to migrate an existing Legacy (or Mobile) mSupply store to an Open mSupply store; only new stores can be created in Open mSupply</li>
+</ol>
+<h4 id="procedure">Procedure:<a class="zola-anchor" href="#procedure" aria-label="Anchor link for: procedure">🔗</a></h4>
+<ol>
+<li>Any Open mSupply stores need to be created in the Legacy mSupply central server as detailed in <a href="https://docs.msupply.org.nz/other_stuff:virtual_stores#creating_new_stores">Creating new stores</a>.  Note that you will normally <a href="https://docs.msupply.org.nz/other_stuff:virtual_stores#transition_a_customer_to_a_virtual_store">Turn an existing customer into a store</a>.</li>
+<li>Users need to be created and configured for the store(s) in the Legacy mSupply central server as detailed in <a href="https://docs.msupply.org.nz/admin:managing_users">Managing Users</a></li>
+<li>The Open mSupply site needs to be created  in the Legacy mSupply central server as detailed in <a href="https://docs.msupply.org.nz/synchronisation:sync_sites#creating_new_sync_sites">Creating New Sync Sites</a></li>
+<li>The store(s) will need to be added to the Open mSupply site in the Legacy mSupply central server as detailed in <a href="https://docs.msupply.org.nz/synchronisation:sync_sites#adding_stores">Adding stores</a></li>
+<li>Deploy Open mSupply to your device from the <a href="https://github.com/msupply-foundation/open-msupply">Open mSupply github repository</a>.  Consult with TMF support to make sure that you are deploying the correct version</li>
+<li>Initiate Open mSupply on the device.  You should see something like the screen below.
+<ul>
+<li>URL:  Consult with TMF support to make sure that you have the correct URL</li>
+<li>Site name:  As entered in <a href="https://docs.msupply.org.nz/synchronisation:sync_sites#creating_new_sync_sites">Creating New Sync Sites</a></li>
+<li>Password:  As entered in <a href="https://docs.msupply.org.nz/synchronisation:sync_sites#creating_new_sync_sites">Creating New Sync Sites</a></li>
+</ul>
+</li>
+</ol>
 <p><img src="/docs/introduction/images/initialisation.png" alt="Initialisation" /></p>
-<p>Don't panic! This simply means that the server needs to know how to connect to the central mSupply server. If you don't know what to enter, contact support and they can help.</p>
 
 <div class="docs-navigation d-flex justify-content-between">
 

diff --git a/public/docs/introduction/mobile/index.html b/public/docs/introduction/mobile/index.html
@@ -422,13 +422,13 @@ <h3>On this page</h3>
       <main class="docs-content col-lg-11 col-xl-9">
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;introduction&#x2F;mobile&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;introduction&#x2F;mobile&#x2F;" title="Change language to es"
+            ><img src="/icons/es.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;introduction&#x2F;mobile&#x2F;" title="Change language to es"
-            ><img src="/icons/es.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;introduction&#x2F;mobile&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
         </div>
 
 

diff --git a/public/docs/introduction/roadmap/index.html b/public/docs/introduction/roadmap/index.html
@@ -418,13 +418,13 @@ <h3>On this page</h3>
       <main class="docs-content col-lg-11 col-xl-9">
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;introduction&#x2F;roadmap&#x2F;" title="Change language to fr"
-            ><img src="/icons/fr.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;introduction&#x2F;roadmap&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;introduction&#x2F;roadmap&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;introduction&#x2F;roadmap&#x2F;" title="Change language to fr"
+            ><img src="/icons/fr.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">

diff --git a/public/docs/introduction/tutorial/index.html b/public/docs/introduction/tutorial/index.html
@@ -429,6 +429,11 @@ <h3>On this page</h3>
 
       <main class="docs-content col-lg-11 col-xl-9">
 
+        <div class="flagster" style="float: right; padding: 5px">
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;introduction&#x2F;tutorial&#x2F;" title="Change language to es"
+            ><img src="/icons/es.svg" width="28"> </a>
+        </div>
+
         <div class="flagster" style="float: right; padding: 5px">
           <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;introduction&#x2F;tutorial&#x2F;" title="Change language to en"
             ><img src="/icons/en.svg" width="28"> </a>
@@ -439,11 +444,6 @@ <h3>On this page</h3>
             ><img src="/icons/fr.svg" width="28"> </a>
         </div>
 
-        <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;introduction&#x2F;tutorial&#x2F;" title="Change language to es"
-            ><img src="/icons/es.svg" width="28"> </a>
-        </div>
-
 
         <h1>Tutorial</h1>
          <h2 id="open-msupply-tutorial">Open mSupply Tutorial<a class="zola-anchor" href="#open-msupply-tutorial" aria-label="Anchor link for: open-msupply-tutorial">🔗</a></h2>

diff --git a/public/docs/inventory/stock-takes/index.html b/public/docs/inventory/stock-takes/index.html
@@ -431,13 +431,13 @@ <h3>On this page</h3>
       <main class="docs-content col-lg-11 col-xl-9">
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;inventory&#x2F;stock-takes&#x2F;" title="Change language to fr"
-            ><img src="/icons/fr.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;inventory&#x2F;stock-takes&#x2F;" title="Change language to es"
+            ><img src="/icons/es.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;inventory&#x2F;stock-takes&#x2F;" title="Change language to es"
-            ><img src="/icons/es.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;inventory&#x2F;stock-takes&#x2F;" title="Change language to fr"
+            ><img src="/icons/fr.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">

diff --git a/public/docs/inventory/stock-view/index.html b/public/docs/inventory/stock-view/index.html
@@ -433,13 +433,13 @@ <h3>On this page</h3>
       <main class="docs-content col-lg-11 col-xl-9">
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;inventory&#x2F;stock-view&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;inventory&#x2F;stock-view&#x2F;" title="Change language to fr"
+            ><img src="/icons/fr.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;fr&#x2F;docs&#x2F;inventory&#x2F;stock-view&#x2F;" title="Change language to fr"
-            ><img src="/icons/fr.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;inventory&#x2F;stock-view&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">

diff --git a/public/docs/programs/module-hiv/index.html b/public/docs/programs/module-hiv/index.html
@@ -453,13 +453,13 @@ <h3>On this page</h3>
       <main class="docs-content col-lg-11 col-xl-9">
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;programs&#x2F;module-hiv&#x2F;" title="Change language to es"
-            ><img src="/icons/es.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;programs&#x2F;module-hiv&#x2F;" title="Change language to en"
+            ><img src="/icons/en.svg" width="28"> </a>
         </div>
 
         <div class="flagster" style="float: right; padding: 5px">
-          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;docs&#x2F;programs&#x2F;module-hiv&#x2F;" title="Change language to en"
-            ><img src="/icons/en.svg" width="28"> </a>
+          <a href="https:&#x2F;&#x2F;docs.msupply.foundation&#x2F;es&#x2F;docs&#x2F;programs&#x2F;module-hiv&#x2F;" title="Change language to es"
+            ><img src="/icons/es.svg" width="28"> </a>
         </div>