This Quickstart guide provides steps to follow in order for you to be able to install and understand how to set up an Orchestrator for video mining and use your GPU for transcoding.
Livepeer architecture supports several modes of operation you can choose from based on your use case and preferences.
The following includes detailed high-level descriptions and links with instructions about how to set up a combined Livepeer Orchestrator and Transcoder.
What You Need to Know
- Familiarity with platform capabilities highlighted in Protocol Core Concepts.
- How to work with a command-line interface
wgetis recommended (alternatively,
cURLcan be used)
- grpcurl for interacting with gRPC servers for testing and monitoring
- Basic familiarity with installing binaries directly or with Docker
- Familiarity with networking concepts and configuration (URLs, ports and port forwarding, static IPs, )
- Understanding of how to send and receive funds using EVM-based networks
To install and run
livepeer on the network, you will need to meet the following technical requirements:
Linux, Darwin (macOS), or Windows
Livepeer supports NVIDIA GPUs for encoding/decoding.
Note: Additional hardware support will be added in the future; please refer to GPU Support for a full list.
- Bandwidth should provide a recommended minimum 1G upload/download. Test your available bandwith.
- Static IP/Hostname to receive video streams (to get started, a Dynamic IP will suffice but should be static for ongoing use).
- Ports and Routing: ability to open ports and modify port forwarding.
Current Releases for supported operating systems are found on our Github repository releases page.
Depending on your workflow, you can install Livepeer:
Start Video Mining
You will be setting up a combined orchestrator and transcoder that you will be able to manage, make discoverable on the network, and view on the Livepeer Explorer. For advanced users, it may be preferable to run an orchestrator / transcoder split.
Choosing your role
There are multiple ways to participate as a Video Miner on the network:
This guide focuses on the steps necessary to participate as a combined Orchestrator/Transcoder.
You can follow the instructions provided for your chosen installation workflow.
Check your bandwidth
You can check upload/download bandwidth with these speedtest tools, or use your own. Low bandwidth will result in poor performance on the network.
Assess concurrent stream capabilities
Test your Benchmarking
You can download test streams and test your GPU capacity with the benchmarking tool
To do this, you should:
Download the test streams folder and save it in your
Save the JSON file
transcodingOptions.jsonand save it in your
Be sure to set the
-nvidiaGPU flag; otherwise, the benchmarking will default to CPU transcoding and drastically impact the results
-concurrentSessions allto transcode all the test segments, or specify the number of segments you want to test.
Run the benchmarking tool
Realtime Duration Ratio: You should target a ratio of 1.0 or lower; 1.0 represents real-time transcoding, and anything lower than that is faster than realtime. Higher ratios reflect poor performance.
-in bbb/source.m3u8 \
-transcodingOptions transcodingOptions.json \
-nvidia <NVIDIA_GPU_IDs> \ # Only required for transcoding with GPUs
Note: Pause is not required but will keep the log open so you can make changes. You can remove it once you have completed your testing.
Note: To avoid performance issues, it is highly recommended you run a benchmarking test to gauge the capacity of your GPU before proceeding.
Set Static IP and Set Up Port Forwarding
Note: In your initial setup for testing, you can use a dynamic IP, but to operate on the network, IPs must be static.
When receiving streams for broadcasters, the IP should be static to ensure broadcasters can access the same location each time they want to connect. For some configurations or business goals, it may be helpful use a hostname instead to provide more operational flexibility.
Ports and Forwarding
- Ensure that port
8935can receive external requests.
- Set up port forwarding to forward requests to the service URI to port
Depending on your operational setup, this may need to be done via your router.
Start an Orchestrator on Arbitrum Testnet
Follow the Arbitrum Testnet guide.
Navigate to the Livepeer Explorer on Arbitrum Testnet
Video Mining on Arbitrum Mainnet
Once you have been able to connect and activate on the test network, you are ready to start transcoding on Arbitrum Mainnet:
Make sure to Fund your account with ETH for transaction fees, and LPT to stake.
When starting your orchestrator, be sure to set the
networkflags to connect to the Arbitrum Mainnet instead of testnet
Start an Orchestrator on the Arbitrum Mainnet
Follow the tutorial to start a combined orchestrator / transcoder.
Once you've started your combined orchestrator/transcoder with parameters pointing at Arbitrum Mainnet, follow the guide to activate your orchestrator.
Navigate to the Livepeer Explorer on Arbitrum Mainnet
Once you have activated your orchestrator on the Arbitrum Mainnet, you should be able to see it on the Livepeer Explorer.
Optimize your Orchestrator
The following How-to Guides provide further instruction on how video miners can optimize an activated orchestrator.