calls-transcriber

module
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2024 License: Apache-2.0

README

calls-transcriber

A headless speech transcriber for Mattermost Calls.

Usage

This program is not meant to be run directly (nor manually) other than for development/testing purposes. In fact, this is automatically used by the calls-offloader service to run transcribing jobs. Please refer to that project if you are looking to enable call transcriptions in your Mattermost instance.

Manual execution (testing only)

Fetch the latest image

The latest official docker image can be found at https://hub.docker.com/r/mattermost/calls-transcriber.

docker pull mattermost/calls-transcriber:latest
Run the container
docker run --network=host --name calls-transcriber -e "SITE_URL=http://127.0.0.1:8065/" -e "AUTH_TOKEN=ohqd1phqtt8m3gsfg8j5ymymqy" -e "CALL_ID=9c86b3q57fgfpqr8jq3b9yjweh" -e "POST_ID=e4pdmi6rqpn7pp9sity9hiza3r" -e "DEV_MODE=true" -v calls-transcriber-volume:/recs mattermost/calls-transcriber

Note

This process requires:

  • Mattermost Server >= v7.8
  • Mattermost Calls >= v0.19.0

Note

  • SITE_URL: The URL pointing to the Mattermost installation.
  • AUTH_TOKEN: The authentication token for the Calls bot.
  • CALL_ID: The channel ID in which the call to transcribe has been started.
  • POST_ID: The post ID the transcription file(s) should be attached to.

Note

The auth token for the bot can be found through this SQL query:

SELECT Token FROM Sessions JOIN Bots ON Sessions.UserId = Bots.UserId AND Bots.OwnerId = 'com.mattermost.calls' ORDER BY Sessions.CreateAt DESC LIMIT 1;
Development

Run make help to see available options.

Directories

Path Synopsis
cmd
transcriber/ogg
Package oggreader implements the Ogg media container reader
Package oggreader implements the Ogg media container reader

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL