v0.0.1 released

README.md

@@ -1,61 +1,14 @@
-# Hardware h264 encoding using vaapi
+# Hardware h264 encoding using NVIDIA NVENC
 
-This plugin tries to enable hardware accelerated transcoding profiles using vaapi on linux. It should be considered experimental and tinkering will certainly be necessary to make this plugin work on your hardware.
+This plugin tries to enable hardware accelerated transcoding profiles using nvenc on linux. It should be considered experimental and tinkering will certainly be necessary to make this plugin work on your hardware.
 
 
-For more information on vaapi and hardware acceleration:
+For more information on nvenc and hardware acceleration:
 
 - https://jellyfin.org/docs/general/administration/hardware-acceleration.html#enabling-hardware-acceleration
 - https://wiki.archlinux.org/index.php/Hardware_video_acceleration#Comparison_tables
 
 
-# Building a compatible docker image
+# Building and running a compatible docker image
 
-Official docker images do not ship with required libraries for hardware transcode.
-You can build your own image with the following Dockerfile:
-
-```Dockerfile
-ARG VERSION=v4.2.0
-FROM chocobozzz/peertube:${VERSION}-bullseye
-
-
-# install dependencies for vaapi
-RUN 	   apt update \
-	&& apt install -y --no-install-recommends wget apt-transport-https \
-	&& echo "deb http://deb.debian.org/debian/ $( awk -F'=' '/^VERSION_CODENAME=/{ print $NF }' /etc/os-release ) non-free" | tee /etc/apt/sources.list.d/non-free.list \
-	&& apt update \
-	&& apt install -y --no-install-recommends vainfo i965-va-driver-shaders \
-	&& apt install -y --no-install-recommends python3 \
-	&& rm /var/lib/apt/lists/* -fR
-```
-
-If you are using a recent Intel CPU (generation 8 and newer), replace `i965-va-driver-shaders` by `intel-media-va-driver-non-free`.
-
-
-# Running the docker image
-
-In order to access the GPU inside docker, the `docker-compose.yml` should be adapted as follow.
-Note that you must find the id of the `render` group on your machine.
-You can use `grep render /etc/group | cut -d':' -f3`  to find the id.
-
-
-```yaml
-version: "2"
-
-services:
-  peertube:
-    # replace image key with
-    build:
-      context: .
-      args:
-        VERSION: v5.0.1
-    # usual peertube configuration
-    # ...
-
-    # add these keys
-    group_add:
-      - <replace with the id of the render group>
-    devices:
-      # VAAPI Devices
-      - /dev/dri:/dev/dri
-```
+ - https://github.com/ryanho/peertube-hwaccel