search

jlesage / docker-filebot

Docker container for FileBot
MIT License
176 stars 35 forks source link

readme

Docker container for FileBot

Release Docker Image Size Docker Pulls Docker Stars Build Status Donate

This project implements a Docker container for FileBot.

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

FileBot logoFileBot

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

Quick Start

[!IMPORTANT] 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 5800:5800 \
    -v /docker/appdata/filebot:/config:rw \
    -v /home/user:/storage:rw \
    jlesage/filebot

Where:

Browse to http://your-host-ip:5800 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>]... \
    jlesage/filebot
Parameter Description
-d Run the container in the background. If not set, the container runs in the foreground.
-e Pass an environment variable to the container. See the Environment Variables section for more details.
-v Set a volume mapping (allows to share a folder/file between the host and the container). See the Data Volumes section for more details.
-p Set a network port mapping (exposes an internal container port to the host). See the Ports section for more details.

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>.

Variable Description Default
USER_ID ID of the user the application runs as. See User/Group IDs to better understand when this should be set. 1000
GROUP_ID ID of the group the application runs as. See User/Group IDs to better understand when this should be set. 1000
SUP_GROUP_IDS Comma-separated list of supplementary group IDs of the application. (no value)
UMASK Mask that controls how permissions are set for newly created files and folders. The value of the mask is in octal notation. By default, the default umask value is 0022, meaning that newly created files and folders are readable by everyone, but only writable by the owner. See the online umask calculator at http://wintelguy.com/umask-calc.pl. 0022
LANG Set the locale, which defines the application's language, if supported. Format of the locale is language[_territory][.codeset], where language is an ISO 639 language code, territory is an ISO 3166 country code and codeset is a character set, like UTF-8. For example, Australian English using the UTF-8 encoding is en_AU.UTF-8. en_US.UTF-8
TZ TimeZone used by the container. Timezone can also be set by mapping /etc/localtime between the host and the container. Etc/UTC
KEEP_APP_RUNNING When set to 1, the application will be automatically restarted when it crashes or terminates. 0
APP_NICENESS Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. The default niceness value is 0. NOTE: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option --cap-add=SYS_NICE. 0
INSTALL_PACKAGES Space-separated list of packages to install during the startup of the container. List of available packages can be found at https://pkgs.alpinelinux.org. ATTENTION: Container functionality can be affected when installing a package that overrides existing container files (e.g. binaries). (no value)
PACKAGES_MIRROR Mirror of the repository to use when installing packages. List of mirrors is available at https://mirrors.alpinelinux.org. (no value)
CONTAINER_DEBUG Set to 1 to enable debug logging. 0
DISPLAY_WIDTH Width (in pixels) of the application's window. 1920
DISPLAY_HEIGHT Height (in pixels) of the application's window. 1080
DARK_MODE When set to 1, dark mode is enabled for the application. 0
WEB_AUDIO When set to 1, audio support is enabled, meaning that any audio produced by the application is played through the browser. Note that audio is not supported for VNC clients. 0
WEB_AUTHENTICATION When set to 1, the application' GUI is protected via a login page when accessed via a web browser. Access is allowed only when providing valid credentials. NOTE: This feature requires secure connection (SECURE_CONNECTION environment variable) to be enabled. 0
WEB_AUTHENTICATION_USERNAME Optional username to configure for the web authentication. This is a quick and easy way to configure credentials for a single user. To configure credentials in a more secure way, or to add more users, see the Web Authentication section. (no value)
WEB_AUTHENTICATION_PASSWORD Optional password to configure for the web authentication. This is a quick and easy way to configure credentials for a single user. To configure credentials in a more secure way, or to add more users, see the Web Authentication section. (no value)
SECURE_CONNECTION When set to 1, an encrypted connection is used to access the application's GUI (either via a web browser or VNC client). See the Security section for more details. 0
SECURE_CONNECTION_VNC_METHOD Method used to perform the secure VNC connection. Possible values are SSL or TLS. See the Security section for more details. SSL
SECURE_CONNECTION_CERTS_CHECK_INTERVAL Interval, in seconds, at which the system verifies if web or VNC certificates have changed. When a change is detected, the affected services are automatically restarted. A value of 0 disables the check. 60
WEB_LISTENING_PORT Port used by the web server to serve the UI of the application. This port is used internally by the container and it is usually not required to be changed. By default, a container is created with the default bridge network, meaning that, to be accessible, each internal container port must be mapped to an external port (using the -p or --publish argument). However, if the container is created with another network type, changing the port used by the container might be useful to prevent conflict with other services/containers. NOTE: a value of -1 disables listening, meaning that the application's UI won't be accessible over HTTP/HTTPs. 5800
VNC_LISTENING_PORT Port used by the VNC server to serve the UI of the application. This port is used internally by the container and it is usually not required to be changed. By default, a container is created with the default bridge network, meaning that, to be accessible, each internal container port must be mapped to an external port (using the -p or --publish argument). However, if the container is created with another network type, changing the port used by the container might be useful to prevent conflict with other services/containers. NOTE: a value of -1 disables listening, meaning that the application's UI won't be accessible over VNC. 5900
VNC_PASSWORD Password needed to connect to the application's GUI. See the VNC Password section for more details. (no value)
ENABLE_CJK_FONT When set to 1, open-source computer font WenQuanYi Zen Hei is installed. This font contains a large range of Chinese/Japanese/Korean characters. 0
FILEBOT_GUI Setting this to 1 enables the FileBot GUI, 0 disables it. 1
AMC_ENABLED Setting this to 1 enables the Automated Media Center (AMC) script, 0 disables it. 1
OPENSUBTITLES_USERNAME Username of your OpenSubtitles account. Required to download subtitles. (no value)
OPENSUBTITLES_PASSWORD Password of your OpenSubtitles account. Required to download subtitles. (no value)
FILEBOT_CUSTOM_OPTIONS Custom arguments to pass to FileBot. This applies to the UI only. (no value)
USE_FILEBOT_BETA When set to 1, FileBot installed under /config/beta (container path) is used. If no FileBot installation is found under this folder, the latest beta version is automatically downloaded during container startup. See Using a Beta Version section for more details. NOTE: Use at your own risk. Beta version may have bugs and stability issues. 0
AMC_INTERVAL Time (in seconds) between each invocation of the Automated Media Center (AMC) script. 1800
AMC_INPUT_STABLE_TIME Time (in seconds) during which properties (e.g. size, time, etc) of files in the watch folder need to remain the same before invoking the Automated Media Center (AMC) script. This is to avoid processing the watch folder while files are being copied. 10
AMC_ACTION Action performed by the Automated Media Center (AMC) script on files. Valid values are test, copy, move, symlink, hardlink, keeplink, duplicate or clone. Use the test operation to perform a dry-run and verify that everything gets matched up correctly. test
AMC_CONFLICT Conflict resolution strategy used by the Automated Media Center (AMC) script. When set to skip, existing files are never overriden, while auto overrides existing file only if new media is better. auto
AMC_MATCH_MODE Match mode used by the Automated Media Center (AMC) script. The opportunistic mode works for all files regardless how badly they are named, while strict mode works for reasonably well-named files and ignore files that cannot be matched accurately. See Match Mode for complete documentation. opportunistic
AMC_ARTWORK When set to y, artwork is fetched and NFO file is generated by the Automated Media Center (AMC) script. n
AMC_LANG Language used by the Automated Media Center (AMC) script to rename files. Two-characters language code or value like English, French, German, Chinese, etc can be used. English
AMC_MUSIC_FORMAT Define how music files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See Format Expressions for complete documentation. {plex}
AMC_MOVIE_FORMAT Define how movie files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See Format Expressions for complete documentation. {plex}
AMC_SERIES_FORMAT Define how TV series files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See Format Expressions for complete documentation. {plex}
AMC_ANIME_FORMAT Define how anime files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See Format Expressions for complete documentation. {plex}
AMC_PROCESS_MUSIC When set to y, music files are processed by the Automated Media Center (AMC) script. A value of n does not process them. y
AMC_SUBTITLE_LANG Comma-separated list of subtitle languages to download. Example: en,de,fr. (no value)
AMC_CUSTOM_OPTIONS Custom arguments to pass to the Automated Media Center (AMC) script. (no value)
AMC_INPUT_DIR Directory inside the container used as the input folder of the Automated Media Center (AMC) script. /watch
AMC_OUTPUT_DIR Directory inside the container used as the output folder of the Automated Media Center (AMC) script. /output

