webvm

[itachi]

 

Navigation Menu

Sign in

leaningtech

/

webvm

Public

Virtual Machine for the Web

 

webvm.io

License

 Apache-2.0 license

 12.9k stars 2.4k forks Branches Tags Activity

Code

Issues

11

Pull requests

Actions

Security

Insights

leaningtech/webvm

Name 

alexp-sssup

alexp-sssup

4 days ago

.circleci

last month

.github/workflows

3 months ago

assets

2 months ago

dockerfiles

2 years ago

docs

7 months ago

documents

6 months ago

examples

2 years ago

src

last month

xterm

10 months ago

.gitignore

2 months ago

Repository files navigation

README

Apache-2.0 license

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

Clone the WebVM Repository

git clone https://github.com/leaningtech/webvm.git

cd webvm

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)

 

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"

 

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.

 

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;

 }

Start Nginx

 

Run the following command to start Nginx:

 

nginx -p . -c nginx.conf

Nginx will automatically serve the build directory.

 

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:

 

Create an account

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

 

 

Get your API key

Once logged in, navigate to Get API keys.

Purchase the amount of credits you need. After completing the purchase, you'll be able to generate the key through the API console.

 

 

Log in with your API key

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.

You'll see a prompt where you can insert your Claude API key.

Insert your key and press enter.

 

 

Start using Claude AI

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

Github link

 https://github.com/leaningtech/webvm