munshkr / muxy Goto Github PK

RTMP-based streaming muxer for online events

License: GNU Affero General Public License v3.0

Dockerfile 0.66% Python 84.62% XSLT 14.25% DIGITAL Command Language 0.46%

muxy's Introduction

muxy

RTMP-based streaming muxer for online events

Allows user to organize online self-streaming events, where each user can stream herself to public channels or other streaming services.

Requirements

Postgres
Python
nginx-rtmp

Install

Docker

The easiest way to get everything running quickly is by using Docker Compose.

Run:

docker compose up

This will build Muxy and start the server, while also serving Postgres database service and nginx-rtmp.

Manual

Clone repository or download zipfile and extract somewhere.

Create virtual environment and activate:

python -m venv .venv
source .venv/bin/activate

Install the dependencies:

pip install -r requirements.txt

Initial configuration

Copy env.sample to .env and update if necessary. You should set at least:

SECRET_KEY: Use a unique random string.
ALLOWED_HOSTS: Add your hostname.
CORS_ALLOWED_ORIGINS: Add your request origin.
LANGUAGE_CODE: Set default language code.
TIME_ZONE: Set server time zone if different than UTC.
DB_PATH: Set path where to save database file

Now, run migrations to create and prepare database:

./manage.py migrate

Then, create a super user to enter admin panel:

./manage.py createsuperuser

Finally, collect static files for admin panel:

./manage.py collectstatic

Usage

If you are using Docker, just use docker compose up

Otherwise, to run server locally, use:

./manage.py runserver

Deploy

Read the deployment wiki page.

License

This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for details.

muxy's People

Contributors

Stargazers

Watchers

Forkers

yaxu givo29 tiemposdelruido petrichbg highharmonics2

muxy's Issues

Notify all publishers from admin

It'd be nice to have a way to send custom emails to all participants of an event (emails that signed up a Stream for an Event) from the admin.

Right now we have this management command script, only usable from the terminal of the server hosting muxy.

Streams API results ordering

Some improvements @sfradkin asked:

Order the results array from earliest time to latest time: Right now it appears that all the entries in the json array are in reverse order.
Ordering the recordings array: There aren't too many instances where there's more than one recording file, but in the case that there are, it appears that the filenames are not in correct date order.

Predefined Slots endpoints (SlotInterval)

An API endpoint for predefined slots: This would allow the frontend to easily see all free and occupied slots, while keeping the flexibility of the current Stream model.

SlotInterval

An Event has one or more SlotIntervals
A SlotInterval defines an interval (has a start and end datetime), and a fixed slot duration (eg. 20 minutes)
If not specified, an Event has a SlotInterval that spans the whole event
SlotInterval start and end datetime must be within its related Event start and end datetimes

Send emails when modifying or removing a Stream

Add SupportLinks to Event (similar to EventStreamURL) and include on emails

Allow creating Streams with no key

key should be optional, or not present at all in the POST payload. key should be autogenerated on creation.

Automatically configure nginx-rtmp server apps

Send email when creating a Stream

"Ovelaps with other streams" error when there is no overlap

Hey, just seeing some weird behaviour, I currently have these two empty streams in Muxy:

I'm trying to update some fields via a put request:

        fetch(muxyStream.url, {
            method: 'put',
            headers: new Headers({
                "Authorization": `Api-Key ${muxyApiKey}`,
                "Content-Type": "application/json",
                "Accept": "application/json"
            }),
            body: JSON.stringify({
                publisher_name: "joel",
                publisher_email: "[email protected]",
                description: "hello there",
                location: "Australia",
                timezone: "Australia/Sydney",
                event: "http://localhost:8000/events/1/",
                starts_at: muxyStream.starts_at,
                ends_at: muxyStream.ends_at
            })
        })

for which the payload looks like:

description: "hello there"
ends_at: "2021-12-01T06:00:00Z"
event: "http://localhost:8000/events/1/"
location: "Australia"
publisher_email: "[email protected]"
publisher_name: "joel"
starts_at: "2021-12-01T00:00:00Z"
timezone: "Australia/Sydney"

And I'm seeing this error returned:

{
   "non_field_errors":[
      "overlaps with other streams: ['Longest Night:  (2021-12-01 00:00:00+00:00 - 2021-12-01 06:00:00+00:00)']"
   ]
}

Which can't be the case, as there are no overlapping streams in my muxy instance.

Any ideas on why this might be happening?

Thanks,
Joel

It's possible to reserve a slot multiple times

Using muxy-frontend, if you are an elite gamer and click super fast you can create multiple streams for the same slot. You then get multiple emails with different stream keys. This happened with three out of 144 people for the upcoming solstice stream.

Use timezone information when sending emails

[wishlist] one or more url archive link fields per slot, for linking to archives of that performance

we're currently brainstorming some post-event display stuff in muxy-frontend, and thought it'd be handy to link to the archived performance (on youtube.com/archive.org) from the performer card on night.tidalcycles.org (for example)

The place to keep that info of course is here, and sfradkin can add/update the links via the api when doing the video processing/upload

Show Stream starting/ending datetimes using timezone information on email

If timezone is avaiable and is valid, also show datetimes in that timezone.

[wishlist] User defined tags

As part of the registration process allow users to denote their own list of tags for their performance. These will be used during the archiving process to ensure that their performance video will be tagged accordingly.

Use a custom APIKey model for distinguishing between web clients and other clients

API keys for web clients will have less privileges. For example, the streams list and detail endpoints won't return private fields, like the stream key or the performer's email.

Add `watch_urls` Array field on Event

For example:

https://www.youtube.com/eulerroom/live
https://www.twitch.tv/eulerroom

A more secure mechanism for registering slots

Currently, using the API, anyone could see the users emails and anyone can add/remove slots. I’d like to implement something like @mashaal did on the web site, that is, when the user takes up a slot, the web site returns a auto-generated password/token that they can use to modify/remove their slot afterwards. That way, only the user that registered a slot can modify or remove it.

Change label of current "Description" input to "Title"
Add an input field with a label of "Description detail". Allow for this as an extended field (maybe 1000 character limit?)
Modify backend storage so that the new description field can be extracted with the archive process