Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soylent/offstream
Personal twitch stream recorder
https://github.com/soylent/offstream
twitch
Last synced: 3 months ago
JSON representation
Personal twitch stream recorder
- Host: GitHub
- URL: https://github.com/soylent/offstream
- Owner: soylent
- License: mit
- Created: 2021-01-27T01:18:26.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-22T09:01:59.000Z (over 2 years ago)
- Last Synced: 2024-09-14T18:49:21.792Z (4 months ago)
- Topics: twitch
- Language: Python
- Homepage:
- Size: 145 KB
- Stars: 24
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# offstream
Record your favorite twitch streams automatically and watch them later.
- There is no web UI, just use curl and your favorite video player.
- Streams are recorded as is, without re-transcoding.
- Recordings are never muted.
- Ads are optional.
- You can run it on Heroku (completely free) or locally.
- Recordings are stored on IPFS.
- RSS feed of all recordings is available. It can be consumed by youtube-dl,
VLC, and other feed readers.
- Streams are available while recording is in progress.
## Installing
### Option 1: Heroku
You can deploy the app to Heroku by clicking the button below and following the
instructions. IMPORTANT: When the app is deployed, click on the "View" button at
the bottom to complete the setup.
[](https://heroku.com/deploy?template=https://github.com/soylent/offstream/tree/v1.0.3)
### Option 2: Local installation
1. Install the package.
```sh
$ pip install offstream
```
1. Setup your local sqlite database located at `~/.offstream/offstream.db`.
```sh
$ offstream setup
```
You will get credentials to control the app. I recommend adding them to your
`~/.netrc` file (or `_netrc` on Windows):
```
machine
login offstream
password
```
1. Start the app.
```sh
$ offstream
```
## Usage
Once your app is ready, you can add your favorite streamers.
```sh
$ curl -n https://your-app-name.herokuapp.com/streamers -d name=garybernhardt
$ curl -n https://your-app-name.herokuapp.com/streamers -d name=esl_sc2 -d max_quality=720p60
```
The `max_quality` parameter is optional and defaults to `best`. Typical stream
quality options are
`audio_only`, `160p`, `360p`, `480p`, `720p`, `720p60`, `1080p60`, `best`.
When any of the streamers goes live, the app will record the stream.
An RSS feed of all recordings is available at
`https://your-app-name.herokuapp.com/rss`.
Finally, to watch the latest recording, open the following URL in mpv, VLC,
QuickTime, or any other video player.
```sh
$ mpv https://your-app-name.herokuapp.com/latest/{streamer_name}
```
## API
- `POST /streamers -d name= -d max_quality=`
Track a new streamer.
Requires auth.
- `DELETE /streamers/{streamer_name}`
Delete a streamer. WARNING: Deletes all associated recordings too.
Requires auth.
- `GET /latest/{streamer_name}`
Get the latest recorded stream.
- `POST /settings -d ping_start_hour= -d ping_end_hour=`
Modify ping settings. On Heroku, offstream keeps itself awake 24/7 by pinging
itself periodically. You can save some dyno hours by changing the
`ping_start_hour` and `ping_end_hour` settings to let the app sleep when no
one is streaming.
Requires auth.
- `GET /rss` or `GET /rss?limit=100`
RSS feed of recent recordings.
## Configuration
The following environment variables are supported.
- `OFFSTREAM_FLUSH_THRESHOLD`
Default: automatically calculated, normally `100000000` bytes (100M).
- `OFFSTREAM_CHECK_INTERVAL`
Default: `120` seconds
- `OFFSTREAM_IPFS_API_ADDR`
Default: `/dns/ipfs.infura.io/tcp/5001/https`
- `OFFSTREAM_IPFS_GATEWAY_URI_TEMPLATE`
Default: `https://{cid}.ipfs.infura-ipfs.io/{path}`
- `OFFSTREAM_MAX_CONCURRENT_RECORDERS`
Default: `5`
- `DATABASE_URL`
Default: `sqlite:///$HOME/.offstream/offstream.db`
- `TZ`
Preferred timezone, e.g. `America/New_York`. Please see
https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
## FAQ
- Q: My video player reports the following error:
`keepalive request failed for 'https://bafybeie3v6lomkfti2b4zsa4yj35nypojllvjrzpbzyxhn5tkfoqaswmbm.ipfs.infura-ipfs.io/18846.ts'`
A: This warning can be safely ignored. It's because Infura keeps the root
content identifier (CID) in a subdomain, rather than in the path portion of
the URL.
## See Also
Please also check out the [streamlink](https://streamlink.github.io/) project.