Docker container for FileBot

This project provides a Docker container for FileBot.

The graphical user interface (GUI) of the application can be accessed through a modern web browser, requiring no installation or configuration on the client side, or via any VNC client.

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.

Quick Start

Important

The Docker command provided in this quick start is an example, and parameters should be adjusted to suit your needs.

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:

/docker/appdata/filebot: Stores the application's configuration, state, logs, and any files requiring persistency.
/home/user: Contains files from the host that need to be accessible to the application.

Access the FileBot GUI by browsing to http://your-host-ip:5800. 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	Runs the container in the background. If not set, the container runs in the foreground.
-e	Passes an environment variable to the container. See Environment Variables for details.
-v	Sets a volume mapping to share a folder or file between the host and the container. See Data Volumes for details.
-p	Sets a network port mapping to expose an internal container port to the host). See Ports for details.

Environment Variables

To customize the container's behavior, you can pass environment variables using the -e parameter in the format <VARIABLE_NAME>=<VALUE>.

Variable	Description	Default
`USER_ID`	ID of the user the application runs as. See User/Group IDs for details.	`1000`
`GROUP_ID`	ID of the group the application runs as. See User/Group IDs for details.	`1000`
`SUP_GROUP_IDS`	Comma-separated list of supplementary group IDs for the application.	(no value)
`UMASK`	Mask controlling permissions for newly created files and folders, specified in octal notation. By default, `0022` ensures files and folders are readable by all but writable only by the owner. See the umask calculator at http://wintelguy.com/umask-calc.pl.	`0022`
`LANG`	Sets the locale, defining the application's language, if supported. Format 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 UTF-8 is `en_AU.UTF-8`.	`en_US.UTF-8`
`TZ`	TimeZone used by the container. The 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 is automatically restarted if it crashes or terminates.	`0`
`APP_NICENESS`	Priority at which the application runs. A niceness value of -20 is the highest, 19 is the lowest and 0 the default. NOTE: A negative niceness (priority increase) requires additional permissions. The container must be run with the Docker option `--cap-add=SYS_NICE`.	`0`
`INSTALL_PACKAGES`	Space-separated list of packages to install during container startup. List of available packages can be found at https://pkgs.alpinelinux.org.	(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`	When set to `1`, enables 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`, enables dark mode for the application. See Dark Mode](#dark-mode) for details.	`0`
`WEB_AUDIO`	When set to `1`, enables audio support, allowing audio produced by the application to play through the browser. See Web Audio for details.	`0`
`WEB_FILE_MANAGER`	When set to `1`, enables the web file manager, allowing interaction with files inside the container through the web browser, supporting operations like renaming, deleting, uploading, and downloading. See Web File Manager for details.	`0`
`WEB_FILE_MANAGER_ALLOWED_PATHS`	Comma-separated list of paths within the container that the file manager can access. By default, the container's entire filesystem is not accessible, and this variable specifies allowed paths. If set to `AUTO`, commonly used folders and those mapped to the container are automatically allowed. The value `ALL` allows access to all paths (no restrictions). See Web File Manager for details.	`AUTO`
`WEB_FILE_MANAGER_DENIED_PATHS`	Comma-separated list of paths within the container that the file manager cannot access. A denied path takes precedence over an allowed path. See Web File Manager for details.	(no value)
`WEB_AUTHENTICATION`	When set to `1`, protects the application's GUI with a login page when accessed via a web browser. Access is granted only with valid credentials. This feature requires the secure connection to be enabled. See Web Authentication for details.	`0`
`WEB_AUTHENTICATION_TOKEN_VALIDITY_TIME`	Lifetime of a token, in hours. A token is assigned to the user after successful login. As long as the token is valid, the user can access the application's GUI without logging in again. Once the token expires, the login page is displayed again.	`24`
`WEB_AUTHENTICATION_USERNAME`	Optional username for web authentication. Provides a quick and easy way to configure credentials for a single user. For more secure configuration or multiple users, see the Web Authentication section.	(no value)
`WEB_AUTHENTICATION_PASSWORD`	Optional password for web authentication. Provides a quick and easy way to configure credentials for a single user. For more secure configuration or multiple users, see the Web Authentication section.	(no value)
`SECURE_CONNECTION`	When set to `1`, uses an encrypted connection to access the application's GUI (via web browser or VNC client). See Security for details.	`0`
`SECURE_CONNECTION_VNC_METHOD`	Method used for encrypted VNC connections. Possible values are `SSL` or `TLS`. See Security for details.	`SSL`
`SECURE_CONNECTION_CERTS_CHECK_INTERVAL`	Interval, in seconds, at which the system checks if web or VNC certificates have changed. When a change is detected, 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 application's GUI. This port is internal to the container and typically does not need to be changed. By default, a container uses the default bridge network, requiring each internal port to be mapped to an external port (using the `-p` or `--publish` argument). If another network type is used, changing this port may prevent conflicts with other services/containers. NOTE: A value of `-1` disables HTTP/HTTPS access to the application's GUI.	`5800`
`VNC_LISTENING_PORT`	Port used by the VNC server to serve the application's GUI. This port is internal to the container and typically does not need to be changed. By default, a container uses the default bridge network, requiring each internal port to be mapped to an external port (using the `-p` or `--publish` argument). If another network type is used, changing this port may prevent conflicts with other services/containers. NOTE: A value of `-1` disables VNC access to the application's GUI.	`5900`
`VNC_PASSWORD`	Password required to connect to the application's GUI. See the VNC Password section for details.	(no value)
`ENABLE_CJK_FONT`	When set to `1`, installs the open-source font `WenQuanYi Zen Hei`, supporting a wide 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 to create or deploy the container.

