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

Jump to bottom

Add usage example to README.md #118

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add usage example to README.md #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,14 @@ 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.

### Connect to running Wayland session
Let's say you want to control the host at `192.168.178.28` which is already up and running Wayland:

* `ssh [email protected]`
* Start wayvnc on the remote host from inside the SSH session: `WAYLAND_DISPLAY=wayland-1 wayvnc 192.168.178.28`
* Now, connect from your local device (outside of SSH): `vncviewer 192.168.178.28:5900`


### Encryption & Authentication
You'll need a private X509 key and a certificate. A self-signed key with a
certificate can be generated like so:
Expand Down