admin:msupplyclient-for-a-mac

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
admin:msupplyclient-for-a-mac [2026/07/03 06:23] – [Setup Steps] Ujwal Khatryadmin:msupplyclient-for-a-mac [2026/07/07 09:53] (current) Ujwal Khatry
Line 21: Line 21:
   - Run the mSupply Client by double clicking on the file : mSupply Client.app   - Run the mSupply Client by double clicking on the file : mSupply Client.app
     - The mSupply Client may automatically connect to the mSupply server. This will happen if the msupply Client has been operated successfully in the past.     - The mSupply Client may automatically connect to the mSupply server. This will happen if the msupply Client has been operated successfully in the past.
-  Enter the **server's IP address** (rather than hostname) in the custom setting field. +    The mSupply Client may show you list of available servers. View the image belowSimply select the available server and click `Ok` to connect. 
-  - Connect and confirm the client reaches the server.+    - The mSupply Client may just fail. View trouble shooting below.
  
 +{{ :admin:msupply_client_mac_available_server_2026-07-03-11-54-10.png?400 |mSupply Client : Showing a list of servers}}
 +
 +**Trouble Shooting**
 +If the mSupply client fails to work, try the following : 
 +  - Double click on the mSupply Client.app and immediately click on the option (MAC) or alt (Win) key
 +  - The mSupply Client may present a window with available mSupply server. As above, select the server and click ok.
 +  - If the mSupply Client is not able to list the mSupply server due to firewall issue then : 
 +    - Click on the `Custom` tab
 +    - Type `mSupply` for Project Name
 +    - Type the **server's IP address** in the Network Address field. The image shows the port number 19813, but this is not normally not necessary.
 +    - Click `OK`  and you should be able to connect to the server if it is available. 
 + 
 +{{ :admin:msupply_client_custom_tab_2026-07-07.png?400 |}}
 ===== Code Signing (may be required) ===== ===== Code Signing (may be required) =====
  
 macOS Gatekeeper may block an unsigned mSupply Client.app from opening. If this happens: macOS Gatekeeper may block an unsigned mSupply Client.app from opening. If this happens:
  
-  * The app can be **locally code-signed on a Mac** before distributing it to the end user (this has been done successfully by support staff prior to sending the app to a client). +  * Go to system setting > Security & Privacy and allow the mSupply Client app to operate if it has been blocked.  
-  * //Note: exact code-signing command/procedure is not yet documented — add the specific steps here once standardized (e.g. ''codesign --force --deep --sign - /path/to/mSupply\ Client.app'').// +  * The app can be **locally code-signed on a Mac** before distributing it to the end user (this has been done successfully by support staff prior to sending the app to a client). However it is possible for users to do it on their MAC via the terminal by running the code : ''codesign --force --deep --sign - /path/to/mSupply\ Client.app''
- +
-===== Version Notes ===== +
- +
-  * For sites needing an update alongside a Mac setup, running the relevant version upgrader (e.g. V9.01.03) on the server may be sufficient — check the current recommended version before advising a client. +
- +
-===== Troubleshooting Checklist ===== +
- +
-  - Is the Mac on the same network as the server? If not, that's the most common blocker. +
-  - Try connecting using the server's **IP address** directly instead of a hostname in the custom setting. +
-  - Does macOS refuse to open the app (Gatekeeper warning)? → Locally code-sign the Client.app. +
-  - Confirm the server itself is reachable (ping / port check) before assuming it's a client-side issue. +
- +
-===== Known Limitations / Open Work ===== +
- +
-  * There's an open GitHub issue to build a server executable that is more Mac-client-friendly: [[https://github.com/msupply-foundation/msupply/issues/18363]]. Check this issue for current progress before troubleshooting from scratch. +
-  * This guide should be reviewed and expanded by the support team (see internal ticket #GT-9612-AP) — particularly the code-signing steps, which haven't been fully written up yet.+
  
-===== References ===== 
  
-  * Support ticket: #GT-9612-AP — Setup for Mac in Kiribati 
-  * GitHub issue: https://github.com/msupply-foundation/msupply/issues/18363 
-  * Client: Peter Laing, Beyond Essential Systems (Kiribati) 
  
----- 
-//Last updated: drafted from ticket #GT-9612-AP. Please edit/expand with exact code-signing commands and any additional edge cases encountered.// 
  
  
  • Last modified: 2026/07/03 06:23
  • by Ujwal Khatry