Skip to content

README.md

Latest commit

 

History

History
43 lines (29 loc) · 1 KB

README.md

File metadata and controls

43 lines (29 loc) · 1 KB

VM Connector

Service to schedule the execution of Aleph VM functions for the Aleph.im project and assist VM Supervisors with operations related to the Aleph network.

1. Supported platforms

We support running the VM Connector in a Docker container, on platforms supported by Docker.

2. Installation

2.a. Install Docker

On a Debian/Ubuntu system:

apt update
apt install -y docker.io

2.b. Pull the Docker image

docker pull alephim/vm-connector:alpha

3. Running

Run the Docker image

docker run -d -p 4021:4021/tcp --restart=always --name vm-connector alephim/vm-connector:alpha

4. Configuration

The VM Supervisor can be configured using environment variables:

API_SERVER should point to your Aleph Node. Defaults to https://official.aleph.cloud

IPFS_SERVER should point to your IPFS Gateway, defaults to https://ipfs.aleph.im/ipfs