Differences

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

--- preferences:general [2025/08/12 15:14] – [E-mail tab] Gary Willetts
+++ preferences:general [2026/01/14 17:18] (current) – [Misc tab] Gary Willetts
@@ Line 121: / Line 121: @@
 **Allow users to attach documents after transactions have been finalised**
-When this box is checked, mSupply will allow to upload documents on finalised customer invoices, Supplier invoices, Purchase Order and Good receipt.
+When this box is checked, users can upload documents to finalised customer invoices, supplier invoices, purchase orders and goods receipts.
+**Allow to sync documents**
+If this is checked then documents attached to transactions on remote sites in a sync. system will be synchronised to the central server and will be available there. This is oinly advisable is a remote site has good internet because synchronising a large document will block the rest of the sync. queue until it has finished. If this is not checked then documents attached to transactions will not synchronise with the central server and will only be available at the remote site they were uploaded at.
 **Currency formats** This option specifies the format in which currencies will be displayed in mSupply. We provide two preset formats for currencies with 2 decimal places and currencies with none. If you want to enter a custom format you can change the field below the drop-down list. For example you may want to use a different separator than a comma. Note that if you type illogical values into the field the numbers may not display at all, or display erroneous data. Contact Sustianable Solutions if you need more information.
@@ Line 197: / Line 200: @@
 By default all customers are assigned a price category of "A"
-To assign a different category to a customer, choose Customers > Show customers... and find the customer entry. Then set the price category field to a different value
+To assign a different category to a customer, choose Customers > Show customers... and find the customer entry. Then set the price category field to a different value (see the [[https://docs.msupply.org.nz/names:adding_and_editing#price_category|5.01. Names: using, adding and editing]] page for details on where this field is).
 Here in the Preferences, you specify what percentage change to the default price will be made for each category.
@@ Line 699: / Line 702: @@
 ===== Alternate server tab =====
-The alternate server is used for sending cold chain notifications. For more detail please see the [[cold_chain_equipment:configure_coldchain_app_on_desktop#setting_up|Setting up Cold Chain App Notifications]] page.
+The alternate server is used for a few functionalities in mSupply e.g. sending cold chain notifications ([[cold_chain_equipment:configure_coldchain_app_on_desktop]] and barcode scanning ([[barcode_scanning:handheld_computer]]).
+To turn on the alternate server, choose //File > Preferences// from the menus and click on the //Alternate Server// tab:
+{{ :cold_chain_equipment:pref_alernate_server.png?600 |}}
+  * **Start alternate web server** button: Click to start the alternate webserver with the settings in the table. The button label Will change to //Stop alternate web server// and clicking it will stop the alternate web server. When the web server is running you cannot edit the settings in the table. To edit them, stop the web server first.
+  * **Reset preferences to default** button: Clicking this when the alternate web server is **not** running will reset the settings in the table to their defaults (shown in the screenshot above).
+If you would like this server to start up every time mSupply is started, check the **Start web server on this computer when mSupply starts** checkbox. This is a good idea if you're using cold chain notifications or barcode scanning so that, if the mSupply server is restarted for any reason, the alternate server automatically restarts with it and barcode scanning and cold chain notification functionality can continue without further interruption for users.
+The settings in the table:
+^ Server parameter ^ Description ^
+| HTTP port number | The port number the alternate web server will use for the HTTP protocol. |
+| HTTPS port number | The port number the alternate web server will use for the HTTPS protocol. |
+| Maximum size (in bytes) of incoming HTTP requests | Requests over this size (in bytes) will be ignored by the alternate web server. |
+| Parse header timeout (milliseconds) | The maximum time it can take to parse incoming request headers. Requests with headers that take longer than this to process will be rejected. |
+| Parse body timeout (milliseconds) | The maximum time it can take to parse incoming request bodies. Requests with bodies that take longer than this to process will be rejected. |
+| Worker threadpool count | The maximum number of staff you can have in a swimming pool at any one time. Just kidding! This is the maximum of threads the server will use to process an incoming request. |
+|Log level | 0: No logging, 1: Log only 500 responses, 2: Log all responses, 3: Log all responses and requests.|
+| REST API enabled | Check this if the alternate web server REST API is to be enabled. Functionalities like cold chain notifications and barcode scanning require this REST API so turn it on if you're using one of them. |
+The default //HTTP Port number// is 8081 and must be different from the port number used by the mSupply server set on the //Server// tab (see the [[preferences:general#server_tab|16.01. General preferences]] page for details). If you inadvertantly try to set both servers to the same port, mSupply will warn you and prevent you from saving your settings.
+Please note that setting either the HTTP or HTTPS port to 0 will turn off the alternate server for that protocol.
 ===== Assets tab =====