From fb184d75fdd38873a270e02e1a1fafffba3b69dc Mon Sep 17 00:00:00 2001 From: zinobias Date: Wed, 17 May 2023 13:42:07 +0200 Subject: [PATCH] Adjusted README.md to reflect the recent changes to WebVM --- README.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 2f51b99..f91a203 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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. @@ -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. -# How to: general usage - -- go to [https://webvm.io](https://webvm.io) -- use the provided terminal environment -- have fun! - # How to: enable networking - 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 - 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=` at the end of the URL -- Done. You don't need to manually log in anymore +deploy_instructions_gif -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) + -- Add `#controlUrl=` at the end of the URL -- You can combine this option with `authKey` with a `&`: `#controlUrl=&authKey=` -# 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) -- Run nginx -p . -c nginx.conf in the root of the WebVM directory. WebVM can then be found at `http://localhost:8081` +- Replace `UID` and `GID` with the requested uid and gid in double quotes. +- 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