Add configurable websocket heartbeat #826
Conversation
Without the --heartbeat option the VNC session will timeout after 1 minute of idle time. This adds --heartbeat with a default of 30 seconds, configurable with websockify_hb in the context or the environment variable WEBSOCKIFY_HB
|
First off, yes please and thank you! I was going to patch this for the next release, so thank you for beating me to it! |
| @@ -130,7 +130,8 @@ def run_script | |||
| # successful connections so that the password can be reset | |||
| def after_script | |||
| websockify_cmd = context.fetch(:websockify_cmd, "${WEBSOCKIFY_CMD:-/opt/websockify/run}").to_s | |||
|
|
|||
| websockify_hb = context.fetch(:websockify_hb, "${WEBSOCKIFY_HB:-30}").to_s | |||
There was a problem hiding this comment.
I'm wondering if this should be expanded to websockify_heartbeat_seconds just to be a little more specific? The internal variable doesn't matter as much to me, but the user facing configuration I think may need to be a little more explicit?
There was a problem hiding this comment.
Fine by me. I did consider this, but left it similar to the previous line where command has been abbreviated to 'cmd'
There was a problem hiding this comment.
I was considering the same lol. cmd was before my time, but to an admin configuring it - it may be more recognizable then hb.
There was a problem hiding this comment.
I'm going to go ahead and merge this now and change it later. Thanks again for the contribution!
Without the --heartbeat option the VNC session will timeout after 1 minute of idle time. This adds --heartbeat with a default of 30 seconds, configurable with websockify_hb in the context or the environment variable WEBSOCKIFY_HB.
This implements the VNC timeout workaround mentioned in
VNC timeout
The VNC app in OSC/ondemand will need to be updated to recognise the websockify_hb context variable.