Deployment Considerations

Many tools used to manage Docker containers extract environment variables defined by the Docker image and use them to create/deploy the container. For example, this is done by:

While this can be useful for the user to adjust the value of environment variables to fit its needs, it can also be confusing and dangerous to keep all of them.

A good practice is to set/keep only the variables that are needed for the container to behave as desired in a specific setup. If the value of variable is kept to its default value, it means that it can be removed. Keep in mind that all variables are optional, meaning that none of them is required for the container to start.

Removing environment variables that are not needed provides some advantages:

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].

Container path Permissions Description
/config rw This is where the application stores its configuration, states, log and any files needing persistency.
/storage rw This location contains files from your host that need to be accessible to the application.
/watch rw This is the input folder of the Automated Media Center (AMC) script. Any media copied to this folder will be processed by the script. Note that there is no need to map this folder if the script is not used.
/output rw This is the output folder of the Automated Media Center (AMC) script. This is where medias are located once they are renamed and organized. Note that there is no need to map this folder if the script is not used.

Ports

Here is the list of ports used by the container.

When using the default bridge network, ports can be mapped to the host via the -p parameter (one per port mapping). Each mapping is defined with the following format: <HOST_PORT>:<CONTAINER_PORT>. The port number used inside the container might not be changeable, but you are free to use any port on the host side.

