Installation via Docker
Supported Architectures
The Unmanic docker image is built for the following architectures:
note
It may work on others such as Windows or MacOS but they will not be officially supported at this time.
Follow the Windows 10/11 (WSL + Docker) installation guide if you wish to attempt installing and running Unmanic on Windows 10 or 11.
- linux/amd64
- linux/armv7
- linux/arm64
Running Unmanic
There are a number of ways you may start Unmanic with Docker.
The most basic method is shown below:
- Docker run
- Docker-compose
PUID=$(id -u)
PGID=$(id -g)
# CONFIG_DIR - Where you settings are saved
CONFIG_DIR=/config
# LIBRARY_DIR - The location/locations of your library
LIBRARY_DIR=/library
# CACHE_DIR - A tmpfs or and folder for temporary conversion files
CACHE_DIR=/tmp/unmanic
docker run -ti --rm \
-e PUID=${PUID} \
-e PGID=${PGID} \
-p 8888:8888 \
-v ${CONFIG_DIR}:/config \
-v ${LIBRARY_DIR}:/library \
-v ${CACHE_DIR}:/tmp/unmanic \
josh5/unmanic:latest
# Variables that will need to be changed:
# <PUID> - User id for folder/file permissions
# <PGID> - Group id for folder/file permissions
# <PATH_TO_CONFIG> - Path where Unmanic will store config files
# <PATH_TO_LIBRARY> - Path where you store the files that Unmanic will scan
# <PATH_TO_ENCODE_CACHE> - Cache path for in-progress encoding tasks
#
---
version: '2.4'
services:
unmanic:
container_name: unmanic
image: josh5/unmanic:latest
ports:
- 8888:8888
environment:
- PUID=<PUID>
- PGID=<PGID>
volumes:
- <PATH_TO_CONFIG>:/config
- <PATH_TO_LIBRARY>:/library
- <PATH_TO_ENCODE_CACHE>:/tmp/unmanic
For more advanced methods using hardware acceleration, see these articles: