Skip to content

README.md

Latest commit

 

History

History
265 lines (209 loc) · 6.58 KB

README.md

File metadata and controls

265 lines (209 loc) · 6.58 KB
Raw

Emby

Build Status Last Commit OCI Pulls mlock Required

Personal media server with apps on just about every device.
Port 8096
Registry ghcr.io/daemonless/emby
Source https://github.com/MediaBrowser/Emby
Website https://emby.media/

Version Tags

Tag Description Best For
latest / pkg FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.
beta Upstream Binary. Built from official release. Alternative build.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  emby:
    image: "ghcr.io/daemonless/emby:latest"
    container_name: emby
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/path/to/containers/emby:/config"
    ports:
      - "8096:8096"
    annotations:
      org.freebsd.jail.allow.mlock: "true"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=emby
PUID=1000
PGID=1000
TZ=UTC

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  emby:
    name: emby
    options:
      - container: 'args:--pull'
      - expose: '8096:8096 proto:tcp'
      - template: !ENV '${PWD}/template.conf'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - emby: /config
volumes:
  emby:
    device: '/path/to/containers/emby'

Makejail:

# Makejail

ARG tag=pkg

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/emby:${tag}

template.conf:

# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.mlock

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Podman CLI

podman run -d --name emby \
  -p 8096:8096 \
  --annotation 'org.freebsd.jail.allow.mlock=true' \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/emby:/config \
  ghcr.io/daemonless/emby:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o template=template.conf \
  -o expose="8096:8096 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -o fstab="/path/to/containers/emby /config <pseudofs>" \
  ghcr.io/daemonless/emby:latest emby

template.conf:

# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.mlock

Save the files above, then run sh run.sh.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  emby:
    name: emby
    image: "ghcr.io/daemonless/emby:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/path/to/containers/emby:/config"

Save as bastille-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --volume /path/to/containers/emby /config \
  emby ghcr.io/daemonless/emby:latest inherit

Ansible

- name: Deploy emby
  containers.podman.podman_container:
    name: emby
    image: "ghcr.io/daemonless/emby:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "8096:8096"
    volumes:
      - "/path/to/containers/emby:/config"
    annotation:
      org.freebsd.jail.allow.mlock: "true"

Save as emby-deploy.yaml, then run ansible-playbook emby-deploy.yaml.

Access at: http://localhost:8096

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container

Volumes

Path Description
/config Configuration and data directory

Ports

Port Protocol Description
8096 TCP Web UI

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1

Need help? Join our Discord community.