Sunny-Moom/webvm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adjusted README.md to reflect the recent changes to WebVM

Browse Source
This commit is contained in:
zinobias 2023-05-17 13:42:07 +02:00 committed by Alessandro Pignotti
parent 9910ed2928
commit fb184d75fd
1 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,6 +1,6 @@
# WebVM # WebVM
This repository hosts the source code of for [https://webvm.io](https://webvm.io), a Linux virtual machine that runs in your browser. This repository hosts the source code for [https://webvm.io](https://webvm.io), a Linux virtual machine that runs in your browser.
<img src="assets/welcome_to_WebVM_slim.png" width="70%"> <img src="assets/welcome_to_WebVM_slim.png" width="70%">
@ -8,12 +8,6 @@ WebVM is a server-less virtual environment running fully client-side in HTML5/We
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. 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
- go to [https://webvm.io](https://webvm.io)
- use the provided terminal environment
- have fun!
# How to: enable networking # How to: enable networking
- go to [https://webvm.io](https://webvm.io) - go to [https://webvm.io](https://webvm.io)
@ -25,22 +19,30 @@ WebVM is powered by the CheerpX virtualization engine, and enables safe, sandbox
- go back to the WebVM tab. You will see your IP address in the top right - go back to the WebVM tab. You will see your IP address in the top right
- start firing network requests! - start firing network requests!
# How to: login to Tailscale with an Auth key # 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`.
- Add `#authKey=<your-key>` at the end of the URL <img src="/assets/fork_deploy_instructions.gif" alt="deploy_instructions_gif" width="90%">
- Done. You don't need to manually log in anymore
It is recommended to use an ephemeral key. After the action completes, it will show the URL to the GitHub Pages site below the `deploy_to_github_pages` job.
# How to: login to a self-hosted Tailscale network (Headscale) <img src="/assets/result.png" width="70%" >
- 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 # 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](https://webvm.io) - Replace `UID` and `GID` with the requested uid and gid in double quotes.
- Run nginx -p . -c nginx.conf in the root of the WebVM directory. WebVM can then be found at `http://localhost:8081` - Replace `DEVICE_TYPE` with `"bytes"`.
- 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 # Bugs and Issues