Owncast fork for Jannik Volkland's bachelor thesis

This is a fork of the Owncast project which aims to implement an online transcription service into Owncast. As part of my bachelor thesis, I cannot accept pull requests at this point. Also, please do not expect the master branch to be as reliable as on the Owncast master branch.

This fork appeared after the v0.0.6 release.

For any issues besides the transcription, please visit the Owncast issues page and our RocketChat.

Building from Source with AWS integration

1. Create an AWS account if you don't have one already.
2. In IAM, create an user with "Programmatic Access" and access to AmazonTranscribeFullAccess.
3. Generate a key pair and save it in $HOME/.aws/credentials:

[default]
aws_access_key_id = <Access key ID>
aws_secret_access_key = <Secret access key>

1. Configure the application acc. to the instructions below.
2. Start the application with ./start.sh.

Building from Source with Azure integration

1. Ensure you have the gcc compiler configured.
2. Install the Go toolchain.
3. Install the Microsoft Azure Speech SDK for Go
4. Clone the repo. git clone https://github.com/owncast/owncast
5. Update start.sh to contain the right paths.
6. ./start.sh will run from source.
7. Point your broadcasting software at your new server and start streaming.

Building from Source with Google integration

1. Make sure you have a GCP account with a project and a service account. Activate the "Speech-to-Text" feature and download a JSON key.
2. Clone the repo (see Azure).
3. Edit start.sh to contain the path to your key file.
4. ./start.sh

Configuration

Copy the transcription-example.yaml file to transcription.yaml and edit accordingly. Edit the configuration according to the documentation.

Use WebVTT instead of WebSockets

This build usually uses the WebSockets delivery method, since it works better in most environments. If you are looking to use WebVTT instead, please edit ./start.sh to build Owncast with -tags webvtt.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project chat: Join us on Rocket.Chat if you want to contribute, follow along, or if you have questions.

Jannik Volkland - @jannik@uelfte.club - email jvolklan@th-koeln.de

Project Link: https://github.com/owncast/owncast