https://github.com/rviscarra/webrtc-remote-screen

Stream a remote desktop screen directly to your browser
https://github.com/rviscarra/webrtc-remote-screen

Last synced: 4 days ago
JSON representation

Stream a remote desktop screen directly to your browser

• Host: GitHub
• URL: https://github.com/rviscarra/webrtc-remote-screen
• Owner: rviscarra
• License: mit
• Created: 2019-08-05T17:08:02.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-16T20:05:15.000Z (7 months ago)
• Last Synced: 2024-08-01T13:29:38.193Z (3 months ago)
• Language: Go
• Homepage:
• Size: 601 KB
• Stars: 459
• Watchers: 16
• Forks: 72
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-pion - rviscarra/webrtc-remote-screen - Stream a remote desktop screen directly to your browser (Media API)
• awesome-repositories - rviscarra/webrtc-remote-screen - Stream a remote desktop screen directly to your browser (Go)

README

        
## WebRTC remote view

### Dependencies

- [Go 1.12](https://golang.org/doc/install)

- 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](docs/architecture.png)

More info in [this blog post](https://viscarra.dev/post/webrtc-remote-screen/). 

### 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](https://wikipedia.org/wiki/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:

```bash

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](docs/screenshot.png)

### Feature requests

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

### License

MIT - see [LICENSE](LICENSE) for the full text.