mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
docker-documentation/docs/images/docker-emby.md

18 KiB
Czysty Bezpośredni odnośnik Wina Historia

title tags description
emby
Media Servers
Music
Audiobooks
[Emby](https://emby.media/) organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server.

linuxserver/emby

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server.

emby

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/emby:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 ✅ amd64-<version tag>
arm64 ✅ arm64v8-<version tag>
armhf ❌

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag Available Description
latest ✅ Stable emby releases
beta ✅ Beta emby releases

Application Setup

Webui can be found at http://<your-ip>:8096

Emby has very complete and verbose documentation located here .

Hardware Acceleration Enhancements

This section lists the enhancements we have made for hardware acceleration in this image specifically.

OpenMAX (Raspberry Pi)

Hardware acceleration users for Raspberry Pi MMAL/OpenMAX will need to mount their /dev/vcsm and /dev/vchiq video devices inside of the container and their system OpenMax libs by passing the following options when running or creating the container:

--device=/dev/vcsm:/dev/vcsm
--device=/dev/vchiq:/dev/vchiq
-v /opt/vc/lib:/opt/vc/lib

V4L2 (Raspberry Pi)

Hardware acceleration users for Raspberry Pi V4L2 will need to mount their /dev/video1X devices inside of the container by passing the following options when running or creating the container:

--device=/dev/video10:/dev/video10
--device=/dev/video11:/dev/video11
--device=/dev/video12:/dev/video12

Hardware Acceleration

Many desktop applications need access to a GPU to function properly and even some Desktop Environments have compositor effects that will not function without a GPU. However this is not a hard requirement and all base images will function without a video device mounted into the container.

Intel/ATI/AMD

To leverage hardware acceleration you will need to mount /dev/dri video device inside of the container.

--device=/dev/dri:/dev/dri

We will automatically ensure the abc user inside of the container has the proper permissions to access this device.

Nvidia

Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-container-toolkit

We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-container-toolkit is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the container.

Arm Devices

Best effort is made to install tools to allow mounting in /dev/dri on Arm devices. In most cases if /dev/dri exists on the host it should just work. If running a Raspberry Pi 4 be sure to enable dtoverlay=vc4-fkms-v3d in your usercfg.txt.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

!!! info

Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  emby:
    image: lscr.io/linuxserver/emby:latest
    container_name: emby
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/emby/library:/config
      - /path/to/tvshows:/data/tvshows
      - /path/to/movies:/data/movies
      - /opt/vc/lib:/opt/vc/lib #optional
    ports:
      - 8096:8096
      - 8920:8920 #optional
    devices:
      - /dev/dri:/dev/dri #optional
      - /dev/vchiq:/dev/vchiq #optional
      - /dev/video10:/dev/video10 #optional
      - /dev/video11:/dev/video11 #optional
      - /dev/video12:/dev/video12 #optional
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=emby \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 8096:8096 \
  -p 8920:8920 `#optional` \
  -v /path/to/emby/library:/config \
  -v /path/to/tvshows:/data/tvshows \
  -v /path/to/movies:/data/movies \
  -v /opt/vc/lib:/opt/vc/lib `#optional` \
  --device /dev/dri:/dev/dri `#optional` \
  --device /dev/vchiq:/dev/vchiq `#optional` \
  --device /dev/video10:/dev/video10 `#optional` \
  --device /dev/video11:/dev/video11 `#optional` \
  --device /dev/video12:/dev/video12 `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/emby:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
8096:8096 Http webUI.
8920:8920 Https webUI (you need to setup your own certificate).

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.

Volume Mappings (-v)

Volume Function
/config Emby data storage location. This can grow very large, 50gb+ is likely for a large collection.
/data/tvshows Media goes here. Add as many as needed e.g. /data/movies, /data/tv, etc.
/data/movies Media goes here. Add as many as needed e.g. /data/movies, /data/tv, etc.
/opt/vc/lib Path for Raspberry Pi OpenMAX libs optional.

Device Mappings (--device)

Parameter Function
/dev/dri Only needed if you want to use your Intel or AMD GPU for hardware accelerated video encoding (vaapi).
/dev/vchiq Only needed if you want to use your Raspberry Pi OpenMax video encoding (Bellagio).
/dev/video10 Only needed if you want to use your Raspberry Pi V4L2 video encoding.
/dev/video11 Only needed if you want to use your Raspberry Pi V4L2 video encoding.
/dev/video12 Only needed if you want to use your Raspberry Pi V4L2 video encoding.

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:

    docker exec -it emby /bin/bash

  • To monitor the logs of the container in realtime:

    docker logs -f emby

  • Container version number:

    docker inspect -f '{{ index .Config.Labels "build_version" }}' emby

  • Image version number:

    docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/emby:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

  • Update images:

    • All images:

      docker-compose pull

    • Single image:

      docker-compose pull emby

  • Update containers:

    • All containers:

      docker-compose up -d

    • Single container:

      docker-compose up -d emby

  • You can also remove the old dangling images:

    docker image prune

Via Docker Run

  • Update the image:

    docker pull lscr.io/linuxserver/emby:latest

  • Stop the running container:

    docker stop emby

  • Delete the container:

    docker rm emby

  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

  • You can also remove the old dangling images:

    docker image prune

Image Update Notifications - Diun (Docker Image Update Notifier)

!!! tip

We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-emby.git
cd docker-emby
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/emby:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

To help with development, we generate this dependency graph.

??? info "Init dependency graph"

```d2
"emby:latest": {
  docker-mods
  base {
    fix-attr +\nlegacy cont-init
  }
  docker-mods -> base
  legacy-services
  custom services
  init-services -> legacy-services
  init-services -> custom services
  custom services -> legacy-services
  legacy-services -> ci-service-check
  init-migrations -> init-adduser
  init-os-end -> init-config
  init-config -> init-config-end
  init-crontab-config -> init-config-end
  init-video -> init-config-end
  init-config -> init-crontab-config
  init-mods-end -> init-custom-files
  init-config -> init-emby-config
  base -> init-envfile
  base -> init-migrations
  init-config-end -> init-mods
  init-mods-package-install -> init-mods-end
  init-mods -> init-mods-package-install
  init-adduser -> init-os-end
  init-envfile -> init-os-end
  init-custom-files -> init-services
  init-emby-config -> init-video
  init-services -> svc-cron
  svc-cron -> legacy-services
  init-services -> svc-emby
  svc-emby -> legacy-services
}
Base Images: {
  "baseimage-ubuntu:noble"
}
"emby:latest" <- Base Images
```

Versions

  • 13.08.24: - Rebase to Ubuntu Noble.
  • 12.02.24: - Use universal hardware acceleration blurb
  • 19.01.24: - Fix tonemapping so it's done with hw acceleration.
  • 06.07.23: - Deprecate armhf. As announced here
  • 08.06.23: - Fix package extraction so it doesn't change /tmp perms.
  • 31.05.23: - Use upstream deb packages instead of rpm.
  • 26.09.22: - Update chown behavior.
  • 18.09.22: - Migrate to s6v3, rebase to Ubuntu Jammy.
  • 19.05.21: - Structural changes upstream.
  • 17.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information. Remove no longer used mapping for /transcode.
  • 21.12.20: - Rebase to Focal, see here for troubleshooting armhf.
  • 03.11.20: - Fix issue with missing samba folder.
  • 13.11.20: - Fix issue with samba and ffmpeg.
  • 03.07.20: - Add support for amd vaapi hw transcode.
  • 29.02.20: - Add v4l2 support on Raspberry Pi.
  • 26.02.20: - Add openmax support on Raspberry Pi.
  • 15.02.20: - Allow restarting emby from the gui (also allows for auto restarts after addon updates).
  • 02.10.19: - Improve permission fixing for render and dvb devices.
  • 13.08.19: - Add umask environment variable.
  • 24.06.19: - Fix typos in readme.
  • 30.05.19: - Initial release.