ety/owncast-clipper
1
0
Fork 0
Code Issues Packages Activity

clarify docs

Browse Source
This commit is contained in:
Glyphscribe Ety 2025-04-27 12:39:01 -05:00
parent 324526ebe1
commit 48c6ef84e9
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -18,7 +18,7 @@ Can be found by visiting the `Integrations -> Acess Tokens` page of the Owncast
### PeerTube Channel ID ### 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: 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:
1. Go to your Channel (not _User_) page on PeerTube. If your PeerTube instance is `https://peertube.video.site` and your channel name is `Cool Channel`, you should have a URL like this: `https://peertube.video.site/c/cool_channel/videos`. 1. Go to your Channel (not _User_) page on PeerTube. If your PeerTube instance is `https://peertube.video.site`, and your channel name is `Cool Channel`, you should have a URL like this: `https://peertube.video.site/c/cool_channel/videos`.
2. You want the part of the URL between the `/c/` and `/videos`: in this case: `cool_channel`. 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`. 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". 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".
@ -35,9 +35,9 @@ At the moment, configuration is performed exclusively through environment variab
| PEERTUBE_CHANNEL_ID | The internal "channel id" of the PeerTube channel we're uploading clips to. Described [above](#peertube-channel-id). | **Yes** | | PEERTUBE_CHANNEL_ID | The internal "channel id" of the PeerTube channel we're uploading clips to. Described [above](#peertube-channel-id). | **Yes** |
| OWNCAST_HOST | The base URL for the PeerTube server we're making API calls against, e.g. `https://coolstream.site` or `http://app:8080` | **Yes** | | OWNCAST_HOST | The base URL for the PeerTube server we're making API calls against, e.g. `https://coolstream.site` or `http://app:8080` | **Yes** |
| OWNCAST_AUTH | A valid Owncast Access Token, with access to the User Chat scope. Described [above](#owncast-access-token). | **Yes** | | OWNCAST_AUTH | A valid Owncast Access Token, with access to the User Chat scope. Described [above](#owncast-access-token). | **Yes** |
| CLIP_DIRECTORY | The directory where source .ts files from owncast will be collected. /var/data/hls/0/ by default. | No | | CLIP_DIRECTORY | The directory where source .ts files from owncast will be collected. `/var/data/hls/0/` by default. | No |
| TEMP_DIRECTORY | The directory where intermediate remuxed .mp4 files will be stored. /tmp/ by default. | No | | TEMP_DIRECTORY | The directory where intermediate remuxed .mp4 files will be stored. `/tmp/` by default. | No |
| CLIP_QUANTITY | The maximum number of segment files to attempt to collect to make a clip. 20 by default. | No | | CLIP_QUANTITY | The maximum number of segment files to attempt to collect to make a clip. `20` by default. | No |
## Example docker-compose.yml ## Example docker-compose.yml
```yaml ```yaml
@ -75,4 +75,4 @@ services:
## Considerations ## Considerations
At the moment, this project is mostly intended to be run in a docker compose context alongside an existing owncast installation, because that matches my deployment. If there's interest in updating this project to run standalone, this can probably be done, I just didn't want to spend the effort on it yet without any interest. At the moment, this project is mostly intended to be run in a docker compose context alongside an existing owncast installation, because that matches my deployment. If there's interest in updating this project to run standalone, this can probably be done, I just didn't want to spend the effort on it yet without any interest.
Becauase the permissions on the Owncast hls folder are restrictive, it's easiest if you force both the `owncast` and `owncast-clipper` containers to run as the same user. If your Owncast instance already exists and you haven't been running it as a specific user already, you may need to `chown` your owncast directory to the new service user. Becauase the permissions on the Owncast `hls` folder are restrictive, it's easiest if you force both the `owncast` and `owncast-clipper` containers to run as the same user. If your Owncast instance already exists and you haven't been running it as a specific user already, you may need to `chown` your owncast directory to the new service user.