Broadcastarr is a service that allows you to broadcast media content retrieved from web pages.
The different actions are split into tasks that are handled by the AgendaTS service.
The tasks are:
- Publish category
Ensures that the active categories are published, and starts indexing the categories for each active indexer. - Index category
Indexes the category for each a given indexer, schedules the next indexation and the grabbing of the broadcast stream. - Grab broadcast stream
Grabs the broadcast stream for each broadcast in the category, schedules the release of the broadcast. - Release broadcast
Releases the broadcast to the active releasers, schedules the publishing of associated group. - Publish group
Publishes the group to the active publishers. - Update category channel name
Updates the category channel name on the active publishers. - Delete broadcast
Deletes the broadcast.
Handles interactions and commands via Discord.
If no authorization was set, the bot will be available to everyone.
Available commands:
- addcategory
- addrole
- indexcategory
- removecategory
- setcategoryemoji
- setconfig
- setgroupemoji
- togglegroup
- toggleindexer
A releaser is a service that can read the broadcasts.
Implemented releasers:
A publisher is a service that can publish the categories, groups and broadcasts to different platforms.
Implemented publishers:
The service is designed to be scalable and can be deployed on multiple instances.
The docker compose includes a Wireguard client that allows the workers to scrape and grab the broadcasts from the web pages through a VPN.
The used configuration file is ./wg0.conf.
First you need to create the env files and fill them with the correct values.
cp .env.default .env
cp .env.init.default .env.init
Then you need to initialize the database and shut it down.
docker compose up init
docker compose down init
Finally you can start the service.
docker compose up -d server worker
Additionally you can have multiple workers in the compose file to handle more tasks at the same time.
In the .env.init file:
- Set the different delay values (in second).
- Set the limit values (in minutes).
- Set the Categories to create with their respective emoji.
CATEGORIES_EMOJI=Football:⚽,Basketball:🏀
- Set the groups to create with their respective category and country.
GROUPS="Football:France*Ligue 1,Spain*La Liga|Basketball:USA*NBA"
- Set the discord webhookks to activate.
DISCORD_WEBHOOKS="Football:id:token,Rugby:id:token"
Add the definitions of the indexers as json files in the ./src/init/data
type Replacement = {
regex: RegExp;
replace: string;
}
type DateReplacement = {
regex: RegExp;
format: string;
}
type Selector = {
path: string;
}
type TextContentSelector = Selector & {
attribute?: string;
replacement?: Replacement;
}
type DateSelector = TextContentSelector & {
format?: string;
dateReplacement?: DateReplacement;
}
type RegexSelector<T extends Record<string, string>> = TextContentSelector & {
regex: RegExp;
default?: T;
}
{
"name": string,
"url": string,
"active": boolean,
// The data to configure the indexation
"data": {
"category": {
// The links to retrieve the categories
"links": Selector[],
// When set, the lookup is a map category => strings to look for in the category name in the links textContent retrieved by the links selectors
"lookups": Map<string, string[]>,
},
// Element to wait before looking for links
"loadPageElement": string,
// Broadcasts can be grouped by sets, in this case we start by looking for the day
"broadcastSets": {
// The selectors to retrieve the sets of broadcasts
"selector": Selector[],
// The selectors to retrieve the day
"day": DateSelector[],
// Some sites have a "today" string instead of the current date, in this case we need to replace it
"today": {
"regex": string,
"format": string,
},
},
// The selectors to retrieve the broadcasts, is run in the context of the set, or the page if not set
"broadcast": {
// The selectors to retrieve the broadcasts
"selector": Selector[],
// The selectors to retrieve the broadcast start time, is run in the context of the broadcast
"startTime": DateSelector[],
// The selectors to retrieve the broadcast link, is run in the context of the broadcast
"link": TextContentSelector[],
// The selectors to retrieve the broadcast title, is run in the context of the broadcast
"name": TextContentSelector[],
// The selectors to retrieve the broadcast group, is run in the context of the broadcast
"group": RegexSelector[],
},
// The selectors to retrieve the next page link, as long as there is a next page, and the broadcastSets start before the future limit, we go to the next page and continue the indexation
"nextPage": Selector[],
},
// The data to configure the grabbing
"interceptorData": {
// Element to wait before looking for stream items
"loadPageElement": string,
// The selectors to retrieve the stream items
"streamItems": Selector[],
// The selectors to retrieve the score of the broadcast, is run in the context of the stream item
"positiveScores": Selector[],
// The selectors to retrieve the link of the broadcast, is run in the context of the stream item
"link": TextContentSelector[],
// If set, we go to the link(s) previously found with a referer header
"referer": string,
// If set, we click on the items found (play button for instance)
"clickButton": Selector[],
}
}
Fill the .env file with the correct values.
- [] Unit tests
- [] Configuration to activate / deactivate publishers
- [] Discord bot commands to activate / deactivate publishers
- [] Configuration to activate / deactivate releasers
- [] Discord bot commands to activate / deactivate releasers
- [] Working API for TheSportsDB
- [] Option to reload a stream when proxying has been requested
- [] Script for versioning & automated changelog generation with the releases
- [] Create docker image that does not mount the src folder
- [] Improve doc with screenshots
