gitea-mirror/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2026-02-04 19:12:11 -08:00
Code Issues Packages Projects Releases Wiki Activity

docs(ml,server): updated hwaccel docs (#6878)

Browse Source
This commit is contained in:
Mert
2024-02-03 09:11:53 -05:00
committed by GitHub
parent a4cfb51df5
commit 329659b2fb
2 changed files with 95 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/docs/features/hardware-transcoding.md
View File

@@ -4,6 +4,10 @@ This feature allows you to use a GPU to accelerate transcoding and reduce CPU lo
Note that hardware transcoding is much less efficient for file sizes.
As this is a new feature, it is still experimental and may not work on all systems.
:::info
You do not need to redo any transcoding jobs after enabling hardware acceleration. The acceleration device will be used for any jobs that run after enabling it.
:::
## Supported APIs
- NVENC (NVIDIA)
@@ -50,6 +54,40 @@ As this is a new feature, it is still experimental and may not work on all syste
3. Redeploy the `immich-microservices` container with these updated settings.
4. In the Admin page under `Video transcoding settings`, change the hardware acceleration setting to the appropriate option and save.
#### Single Compose File
Some platforms, including Unraid and Portainer, do not support multiple Compose files as of writing. As an alternative, you can "inline" the relevant contents of the [`hwaccel.transcoding.yml`][hw-file] file into the `immich-microservices` service directly.
For example, the `qsv` section in this file is:
```yaml
devices:
- /dev/dri:/dev/dri
```
You can add this to the `immich-microservices` service instead of extending from `hwaccel.transcoding.yml`:
```yaml
immich-microservices:
container_name: immich_microservices
image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
# Note the lack of an `extends` section
devices:
- /dev/dri:/dev/dri
command: ['start.sh', 'microservices']
volumes:
- ${UPLOAD_LOCATION}:/usr/src/app/upload
- /etc/localtime:/etc/localtime:ro
env_file:
- .env
depends_on:
- redis
- database
restart: always
```
Once this is done, you can continue to step 3 of "Basic Setup".
#### All-In-One - Unraid Setup
##### NVENC - NVIDIA GPUs
@@ -59,20 +97,6 @@ As this is a new feature, it is still experimental and may not work on all syste
3. Restart the container app.
4. Continue to step 4 of "Basic Setup".
##### Other APIs
Unraid does not currently support multiple Compose files. As an alternative, you can "inline" the relevant contents of the [`hwaccel.transcoding.yml`][hw-file] file into the `immich-microservices` service directly.
For example, the `qsv` section in this file is:
```
devices:
- /dev/dri:/dev/dri
```
You can add this to the `immich-microservices` service instead of extending from `hwaccel.transcoding.yml`.
Once this is done, you can continue to step 3 of "Basic Setup".
## Tips
- You may want to choose a slower preset than for software transcoding to maintain quality and efficiency