For example, this behavior is seen in:

The Docker application on Synology NAS
The Container Station on QNAP NAS
Portainer
etc.

While this is useful for users to adjust environment variable values to suit their needs, keeping all of them can be confusing and even risky.

A good practice is to set or retain only the variables necessary for the container to function as desired in your setup. If a variable is left at its default value, it can be removed. Keep in mind that all environment variables are optional; none are required for the container to start.

Removing unneeded environment variables offers several benefits:

Prevents retaining variables no longer used by the container. Over time, with image updates, some variables may become obsolete.
Allows the Docker image to update or fix default values. With image updates, default values may change to address issues or support new features.
Avoids changes to variables that could disrupt the container's functionality. Some undocumented variables, like PATH or ENV, are required but not meant to be modified by users, yet container management tools may expose them.
Addresses a bug in Container Station on QNAP and the Docker application on Synology, where variables without values may not be allowed. This behavior is incorrect, as variables without values are valid. Removing unneeded variables prevents deployment issues on these devices.

Data Volumes

The following table describes the data volumes used by the container. Volume mappings are set using the -v parameter with a value in the format <HOST_DIR>:<CONTAINER_DIR>[:PERMISSIONS].

Container path	Permissions	Description
`/config`	rw	Stores the application's configuration, state, logs, and any files requiring persistency.
`/storage`	rw	Contains files from the 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

The following table lists the ports used by the container.

When using the default bridge network, ports can be mapped to the host using the -p parameter with value in the format <HOST_PORT>:<CONTAINER_PORT>. The internal container port may not be changeable, but you can use any port on the host side.

See the Docker Docker Container Networking documentation for 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 web access is not needed. For non-default bridge networks, 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 VNC access is not needed. For non-default bridge networks, the port can be changed with the `VNC_LISTENING_PORT` environment variable.

Changing Parameters of a Running Container

Environment variables, volume mappings, and port mappings are specified when creating the container. To modify these parameters for an existing container, follow these steps:

Stop the container (if it is running):

docker stop filebot

Remove the container:

docker rm filebot

Recreate and start the container using the docker run command, adjusting parameters as needed.

Note

Since all application data is saved under the /config container folder, destroying and recreating the container does not result in data loss, and the application resumes with the same state, provided the /config folder mapping remains unchanged.

Docker Compose File

Below is an example docker-compose.yml file for use with Docker Compose.

Adjust the configuration to suit your needs. Only mandatory settings are included in this example.

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

Docker Image Versioning and Tags

Each release of a Docker image is versioned, and each version as its own image tag. Before October 2022, the versioning scheme followed semantic versioning.

Since then, the versioning scheme has shifted to calendar versioning with the format YY.MM.SEQUENCE, where:

YY is the zero-padded year (relative to year 2000).
MM is the zero-padded month.
SEQUENCE is the incremental release number within the month (first release is 1, second is 2, etc).

