A VNC server for wlroots based Wayland compositors

Go to file

Jan Beich 6916780389 buffer: guard gbm.h after `3742dc7144` ../src/buffer.c:25:10: fatal error: 'gbm.h' file not found #include <gbm.h> ^~~~~~~		2020-07-27 19:51:59 +00:00
include	Add build option for enabling screencopy-dmabuf	2020-07-26 15:12:14 +00:00
protocols	protocols: Use screencopy v3	2020-07-11 20:52:01 +00:00
src	buffer: guard gbm.h after `3742dc7144`	2020-07-27 19:51:59 +00:00
util	util: latency_report: Update probes	2020-07-11 20:53:31 +00:00
.gitignore	.gitignore: Add .pem files	2020-07-11 20:53:31 +00:00
COPYING	COPYING: It's 2020 now	2020-01-14 19:03:38 +00:00
FAQ.md	FAQ: Fix typo	2020-03-28 16:59:31 +00:00
README.md	README: Update dependencies	2020-07-11 20:53:31 +00:00
meson.build	meson: Update project version	2020-07-27 19:10:19 +00:00
meson_options.txt	Add build option for enabling screencopy-dmabuf	2020-07-26 15:12:14 +00:00

README.md

wayvnc

Introduction

This is a VNC server for wlroots based Wayland compositors. It attaches to a running Wayland session, creates virtual input devices and exposes a single display via the RFB protocol. The Wayland session may be a headless one, so it is also possible to run wayvnc without a physical display attached.

Please check the FAQ for answers to common questions. For further support, join the #wayvnc IRC channel on freenode.

Installing

archlinux

git clone https://aur.archlinux.org/neatvnc.git
cd neatvnc
makepkg -si
cd -

git clone https://aur.archlinux.org/wayvnc.git
cd wayvnc
makepkg -si
cd -

FreeBSD

pkg install wayvnc

Fedora

dnf install wayvnc

Building

Runtime Dependencies

aml
drm
gbm
libxkbcommon
neatvnc
pixman

Build Dependencies

GCC
meson
ninja
pkg-config

For archlinux

pacman -S base-devel libglvnd libxkbcommon pixman gnutls

For fedora 31

dnf install -y meson gcc ninja-build pkg-config egl-wayland egl-wayland-devel \
	mesa-libEGL-devel mesa-libEGL libwayland-egl libglvnd-devel \
	libglvnd-core-devel libglvnd mesa-libGLES-devel mesa-libGLES \
	libxkbcommon-devel libxkbcommon libwayland-client libwayland \
	wayland-devel gnutls-devel

The easiest way to satisfy the neatvnc and aml dependencies is to link to them in the subprojects directory:

git clone https://github.com/any1/wayvnc.git
git clone https://github.com/any1/neatvnc.git
git clone https://github.com/any1/aml.git

mkdir wayvnc/subprojects
cd wayvnc/subprojects
ln -s ../../neatvnc .
ln -s ../../aml .
cd -

mkdir neatvnc/subprojects
cd neatvnc/subprojects
ln -s ../../aml .
cd -

meson build
ninja -C build

Running

Wayvnc can be run from the build directory like so:

./build/wayvnc

☢️ The server only accepts connections from localhost by default. To accept connections via any interface, set the address to 0.0.0.0 like this:

./build/wayvnc 0.0.0.0

⚠️ Do not do this on a public network or the internet without user authentication enabled. The best way to protect your VNC connection is to use SSH tunneling while listening on localhost, but users can also be authenticated when connecting to Wayvnc.

Encryption & Authentication

You'll need a private X509 key and a certificate. A self signed key with a certificate can be generated like so:

openssl req -x509 -newkey rsa:4096 -sha256 -days 3650 -nodes \
	-keyout key.pem -out cert.pem -subj /CN=localhost \
	-addext subjectAltName=DNS:localhost,DNS:localhost,IP:127.0.0.1

Replace localhost and 127.0.0.1 in the command above with your public facing host name and IP address, respectively, or just keep them as is if you're testing locally.

Create a config with the authentication info and load it using the --config command line option or place it at the default location $HOME/.config/wayvnc/config.

address=0.0.0.0
enable_auth=true
username=luser
password=p455w0rd
private_key_file=/path/to/key.pem
certificate_file=/path/to/cert.pem

Compatible Software

See https://github.com/any1/neatvnc#client-compatibility