Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.58 KB

README.md

File metadata and controls

57 lines (36 loc) · 2.58 KB
Raw

Live Stream Recorder

How to use

  • Volume mount output folder to /download
  • Replace [TWITCASTING_ID] in the following command with the channel id you want to monitor.
  • Any other arguments will be passed to the underlying python script. Check TwitCasting Recorder for more information.

Monitor (default)

The standard operation is to monitor the channel, checking every 10 seconds, and record the live stream when it is live.
To modify the interval frequency, you can specify the argument such as loop 60.

docker run --rm -v ".:/download" ghcr.io/jim60105/twitcasting-recorder [TWITCASTING_ID]
docker run --rm -v ".:/download" ghcr.io/jim60105/twitcasting-recorder [TWITCASTING_ID] loop 60

Also available at quay.io

Run once

Use once as the argument to run the script once and exit.

docker run --rm -v ".:/download" ghcr.io/jim60105/twitcasting-recorder [TWITCASTING_ID] once

Run once and specify output file name

Any other arguments will be passed to the underlying python script. Check TwitCasting Recorder for more information.

docker run --rm -v ".:/download" ghcr.io/jim60105/twitcasting-recorder [TWITCASTING_ID] once -o [OUTPUT_FILE_NAME]

Discord webhook notification

The functionality of Discord webhook notification can be config by using the environment variables.
While it is possible to use the -e option with docker run, it is strongly advised to use docker-compose deployment for a better choice.

  1. Clone this git repo.
  2. Copy .env_sample to .env
  3. Fill out .env
  4. docker-compose up -d

LICENSE

open graph

GNU GENERAL PUBLIC LICENSE Version 3

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.