View all available tags on Docker Hub or check the Releases page for version details.

Docker Image Update

The Docker image is regularly updated to incorporate new features, fix issues, or integrate newer versions of the containerized application. Several methods can be used to update the Docker image.

If your system provides a built-in method for updating containers, this should be your primary approach.

Alternatively, you can use Watchtower, a container-based solution for automating Docker image updates. Watchtower seamlessly handles updates when a new image is available.

To manually update the Docker image, follow these steps:

Fetch the latest image:

docker pull jlesage/filebot

Stop the container:

docker stop filebot

Remove the container:

docker rm filebot

Recreate and start the container using the docker run command, with the same parameters used during initial deployment.

Synology

For Synology NAS users, follow these steps to update a container image:

Open the Docker application.
Click Registry in the left pane.
In the search bar, type the name of the container (jlesage/filebot).
Select the image, click Download, and choose the latest tag.
Wait for the download to complete. A notification will appear once done.
Click Container in the left pane.
Select your FileBot container.
Stop it by clicking Action -> Stop.
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.
Start the container again by clicking Action -> Start. NOTE: The container may temporarily disappear from the list while it is recreated.

unRAID

For unRAID users, update a container image with these steps:

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

User/Group IDs

When mapping data volumes (using the -v flag of the docker run command), permission issues may arise between the host and the container. Files and folders in a data volume are owned by a user, which may differ from the user running the application. Depending on permissions, this could prevent the container from accessing the shared volume.

To avoid this, specify the user the application should run as using the USER_ID and GROUP_ID environment variables.

To find the appropriate IDs, run the following command on the host for the user owning the data volume:

id <username>

This produces output like:

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

Use the uid (user ID) and gid (group ID) values to configure the container.

Accessing the GUI

Assuming the container's ports are mapped to the same host's ports, access the application's GUI as follows:

Via a web browser:

http://<HOST_IP_ADDR>:5800

Via any VNC client:

<HOST_IP_ADDR>:5900

Security

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

A secure connection can be enabled via the SECURE_CONNECTION environment variable. See the Environment Variables section for details on configuring environment variables.

When enabled, the GUI is accessed over HTTPS when using a browser, with all HTTP accesses redirected to HTTPS.

For VNC clients, the connection can be secured using on of two methods, configured via the SECURE_CONNECTION_VNC_METHOD environment variable:

SSL: An SSL tunnel is used to transport the VNC connection. Few VNC clients supports this method; SSVNC is one that does.
TLS: A VNC security type negotiated during the VNC handshake. It uses TLS to establish a secure connection. Clients may optionally validate the server’s certificate. Valid certificates must be provided for this validation to succeed. See Certificates for details. TigerVNC is a client that supports TLS encryption.

SSVNC

SSVNC is a VNC viewer that adds encryption to VNC connections by using an SSL tunnel to transport the VNC traffic.

While the Linux version of SSVNC works well, the Windows version has issues. At the time of writing, the latest version 1.0.30 fails with the error:

ReadExact: Socket error while reading

For convenience, an unofficial, working version is provided here:

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

This version upgrades the bundled stunnel to version 5.49, resolving the connection issues.

Certificates

The following certificate files are required by the container. If missing, self-signed certificates are generated and used. All files are 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 avoid certificate validity warnings or errors in browsers or VNC clients, provide your own valid certificates.

Note

Certificate files are monitored, and relevant services are restarted when changes are detected.

VNC Password

To restrict access to your application, set a password using one of two methods:

Via the VNC_PASSWORD environment variable.
Via a .vncpass_clear file at the root of the /config volume, containing the password in clear text. During container startup, the content is obfuscated and moved to .vncpass.

The security of the VNC password depends on:

The communication channel (encrypted or unencrypted).
The security of host access.

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

Unauthorized users with sufficient host privileges can retrieve the password by:

Viewing the VNC_PASSWORD environment variable via docker inspect. By default, the docker command requires root access, but it can be configured to allow users in a specific group.
Decrypting the /config/.vncpass file, which requires root or USER_ID permissions.

Caution

VNC password is limited to 8 characters. This limitation comes from the Remote Framebuffer Protocol RFC (see section 7.2.2).

