README.md

Aleph-VM

The Aleph-VM project allows you to run programs on Aleph.im.

Aleph-VM is optimized to run programs on demand in a "function-as-as-service", as a response to HTTP requests.

Programs can be written in any language as long as they can run a web server. They benefit from running in their own, customizable Linux virtual environment.

Writing programs in Python using ASGI compatible frameworks ( FastAPI, Django, ...) allows developers to use advanced functionalities not yet available for other languages.

1. Install Aleph-VM from packages

Install Aleph-VM to run an Aleph.im Compute Resource Node easily from official pre-built packages.

See the official user doc https://docs.aleph.im/nodes/compute/

2. Install Aleph-VM from source

For development and testing, install Aleph-VM from source.

1. Install the VM-Connector
2. Install the VM-Supervisor.
3. Install and configure a reverse-proxy such as Caddy

3. Create and run an Aleph Program

Have a look at tutorials/README.md for a tutorial on how to program VMs as a user.

The rest of this document focuses on how to run an Aleph-VM node that hosts and executes the programs.

4. Architecture

VM Supervisor

Actually runs the programs in a secure environment on virtualization enabled systems.

See vm_supervisor/README.md.

VM Connector

Assist with operations related to the Aleph network.

See vm_connector/README.md.

---