NOTE this is not a well-maintained or serious project and I am not working on this full time. I give no guarantees that the code in this repository works. For a better looking and more complete project I would recommend checking out neko
A (WIP) self-hosted virtual browser inspired by rabb.it
Forked from bunny by SimplyLin.
Features
- Control a virtual stateless firefox browser served via docker container...✔
- Create user accounts and rooms...IN PROGRESS
- Voice and video chat over p2p, text chat over not p2p...TODO
To run locally simply run docker-compose up in the root of the repository. This will build all of the required images and start the server on port 5000 (by default).
For more information see the wiki page on running locally
The steps for running on a cloud host such as AWS, Google Cloud, or Azure are more involved. In the future I'm planning on creating some basic terraform modules.
Environment variables can be supplied via a .env file.
See example.env located at the root of the project for descriptions of the
Tags pushed to this repository autobuild three images on DockerHub tagged as such:
turtus:server- The node web server backendturtus:client- The react based web clientturtus:browser- The virtual browser
Thesee images can be run together for a smooth integration, or you can choose to use some or not the other. eg if you want to supply your own front-end and/or integrate the virtual browser into your existing application, you might only require the turtus:browser image. For easily managing interactions I would recommend using the companion turtus-lib node package.
First I would recommend following the instructions for getting the project to run locally.
Once that's done start the development servers for both the server and web client. You can do that by opening two separate terminal windows.
First, inside services/server:
yarn devThen, inside services/web:
yarn devThe Virtual Browser is a docker container based on a dockernode image that manages a bunch of processes with the help of a not too complicated node script (bc js is cool).
Those important processes are as follows:
- dbus
- Controls inter process communication.
- This is a dependancy of some of the following processes.
- Xvfb
- Virtual Frame Buffer that implements X11 protocol.
- Basically alows us to run graphical applications without an actual display attached
- xdotool
- What allows
- pulseaudio
- A general purpose sound server.
- Used to capture sound output from the container.
- ffmpeg
- Records video and sound from
- firefox-esr
- The web browser itself.
- Launched fullscreen and installed with ublock-origin (as soon as I figure out how)
The VirtualBrowser is intended to be launched dynamically from a script (i.e. the backend).
The container can be launched using a few arguments.
-s, --signal-server <url>- The url to the signal server. See server sections for more details.
-t, --timeout <ms>- Not yet implemented
- The amount of time in ms the browser will wait after the last peer has disconnected before automatically shutting down.
- Defaults to
60000(1 minute)
After launching the Virtual Browser and establishing the source for the media stream, a wrtc connection is made through the signalling server specifiec using the -s option.
Whenever a peer connects they receive a copy of the stream via p2p and webrtc.
The Virtual Browser can be shut down either by the client asking it nicely (i.e. sending a shutdown message) or by timing out due to a lack of peers as described above or by the signaling server itself shutting down.
The backend performs webrtc handshake negotiation and serves an api that is used to manage users and rooms. Unlike a traditional application the backend does not serve the web client. Why? Because I read an article on microservices once.
The backend is served over https only because Chrome requires a secure connection for webrtc. This means when developing locally you are required to have a certificate. You can use the one provided in the repository and simply accept the SSL error.
For mac/linux there is a script /gen_cert.sh that you can run that will generate the cert and key, localhost.cert and localhost.key respectively. Double click on the .cert file to add it to your keychain / trusted ca.
Note: On mac you might have to go a bit futher by right clicking the certificate you just added to the keychain, click "get info", expand the "Trust" dropdown, then set "When using this certificate" to "Always Trust".
Start server with:
yarn devTest the server is online with curl:
curl -k https://localhost/
# Returns the time the server received the requestFor now there is only one client application: a responsive web application that connects to the virtual browser over p2p.
The app is built using React.
They can convey meaning quickly without having to read. Here's a quick dictionary:
- 🙂Success
- 🤔Info / Warning
- 👎Non-Fatal Error
- ☠️Fatal Error
p2p connections are negotiated over the signal server and work as follows:
- A client connects to the signal server via websocket url
- The signal server sends the client an
identitypacket
- This packet will be attached to every outgoing message.
- One or more clients subsequently connect to the websocket url
- The server negotiates the handshake between existing clients and the new client
- All old clients ask the new client to identify their client type
- If the client type is
vbthen a client must specifically ask for the stream by providing arequest.streampacket. - Otherwise the client is automatically sent the stream.
Break monolith app into microservices
Deploy Node.js application to AWS
Making and trusting your own certificates