From af9f20925df648a695bfefb431518629a60a23e6 Mon Sep 17 00:00:00 2001 From: Glyphscribe Ety Date: Sun, 27 Apr 2025 12:13:41 -0500 Subject: [PATCH] fix readme links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 79e7416..b9e998b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # owncast-clipper -WIP: a bot that listens for clip requests from owncast chat and uploads to a configured peertube instance. +A simple and single-purpose bot which provides a clip command to Owncast stream viewers and automatically uploads to a specified PeerTube instance. ## ✅ Preparation Beyond easily-discoverable information such as user credentials and base URLs, there are two pieces of information needed which non-technical users may struggle with: the Owncast Access Token and the PeerTube channel ID. @@ -9,7 +9,7 @@ Can be found by visiting the `Integrations -> Acess Tokens` page of the Owncast 1. Visit the Access Tokens page of your Owncast Admin interface. If your instance is `https://stream.person.site`, the page may be found at `https://stream.person.site/admin/access-token`. 2. You'll need to Create an Access Token and name it appropriately (something like "Clip Bot" is a good starting point). It will require the "Can send chat messages on behalf of the owner of this token" permission. -3. Once the token is created, you'll be able to retrieve it by clicking on the eye icon to unhide the token, then copying and pasting into the `OWNCAST_AUTH` variable as described [below](#⚙️-configuration). +3. Once the token is created, you'll be able to retrieve it by clicking on the eye icon to unhide the token, then copying and pasting into the `OWNCAST_AUTH` variable as described [below](#-configuration). ### PeerTube Channel ID This one is a little trickier to get, because the value that we need isn't directly exposed via the UI. Here's what to do: @@ -17,7 +17,7 @@ This one is a little trickier to get, because the value that we need isn't direc 2. You want the part of the URL between the `/c/` and `/videos`: in this case: `cool_channel`. 3. Adjust the following URL to match your environment and open it in your browser: `https://peertube.video.site/api/v1/video-channels/cool_channel`. 4. Your browser may or may not format the raw data, but you're looking for the _first_ instance of "id" in the response. If your browser is showing you raw data, you can just do a text search for "id". -5. The number immediately following "id" is your Channel ID! Copy and paste it into your `PEERTUBE_CHANNEL_ID` variable as described [below](#⚙️-configuration). +5. The number immediately following "id" is your Channel ID! Copy and paste it into your `PEERTUBE_CHANNEL_ID` variable as described [below](#-configuration). ## ⚙️ Configuration At the moment, configuration is performed exclusively through environment variables.