Link Search Menu Expand Document

Overview

InterPlanetary File System or IPFS is a distributed file system that can be used for hosting videos for a video marker. It has the advantage of being pretty straight forward to use and requires very little setup.

Quickstart

Firtst time set up

First you need to install IPFS, then for links it generates to work with Electaco you need to go to Settings and change “Public Gateway” to https://dweb.link

gateway

Using a video file via IPFS

When you got a video file you want to use in a marker, you can just upload it to your node, get the shareable link, and use that link for your video marker.

Import it to your node

gateway

sharelink

Use that URL for the marker

markerurl

And the video should start playing shortly.

More details

IPFS works by you running a node on your machine, and upload files to that node. If someone else tries to access it, their node will first figure out who has the file and then contact that node and download it, temporarily storing it on their local node. If a third person then open the file, it will use it’s local copy to help the third one get the file.

Files you upload gets automatically “pinned”, which means it’ll never be removed from your node unless you delete or unpin it. There are also “pinning services” that also pins your content on their nodes, to provide extra robustness.

As with all things in life, there are a few drawbacks too. Electaco can’t talk directly with IPFS, and relies on a gateway to access the data. IPFS provides this, but the default one won’t work with electaco and needs to be changed in the node’s config (or in the url given from the ipfs node).

This Public Gateway Checker has a list of gatweays, for it to work with Electaco it needs a green checkmark on the Origin column. I recommend https://dweb.link

Also, expect the first load to be slow since the gateway will have to find and copy the video from your node first. After that it should be fast as long as it’s access semi-regularly.