beenull/webvm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Virtual Machine for the Web
92 commits 14 branches 1 tag 25 MiB
Svelte 50.5%
JavaScript 30.1%
CSS 14%
HTML 5.4%
Find a file
zinobias d871a7867b seviceworker.js: Added try / catch around reload call in doRegister to log in case of error
2023-04-18 13:53:29 +02:00
assets README: Add image 2022-10-06 14:07:47 +02:00
examples Initial commit 2022-01-31 22:00:49 +01:00
tun Use new network classes from tailscale_tun 2023-01-30 12:01:30 +01:00
xterm Remove xterm's SourceMap warnings 2022-10-05 09:31:39 +02:00
favicon.ico New favicon: red tower on black background 2022-10-06 11:48:43 +02:00
index.html Serviceworker with primary goal to add COI when unsupported. 2023-04-12 12:31:40 +02:00
login.html Revert "Experimental function calling across tabs" 2022-10-06 11:48:43 +02:00
network.js Use new network classes from tailscale_tun 2023-01-30 12:01:30 +01:00
nginx.conf Initial commit 2022-01-31 22:00:49 +01:00
README.md Add information about self-hosting to README 2023-02-01 12:50:53 +01:00
scrollbar.css Scrollbar 2022-10-05 09:31:39 +02:00
serviceWorker.js seviceworker.js: Added try / catch around reload call in doRegister to log in case of error 2023-04-18 13:53:29 +02:00
tinycore.html Serviceworker with primary goal to add COI when unsupported. 2023-04-12 12:31:40 +02:00
tower.ico Move favicon to red tower on black background 2022-10-05 09:31:39 +02:00

README.md

WebVM

This repository hosts the source code of for https://webvm.io, a Linux virtual machine that runs in your browser.

WebVM is a server-less virtual environment running fully client-side in HTML5/WebAssembly. It's designed to be Linux ABI-compatible. It runs an unmodified Debian distribution including many native development toolchains.

WebVM is powered by the CheerpX virtualization engine, and enables safe, sandboxed client-side execution of x86 binaries on any browser. CheerpX includes an x86-to-WebAssembly JIT compiler, a virtual block-based file system, and a Linux syscall emulator.

How to: general usage

How to: enable networking

  • go to https://webvm.io
  • click "Tailscale Login" in the top right corner
  • log in to Tailscale (create an accout if you don't have one)
  • if you want to access the public internet, you need an Exit Node. See here for how to set one up. If you just want to access a machine in your Tailscale Network, you don't need it
  • depending on your network speed, you may need to wait a few moments for the Tailscale Wasm module to be downloaded
  • log in with your Tailscale credentials
  • go back to the WebVM tab. You will see your IP address in the top right
  • start firing network requests!

How to: login to Tailscale with an Auth key

  • Add #authKey=<your-key> at the end of the URL
  • Done. You don't need to manually log in anymore

It is recommended to use an ephemeral key.

How to: login to a self-hosted Tailscale network (Headscale)

  • Add #controlUrl=<your-control-url> at the end of the URL
  • You can combine this option with authKey with a &: #controlUrl=<url>&authKey=<key>

How to host WebVM locally

  • Replace CX_VERSION in index.html and tinycore.html with a valid version of CheerpX. The latest version can be found at https://webvm.io
  • Run nginx -p . -c nginx.conf in the root of the WebVM directory. WebVM can then be found at http://localhost:8081

Bugs and Issues

Please use Issues to report any bug. Or come to say hello / share your feedback on Discord.

Browsers support

WebVM and CheerpX are compatible with any browser, both Desktop and Mobile, provided support for SAB, IndexedDB, and the device having enough memory.

More links

Thanks to...

This project depends on:

License

Copyright (c) Leaning Technologies Limited. All rights reserved.