streamroller

command module
v0.0.0-...-ebc5dce Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2019 License: MIT Imports: 18 Imported by: 0

README

Streamroller

Self hosted simulcasting made easy

Build Status

Deploy to Docker Cloud

Streamroller is a mutlistream tool that allows you to broadcast your streams (e.g OBS/Xsplit) to multiple platforms such as Twitch, Youtube, and Facebook at once. It also has read only chat to make it easy to vocally respond to your viewers in a single window.

This tool is meant to be hosted remotely to avoid networking issues locally as trying to stream for multiple sources can get quite heavy.

Screenshots

Chat: Chat

Features/Roadmap

  • Combined chat (read)
  • Combined chat (write)
  • RTMP cloning
  • Streamroller stream key protection
  • RTMPT to RTMP
Platforms
  • Twitch
  • Facebook Live
  • Youtube
  • Azubu
  • Hitbox

Changelog

Getting Keys/Tokens

Before installing to make the setup simpler, it's best to get all the keys and tokens you'll need from your accounts first. Not every platform is required, only keys and tokens for the platforms you wish to stream to. See the SERVICES.md doc.

Install

Docker Cloud

Deploy to Docker Cloud

Docker Cloud is users who are atleast somewhat familiar with working on servers. You can follow Docker Cloud's get started guide here, and then afterwards hit the Deploy with Cloud button.

Docker

A docker image is available over at Docker Hub. It's suggested to use a tag rather then latest.

Server

Grab the latest release from the releases page, or build from source and install directly from master. Streamroller is currently built and tested against Go 1.8.

Quick install for Linux:

curl -Ls "https://github.com/dustinblackman/streamroller/releases/download/1.0.0/streamroller-linux-amd64-1.0.0.tar.gz" | tar xz -C /usr/local/bin/

Build From Source:

A makefile exists to handle all things needed to build and install from source.

git pull https://github.com/dustinblackman/streamroller
cd streamroller
make install

Configure

Configuration can be done either by command line parameters, environment variables, or a JSON file. Please see all available flags with streamroller --help or in the example below.

To set a configuration, you can take the flag name and export it in your environment or save in one of the three locations for config files.

After launch, chat can be found on the index, (e.g http://localhost:8080). And streams can also be submitted to index (e.g rtmp://localhost:8080).

Parameters
{
  "twitch-livekey": "", // Twitch live key
  "twitch-username": "", // Twitch Username
  "twitch-oauth": "", // Twitch oauth key

  "facebook-livekey": "", // Facebook live key
  "facebook-token": "", // Facebook auth token

  "youtube-livekey": "", // Youtube live key
  "youtube-token": "", // Youtube oauth refresh token

  "port": 8080, // Port for server to listen on
  "debug": false, // Debug logging
}
Examples

Flags:

streamroller --twitch-livekey aBc123 facebook-livekey EfG456

Environments:

All flags/parameters can be used with environment variables by prefixing with SR_, and replacing dashes with underscores.

export SR_TWITCH_LIVEKEY=aBc123
export SR_FACEBOOK_LIVEKEY=EfG456

JSON File:

Configuration files can be stored in one of the three locations

./streamroller.json
/etc/streamroller.json
$HOME/.streamroller/streamroller.json
{
  "twitch-livekey": "aBc123",
  "facebook-livekey": "EfG456"
}

Credit

  • Ethan for the name
  • JDoeDevel for the chat snippet
  • StreamWithFriends - StreamWithFriends allows your friends webcams to appear on your stream all through a web broswer.

License

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL