Skip to content

Commit

Permalink
add docs on websockify_heartbeat_seconds (#966)
Browse files Browse the repository at this point in the history
  • Loading branch information
johrstrom authored May 7, 2024
1 parent e633904 commit d6ad16c
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions source/reference/files/submit-yml/vnc-bc-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down Expand Up @@ -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
.. 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

0 comments on commit d6ad16c

Please sign in to comment.