Merge branch 'main' into hackathon

Author: GabrielaReyna

content/blog/CJ-3-1-roadmap.mdx

@@ -7,7 +7,7 @@ authors:
   - alessandro
   - stefano
 pubDate: "February 5 2025"
-heroImage: "./CJ3-1.png"
+heroImage: "./CJ3-1-hero.png"
 featured: true
 tags:
   - CheerpJ

content/blog/CJ3-1-hero.png

@@ -39,9 +39,11 @@ const { href, label, type = "secondary", iconLeft, iconRight } = Astro.props;
 				type === "primary-cheerpx",
 			"border-white text-white hover:border-[#909090] hover:text-[#909090]":
 				type === "secondary-cheerpx",
+
 			"border-white bg-white text-black font-mono hover:bg-primary-300 hover:text-white hover:border-primary-300 hover:drop-shadow-[0px_0px_5px_rgba(240,125,153,0.6)]":
 				type === "primary-mono",
 			"border-white text-white font-mono hover:border-primary-300 hover:text-primary-300 hover:drop-shadow-[0px_0px_5px_rgba(240,125,153,0.6)]":
+
 				type === "secondary-mono",
 			"border-white border-opacity-30 bg-blurple text-white hover:border-opacity-80":
 				type === "discord",

packages/astro-theme/components/LinkButton.astro

@@ -185,11 +185,11 @@ await dataDevice.writeFile("/filename", "File content here");
 
 ## Block devices with ext2
 
-CheerpX supports ext2 filesystems, which can be configured as an overlay device. This allows for a flexible setup that can combine different storage types.
+CheerpX supports ext2 filesystems, which can be configured as an [`OverlayDevice`](/docs/reference/CheerpX.OverlayDevice). This allows for a flexible setup that can combine different storage types.
 
 ### Usage
 
-Create an ext2 filesystem by combining a [`HttpBytesDevice`](/docs/reference/httpBytesDevice) to acess disk blocks, an [`IDBDevice`](/docs/reference/CheerpX.IDBDevice) to cache and persist data and a `OverlayDevice` to combine the two.
+Create an ext2 filesystem by combining a [`HttpBytesDevice`](/docs/reference/httpBytesDevice) to acess disk blocks, an [`IDBDevice`](/docs/reference/CheerpX.IDBDevice) to cache and persist data and a [`OverlayDevice`](/docs/reference/CheerpX.OverlayDevice) to combine the two.
 
 ```javascript
 // Create an HttpBytesDevice for streaming disk blocks via HTTP
@@ -215,7 +215,7 @@ CheerpX supports various types of devices that can be used in the OverlayDevice
 
 1. [**HttpBytesDevice**](/docs/reference/httpBytesDevice): The default choice for loading filesystem images via HTTP. Suitable for most web-hosted files.
 2. **GitHubDevice**: Ideal for projects forked from the [WebVM](https://github.com/leaningtech/webvm/) repository. The Integrated GitHub Action will take care of preparing disk chunks for efficient access.
-3. **OverlayDevice**: `OverlayDevice` supports chaining, making it possible to efficiently "fork" disk images while only storing the changes from previous versions.
+3. [**OverlayDevice**](/docs/reference/CheerpX.OverlayDevice): `OverlayDevice` supports chaining, making it possible to efficiently _fork_ disk images while only storing the changes from previous versions.
 
 ## Best practices
 

sites/cheerpx/src/content/docs/11-guides/File-System-support.md

@@ -128,6 +128,12 @@ What is happening here?
 - [loginUrlCb] expects the base URL of a control server that will continue and finish the login process. This callback is executed when prompting the user to log in interactively with Tailscale.
 - [stateUpdateCb] and [netmapUpdateCb] are necessary for tracking network status and updates to network maps.
 
+After setting up the network interface, you can trigger the network login by calling.
+
+```js
+await cx.networkLogin();
+```
+
 ## Self-hosting Headscale
 
 Headscale is an open-source and self-hosted implementation of the Tailscale control server. The upstream version of Headscale does not yet properly support the WebSocket transport. For the time being, please use [our fork](https://github.com/leaningtech/headscale).

sites/cheerpx/src/content/docs/11-guides/Networking.md

@@ -24,7 +24,7 @@ RUN apt-get update && apt-get -y upgrade && apt-get -y install curl
 Once the `Dockerfile` is ready, build the image. Use `buildah` to create a container image for your filesystem.
 
 ```bash
