anonstream/README.md

93 行
4.1 KiB
Markdown
Raw 通常表示 履歴

2021-04-10 02:10:22 +09:00
# onion-livestreaming
2021-04-10 03:24:40 +09:00
Recipe for livestreaming over the Tor network
2021-04-10 15:55:16 +09:00
![Screenshot of the livestream web interface](demo.png)
2021-04-10 03:24:40 +09:00
This was originally made for fun over the course of five days and hence sloppiness may pervade (especially in the CSS).
## Dependencies
2021-04-10 03:46:23 +09:00
* Tor
* FFmpeg
2021-04-10 03:24:40 +09:00
* [Flask](https://github.com/pallets/flask)
2021-04-10 03:45:29 +09:00
* [captcha](https://github.com/lepture/captcha)
2021-04-10 03:24:40 +09:00
* [Flask-HTTPAuth](https://github.com/miguelgrinberg/Flask-HTTPAuth) (to identify the broadcaster in chat)
* [Flask-Compress](https://github.com/colour-science/flask-compress) (should probably be optional)
2021-04-10 03:33:56 +09:00
* Knowledge of FFmpeg and Tor
2021-04-10 03:24:40 +09:00
## Features
2021-04-10 15:15:30 +09:00
* Twitch-looking web interface (mobile friendly)
2021-04-10 03:24:40 +09:00
* Change stream title as you're streaming
* Viewer count
* Stream on/off indicator (and with JavaScript, playback error messages with prompts to refresh)
* Chat with custom names & tripcodes
* Ban/unban chatters & hide messages
2021-04-10 03:45:29 +09:00
* Flood detection / liberal captcha
2021-04-12 00:19:39 +09:00
* Shows stream uptime
* List of users watching / not watching
* Optionally uses videojs (append `?videojs=0` to the URL to disable it)
* With videojs disabled, you can scrub backwards and forwards on the video timeline. If you scrub to the end (the most recent segment), you can achieve really quite low latency, as low as 12 seconds.
2021-04-10 23:55:37 +09:00
* Works without JavaScript
2021-04-10 03:24:40 +09:00
## Issues
* CSS is spaghetti (e.g. the PureCSS framework is used sometimes when it might not need be)
* AFAIK the FFmpeg command in `stream.sh` only works on Linux, change it for other OSs
* Slow: stream delay of at least 30 seconds (lower with videojs disabled). Hopefully this will decrease when congestion control gets into Tor: https://youtu.be/watch?v=zQDbfHSjbnI
* Doesn't use low-latency HLS
2021-04-10 03:24:40 +09:00
## How it works
* FFmpeg creates an HLS stream
* Flask creates a website interface for the stream
2021-04-10 03:24:40 +09:00
* tor makes the website accessible at an onion address
2021-04-10 03:31:27 +09:00
## Explanation of the FFmpeg command in `stream.sh`
2021-04-10 03:24:40 +09:00
TODO
2021-04-10 23:55:37 +09:00
See https://www.martin-riedl.de/2018/08/24/using-ffmpeg-as-a-hls-streaming-server-part-1/ and https://www.martin-riedl.de/2018/08/24/using-ffmpeg-as-a-hls-streaming-server-part-2/ as `stream.sh` is based on those.
2021-04-10 03:31:27 +09:00
2021-04-10 03:24:40 +09:00
## Tutorial
To run this yourself, get this source code. As the project currently exists you might need to change some things:
2021-04-13 22:23:11 +09:00
* If you're on Windows `stream.sh` will be wrong for you and so will all the fonts in `config.json`. `stream.sh` uses `$$` to get its process ID, you'll have to use the Windows equivalent.
* If you're on macOS `stream.sh` might need to be changed a bit and you might not have the fonts in `config.json`.
* If you're on Linux `stream.sh` will probably be alright but you might not have all the fonts in `config.json`.
2021-04-10 03:24:40 +09:00
Assuming you've dealt with that, this is what you have to do.
### Start streaming
2021-04-10 03:24:40 +09:00
#### FFmpeg
2021-04-10 03:24:40 +09:00
Go to the project root and type `sh stream.sh`. This starts the livestream.
2021-04-10 03:24:40 +09:00
#### Flask
2021-04-10 03:24:40 +09:00
Go to the project root and type `flask run`. This starts the websever.
#### tor
2021-04-10 03:24:40 +09:00
Now your webserver is running on port 5000 (or whichever port you set it to, if you did that). We need to tell tor to create a hidden service and to point it at port 5000.
In your [torrc](https://support.torproject.org/tbb/tbb-editing-torrc/), add these two lines
```
HiddenServiceDir $PROJECT_ROOT/hidden_service
HiddenServicePort 80 127.0.0.1:5000
```
2021-04-12 00:41:42 +09:00
where `$PROJECT_ROOT` is the root folder of this project. When you reload tor it will create the `hidden_service` directory and your website will be online. Your onion address is in `hidden_service/hostname`. You only need to do this once.
### While streaming
2021-04-12 00:41:42 +09:00
To appear as the broadcaster in chat, go to `/broadcaster` and log in with the username `broadcaster` and the password printed in your terminal when you started Flask.
2021-04-12 00:38:10 +09:00
You can change the stream title while streaming and it will update for all viewers. Edit `title.txt` to do that.
2021-04-16 21:50:43 +09:00
If you restart FFmpeg while you're streaming, viewers will have to refresh the page. All viewers are prompted to refresh the page.
### Stop streaming
To stop streaming, stop FFmpeg and delete all the files in `stream/`. To start streaming again just run `stream.sh`.
2021-04-12 00:38:10 +09:00
If you restart Flask, the chat will be cleared, you'll have to log in again, and everyone else will have to do the captcha again.