Skip to content

Commit 601f37e

Browse files
committed
Update README
- Minor formating changes - Move AUTH_TOKEN to advanced settings, it's not required
1 parent fd1767b commit 601f37e

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,44 @@
22
A Docker container to automatically record Twitch streams.
33

44
## Description
5-
This repository hosts the source code for a Docker container that can automatically record livestreams from Twitch as they go live.
5+
This repository hosts the source code for a Docker container that can automatically record livestreams from Twitch as they go live.
66
The main component is from [Ancalentari Twitch Stream Recorder](https://github.com/ancalentari/twitch-stream-recorder).
77

88
## Requirements
9-
To run this container and record streams from Twitch, you need to register a dummy app and get a client_id and client_secret. Both is explained in the setup section.
9+
To run this container and record streams from Twitch, you need to register a dummy app and get a `client_id` and `client_secret`.
10+
Both is explained in the setup section.
1011

1112
## Setup
1213
The container needs a few configuration parameters. These are:
1314

14-
`USERNAME` - name of the streamer you want to record (Change this accordingly!)
15-
`QUALITY` - this uses the streamlink [STREAM](https://streamlink.github.io/cli.html#cmdoption-arg-STREAM) setting to choose the quality to record.
16-
`CLIENT_ID` - you can grab this from [here](https://dev.twitch.tv/console/apps) once you register your application (Replace with your own!)
17-
`CLIENT_SECRET` - you generate this [here](https://dev.twitch.tv/console/apps) as well, for your registered application (Replace with your own!)
18-
`AUTH_TOKEN` - optionally your [OAuth Token](https://streamlink.github.io/cli/plugins/twitch.html#authentication) to prevent ad breaks if you're subscribed to the streamer.
19-
only add the string consisting of 30 alphanumerical characters without any quotations
15+
- `USERNAME` - Name of the streamer you want to record.
16+
- `QUALITY` - This uses the streamlink [STREAM](https://streamlink.github.io/cli.html#cmdoption-arg-STREAM) setting to choose the quality to record.
17+
- `CLIENT_ID` - You can grab this from [here](https://dev.twitch.tv/console/apps) once you register your application.
18+
- `CLIENT_SECRET` - You generate this [here](https://dev.twitch.tv/console/apps) as well, for your registered application.
2019

2120
Additionally, there are more advanced settings to set:
2221

23-
`DISABLE_FFMPEG` - disables ffmpeg processing (fixing errors in recorded file) (Optional, defaults to True, Use "True" or "False")
24-
`REFRESH` - the interval to check user availability (Optional, can't be set below 15, defaults to 15)
22+
- `AUTH_TOKEN` - Your [OAuth Token](https://streamlink.github.io/cli/plugins/twitch.html#authentication) to prevent ad breaks if you're subscribed to the streamer.
23+
Only add the string consisting of 30 alphanumerical characters without any quotations. (Optional)
24+
- `DISABLE_FFMPEG` - Disables ffmpeg processing (fixing errors in recorded file). (Optional, defaults to `True`, Use `True` or `False`.)
25+
- `REFRESH` - The interval to check user availability. (Optional, can't be set below `15`, defaults to `15`.)
2526

2627
## Usage
27-
Start the container with the following `docker run` command:
28+
Start the container with the following `docker run` command:
29+
2830
```bash
2931
docker run -d \
3032
-e USERNAME=your_favourite_streamer \
3133
-e QUALITY=best \
3234
-e CLIENT_ID=your_client_id \
3335
-e CLIENT_SECRET=your_client_secret \
34-
-e AUTH_TOKEN=your_oauth_token_cookie \
3536
-v /path/to/recordings:/opt/recordings \
3637
ghcr.io/mkody/twitch-stream-recorder:master
3738
```
39+
3840
The options in this command:
39-
`-v /path/to/recordings:/opt/recordings` Map a folder of your choice (left of ":") to a defined location in the container (right of ":"). This is the place where all recordings will be saved to.
40-
`ghcr.io/mkody/twitch-stream-recorder:master` Use the "master" tag for the latest version, that's the GitHub branch from which the Docker images will be built.
41+
- `-v /path/to/recordings:/opt/recordings` - Map a folder of your choice (left of ":") to a defined location in the container (right of ":"). This is the place where all recordings will be saved to.
42+
- `ghcr.io/mkody/twitch-stream-recorder:master` - Use the "master" tag for the latest version, that's the GitHub branch from which the Docker images will be built.
4143

4244
You can also run it as a Docker Compose setup, see [docker-compose.example.yml](docker-compose.example.yml).
43-
If you want to build the image while using Compose (ie. you changed the UID/GID) run `docker-compose up -d --build`.
45+
If you want to build the image while using Compose (i.e. you changed the UID/GID) run `docker compose up -d --build`.

0 commit comments

Comments
 (0)