owncast-webhook/README.md
2025-08-29 13:02:55 +02:00

40 lines
861 B
Markdown

# Owncast webhook server and chat aggregator
This project provides a webhook server for Owncast.
It implements the webhook triggered when a new message is posted in the chat. It also allows retrieving messages from a Twitch channel and displaying them together on a page that can be embedded into OBS.
## Installation
Requirements: nodejs (tested with >=22), golang (tested with >=1.24)
```
git clone https://gitnet.fr/deblan/owncast-webhook
npm i
make build
```
## Configuration
### Server side
```
cp config.ini.example config.ini
```
### Owncast
Add a webhook (Integration > Webhooks):
- URL: `{server.base_url}/webhook/{server.webhook_secret}/owncast/chat_message`
- Events: `When a user sends a chat message`
### OBS
You can embed the chat using this URL: `{server.base_url}/chat/messages`
## Usage
```
./owncast-webhook -c ./config.ini
```