Skip to content

Stream a remote desktop screen directly to your browser

License

Notifications You must be signed in to change notification settings

metaphor-cloud/webrtc-remote-screen

This branch is 3 commits ahead of, 2 commits behind rviscarra/webrtc-remote-screen:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
Rupert Bryant-Greene
Sep 19, 2021
1889a31 · Sep 19, 2021

History

19 Commits
Aug 29, 2019
Aug 28, 2019
Aug 29, 2019
Aug 9, 2019
Aug 28, 2019
Aug 9, 2019
Aug 29, 2019
Aug 28, 2019
Sep 19, 2021
Sep 19, 2021

Repository files navigation

WebRTC remote view

Dependencies

  • Go 1.12
  • If you want h264 support: libx264 (included in x264-go, you'll need a C compiler / assembler to build it)
  • If you want VP8 support: libvpx

Architecture

Architecture

More info in this blog post.

Running the server

The server receives the following flags through the command line:

--http.port (Optional)

Specifies the port where the HTTP server should listen, by default the port 9000 is used.

--stun.server (Optional)

Allows to speficy a different STUN server, by default a Google STUN server is used.

Chrome 74+, Firefox 66+, Safari 12.x are supported. Older versions (within reason) should be supported as well but YMMV.

Building the server

Build the deployment package by runnning make. This should create a tar file with the binary and web directory, by default only support for h264 is included, if you want to use VP8 run make encoders=vp8, if you want both then make encoders=vp8,h264.

Copy the archive to a remote server, decompress it and run ./agent. The agent application assumes the web dir. is in the same directory.

WebRTC requires a secure domain to work, the recommended approach towards this is to forward the agent port thru SSH tunneling:

ssh -L YOUR_LOCAL_PORT:localhost:9000 

Then access the application on http://localhost:YOUR_LOCAL_PORT, localhost should be considered secure by modern browsers.

Screenshot

Demo screenshot

Feature requests

I'll see what I can do! Create an issue.

License

MIT - see LICENSE for the full text.

About

Stream a remote desktop screen directly to your browser

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 76.0%
  • JavaScript 12.8%
  • CSS 6.4%
  • HTML 3.2%
  • Makefile 1.6%