Skip to content

Latest commit

 

History

History
115 lines (91 loc) · 3.16 KB

README.md

File metadata and controls

115 lines (91 loc) · 3.16 KB

Start9 wrapper for ipfs-podcasting

This package creates an IPFS Podcasting node on your Start9 device. It is used for self-hosting, crowd-hosting, and archiving your favorite podcasts to the IPFS network. Visit https://ipfspodcasting.net for more information.

Dependencies

Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging documentation.

Build environment

Prepare your StartOS build environment. In this example we are using Ubuntu 22.04.

  1. Install docker
curl -fsSL https://get.docker.com | bash
sudo usermod -aG docker "$USER"
exec sudo su -l $USER
  1. Set buildx as the default builder
docker buildx install
docker buildx create --use
  1. Enable cross-arch emulated builds in docker
docker run --privileged --rm linuxkit/binfmt:v0.8
  1. Install yq
sudo snap install yq
  1. Install deno
sudo snap install deno
  1. Install essentials build packages
sudo apt-get install -y build-essential openssl libssl-dev libc6-dev clang libclang-dev ca-certificates
  1. Install Rust
curl https://sh.rustup.rs -sSf | sh
# Choose nr 1 (default install)
source $HOME/.cargo/env
  1. Build and install embassy-sdk
cd ~/ && git clone --recursive https://github.com/Start9Labs/embassy-os.git
cd embassy-os/backend/
./install-sdk.sh
embassy-sdk init

Now you are ready to build the ipfs-podcasting package!

Cloning

Clone the project locally:

git clone https://github.com/Cameron-IPFSPodcasting/podcastnode-Start9-wrapper
cd podcastnode-Start9-wrapper

Building

To build the ipfs-podcasting package for all platforms using embassy-sdk version >=0.3.3, run the following command:

make all

To build the ipfs-podcasting package for a single platform using embassy-sdk version <=0.3.2, run:

# for amd64
make ARCH=x86_64

or

# for arm64
make ARCH=aarch64

Installing (on StartOS)

Run the following commands to determine successful install:

ℹ️ Change embassy-server-name.local to your Embassy address

embassy-cli auth login
# Enter your embassy password
embassy-cli --host https://embassy-server-name.local package install ipfs-podcasting.s9pk

If you already have your embassy-cli config file setup with a default host, you can install simply by running:

make install

Tip: You can also install the ipfs-podcasting.s9pk using Sideload Service under the System > Manage section.

Verify Install

Go to your Embassy Services page, select IPFS Podcasting, configure and start the service. Then, verify its interfaces are accessible.

Visit the [https://ipfspodcasting.net/FAQ](IPFS Podcasting FAQ) to learn more.

Done!