Differences

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

--- preferences:general [2026/01/05 13:15] – [Alternate server tab] Gary Willetts
+++ preferences:general [2026/01/05 13:32] (current) – [Alternate server tab] Gary Willetts
@@ Line 705: / Line 705: @@
 {{ :cold_chain_equipment:pref_alernate_server.png?600 |}}
-^ Server parameter ^ Description ^
+  * **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.
-|Log level | 0: No logging, 1: Log only 500 responses, 2: Log all responses, 3: Log all responses and requests.|
+  * **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).
-These server parameters must be set up before turning on the alternate server (contact mSupply Support if you need help setting this up!) Once the server is turned on, the parameters cannot be edited.
 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 of the ports to 0 will turn off the alternate server for that protocol.
+Please note that setting either the HTTP or HTTPS port to 0 will turn off the alternate server for that protocol.
 ===== Assets tab =====