Bump packages

Also rename docker-compose.yml and add note about using a .env file

.gitignore

@@ -0,0 +1,2 @@
+recordings/
+.env

Dockerfile

@@ -1,10 +1,10 @@
-FROM python:3.11.2-alpine3.17
+FROM python:3.11.3-alpine3.18
 
 RUN apk add --no-cache tini=0.19.0-r1
 
-RUN apk add --no-cache ffmpeg=5.1.2-r1
+RUN apk add --no-cache ffmpeg=6.0-r14
 
-RUN python -m pip install --no-cache-dir --upgrade streamlink==5.3.1
+RUN python -m pip install --no-cache-dir --upgrade streamlink==5.5.1
 
 COPY twitch-recorder.py /opt/
 

README.md

@@ -15,7 +15,7 @@ The container needs a few configuration parameters. These are:
 `CLIENT_ID` - you can grab this from [here](https://dev.twitch.tv/console/apps) once you register your application (Replace with your own!) 
 `CLIENT_SECRET` - you generate this [here](https://dev.twitch.tv/console/apps) as well, for your registered application (Replace with your own!) 
 `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 
- only add the string consisting of 30 alphanumerical characters without any quotations
+ (Only add the string consisting of 30 alphanumerical characters without any quotations!)
 
 ## Usage
 Start the container with the following `docker run` command: 
@@ -32,7 +32,7 @@ The options in this command:
 `-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. 
 `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.
 
-You can also run it as a Docker Compose setup, see [docker-compose.yml](docker-compose.yml). 
+You can also run it as a Docker Compose setup, see [docker-compose.example.yml](docker-compose.example.yml). 
 If you want to build the image while using Compose (ie. you changed the UID/GID) run `docker-compose up -d --build`.
 
 ## Notes

docker-compose.yml → docker-compose.example.yml

@@ -21,6 +21,9 @@ services:
  - /path/to/recordings:/opt/recordings
  restart: unless-stopped
 
+ # I'd recommend to remove the "=" and values after CLIENT_ID, CLIENT_SECRET
+ # and AUTH_TOKEN and set them in a `.env` file instead.
+
  # If you want to run it for multiple streamers:
  # - duplicate the whole "tsr" section
  # - change the "twitch-stream-recorder" service name to something else