See the Docker Container Networking documentation for more details.

Port Protocol Mapping to host Description
5800 TCP Optional Port to access the application's GUI via the web interface. Mapping to the host is optional if access through the web interface is not wanted. For a container not using the default bridge network, the port can be changed with the WEB_LISTENING_PORT environment variable.
5900 TCP Optional Port to access the application's GUI via the VNC protocol. Mapping to the host is optional if access through the VNC protocol is not wanted. For a container not using the default bridge network, the port can be changed with the VNC_LISTENING_PORT environment variable.

Changing Parameters of a Running Container

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

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

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

    docker stop filebot

  2. Remove the container:

    docker rm filebot

  3. 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 Compose File

Here is an example of a docker-compose.yml file that can be used with Docker Compose.

Make sure to adjust according to your needs. Note that only mandatory network ports are part of the example.

version: '3'
services:
  filebot:
    image: jlesage/filebot
    ports:
      - "5800:5800"
    volumes:
      - "/docker/appdata/filebot:/config:rw"
      - "/home/user:/storage:rw"

Docker Image Versioning

Each release of a Docker image is versioned. Prior to october 2022, the semantic versioning was used as the versioning scheme.

Since then, versioning scheme changed to calendar versioning. The format used is YY.MM.SEQUENCE, where:

Docker Image Update

Because features are added, issues are fixed, or simply because a new version of the containerized application is integrated, the Docker image is regularly updated. Different methods can be used to update the Docker image.

The system used to run the container may have a built-in way to update containers. If so, this could be your primary way to update Docker images.

An other way is to have the image be automatically updated with Watchtower. Watchtower is a container-based solution for automating Docker image updates. This is a "set and forget" type of solution: once a new image is available, Watchtower will seamlessly perform the necessary steps to update the container.

Finally, the Docker image can be manually updated with these steps:

  1. Fetch the latest image:

    docker pull jlesage/filebot

  2. Stop the container:

    docker stop filebot

  3. Remove the container:

    docker rm filebot

  4. Create and start the container using the docker run command, with the the same parameters that were used when it was deployed initially.

Synology

