diff --git a/README.md b/README.md index b9e998b..fd9fc60 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ At the moment, configuration is performed exclusively through environment variab | Variable | Description | Required | | :------- | :---------- | :------: | -| PEERTUBE_HOST | The base URL for the PeerTube server we're uploading to, e.g. https://peertube.video.site | **Yes** | +| PEERTUBE_HOST | The base URL for the PeerTube server we're uploading to, e.g. `https://peertube.video.site` | **Yes** | | PEERTUBE_USER | The username of the account authorized to post to PeerTube | **Yes** | | PEERTUBE_PASS | The password of the account authorized to post to PeerTube | **Yes** | | PEERTUBE_CHANNEL_ID | The internal "channel id" of the PeerTube channel we're uploading clips to. Described [above](#peertube-channel-id). | **Yes** | @@ -67,8 +67,7 @@ services: - OWNCAST_AUTH=AReallyLongOwncastAccessTokenString # Owncast access token with chat permission ``` +## 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. -CLIP_DIRECTORY, TEMP_DIRECTORY, CLIP_QUANTITY = None, None, None -PEERTUBE_HOST, PEERTUBE_USER, PEERTUBE_PASS = None, None, None -OWNCAST_HOST, OWNCAST_AUTH = None, None -AUTHENTICATION_REQUIRED, PT_API_BASE, PEERTUBE_CHANNEL_ID = None, None, None +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. \ No newline at end of file