Getting Started

Welcome to the Myel documentation. Here you'll find information on how to run a cache provider, a.k.a a pop node.

What's a pop node ?

pop nodes are the independent caches on the Myel network that can host and serve content to requesting clients. These nodes can execute four operations, which are:

• Content dispatching: a node can cache content and then ask other peers to cache this same content.
• Content routing: a node can search for specific content, as determined by a unique Content ID (CID).
• Content delivery: a node can serve content they have cached.
• Payments: a node can pay another node for delivering content. Currently payments are issued via Filecoin payment channels.

System Requirements

• MacOS or Linux (Windows supported only for cache providers, see pop provider)

Setup

Download and install the binaries from the Github release page.

Or build from source:

$ git clone https://github.com/myelnet/pop.git

First install the latest version of golang for your system. Then install the following dependencies:

Mac

$ brew install gcc make

Linux

$ sudo apt install gcc make

Lastly run:

$ make all

Run

Once installed, the pop CLI will be available in your path. You can run pop -h to print the available commands.

A Myel point of presence is a long running process that operates in the background. To start the daemon run:

$ pop start

For help on the possible flags to set when starting a pop, run pop start -h.