For owners of a Synology NAS, the following steps can be used to update a container image.

  1. Open the Docker application.
  2. Click on Registry in the left pane.
  3. In the search bar, type the name of the container (jlesage/filebot).
  4. Select the image, click Download and then choose the latest tag.
  5. Wait for the download to complete. A notification will appear once done.
  6. Click on Container in the left pane.
  7. Select your FileBot container.
  8. Stop it by clicking Action->Stop.
  9. Clear the container by clicking Action->Reset (or Action->Clear if you don't have the latest Docker application). This removes the container while keeping its configuration.
  10. Start the container again by clicking Action->Start. NOTE: The container may temporarily disappear from the list while it is re-created.

unRAID

For unRAID, a container image can be updated by following these steps:

  1. Select the Docker tab.
  2. Click the Check for Updates button at the bottom of the page.
  3. Click the update ready link of the container to be updated.

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 exist 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 USER_ID and GROUP_ID 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:

http://<HOST IP ADDR>:5800
<HOST IP ADDR>:5900

Security

By default, access to the application's GUI is done over an unencrypted connection (HTTP or VNC).

Secure connection can be enabled via the SECURE_CONNECTION environment variable. See the Environment Variables section for more details on how to set an environment variable.

When enabled, application's GUI is performed over an HTTPs connection when accessed with a browser. All HTTP accesses are automatically redirected to HTTPs.

When using a VNC client, the VNC connection is performed over SSL. Note that few VNC clients support this method. SSVNC is one of them.

SSVNC

SSVNC is a VNC viewer that adds encryption security to VNC connections.

While the Linux version of SSVNC works well, the Windows version has some issues. At the time of writing, the latest version 1.0.30 is not functional, as a connection fails with the following error:

ReadExact: Socket error while reading

However, for your convenience, an unofficial and working version is provided here:

https://github.com/jlesage/docker-baseimage-gui/raw/master/tools/ssvnc_windows_only-1.0.30-r1.zip

The only difference with the official package is that the bundled version of stunnel has been upgraded to version 5.49, which fixes the connection problems.

Certificates

Here are the certificate files needed by the container. By default, when they are missing, self-signed certificates are generated and used. All files have PEM encoded, x509 certificates.

Container Path Purpose Content
/config/certs/vnc-server.pem VNC connection encryption. VNC server's private key and certificate, bundled with any root and intermediate certificates.
/config/certs/web-privkey.pem HTTPs connection encryption. Web server's private key.
/config/certs/web-fullchain.pem HTTPs connection encryption. Web server's certificate, bundled with any root and intermediate certificates.

[!TIP] To prevent any certificate validity warnings/errors from the browser or VNC client, make sure to supply your own valid certificates.

[!NOTE] Certificate files are monitored and relevant daemons are automatically restarted when changes are detected.

VNC Password

To restrict access to your application, a password can be specified. This can be done via two methods:

The level of security provided by the VNC password depends on two things:

When using a VNC password, it is highly desirable to enable the secure connection to prevent sending the password in clear over an unencrypted channel.

[!CAUTION] Password is limited to 8 characters. This limitation comes from the Remote Framebuffer Protocol RFC (see section 7.2.2). Any characters beyond the limit are ignored.

Web Authentication

Access to the application's GUI via a web browser can be protected with a login page. When web authentication is enabled, users have to provide valid credentials, otherwise access is denied.

Web authentication can be enabled by setting the WEB_AUTHENTICATION environment variable to 1.

See the Environment Variables section for more details on how to set an environment variable.

[!IMPORTANT] Secure connection must also be enabled to use web authentication. See the Security section for more details.

Configuring Users Credentials

Two methods can be used to configure users credentials:

  1. Via container environment variables.
  2. Via password database.

Containers environment variables can be used to quickly and easily configure a single user. Username and pasword are defined via the following environment variables:

See the Environment Variables section for more details on how to set an environment variable.

The second method is more secure and allows multiple users to be configured. The usernames and password hashes are saved into a password database, located at /config/webauth-htpasswd inside the container. This database file has the same format as htpasswd files of the Apache HTTP server. Note that password themselves are not saved into the database, but only their hash. The bcrypt password hashing function is used to generate hashes.

Users are managed via the webauth-user tool included in the container:

Reverse Proxy

The following sections contain NGINX configurations 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.

Routing Based on Hostname

In this scenario, each hostname is routed to a different application/container.

For example, let's say the reverse proxy server is running on the same machine as this container. The server would proxy all HTTP requests sent to filebot.domain.tld to the container at 127.0.0.1:5800.

Here are the relevant configuration elements that would be added to the NGINX configuration:

map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
}

