Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: small readability and consistency details #104

Merged
merged 4 commits into from
Mar 30, 2024
Merged

refactor: small readability and consistency details #104

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc7b52e
refactor: adjust variable name for readability
consideRatio Mar 29, 2024
a27fde4
refactor: use long flag names
consideRatio Mar 29, 2024
4219727
refactor: let turbovnc listen to localhost
consideRatio Mar 29, 2024
7797912
refactor: co-locate code for tiger's unix socket initialization
consideRatio Mar 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions jupyter_remote_desktop_proxy/setup_websockify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,12 @@


def setup_websockify():
# make a secure temporary directory for sockets
# This is only readable, writeable & searchable by our uid
sockets_dir = tempfile.mkdtemp()
sockets_path = os.path.join(sockets_dir, 'vnc-socket')
vncserver = which('vncserver')

if not vncserver:
raise RuntimeError(
"vncserver executable not found, please install a VNC server"
)

# TigerVNC provides the option to connect a Unix socket. TurboVNC does not.
# TurboVNC and TigerVNC share the same origin and both use a Perl script
# as the executable vncserver. We can determine if vncserver is TigerVNC
# by searching tigervnc string in the Perl script.
Expand All @@ -34,11 +28,17 @@ def setup_websockify():
is_tigervnc = "tigervnc" in vncserver_file.read().casefold()

if is_tigervnc:
# Make a secure temporary directory for sockets that is only readable,
# writeable, and searchable by our uid - TigerVNC can listen to a Unix
# socket!
sockets_dir = tempfile.mkdtemp()
sockets_path = os.path.join(sockets_dir, 'vnc-socket')

websockify_args = ['--unix-target', sockets_path]
vnc_args = [vncserver, '-rfbunixpath', sockets_path]
socket_args = ['--unix-target', sockets_path]
else:
vnc_args = [vncserver, '-rfbport', '{port}']
socket_args = []
websockify_args = []
vnc_args = [vncserver, '-localhost', '-rfbport', '{port}']
Comment on lines -40 to +41
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About passing -localhost to turbovnc

This won't change anything, its just about making both VNC servers startup as localhost and not just TigerVNC for consistency.

TigerVNC listens to localhost by default, and TurboVNC doesn't. Let's make them do the same.

When websockify starts either TigerVNC or TurboVNC, it will listen only to localhost anyhow - so this doesn't change anything really but could reduce the complexity a bit when debugging these things, as I've done at length now.


if not os.path.exists(os.path.expanduser('~/.vnc/xstartup')):
vnc_args.extend(['-xstartup', os.path.join(HERE, 'share/xstartup')])
Expand All @@ -47,23 +47,22 @@ def setup_websockify():
vnc_args
+ [
'-verbose',
'-fg',
'-geometry',
'1680x1050',
'-SecurityTypes',
'None',
'-fg',
]
)

return {
'command': [
'websockify',
'-v',
'--heartbeat',
'30',
'--verbose',
'--heartbeat=30',
'{port}',
]
+ socket_args
+ websockify_args
+ ['--', '/bin/sh', '-c', f'cd {os.getcwd()} && {vnc_command}'],
'timeout': 30,
'new_browser_window': True,
Expand Down