arranhs/filebot repository overview

⁠Docker container for FileBot

This is a Docker container for FileBot. Much of the work came from jlesage's excellent filebot image but this image ustilises Guacamole due to its advantages.

The GUI of the application is accessed through a modern web browser (no installation or configuration needed on client side) or via any VNC client.

Guacamole is used for GUI access in this fork. This is different to jlesage's image, and means the viewer will be more performant.

This container uses FileBot version 4.7.9 as this is the last free version available. While the container will be updated, the FileBot version will not be.

FileBot is the ultimate tool for organizing and renaming your movies, tv shows or anime, and music well as downloading subtitles and artwork. It's smart and just works.

⁠Table of Content

• Docker container for FileBot⁠
  • Table of Content⁠
  • Quick Start⁠
  • Usage⁠
    • Environment Variables⁠
    • Data Volumes⁠
    • Ports⁠
    • Changing Parameters of a Running Container⁠
  • Docker Image Update⁠
  • User/Group IDs⁠
  • Accessing the GUI⁠
  • Shell Access⁠
  • Support or Contact⁠

⁠Quick Start

NOTE: The Docker command provided in this quick start is given as an example and parameters should be adjusted to your need.

Launch the FileBot docker container with the following command:

docker run -d \
    --name=filebot \
    -p 8080:8080 \
    -v /docker/appdata/filebot:/config \
    -v $HOME:/storage \
    arranhs/filebot

Where:

• /docker/appdata/filebot: This is where the application stores its configuration, log and any files needing persistency.
• $HOME: This location contains files from your host that need to be accessible by the application.

Browse to http://your-host-ip:8080 to access the FileBot GUI. Files from the host appear under the /storage folder in the container.

⁠Usage

docker run [-d] \
    --name=filebot \
    [-e <VARIABLE_NAME>=<VALUE>]... \
    [-v <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS]]... \
    [-p <HOST_PORT>:<CONTAINER_PORT>]... \
    arranhs/filebot

⁠Environment Variables

To customize some properties of the container, the following environment variables can be passed via the -e parameter (one for each variable). Value of this parameter has the format <VARIABLE_NAME>=<VALUE>.

⁠Data Volumes

The following table describes data volumes used by the container. The mappings are set via the -v parameter. Each mapping is specified with the following format: <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS].

⁠Ports

Here is the list of ports used by the container. They can be mapped to the host via the -p parameter (one per port mapping). Each mapping is defined in the following format: <HOST_PORT>:<CONTAINER_PORT>. The port number inside the container cannot be changed, but you are free to use any port on the host side.

⁠Changing Parameters of a Running Container

As seen, environment variables, volume mappings and port mappings are specified while creating the container.

The following steps describe the method used to add, remove or update parameter(s) of an existing container. The generic idea is to destroy and re-create the container:

1. Stop the container (if it is running):

docker stop filebot

1. Remove the container:

docker rm filebot

1. Create/start the container using the docker run command, by adjusting parameters as needed.

NOTE: Since all application's data is saved under the /config container folder, destroying and re-creating a container is not a problem: nothing is lost and the application comes back with the same state (as long as the mapping of the /config folder remains the same).

⁠Docker Image Update

If the system on which the container runs doesn't provide a way to easily update the Docker image, the following steps can be followed:

1. Fetch the latest image:

docker pull arranhs/filebot

1. Stop the container:

docker stop filebot

1. Remove the container:

docker rm filebot

1. Start the container using the docker run command.

⁠User/Group IDs

When using data volumes (-v flags), permissions issues can occur between the host and the container. For example, the user within the container may not exists on the host. This could prevent the host from properly accessing files and folders on the shared volume.

To avoid any problem, you can specify the user the application should run as.

This is done by passing the user ID and group ID to the container via the UID and GID environment variables.

To find the right IDs to use, issue the following command on the host, with the user owning the data volume on the host:

id <username>

Which gives an output like this one:

uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin)

The value of uid (user ID) and gid (group ID) are the ones that you should be given the container.

⁠Accessing the GUI

Assuming that container's ports are mapped to the same host's ports, the graphical interface of the application can be accessed via:

• A web browser:

http://<HOST IP ADDR>:8080

• Any VNC client:

<HOST IP ADDR>:3389

⁠Shell Access

To get shell access to a the running container, execute the following command:

docker exec -ti CONTAINER sh

Where CONTAINER is the ID or the name of the container used during its creation (e.g. filebot).

⁠Reverse Proxy

The following sections contains NGINX configuration that need to be added in order to reverse proxy to this container.

A reverse proxy server can route HTTP requests based on the hostname or the URL path.

⁠Support or Contact

Having troubles with the container or have questions? Please create a new issue⁠.