nixvm 0.0.0

A portable VM-style sandbox that runs a real Linux userland by emulating Linux syscalls directly (no guest kernel, no device emulation).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

name: Deploy browser demo to GitHub Pages

# Builds src/wasm.rs (the `wasm` feature) to WebAssembly with wasm-pack,
# builds the Vue + xterm.js frontend in web/ with Vite, assembles them
# together with a bundled Alpine minirootfs, and publishes the result as a
# GitHub Pages site: a real Alpine Linux userland, booted and driven through
# an interactive shell, entirely client-side.

on:
  push:
    branches: [master]
    paths:
      - "src/**"
      - "web/**"
      - "Cargo.toml"
      - "Cargo.lock"
      - ".github/workflows/pages.yml"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

# Only one deployment at a time; let in-flight runs finish rather than racing.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: wasm32-unknown-unknown

      - name: Install wasm-pack
        uses: jetli/wasm-pack-action@v0.4.0
        with:
          version: "latest"

      - name: Build the wasm sandbox (src/wasm.rs, `wasm` feature)
        # wasm-pack already builds only the library target (`cargo build --lib`)
        # internally, so it never touches src/bin/run-elf.rs (a native dev
        # harness gated on `cfg(unix)`). Passing an extra `-- --lib` is a
        # duplicate arg that wasm-pack rejects.
        run: wasm-pack build --target web --no-default-features --features wasm

      - name: Set up Node
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: npm
          cache-dependency-path: web/package-lock.json

      - name: Install frontend dependencies
        working-directory: web
        run: npm ci

      - name: Build the frontend (Vite)
        working-directory: web
        run: npm run build

      - name: Fetch the Alpine minirootfs
        # Resolve the current v3.20 aarch64 minirootfs filename from the
        # release manifest rather than hardcoding a version, so this keeps
        # working as Alpine ships point releases.
        run: |
          set -euo pipefail
          VER=$(curl -sSL https://dl-cdn.alpinelinux.org/alpine/v3.20/releases/aarch64/latest-releases.yaml | grep -m1 -oE 'alpine-minirootfs-[0-9.]+-aarch64.tar.gz')
          echo "Resolved Alpine minirootfs: $VER"
          curl -sSL -o web/dist/rootfs.tar.gz "https://dl-cdn.alpinelinux.org/alpine/v3.20/releases/aarch64/$VER"

      - name: Copy the wasm-pack output into the built site
        # web/dist/index.html's `import('./pkg/nixvm.js')` (see
        # web/src/components/NixTerm.vue) expects pkg/ to sit next to it.
        run: |
          set -euo pipefail
          mkdir -p web/dist/pkg
          cp pkg/nixvm.js pkg/nixvm_bg.wasm web/dist/pkg/
          [ -f pkg/nixvm.d.ts ] && cp pkg/nixvm.d.ts web/dist/pkg/ || true
          [ -f pkg/nixvm_bg.wasm.d.ts ] && cp pkg/nixvm_bg.wasm.d.ts web/dist/pkg/ || true

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: web/dist

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4