Unmanic smart home integration, free and open source

Unmanic in Gladys: transcode queue, workers, progress, failed tasks, pause and resume.
Bring your Unmanic server (the self-hosted video library optimizer) into Gladys, over your local network: the tasks waiting and in progress, the tasks completed and failed today, the state and progress of each worker, pause switches, and scenes that react when a task fails or when the queue is empty.
The integration was tested against a real Unmanic 0.4.1 server (the official
josh5/unmanic Docker image, with real transcode tasks and a failed one), not
yet in a real Gladys installation: feedback is welcome on the
Gladys forum or in the
issues.
What you need
- Gladys Assistant 5.1.0 or later.
- An Unmanic server reachable from Gladys (same network), on the port of
its web interface (
8888by default). - Unmanic has no login of its own: nothing to create. If you put a reverse proxy with Basic auth in front of it, keep its user name and password at hand.
Set up
- Install the integration from the Gladys catalog.
- In Configuration, enter the Address of the Unmanic server (for
example
192.168.1.2:8888; without a port,8888is used). Behind a reverse proxy, the full address (https://example.org/unmanic) and, with Basic auth, the User name (reverse proxy) and Password (reverse proxy). - Save, then click Test the connection: the message under the button gives the version of Unmanic, the number of workers and the tasks waiting.
- Open the Discover tab: one device for the server, one for the queue, one per worker. Click Add on the ones you want, pick a room and save.
Options:
- Allow pause and resume (off by default): Gladys may pause and resume the workers (switches, scenes, widget button). Off, the integration only reads.
- Refresh interval: 30 seconds to 5 minutes (1 minute by default).
- Language of the feature names: the names given to the features when a device is added, and the language of the summary sentence.
The devices
The Unmanic server
| Feature | What it shows |
|---|---|
| Online | 1 while the server answers. |
| All workers paused | Switch: pauses or resumes every worker (1 when all paused). |
| Version | Version of Unmanic. |
The Unmanic queue
| Feature | What it shows |
|---|---|
| Waiting tasks | Tasks waiting for a worker (the Pending tasks of Unmanic). |
| Tasks in progress | Tasks a worker is processing right now. |
| Completed today | Tasks completed with success since midnight. |
| Failed today | Tasks failed since midnight. |
Each worker (named after the worker in Unmanic, Default-Worker-1…)
| Feature | What it shows |
|---|---|
| Active | 1 while the worker processes a task. |
| Paused | Switch: pauses or resumes this worker. |
| Progress | Progress of the task in %, when the plugin of Unmanic reports it. |
| File in progress | Name of the file being processed (— when idle). |
A paused worker stops its task where it is and goes on from there when it is resumed: nothing is lost. A worker that disappears (worker group shrunk or renamed in Unmanic) stays in Gladys, offline.
Dashboard
The Unmanic widget shows four tiles (waiting, in progress, done today, failed today), one row per worker (progress and file, paused, idle) and a button: Pause all while the workers run, Resume all once they are all paused. No button when the commands are off in the configuration. Two settings of the widget hide the worker rows and the button.
Scenes
Triggers
- Unmanic queue emptied: everything is processed, no task waiting and no worker busy any more. Variables: the tasks completed and failed today.
- Unmanic task failed: a task has just ended in failure. Variables: the file name, the tasks failed today.
Actions
- Pause Unmanic: one worker, or every worker when no worker is chosen.
- Resume Unmanic: same choice.
- Read the Unmanic summary: a sentence for a message or a voice announcement ("Unmanic: 12 task(s) waiting, 2 in progress, 30 completed today, 1 failed today."), and the same figures as numbers.
The pause and resume actions need Allow pause and resume in the configuration.
Scene ideas
- During the peak hours of your electricity contract, Pause Unmanic; when the off-peak hours start, Resume Unmanic.
- Unmanic task failed → send a Telegram message with the file name.
- Unmanic queue emptied → a notification: "Unmanic is done for today".
- In the evening, Pause Unmanic to keep the CPU for the movie, and resume it at night.
Troubleshooting
- "Unmanic does not answer": check the address and the port (
8888), and that Gladys reaches the server (firewall, Docker network). - "Access refused": a reverse proxy protects Unmanic; check the user name and password in the configuration.
- "No Unmanic server at this address": another application answers on this port, or the base path of the reverse proxy is missing.
- No worker: Unmanic has no worker until a worker group has one (Settings → Workers).
- The progress stays at 0 %: the plugin of the task gives Unmanic no progress; the worker is still shown active with its file.
- The switch does nothing: check Allow pause and resume in the configuration.
- More details in the logs of the integration (Integrations → Unmanic →
logs), at the
debuglevel if needed.
Limits
- One Unmanic server per integration.
- The figures are read every refresh interval: a short task may start and end between two readings (it is still counted in the tasks of the day).
- The tasks of the day are counted from the 250 latest tasks of the history, from midnight in the time zone of Gladys. Unmanic task failed announces at most ten tasks per reading, none older than an hour.
- Unmanic has no authentication: anyone on your network reaches its API. The integration does not change the settings, libraries or plugins of Unmanic, and deletes nothing.
- Not affiliated with Unmanic or its authors.
Configuration settings
These are the settings Unmanic asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| Unmanic server | section | No | Address of the Unmanic web interface. Unmanic has no login of its own: fill in the user name and password only if a reverse proxy with Basic auth protects it. |
| Address | string | No | IP address or name of the server, with the port of the web interface (8888 by default). |
| User name (reverse proxy) | string | No | Only behind a reverse proxy with Basic auth. Leave empty otherwise. |
| Password (reverse proxy) | secret | No | Password of the reverse proxy, with the user name above. |
| Allow pause and resume | boolean | No | Gladys may pause and resume the workers (switches, scenes, widget button). Off: read only. |
| Refresh interval | select | No | How often the server is read: queue, workers, completed tasks. |
| Language of the feature names | select | No | Names given to the features when a device is added, and the sentence of the summary action. |
How to install Unmanic in Gladys
- In Gladys, open Integrations: Unmanic appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/guim31/gladys-unmanic:1.0.0), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/guim31/gladys-unmanic.
Unmanic requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.
Not running Gladys yet? It is free and open source: follow the installation guide to get started.
About external integrations
Unmanic is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by guim31, not by the Gladys core team.
- Browse all integrations, native and community
- Build and publish your own external integration
- Source code on GitHub — source of this documentation