Portainer Templates logo

Portainer Templates

Unmanic Unmanic

Container

Tools

Unmanic is a simple tool for optimising your file library. You can use it to convert your files into a single, uniform format, manage file movements based on timestamps, or execute custom commands against a file based on its file size.

Image details

Pulls: 15.7M
Architecture: amd64, arm64, arm/v7
Image size: 581 MB
Latest: 0.4.1
User: josh5
Created: Jan 06, 2019
Updated: 3 hours ago
Status: active

Source details

Stars: 2k
Forks: 122
Language: Python
License: GPL-3.0
Updated: 3 hours ago

Configuration

Type
Container
Platform
linux
Image
josh5/unmanic:latest
Ports
8888:8888/tcp
Volumes
/config : /portainer/Files/AppData/Config/unmanic/config/library : /portainer/Files/AppData/Config/unmanic/library/tmp/unmanic : /portainer/Files/AppData/Config/unmanic/tmp
Env vars
PUID=1000PGID=1000
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://docs.unmanic.app/
Official Docker Documentation: https://docs.unmanic.app/docs/installation/docker


Standalone Install

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

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 Unmanic, fill in any config options, and hit Deploy

Template Import URL

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

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

Unmanic - Library Optimiser

UNMANIC - Library Optimiser
Buy Me a Coffee at ko-fi.com
GitHub tag (latest by date) GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests
Docker Stars Docker Pulls Docker Image Size (tag)
GitHub Workflow Status (branch) GitHub Workflow Status (branch)

GitHub license()

Unmanic is a simple tool for optimising your file library. You can use it to convert your files into a single, uniform format, manage file movements based on timestamps, or execute custom commands against a file based on its file size.
Simply configure Unmanic pointing it at your library and let it automatically manage that library for you.
Unmanic provides you with the following main functions:

  • A scheduler built in to scan your whole library for files that do not conform to your configured presets. Files found with incorrect formats are then queued for conversion.
  • A folder watchdog. When a video file is modified or a new file is added in your library, Unmanic is able to check that video against your configured video presets. Like the first function, if this video is not formatted correctly it is added to a queue for conversion.
  • A handler to manage running multiple file manipulation tasks at a time.
  • A Web UI to easily configure, manage and monitor the progress of your library optimisation.

You choose how you want your library to be.
Unmanic can be used to:
  • Trans-code video or audio files into a uniform format using FFmpeg
  • Move files from one location to another after a configured period of time
  • Execute FileBot against files in your library
  • Run any custom command against files matching a certain extension or above a configured file size

The Docker container is currently based linuxserver.io Ubuntu focal image.

Table Of Contents

Dependencies
Screen-shots Dashboard File metrics Installed plugins
Install and Run
License and Contribution

Dependencies

- Python 3.x (Install) - To install requirements run 'python3 -m pip install -r requirements.txt' from the project root
Unmanic can be used for running many commands. You will need to ensure that the required dependencies for those commands are installed.

Screen-shots

Dashboard:

drawing

File metrics:

drawing

Installed plugins:

drawing

Install and Run

For information on installation and configuration, see the Application Documentation.

Serve Unmanic 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 unmanic.example.com to http://unmanic:8888

Add this to your Caddyfile

unmanic.example.com {
	reverse_proxy http://unmanic:8888
}

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

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

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/unmanic/config (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull josh5/unmanic: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, arm/v7
  • 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 unmanic --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

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

A single container

Unmanic runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Unmanic needs bundled into one download. This template pulls josh5/unmanic:latest, which Docker fetches once (about 581 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. Unmanic's comes from Docker Hub, published by josh5.

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 0.4.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, arm/v7, 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 8888:8888 means it's reachable on port 8888 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8888:8888

Volumes

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

  • /config from /portainer/Files/AppData/Config/unmanic/config on the host
  • /library from /portainer/Files/AppData/Config/unmanic/library on the host
  • /tmp/unmanic from /portainer/Files/AppData/Config/unmanic/tmp on the host

Environment variables

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

  • PUID, defaults to 1000
  • PGID, defaults to 1000

Restart policy

The restart policy here is unless-stopped, so Docker restarts Unmanic 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).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

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

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.

Open source license

Unmanic is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

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