Skip to content

Latest commit

 

History

History
134 lines (94 loc) · 6.16 KB

README.md

File metadata and controls

134 lines (94 loc) · 6.16 KB
Raw

Mediatheken DLNA Bridge

Mediatheken DLNA Bridge is a java standalone program, which consumes contents of various (german) Mediatheken, and serves its content to your local network using DLNA.

Find us at our HOME.

See LICENSE for the Mediatheken DLNA Bridge license.

For a list of all authors, see the AUTHORS file.

Usage

There are two options running the Mediatheken DLNA Bridge: Local installation, or docker.

Local installation

  • Download latest tar.gz from the RELEASES page.
  • unpack it
  • run the provided JAR file with java -jar mediatheken-dlna-bridge.jar.
  • you may give a java parameter -Xmx256m or so for a memory limit. The memory will be used for a lucene query cache. Giving it more than 512MB doesn't improve things.

You may override any setting in three ways:

  • Create a file config/application.properties, and put the settings there, or
  • Add the settings to your java command line with -DSETTING=VALUE, or
  • Create environment variables SETTING=VALUE

A local index directory will be created in a directory local to your working directory. It's a Lucene index. Feel free to dig into it.

Docker installation

Find the released Docker images at DOCKERHUB. Simply run them with:

docker run corelogicsde/mediatheken-dlna-bridge:latest

You may set a memory limit with adding --memory=500M to the docker line. The memory will be used for a lucene query cache. 128MB seem to work fine, and giving it more than 500 MB doesn't improve things.

You may override any setting in two ways:

  • set environment variables with -e SETTING=VALUE. These will be picked up by the image.
  • create a configuration file, and link it into /app/config/application.properties.

The image will then run with host networking, which should usually be fine.

Docker Compose

Use something like this docker-compose.yaml:

version: "3.3"

services:
  mediathekbridge:
    image: "corelogicsde/mediatheken-dlna-bridge"
    restart: unless-stopped
    deploy:
      resources:
        limits:
          memory: 256M
    # This volume can be used to store the lucene index outside of the container
    #volumes:
    #  - source: ./data/mediathek-data
    #    target: /app/data
    #    type: bind
    #  - source: ./data/mediathek-cache
    #    target: /app/cache
    #    type: bind
    # You may overwrite any property here, i.e. the Database Location
    environment:
       DISPLAY_NAME: "My Mediathek DLNA Bridge"
    #  ENABLE_VIEWTRACKING: "true"
    #  DATABASE_LOCATION: /app/data/clipdb
    #  ENABLE_PREFETCHING: 'true'
    #  CACHE_SIZE_GB: '30'

Configuration

Common configuration

  • DATABASE_LOCATION points to the directory and name of the lucene index directory. Defaults to ./data/clipdb
  • UPDATEINTERVAL_FULL_HOURS number of hours between full db updates. Defaults to 24.
  • DISPLAY_NAME under this name, the Mediatheken-DLNA-Bridge will be visible in your network. Defaults to Mediatheken.
  • PUBLIC_HTTP_PORT all DLNA and media data (if prefetching is enabled) will be answered using this port number. Defaults to 9301.
  • ENABLE_VIEWTRACKING: a boolean value (true) indicates that all views should be tracked, and it will give you another menu entry (Meistgesehen). Defaults to false

Configuration for prefetching

  • ENABLE_PREFETCHING (boolean) decides if prefetching is turned on. Defaults to false.
  • PUBLIC_BASE_URL optionally specifies the public address of the prefetching HTTP server. Could be http://<your-hostname>:9301/ or any other location, if you put this behind a reverse proxy. By default, files are served on the address where the query was received.
  • CACHE_DIRECTORY is path to a directory where prefetched files are placed. May be absolute or relative to the run directory. It defaults to ./cache.
  • CACHE_SIZE_GB the amount of disk space (in Gigabyte) dedicated to prefetched files. Defaults to 10. Values below 10GB are rejected.
  • CACHE_DOWNLODERS_PER_VIDEO number of parallel connections, per video, that are used to fetch the file. Defaults to 2.
  • CACHE_MAX_PARALLEL_DOWNLOADS number of videos that can be prefetched in parallel. Defaults to 4. Note that each downloads requires at least 1.3MBytes/s of bandwidth!

Configure prefetching

Sometimes the Mediatheken's CDN is slow. Most of the time, that only means that some servers, or clusters are slow, over some time.

Using prefetching, the Mediatheken-Dlna-Bridge will try to fetch in advance your videos, discard servers that are too slow to handle the required bandwidth.

To use prefetching, you need to:

  • create, and maybe mount a temporary directory for prefetched files
  • configure the base URL, where this server will be reachable, using the PUBLIC_HTTP_PORT configuration. For standalone operation, this will be http://<hostname>:8080/. For docker, the port may differ. You are free to place the Mediathek-Dlna-Bridge behind a reverse proxy. In that case, you may also add a URL prefix here.
  • maybe override the cache directory, using the CACHE_DIRECTORY configuration
  • decide on how much space you'll assign to prefetched videos. Use the CACHE_SIZE_GB configuration. Mediathek-Dlna-Bridge will never use more disk space than that.
  • set the 'ENABLE_PREFETCHING' configuration to true

Configure Favourites

Favourite entries appear at the root level of the DLNA directory tree, just befor all other entries.

You can configure what to display there. Currently, this is done by configuration settings (file, env, ... as you like).

Create entries starting with FAVOURITE_. All entries will be sorted alphabetically, and rendered in that order.

In the value, you configure what to display. Currently, only show entries are supported. Value is in the form:

FAVOURITE_1=show:<channel>:<show title>, i.e. FAVOURITE_ONE=show:ard:Tagesschau

All texts will be compared ignoring the case.