From d6ad16cceb35538d34bf2d0fefa4c9e8d091fcbc Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Tue, 7 May 2024 12:23:38 -0400 Subject: [PATCH] add docs on websockify_heartbeat_seconds (#966) --- .../files/submit-yml/vnc-bc-options.rst | 26 +++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/source/reference/files/submit-yml/vnc-bc-options.rst b/source/reference/files/submit-yml/vnc-bc-options.rst index 026ec663..b1ded250 100644 --- a/source/reference/files/submit-yml/vnc-bc-options.rst +++ b/source/reference/files/submit-yml/vnc-bc-options.rst @@ -27,6 +27,7 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be idle: "" extra_args: "" vnc_clean: "..." + websockify_heartbeat_seconds: 30 .. describe:: websockfiy_cmd (String, "/opt/websockify/run") @@ -222,5 +223,26 @@ All the options in :ref:`basic-bc-options` apply in addition to what's listed be something that can only be determined during the job (for example an environment variable in a module). - conn_params: - - the_connect_api \ No newline at end of file + .. code-block:: yaml + + conn_params: + - the_connect_api + +.. describe:: websockify_heartbeat_seconds (Integer, 30) + + The duration in seconds websockify will wait to send heartbeats + to the client. + + Default + Websockify will send heartbeats every 30 seconds. + + .. code-block:: yaml + + websockify_heartbeat_seconds: 30 + + Example + Have websockfiy send heartbeats every 10 seconds. + + .. code-block:: yaml + + websockify_heartbeat_seconds: 10