Skip to content

hotio/autoscan

GitHub Source GitHub Registry Docker Pulls Discord Upstream Website

Starting the container

CLI:

docker run --rm \
    --name autoscan \
    -p 3030:3030 \
    -e PUID=1000 \
    -e PGID=1000 \
    -e UMASK=002 \
    -e TZ="Etc/UTC" \
    -e ARGS="" \
    -e DEBUG="no" \
    -e AUTOSCAN_VERBOSITY=0 \
    -e PLEX_LOGIN="" \
    -e PLEX_PASSWORD="" \
    -v /<host_folder_config>:/config \
    hotio/autoscan

Compose:

version: "3.7"

services:
  autoscan:
    container_name: autoscan
    image: hotio/autoscan
    ports:
      - "3030:3030"
    environment:
      - PUID=1000
      - PGID=1000
      - UMASK=002
      - TZ=Etc/UTC
      - ARGS
      - DEBUG=no
      - AUTOSCAN_VERBOSITY=0
      - PLEX_LOGIN
      - PLEX_PASSWORD
    volumes:
      - /<host_folder_config>:/config

If PLEX_LOGIN + PLEX_PASSWORD are not empty and the file /config/app/plex.token does not exist, an attempt is made to get a Plex token for Autoscan.

Tags

Tag Upstream Version Build
release (latest) GitHub releases version build
nightly Every commit to master version build

You can also find tags that reference a commit or version number.

Configuration location

Your autoscan configuration inside the container is stored in /config/app, to migrate from another container, you'd probably have to move your files from /config to /config/app.

Using a secure Plex connection

If you want to keep using secure connections within Plex, but don't wanna buy your own domain and keep the connection between Autoscan and Plex inside of their Docker network. Follow the below procedure.

Go to https://plex.tv/pms/resources.xml?includeHttps=1&X-Plex-Token=xxxxxxxxxxxxxx (replace xxxxxxxxxxxxxx with your token) and look for a url that looks like https://10-1-0-100.xxxxxxxxxxxxx.plex.direct:32400. That url can be used in your Autoscan plex target. You should however give the Plex container a static IP if you don't wanna do this every 5 minutes.

Executing your own scripts

If you have a need to do additional stuff when the container starts or stops, you can mount your script with the volume /docker/host/my-script.sh:/etc/cont-init.d/99-my-script to execute your script on container start or /docker/host/my-script.sh:/etc/cont-finish.d/99-my-script to execute it when the container stops. An example script can be seen below.

#!/usr/bin/with-contenv bash

echo "Hello, this is me, your script."

Troubleshooting a problem

By default all output is redirected to /dev/null, so you won't see anything from the application when using docker logs. Most applications write everything to a log file too. If you do want to see this output with docker logs, you can set DEBUG to yes.