Doc improvements for websockets_header_size.

man/mosquitto.conf.5.xml

@@ -987,11 +987,12 @@
 					<listitem>
                         <para>Change the websockets headers size. This is a
 							global option, it is not possible to set per
-							listener. This is the value passed to libwebsockets
-							max_http_header_data which is used for the buffer size
-							to process HTTP headers. See the libwebsockets documention
-							for more details. A value of 0 (the default) means to
-							use libwebsockets' default (which is 1024).</para>
+							listener. This option sets the size of the buffer
+							used in the libwebsockets library when reading HTTP
+							headers. If you are passing large header data such
+							as cookies then you may need to increase this
+							value. If left unset, or set to 0, then the default
+							of 1024 bytes will be used.</para>
 					</listitem>
 				</varlistentry>
 			</variablelist>

mosquitto.conf

@@ -595,14 +595,13 @@
 # libwebsockets documentation for more details. "log_type websockets" must also
 # be enabled.
 #websockets_log_level 0
-#
+
 # Change the websockets headers size. This is a global option, it is not
-# possible to set per listener. This is the value passed to libwebsockets
-# max_http_header_data which is used for the buffer size to process HTTP
-# headers. See the libwebsockets documentation for more details.
-# A value of 0 (the default) means to use libwebsockets' default (which is
-# 1024).
-#websockets_headers_size 0
+# possible to set per listener. This option sets the size of the buffer used in
+# the libwebsockets library when reading HTTP headers. If you are passing large
+# header data such as cookies then you may need to increase this value. If left
+# unset, or set to 0, then the default of 1024 bytes will be used.
+#websockets_headers_size
 
 # If set to true, client connection and disconnection messages will be included
 # in the log.

src/conf.c

@@ -2101,11 +2101,11 @@ int config__read_file_core(struct mosquitto__config *config, bool reload, struct
 #endif
 				}else if(!strcmp(token, "websockets_headers_size")){
 #ifdef WITH_WEBSOCKETS
-#if defined(LWS_LIBRARY_VERSION_NUMBER) && LWS_LIBRARY_VERSION_NUMBER>=1007000
+#  if defined(LWS_LIBRARY_VERSION_NUMBER) && LWS_LIBRARY_VERSION_NUMBER>=1007000
 					if(conf__parse_int(&token, "websockets_headers_size", &config->websockets_headers_size, saveptr)) return MOSQ_ERR_INVAL;
-#else
+#  else
 					log__printf(NULL, MOSQ_LOG_WARNING, "Warning: Websockets headers size require libwebsocket 1.7+");
-#endif
+#  endif
 #else
 					log__printf(NULL, MOSQ_LOG_WARNING, "Warning: Websockets support not available.");
 #endif