-buildah build -f Dockerfile --platform linux/i386 -t cheerpximage
+buildah build -f Dockerfile --dns=none --platform linux/i386 -t cheerpximage
 ```
 
 ## 3. Create a container from the Docker Image

sites/cheerpx/src/content/docs/11-guides/custom-images.mdx

@@ -43,14 +43,14 @@ interface MountPointConfiguration {
 	// Specifies the filesystem type
 	// 'ext2' for Linux ext2
 	// 'dir' for a hierarchical file system
-	// 'devs' for device files
-	// 'proc' for process info files.
+	// 'devs' for device files (no device required)
+	// 'proc' for process info files. (no device required)
 	type: "ext2" | "dir" | "devs" | "proc";
 
 	// First mount must be "/" (root)
 	path: string;
-	// Can be one of: overlayDevice / webDevice / dataDevice / idbDevice
-	dev: CheerpX.Device;
+	// Required for 'ext2' and 'dir' types, but optional for 'devs' and 'proc'
+	dev?: CheerpX.Device;
 }
 ```
 
@@ -61,6 +61,8 @@ const cx = await CheerpX.Linux.create({
 	mounts: [
 		{ type: "ext2", path: "/", dev: overlayDevice },
 		{ type: "dir", path: "/app", dev: webDevice },
+		{ type: "devs", path: "/dev" }, // No dev required
+		{ type: "proc", path: "/proc" }, // No dev required
 	],
 });
 ```

sites/cheerpx/src/content/docs/12-reference/CheerpX.Linux/00-create.md

@@ -0,0 +1,51 @@
+---
+title: create
+description: Create a writable persistent overlay device on top of another block device.
+---
+
+```ts
+namespace CheerpX {
+	class OverlayDevice {
+		static async create(
+			baseDevice: Device,
+			overlayDevice: Device
+		): Promise<OverlayDevice>;
+	}
+}
+```
+
+## Parameters
+
+- **baseDevice (`Device`)** - The underlying device (e.g., [`HttpBytesDevice`](/docs/reference/httpBytesDevice), [`IDBDevice`](/docs/reference/CheerpX.IDBDevice)) that serves as the base layer for the filesystem.
+
+- **overlayDevice (`Device`)** - The writable layer that will overlay the base device, enabling persistent changes.
+
+## Returns
+
+`CheerpX.OverlayDevice.create` returns a [Promise] that resolves to an instance of the `OverlayDevice`. The `OverlayDevice` allows you to overlay a writable layer on top of the base device, enabling persistent changes while still accessing the base data.
+
+## Example
+
+Create an `OverlayDevice` instance to combine a [`HttpBytesDevice`](/docs/reference/httpBytesDevice) for streaming data from an HTTP source and an [`IDBDevice`](/docs/reference/CheerpX.IDBDevice) for caching and persistent local storage.
+
+```ts {8, 12}
+// Create a read-only HttpBytesDevice for streaming disk blocks via HTTP
+const httpDevice = await CheerpX.HttpBytesDevice.create("/cheerpXImage.ext2");
+
+// Create an IDBDevice for local persistent storage
+const idbDevice = await CheerpX.IDBDevice.create("block_idbDevice");
+
+// Create an OverlayDevice to combine the two devices
+const overlayDevice = await CheerpX.OverlayDevice.create(httpDevice, idbDevice);
+
+// Mount the overlay device in the CheerpX environment as an ext2 filesystem
+const cx = await CheerpX.Linux.create({
+	mounts: [{ type: "ext2", path: "/", dev: overlayDevice }],
+});
+```
+
+In this example, the `OverlayDevice` provides a writable layer on top of the [`HttpBytesDevice`](/docs/reference/httpBytesDevice) (which serves as a read-only block device for streaming), allowing changes to be stored locally via the [`IDBDevice`](/docs/reference/CheerpX.IDBDevice).
+
+For more information, please check out the [Files and File system guide](/docs/guides/File-System-support). This guide provides more details on how to work with files and directories in CheerpX.
+
+[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

sites/cheerpx/src/content/docs/12-reference/CheerpX.OverlayDevice/create.md

@@ -22,7 +22,7 @@ CMD [ "/bin/bash" ]
 Create a container out of your Dockerfile:
 
 ```bash
-buildah build -f Dockerfile --platform linux/i386 -t cheerpximage
+buildah build -f Dockerfile --dns=none --platform linux/i386 -t cheerpximage
 podman create --name cheerpxcontainer cheerpximage
 ```