2022-02-01 13:26:39 +00:00
# WebVM
2022-01-31 20:52:13 +00:00
2023-05-17 11:42:07 +00:00
This repository hosts the source code for [https://webvm.io ](https://webvm.io ), a Linux virtual machine that runs in your browser.
2022-01-31 20:52:13 +00:00
2023-05-17 15:28:16 +00:00
< img src = "assets/welcome_to_WebVM_slim.png" width = "95%" >
2022-10-06 12:07:47 +00:00
2022-10-06 12:01:00 +00:00
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.
2022-02-01 13:26:39 +00:00
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.
2022-10-06 12:01:00 +00:00
# How to: enable networking
2023-05-17 11:42:46 +00:00
- Go to [https://webvm.io ](https://webvm.io ).
- Click "Tailscale Login" in the top right corner.
- Log in to Tailscale (create an account if you don't have one).
- If you are unfamiliar with Tailscale or would like additional information see [WebVM and Tailscale ](/docs/Tailscale.md ).
2022-10-06 09:42:24 +00:00
2023-05-17 11:42:07 +00:00
# How to: fork and deploy
- Fork the repository.
- Enable Github pages in settings.
- Click on `Settings` .
- Go to the `Pages` section.
- Select `Github Actions` as the source.
- Run the workflow.
- Go to the forked repository its Github actions tab.
- Accept the prompt.
- Click on the workflow named `Deploy` .
- Click `Run workflow` and then once more `Run workflow` .
2022-12-14 15:42:08 +00:00
2023-05-17 11:42:07 +00:00
< img src = "/assets/fork_deploy_instructions.gif" alt = "deploy_instructions_gif" width = "90%" >
2022-12-14 15:42:08 +00:00
2023-05-17 15:19:28 +00:00
After the action completes, which takes a few minutes, it will show the URL to the GitHub Pages site below the `deploy_to_github_pages` job.
2022-12-14 15:42:08 +00:00
2023-05-17 11:42:07 +00:00
< img src = "/assets/result.png" width = "70%" >
2022-12-14 15:42:08 +00:00
2022-02-01 13:26:39 +00:00
# Bugs and Issues
2022-10-09 09:21:21 +00:00
Please use [Issues ](https://github.com/leaningtech/webvm/issues ) to report any bug.
2022-10-06 12:27:22 +00:00
Or come to say hello / share your feedback on [Discord ](https://discord.leaningtech.com ).
2022-02-01 13:26:39 +00:00
2022-10-06 12:01:00 +00:00
# Browsers support
2022-01-31 20:52:13 +00:00
2022-10-06 12:01:00 +00:00
WebVM and CheerpX are compatible with any browser, both Desktop and Mobile, provided support for [SAB ](https://caniuse.com/sharedarraybuffer ), [IndexedDB ](https://caniuse.com/indexeddb ), and the device having enough memory.
2022-01-31 20:52:13 +00:00
2022-10-06 12:27:22 +00:00
# More links
- [Do: WebVM ](https://webvm.io )
- [Read: WebVM ](https://leaningtech.com/webvm-server-less-x86-virtual-machines-in-the-browser/ )
- [Read: WebVM + Tailscale networking ](https://leaningtech.com/webvm-virtual-machine-with-networking-via-tailscale/ )
- [Learn: WebVM ](https://leaningtech.com/webvm )
- [Watch: WebVM at GitNation ](https://www.youtube.com/watch?v=VqrbVycTXmw )
2022-10-06 12:01:00 +00:00
# Thanks to...
This project depends on:
- CheerpX, made by [Leaning Technologies ](https://leaningtech.com ) for the virtualization part
- xterm.js, [https://xtermjs.org/ ](https://xtermjs.org/ ), for providing the Web-based terminal emulator
- [Tailscale ](https://tailscale.com/ ) for the networking component
- [lwIP ](https://savannah.nongnu.org/projects/lwip/ ) for the TCP/IP stack, compiled to the Web by [Cheerp ](https://github.com/leaningtech/cheerp-meta )
2022-02-01 13:26:39 +00:00
# License
Copyright (c) Leaning Technologies Limited. All rights reserved.
