No Description

Yuri Iozzelli 9b692d984d ci: switch deploy to new server 3 months ago
.circleci 9b692d984d ci: switch deploy to new server 3 months ago
.github b300b4908c Update deploy.yml 5 months ago
assets ff11a42bd5 add Claude instructions 3 months ago
dockerfiles 8190cb971d Dockerfiles: debian_mini, set workdir and Env for following commits. 2 years ago
docs 0069c378a7 Review README to match updated UI, versioning and licensing 9 months ago
documents 52dcded70b Add example image 8 months ago
examples 1385babdfb Added luajit interp lines to the other 2 lua examples. 2 years ago
src b925dc00f0 Restore hackathon messaging 3 months ago
xterm aeb387a92d Bump xterm version 1 year ago
.gitignore fa6a7772da add a basic .gitignore 4 months ago
.npmrc d59c6c069b Basic npm setup for svelte 9 months ago
LICENSE.txt 567abd352e Add Apache 2.0 license 2 years ago
README.md ff11a42bd5 add Claude instructions 3 months ago
config_github_terminal.js a3fc89faeb Make sure GH config can be safely uncommented to get something that works 9 months ago
config_public_alpine.js f60b9478d0 Bump alpine image to support nano and openssh 4 months ago
config_public_terminal.js f7fc244db4 Svelte: Expose more extensive configuration from the main WebVM component 9 months ago
favicon.ico a925d0ae89 New favicon: red tower on black background 2 years ago
login.html 0d37154516 Revert "Experimental function calling across tabs" 2 years ago
nginx.conf 2bc8b7ea91 added mime types 7 months ago
package-lock.json 44a91638d2 Bump NPM deps 3 months ago
package.json b0f9249b0b Claude: Support downloading the conversation history as PNG 4 months ago
postcss.config.js c8cd5daab4 Implement side-bar pinning 4 months ago
scrollbar.css e71bbc97a5 Scrollbar 2 years ago
serviceWorker.js 783f271d4c serviceworker.js: Adjusted a comment in, to clarify the ifstatement in doRegister(). 2 years ago
svelte.config.js 98a0c2a47b Enable SSR 9 months ago
tailwind.config.js f3fbf4a29f Import tailwind to achieve full visual consistency with labs 9 months ago
tower.ico 9977f694c8 Move favicon to red tower on black background 2 years ago
vite.config.js ce162c9e8c Expose the documents directory in the user home 8 months ago

README.md

WebVM

Discord server Issues

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

Try out the new Alpine / Xorg / i3 graphical environment: https://webvm.io/alpine.html

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.

Enable networking