upstream docker-filebot {
    # If the reverse proxy server is not running on the same machine as the
    # Docker container, use the IP of the Docker host here.
    # Make sure to adjust the port according to how port 5800 of the
    # container has been mapped on the host.
    server 127.0.0.1:5800;
}

server {
    [...]

    server_name filebot.domain.tld;

    location / {
            proxy_pass http://docker-filebot;
    }

    location /websockify {
        proxy_pass http://docker-filebot;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        proxy_read_timeout 86400;
    }
}

Routing Based on URL Path

In this scenario, the hostname is the same, but different URL paths are used to route to different applications/containers.

For example, let's say the reverse proxy server is running on the same machine as this container. The server would proxy all HTTP requests for server.domain.tld/filebot to the container at 127.0.0.1:5800.

Here are the relevant configuration elements that would be added to the NGINX configuration:

map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
}

upstream docker-filebot {
    # If the reverse proxy server is not running on the same machine as the
    # Docker container, use the IP of the Docker host here.
    # Make sure to adjust the port according to how port 5800 of the
    # container has been mapped on the host.
    server 127.0.0.1:5800;
}

server {
    [...]

    location = /filebot {return 301 $scheme://$http_host/filebot/;}
    location /filebot/ {
        proxy_pass http://docker-filebot/;
        # Uncomment the following line if your Nginx server runs on a port that
        # differs from the one seen by external clients.
        #port_in_redirect off;
        location /filebot/websockify {
            proxy_pass http://docker-filebot/websockify/;
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;
            proxy_read_timeout 86400;
        }
    }
}

Shell Access

To get shell access to 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.

License

FileBot supports a cross-platform custom license model, which means that a license can be purchased and then be used on all the buyer's machines.

While FileBot can be used/evaluated without a license, certain features, like renaming files, won't work without one.

A license can be purchased at https://www.filebot.net/purchase.html.

Installing a License

Once purchased, the license file received via email can be saved on the host, into the configuration directory of the container (i.e. in the directory mapped to /config).

Then, start or restart the container to have it automatically installed.

NOTE: The license file is expected to have a .psm extension.

Donation Supported Version

In the past, FileBot was donation supported, meaning that the author was expecting users to donate an arbitrary amount of money if they like and use the software.

The last version of FileBot supporting this model is 4.7.9. This version is implemented in container image version 1.0.2.

To revert to this version, create the container by using jlesage/filebot:v1.0.2 as the image name.

NOTE: While no license is required to use this version, it is no longer supported and maintained by the author of FileBot.

Automated Media Center (AMC)

This container supports the FileBot's Automated Media Center (AMC) script. This script automatically and smartly organizes movies, TV shows, anime and music.

Basically, files copied to the /watch container folder are automatically renamed and organized to the /output container folder.

Configuration of the AMC script is done via AMC_* environment variables. See the Environment Variables section for the list and descriptions of environment variables that can be set.

To see what the AMC script is doing, look at the container's log.

NOTE: By default, the script runs in dry mode, meaning that no change is performed. This allows you to verify that results produced by the script are correct. Then, the AMC_ACTION environment variable can be updated to perform changes to the file system.

NOTE: For the script to properly function, container folders /watch and /output must be properly mapped to the host. See the Data Volumes section.

Using a Beta Version

This container provides the stable version of FileBot. However, it's possible to use a beta version when needed. This is done by setting the environment variable USE_FILEBOT_BETA to 1.

When set, the custom FileBot installation located under /config/beta (container path) is used instead of the stable version.

FileBot beta version can be installed manually, by downloading the portable version from https://get.filebot.net/filebot/BETA and extracting the package to /config/beta. Else, the latest beta version is downloaded automatically during the startup of the container if no installation is found under /config/beta.

NOTE: Beta version may have bugs and stability issues. Use at your own risk.

Support or Contact

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

For other great Dockerized applications, see https://jlesage.github.io/docker-apps.