Portainer Templates logo

Portainer Templates

Midarr Midarr

Stack

Multimedia

Your media enjoyed through a minimal lightweight media server.

Configuration

Type
Compose
Platform
linux
Command
bash -c "chmod u+x misc/entry-point-local.sh && ./misc/entry-point-local.sh"
Ports
4000:4000
Volumes
/app : /portainer/Files/AppData/Config/midarr//movies : /portainer/Files/AppData/Config/midarr/movies/series : /portainer/Files/AppData/Config/midarr/series
Env vars
APP_URL=http://midarr:4000SETUP_ADMIN_EMAIL=admin@email.comSETUP_ADMIN_NAME=adminSETUP_ADMIN_PASSWORD=passwordpasswordRADARR_BASE_URL=http://radarr:7878RADARR_API_KEY=d031e8c9b9df4b2fab311d1c3b3fa2c5SONARR_BASE_URL=http://sonarr:8989SONARR_API_KEY=1accda4476394bfcaddefe8c4fd77d4a
Build
.
Source
Repo

Template by xneo1·Source

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 Midarr, 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:

  midarr:
    container_name: midarr
    build: .
    ports:
      - 4000:4000
    volumes:
      - /portainer/Files/AppData/Config/midarr/:/app
      - /portainer/Files/AppData/Config/midarr/movies:/movies
      - /portainer/Files/AppData/Config/midarr/series:/series
    environment:
      - APP_URL=http://midarr:4000
      - SETUP_ADMIN_EMAIL=admin@email.com
      - SETUP_ADMIN_NAME=admin
      - SETUP_ADMIN_PASSWORD=passwordpassword
      - RADARR_BASE_URL=http://radarr:7878
      - RADARR_API_KEY=d031e8c9b9df4b2fab311d1c3b3fa2c5
      - SONARR_BASE_URL=http://sonarr:8989
      - SONARR_API_KEY=1accda4476394bfcaddefe8c4fd77d4a
    command: bash -c "chmod u+x misc/entry-point-local.sh && ./misc/entry-point-local.sh"

Or deploy it directly from the source:

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

More install options in our documentation.

Serve Midarr 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 midarr.example.com to http://midarr:4000

Add this to your Caddyfile

midarr.example.com {
	reverse_proxy http://midarr:4000
}

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:4000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :4000
  • Stop the other service, or pick a different host port. In 4000:4000 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:4000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, midarr can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 4000

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/midarr/ (and the same for the other mapped folders)

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

Midarr 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.

Ports

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

  • 4000:4000

Volumes

A volume is where Midarr 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:

  • /app from /portainer/Files/AppData/Config/midarr/ on the host
  • /movies from /portainer/Files/AppData/Config/midarr/movies on the host
  • /series from /portainer/Files/AppData/Config/midarr/series on the host

Environment variables

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

  • APP_URL, defaults to http://midarr:4000
  • SETUP_ADMIN_EMAIL, defaults to admin@email.com
  • SETUP_ADMIN_NAME, defaults to admin
  • SETUP_ADMIN_PASSWORD, defaults to passwordpassword
  • RADARR_BASE_URL, defaults to http://radarr:7878
  • RADARR_API_KEY, defaults to d031e8c9b9df4b2fab311d1c3b3fa2c5
  • SONARR_BASE_URL, defaults to http://sonarr:8989
  • SONARR_API_KEY, defaults to 1accda4476394bfcaddefe8c4fd77d4a

Networking

Nothing custom is set, so Midarr 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 midarr. That's what you'll spot in the containers list and use in commands like docker logs midarr.

Startup command

The command is what runs the moment the container starts. This template sets its own, bash -c "chmod u+x misc/entry-point-local.sh && ./misc/entry-point-local.sh", in place of the image's default.

Built from source

Instead of pulling a ready-made image, this one is built on the spot from .. The first deploy takes a bit longer while it compiles, and the build files need to be there for it to work.

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 Midarr up. Add the template list to Portainer once, then deploying Midarr is a click rather than a wall of config.