Modern browsers do not provide APIs to directly use TCP or UDP. WebVM provides networking support by integrating with Tailscale, a VPN network that supports WebSockets as a transport layer.

  • Open the "Networking" panel from the side-bar
  • Click "Connect to Tailscale" from the panel
  • Log in to Tailscale (create an account if you don't have one)
  • Click "Connect" when prompted by Tailscale
  • If you are unfamiliar with Tailscale or would like additional information see WebVM and Tailscale.

Fork, deploy, customize

deploy_instructions_gif

  • Fork the repository.
  • Enable Github pages in settings.
    • Click on Settings.
    • Go to the Pages section.
    • Select Github Actions as the source.
      • If you are using a custom domain, ensure Enforce HTTPS is enabled.
  • Run the workflow.
    • Click on Actions.
    • Accept the prompt. This is required only once to enable Actions for your fork.
    • Click on the workflow named Deploy.
    • Click Run workflow and then once more Run workflow in the menu.
  • After a few seconds a new Deploy workflow will start, click on it to see details.
  • After the workflow completes, which takes a few minutes, it will show the URL below the deploy_to_github_pages job.

You can now customize dockerfiles/debian_mini to suit your needs, or make a new Dockerfile from scratch. Use the Path to Dockerfile workflow parameter to select it.

Run WebVM locally with a custom Debian mini disk image

  1. Clone the WebVM Repository

    git clone https://github.com/leaningtech/webvm.git
    cd webvm
    
  2. Download the Debian mini Ext2 image

    Run the following command to download the Debian mini Ext2 image:

    wget "https://github.com/leaningtech/webvm/releases/download/ext2_image/debian_mini_20230519_5022088024.ext2"
    

    (*You can also build your own disk image by selecting the "Upload GitHub release" workflow option*)

  3. Update the configuration file

    Edit config_public_terminal.js to reference your local disk image:

  • Replace:

    "wss://disks.webvm.io/debian_large_20230522_5044875331.ext2"

    With:

    "/disk-images/debian_mini_20230519_5022088024.ext2"

    (Use an absolute or relative URL pointing to the disk image location.)

  • Replace "cloud" with the correct disk image type: "bytes"

  1. Build WebVM

    Run the following commands to install dependencies and build WebVM:

    npm install
    npm run build
    

    The output will be placed in the build directory.

  2. Configure Nginx

  • Create a directory for the disk image:

    mkdir disk-images
    mv debian_mini_20230519_5022088024.ext2 disk-images/
    
  • Modify your nginx.conf file to serve the disk image. Add the following location block:

    location /disk-images/ {
        root .;
        autoindex on;
    }
    
  1. Start Nginx

    Run the following command to start Nginx:

    nginx -p . -c nginx.conf
    

    Nginx will automatically serve the build directory.

  2. Access WebVM

    Open a browser and visit: http://127.0.0.1:8081.

    Enjoy your local WebVM!

Example customization: Python3 REPL

The Deploy workflow takes into account the CMD specified in the Dockerfile. To build a REPL you can simply apply this patch and deploy.

diff --git a/dockerfiles/debian_mini b/dockerfiles/debian_mini
index 2878332..1f3103a 100644
--- a/dockerfiles/debian_mini
+++ b/dockerfiles/debian_mini
@@ -15,4 +15,4 @@ WORKDIR /home/user/
 # We set env, as this gets extracted by Webvm. This is optional.
 ENV HOME="/home/user" TERM="xterm" USER="user" SHELL="/bin/bash" EDITOR="vim" LANG="en_US.UTF-8" LC_ALL="C"
 RUN echo 'root:password' | chpasswd
-CMD [ "/bin/bash" ]
+CMD [ "/usr/bin/python3" ]

How to use Claude AI

To access Claude AI, you need an API key. Follow these steps to get started:

  1. Create an account
  2. Visit Anthropic Console and sign up with your e-mail. You'll receive a sign in link to the Anthropic Console.

  1. Get your API key
  2. Once logged in, navigate to Get API keys.
  3. Purchase the amount of credits you need. After completing the purchase, you'll be able to generate the key through the API console.

  1. Log in with your API key
  2. Navigate to your WebVM and hover over the robot icon. This will show the Claude AI Integration tab. For added convenience, you can click the pin button in the top right corner to keep the tab in place.
  3. You'll see a prompt where you can insert your Claude API key.
  4. Insert your key and press enter.

  1. Start using Claude AI
  2. Once your API key is entered, you can begin interacting with Claude AI by asking questions such as:

"Solve the CTF challenge at /home/user/chall1.bin. Note that the binary reads from stdin."

deploy_instructions_gif

Important: Your API key is private and should never be shared. We do not have access to your key, which is not only stored locally in your browser.

Bugs and Issues

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

More links

Thanks to...

This project depends on:

Versioning

WebVM depends on the CheerpX x86-to-WebAssembly virtualization technology, which is included in the project via NPM.

The NPM package is updated on every release.

Every build is immutable, if a specific version works well for you today, it will keep working forever.

License

WebVM is released under the Apache License, Version 2.0.

You are welcome to use, modify, and redistribute the contents of this repository.

The public CheerpX deployment is provided as-is and is free to use for technological exploration, testing and use by individuals. Any other use by organizations, including non-profit, academia and the public sector, requires a license. Downloading a CheerpX build for the purpose of hosting it elsewhere is not permitted without a commercial license.

Read more about CheerpX licensing

If you want to build a product on top of CheerpX/WebVM, please get in touch: sales@leaningtech.com