README
¶
The Livepeer project aims to deliver a live video-streaming network protocol that is fully decentralized, highly scalable and crypto-token incentivized to serve as the live media layer in the decentralized development (Web3) stack. Read our documentation to learn more about the protocol and its economic incentives.
go-livepeer is a Go implementation of the Livepeer protocol which powers the Livepeer Network. Specifically, go-livepeer contains implementations of Broadcaster, Orchestrator, and Transcoder nodes (roles) in the Livepeer Network ecosystem.
Table of Contents
Requirements
This project requires go and a unix shell.
Getting Started
To get started, clone the repo and follow the installation guide.
Next, follow the guide to set up a private ETH network with the Livepeer protocol deployed.
Contributing
Thanks for your interest in contributing to go-livepeer. There are many ways you can contribute to the project, even non-developers.
To start, take a few minutes to read the "Contributing to go-livepeer" guide.
We look forward to your pull requests and / or involvement in our issues page and hope to see your username on our list of contributors 🎉🎉🎉
Resources
To get a full idea of what Livepeer is about, be sure to take a look at these other resources:
Directories
¶
| Path | Synopsis |
|---|---|
|
Package clog provides Context with logging information.
|
Package clog provides Context with logging information. |
|
cmd
|
|
|
devtool
command
|
|
|
livepeer
command
Livepeer is a peer-to-peer global video live streaming network.
|
Livepeer is a peer-to-peer global video live streaming network. |
|
livepeer_bench
command
|
|
|
livepeer_cli
command
|
|
|
livepeer_router
command
|
|
|
scripts
command
|
|
|
simple_auth_server
command
|
|
|
Core contains the main functionality of the Livepeer node.
|
Core contains the main functionality of the Livepeer node. |
|
Package drivers abstracts different object storages, such as local, s3
|
Package drivers abstracts different object storages, such as local, s3 |
|
Package eth client is the go client for the Livepeer Ethereum smart contract.
|
Package eth client is the go client for the Livepeer Ethereum smart contract. |
|
Package net is a generated GoMock package.
|
Package net is a generated GoMock package. |
|
Package server is the place we integrate the Livepeer node with the LPMS media server.
|
Package server is the place we integrate the Livepeer node with the LPMS media server. |