Web Authentication

Access to the application's GUI via a web browser can be protected with a login page. When enabled, users must provide valid credentials to gain access.

Enable web authentication by setting the WEB_AUTHENTICATION environment variable to 1. See the Environment Variables section for details on configuring environment variables.

Important

Web authentication requires a secure connection to be enabled. See Security for details.

Configuring Users Credentials

User credentials can be configured in two ways:

Via container environment variables.
Via a password database.

Container environment variables provide a quick way to configure a single user. Set the username and password using:

WEB_AUTHENTICATION_USERNAME
WEB_AUTHENTICATION_PASSWORD

See the Environment Variables section for details on configuring environment variables.

For a more secure method or to configure multiple users, use a password database at /config/webauth-htpasswd within the container. This file uses the Apache HTTP server's htpasswd format, storing bcrypt-hashed passwords.

Manage users with the webauth-user tool:

Add a user: docker exec -ti <container name> webauth-user add <username>
Update a user: docker exec -ti <container name> webauth-user update <username>
Remove a user: docker exec <container name> webauth-user del <username>
List users: docker exec <container name> webauth-user list

Reverse Proxy

The following sections provide NGINX configurations for setting up a reverse proxy to this container.

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

Routing Based on Hostname

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

For example, if the reverse proxy server runs on the same machine as this container, it would proxy all HTTP requests for filebot.domain.tld to the container at 127.0.0.1:5800.

Here are the relevant configuration elements to add 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;
	}

	# Needed when audio support is enabled.
	location /websockify-audio {
		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 same hostname is used, but different URL paths route to different applications or containers. For example, if the reverse proxy server runs on the same machine as this container, it 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 to add 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;
		}
		# Needed when audio support is enabled.
		location /filebot/websockify-audio {
			proxy_pass http://docker-filebot/websockify-audio;
			proxy_http_version 1.1;
			proxy_set_header Upgrade $http_upgrade;
			proxy_set_header Connection $connection_upgrade;
			proxy_read_timeout 86400;
		}
	}
}

Web Audio

The container supports streaming audio from the application, played through the user's web browser. Audio is not supported for VNC clients.

Audio is streamed with the following specification:

Raw PCM format
2 channels
16-bit sample depth
44.1kHz sample rate

Enable web audio by setting WEB_AUDIO to 1. See the Environment Variables section for details on configuring environment variables.

Web File Manager

The container includes a simple file manager for interacting with container files through a web browser, supporting operations like renaming, deleting, uploading, and downloading.

Enable the file manager by setting WEB_FILE_MANAGER to 1. See the Environment Variables section for details on configuring environment variables.

By default, the container's entire filesystem is not accessible. The WEB_FILE_MANAGER_ALLOWED_PATHS environment variable is a comma-separated list that specifies which paths within the container are allowed to be accessed. When set to AUTO (the default), it automatically includes commonly used folders and any folders mapped to the container.

The WEB_FILE_MANAGER_DENIED_PATHS environment variable defines which paths are explicitly denied access by the file manager. A denied path takes precedence over an allowed one.

Shell Access

To access the shell of a 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 Dockerized applications, visit https://jlesage.github.io/docker-apps.

Name		Name	Last commit message	Last commit date
Latest commit History 289 Commits
.github		.github
rootfs		rootfs
src		src
DOCKERHUB.md		DOCKERHUB.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
appdefs.yml		appdefs.yml

Uh oh!

License

jlesage/docker-filebot

Folders and files

Latest commit

History

Repository files navigation

Docker container for FileBot

Table of Contents

Quick Start

Usage

Environment Variables

Deployment Considerations

Data Volumes

Ports

Changing Parameters of a Running Container

Docker Compose File

Docker Image Versioning and Tags

Docker Image Update

Synology

unRAID

User/Group IDs

Accessing the GUI

Security

SSVNC

Certificates

VNC Password

Web Authentication

Configuring Users Credentials

Reverse Proxy

Routing Based on Hostname

Routing Based on URL Path

Web Audio

Web File Manager

Shell Access

License

Installing a License

Donation Supported Version

Automated Media Center (AMC)

Using a Beta Version

Support or Contact

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 63

Sponsor this project

Uh oh!

Packages 0

Uh oh!

Uh oh!

Languages

Packages