Tasty Shapes With Friends
A tiny SaaS for sharing song links with your friends over a common stream.
tswf is a api interface for interacting with a queue that serves as a
playlist for an rtmp streaming worker:
apiserves the flask routes for interacting with the queue
nginxroutes to the api, and serves the rtmp endpoint as well
playerplays song links submitted to the queue by calling the api
The API is simple, with more functionality on the way as time permits.
/submit?song=<urlencoded song link> <- submit a song to the queue /stat <- the length of the queue /queue <- the queue /clear <- in case of emergencies /next <- used by player (and assholes) /current <- currently playing URL /skip?username=<username> <- Vote to skip song
This project is intended to be run with docker-compose. Depending on what operating system you are using, you may want to grab it from your package manager, or directly from upstream.
player containers, you should be able to simply
change into their directories, and run:
docker build -t <name> .
nginx container has two extra steps to build:
generate a dhparams file with the following command
openssl dhparam -out dhparam.pem 4096
It's going to take a little bit.
After it's done create a self-signed certificate and private key:
openssl req -newkey rsa:4096 -keyout cert.key -x509 -days 365 -out cert.pem -nodes
Once you have these three things, the cert.key, cert.pem, and dhparams.pem, make a
keys directory and move put that into the
mkdir keys/; mv cert.key cert.pem dhparams.pem keys/; mv keys/ nginx/
nginx container is good to be built in the same fashion as the other two.
after you've build all of the containers you can start them all up with:
docker-compose up -d
(You can leave off the
-d if you want it to run in the tty.)
If things worked as intended, you should see the player attempt to grab a song from the queue immediately.
- Fork the repository
- Clone the project from your forked repository to your macine
- Commit changes to your own branch
- Push your changes on your branch to your forked repository.
- Submit a Pull request back to our repository for review.
NOTE: always merge from latest upstream before submitting pull requests.