joystream/README.md

Joystream Full Node

Joystream node built on top of Substrate.

Follow the instructions below to download the software or build it from source. Further instructions for windows and mac can be found here. Linux should be similar to mac.

Binary releases

Downloads are available in releases.

Building from source

Initial setup

If you want to build from source you will need the Rust toolchain, openssl and llvm/libclang. You can install the required dependencies with:

git clone https://github.com/Joystream/substrate-node-joystream.git
cd substrate-node-joystream/
./setup.sh

If you prefer to use docker see building with docker.

Building

cargo build --release

Running a public node

Run the node and connect to the public testnet

cargo run --release

Installing a release build

This will install the executable joystream-node to your ~/.cargo/bin folder, which you would normally have in your $PATH environment.

cargo install --path ./

Now you can run

joystream-node

Development

Running a local development node

cargo run --release -- --dev

Cleaning development chain data

When making changes to the runtime library remember to purge the chain after rebuilding the node to test the new runtime.

cargo run --release -- purge-chain --dev

Docker

Building localy

A joystream-node can be compiled with give Dockerfile file:

# Build and tag a new image, which will compile joystream-node from source
docker build . -t joystream-node

# run a development chain with the image just created publishing the websocket port
docker run -p 9944:9944 joystream-node --dev --ws-external

Downloading joystream pre-built images from Docker Hub

docker pull joystream/node

Running a public node as a service

docker run -d -p 30333:30333 --name my-node joystream/node

# check status
docker ps

# monitor logs
docker logs --tail 100 -f my-node

[More advanced guide]()