Portainer Templates logo

Portainer Templates

TinyMediaManager TinyMediaManager

Stack

Multimedia

TinyMediaManager is a media management tool written in Java/Swing. It is written to provide metadata for the Kodi Media Center (formerly known as XBMC), MediaPortal and Plex media server.

Image details

Pulls: 5.5M
Architecture: amd64, arm64
Image size: 658 MB
Latest: 5.3.1
User: tinymediamanager
Created: Jun 20, 2021
Updated: 6 days ago
Status: active

Source details

Repo: tinymediamanager/tinymediamanager
Stars: 8
Forks: 14
Updated: 4 years ago

Configuration

Type
Compose
Platform
linux
Image
tinymediamanager/tinymediamanager:latest
Ports
5900:59004000:4000
Volumes
/data : /portainer/Files/AppData/Config/tinemediamanager/data/media/movies : /portainer/movies/media/tvshows : /portainer/tvshows
Env vars
USER_ID=1000GROUP_ID=100ALLOW_DIRECT_VNC=trueLC_ALL=en_US.UTF-8LANG=en_US.UTF-8PASSWORD=tinymediamanager
Restart
unless-stopped
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying TinyMediaManager

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select TinyMediaManager, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  tinymediamanager:
    image: tinymediamanager/tinymediamanager:latest
    container_name: tinymediamanager
    environment:
      - USER_ID=1000
      - GROUP_ID=100
      - ALLOW_DIRECT_VNC=true
      - LC_ALL=en_US.UTF-8 # force UTF8
      - LANG=en_US.UTF-8   # force UTF8
      - PASSWORD=tinymediamanager
    volumes:
      - /portainer/Files/AppData/Config/tinemediamanager/data:/data
      - /portainer/movies:/media/movies
      - /portainer/tvshows:/media/tvshows
    ports:
      - 5900:5900 # VNC port
      - 4000:4000 # Webinterface
    restart: unless-stopped

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/tinymediamanager.yml up -d

More install options in our documentation, or see tinymediamanager/tinymediamanager for app-specific guidance.

tinyMediaManager offers an (experimental) official docker image based on Debian Buster (for maximum compatibility). This image includes all needed components (up to date libmediainfo, FFmpeg, ...) for the best experience. This image should work on any x8664 device.
Using this image, you will get a fully working instance of tinyMediaManager which is accessible remotely (via web/VNC).

Instructions

  • Map any local port to 4000 for web access (via noVNC)
  • Map a local volume/folder to /data where all local data from tinyMediaManager is stores (like data, logs, cache and backups)
  • Map local volumes/folders/mounts to /media/xxx where all media will be accessed. E.g.:
/mnt/movies -> /media/movies /mnt/tvshows -> /media/tvshows
  • If you want to add custom scrapers, you need to map the folder containing the custom addons to /app/addons
  • For the HTTP API access (v4.3+), you need to map the HTTP API port too
  • If you need special start parameters, you would need to map /app/launcher-extra.yml too (see https://www.tinymediamanager.org/docs/start-parameters)

Sample run command:

docker run \
    --name=tinymediamanager \
    -p 4000:4000 \
    -v </path/to/local/data/>:/data \
    -v </path/to/movies>:/media/movies \
    -v </path/to/tvshows>:/media/tvshows \
    --log-driver json-file \ 
    --log-opt max-size=20m \
    --log-opt max-file=5 \    
    tinymediamanager/tinymediamanager:latest

After starting the container, you can access tinyMediaManager via http://your-host-ip:4000.

Sample compose file

---
version: "2.1"
services:
  tinymediamanager:
    image: tinymediamanager/tinymediamanager:latest
    container_name: tinymediamanager
    environment:
      - USER_ID=1000
      - GROUP_ID=100
      - ALLOW_DIRECT_VNC=true
      - LC_ALL=en_US.UTF-8 # force UTF8
      - LANG=en_US.UTF-8   # force UTF8
      - PASSWORD=<password>
    volumes:
      - </path/to/local/data/>:/data
      - </path/to/movies>:/media/movies
      - </path/to/tv_shows/>:/media/tv_shows
    ports:
      - 5900:5900 # VNC port
      - 4000:4000 # Webinterface
    restart: unless-stopped
    logging: # restrict log size
      driver: "json-file"
      options:
        max-file: "5"   # number of files or file count
        max-size: "20m" # file size

Data volumes

You should map the following folders to a volume/folder on the host:
  • /data: where all local data of tinyMediaManager will be stores. If you do not map this out of the container, all your data/settings will be lost on an upgrade of tinyMediaManager
  • /media: contains all your data sources
  • /data/addons: where to put custom scrapers
  • /app/launcher-extra.yml: custom launch parameters - see https://www.tinymediamanager.org/docs/start-parameters

ATTENTION: If you want to use your own launcher-extra.yml you need to add the following lines to make tmm work as intended:

```

javaHome: "" jvmOpts: - "-Dtmm.contentfolder=/data" - "-Dtmm.noupdate=true" env: 
You need read/write access to all mapped volumes!

## Configuration

This image offers some special configuration parameters which can be passed to docker by using [environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)


<table><thead><tr><th>Variable      </th><th>  Description  </th><th>  Default  </th></tr></thead><tbody><tr><td>USER<em>ID</em></td><td>ID of the user tinyMediaManager runs as. See below for an example how to use this.</td><td>1000</td></tr><tr><td>GROUP<em>ID</em></td><td>ID of the group tinyMediaManager runs as. See below for an example how to use this.</td><td>1000</td></tr><tr><td>PASSWORD</td><td>Password for remote access</td><td></td></tr><tr><td>LC<em>TIME</em></td><td>Desired date/time format. <code>en_US.UTF-8</code> for 12 hour format, <code>C.UTF-8</code> for 24 hour format</td><td></td></tr><tr><td>TZ</td><td>Timezone</td><td></td></tr><tr><td>ALLOW<em>DIRECT</em>VNC</td><td>To access the VNC server directly</td><td>false</td></tr></tbody></table>

## Permissions

When using using data volumes (-v flags for `/data` and `media`), permissions issues can occur between the host and the container (tinyMediaManager). For example, the user within the container may not exist on the host or does not match the _right_ user on the host. This could prevent the container from properly accessing files and folders on the shared volume and vice versa. To avoid any problem, you can specify the user tinyMediaManager should run as.

This is done by passing the user ID and group ID to the container via the `USER_ID` and `GROUP_ID` environment variables.

To find the right IDs to use, issue the following command on the host, with the user owning the data volume on the host:
id 
Which gives an output like this one:
uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin) ```
The value of uid (user ID) and gid (group ID) are the ones that you should be given the container.

Clipboard

Because of security restrictions in the browser, your client clipboard cannot be synchronized to the clipboard of tinyMediaManager. To copy data from/to the remote connection of tinyMediaManager, you need to invoke the clipboard feature from noVNC. Just open the control panel of noVNC from the left side of the window and use the clipboard feature from there to copy the data.

Serve TinyMediaManager on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying tinymediamanager.example.com to http://tinymediamanager:5900

Add this to your Caddyfile

tinymediamanager.example.com {
	reverse_proxy http://tinymediamanager:5900
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:5900 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5900
  • Stop the other service, or pick a different host port. In 5900:5900 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:5900. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, tinymediamanager can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5900

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/tinemediamanager/data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull tinymediamanager/tinymediamanager:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

TinyMediaManager is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything TinyMediaManager needs bundled into one download. This template pulls tinymediamanager/tinymediamanager:latest, which Docker fetches once (about 658 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. TinyMediaManager's comes from Docker Hub, published by tinymediamanager.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 5.3.1. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 5900:5900 means it's reachable on port 5900 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5900:5900
  • 4000:4000

Volumes

A volume is where TinyMediaManager keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data from /portainer/Files/AppData/Config/tinemediamanager/data on the host
  • /media/movies from /portainer/movies on the host
  • /media/tvshows from /portainer/tvshows on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. TinyMediaManager takes 6 of them, all with defaults you can leave alone or tweak:

  • USER_ID, defaults to 1000
  • GROUP_ID, defaults to 100
  • ALLOW_DIRECT_VNC, defaults to true
  • LC_ALL, defaults to en_US.UTF-8
  • LANG, defaults to en_US.UTF-8
  • PASSWORD, defaults to tinymediamanager

Restart policy

The restart policy here is unless-stopped, so Docker restarts TinyMediaManager after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so TinyMediaManager sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container tinymediamanager. That's what you'll spot in the containers list and use in commands like docker logs tinymediamanager.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set TinyMediaManager up. Add the template list to Portainer once, then deploying TinyMediaManager is a click rather than a wall of config.