FileBot

FileBot

Docker app from Djoss' Repository

Overview

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. 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. The container is built against Alpine Linux to provide an efficient image in terms of size and resource usage. For a complete documentation of this container, see https://github.com/jlesage/docker-filebot#readme

Runtime arguments

Web UI
http://[IP]:[PORT:5800]
Network
bridge
Privileged
false

Template configuration

Config DirectoryPathrw

Stores the application's configuration, state, logs, and any files requiring persistency.

Target
/config
Default
/mnt/user/appdata/filebot
StoragePathrw

Contains files from the host that need to be accessible to the application.

Target
/storage
Default
/mnt/user
Automated Media Center: Watch DirectoryPathrw

This is the input folder of the Automated Media Center (AMC) script. Any media copied to this folder will be processed by the script.

Target
/watch
Automated Media Center: Output DirectoryPathrw

This is the output folder of the Automated Media Center (AMC) script. This is where medias are located once they are renamed and organized.

Target
/output
User IDVariable

ID of the user the application runs as.

Target
USER_ID
Default
99
Group IDVariable

ID of the group the application runs as.

Target
GROUP_ID
Default
100
UmaskVariable

Mask controlling permissions for newly created files and folders, specified in octal notation.

Target
UMASK
Default
0000
Niceness (priority)Variable

Priority at which the application should run. A niceness value of `-20` is the highest, `19` is the lowest and `0` the default. NOTE: Setting a negative value requires additional permissions. Thus, `--cap-add=SYS_NICE` must be added to Extra Parameters (shown when Advanced View is enabled).

Target
APP_NICENESS
Default
0
Display WidthVariable

Width (in pixels) of the application's window.

Target
DISPLAY_WIDTH
Default
1920
Display HeightVariable

Height (in pixels) of the application's window.

Target
DISPLAY_HEIGHT
Default
1080
Dark ModeVariable

When set to `1`, enables dark mode for the application.

Target
DARK_MODE
Default
0
Web AudioVariable

When set to `1`, enables audio support, allowing audio produced by the application to play through the browser.

Target
WEB_AUDIO
Default
0
Web File ManagerVariable

When set to `1`, enables the web file manager, allowing interaction with files inside the container through a web browser, supporting operations like renaming, deleting, uploading, and downloading.

Target
WEB_FILE_MANAGER
Default
0
Web File Manager Allowed PathsVariable

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

Target
WEB_FILE_MANAGER_ALLOWED_PATHS
Default
AUTO
Web File Manager Denied PathsVariable

Comma-separated list of paths within the container that the file manager cannot access. A denied path takes precedence over an allowed path.

Target
WEB_FILE_MANAGER_DENIED_PATHS
Default
None
Web Desktop NotificationsVariable

When set to `1`, enables the web notification service, allowing the browser to display desktop notifications from the application.

Target
WEB_NOTIFICATION
Default
0
Web TerminalVariable

When set to `1`, enables access to a terminal from the web interface. It is strongly recommended to configure the container with secure web access (HTTPS).

Target
WEB_TERMINAL
Default
0
Web AuthenticationVariable

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.

Target
WEB_AUTHENTICATION
Default
0
Web Authentication Token Validity TimeVariable

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.

Target
WEB_AUTHENTICATION_TOKEN_VALIDITY_TIME
Default
24
Web Authentication UsernameVariable

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

Target
WEB_AUTHENTICATION_USERNAME
Web Authentication PasswordVariable

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

Target
WEB_AUTHENTICATION_PASSWORD
Secure ConnectionVariable

When set to `1`, uses an encrypted connection to access the application's GUI (via web browser or VNC client).

Target
SECURE_CONNECTION
Default
0
Secure Connection VNC MethodVariable

Method used for encrypted VNC connection. Possible values are `SSL` or `TLS`.

Target
SECURE_CONNECTION_VNC_METHOD
Default
SSL
Secure Connection Certificate Check IntervalVariable

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.

Target
SECURE_CONNECTION_CERTS_CHECK_INTERVAL
Default
60
Web Listening Port (Non-Bridge Network Type)Variable

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. NOTE: This setting is relevant only when the Network Type is set to something else than Bridge.

Target
WEB_LISTENING_PORT
Default
5800
VNC Listening Port (Non-Bridge Network Type)Variable

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. NOTE: This setting is relevant only when the Network Type is set to something else than Bridge.

Target
VNC_LISTENING_PORT
Default
5900
FileBot GUI StateVariable

Setting this to `1` enables the FileBot GUI, `0` disables it.

Target
FILEBOT_GUI
Default
1
Automated Media Center: StateVariable

Setting this to `1` enables the Automated Media Center (AMC) script, `0` disables it.

Target
AMC_ENABLED
Default
1
OpenSubtitles UsernameVariable

Username of your OpenSubtitles (https://www.opensubtitles.com) account. Required to download subtitles.

Target
OPENSUBTITLES_USERNAME
OpenSubtitles PasswordVariable

Password of your OpenSubtitles (https://www.opensubtitles.com) account. Required to download subtitles.

Target
OPENSUBTITLES_PASSWORD
Custom OptionsVariable

Custom arguments to pass to FileBot. This applies to the UI only.

Target
FILEBOT_CUSTOM_OPTIONS
Use FileBot Beta VersionVariable

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](#using-a-beta-version) section for more details. **NOTE**: Use at your own risk. Beta version may have bugs and stability issues.

Target
USE_FILEBOT_BETA
Default
0
Automated Media Center: IntervalVariable

Time (in seconds) between each invocation of the Automated Media Center (AMC) script.

Target
AMC_INTERVAL
Default
1800
Automated Media Center: Input Stable TimeVariable

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.

Target
AMC_INPUT_STABLE_TIME
Default
10
Automated Media Center: ActionVariable

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.

Target
AMC_ACTION
Default
test
Automated Media Center: Conflict ResolutionVariable

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.

Target
AMC_CONFLICT
Default
auto
Automated Media Center: Match ModeVariable

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 https://www.filebot.net/forums/viewtopic.php?t=4695 for complete documentation.

Target
AMC_MATCH_MODE
Default
opportunistic
Automated Media Center: ArtworkVariable

When set to `y`, artwork is fetched and NFO file is generated by the Automated Media Center (AMC) script.

Target
AMC_ARTWORK
Default
n
Automated Media Center: LanguageVariable

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.

Target
AMC_LANG
Default
English
Automated Media Center: Music FormatVariable

Define how music files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See https://www.filebot.net/naming.html for complete documentation.

Target
AMC_MUSIC_FORMAT
Default
{plex}
Automated Media Center: Movie FormatVariable

Define how movie files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See https://www.filebot.net/naming.html for complete documentation.

Target
AMC_MOVIE_FORMAT
Default
{plex}
Automated Media Center: TV Series FormatVariable

Define how TV series files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See https://www.filebot.net/naming.html for complete documentation.

Target
AMC_SERIES_FORMAT
Default
{plex}
Automated Media Center: Anime FormatVariable

Define how anime files are renamed by the Automated Media Center (AMC) script. Filebot supports a very powerful naming scheme. See https://www.filebot.net/naming.html for complete documentation.

Target
AMC_ANIME_FORMAT
Default
{plex}
Automated Media Center: Process MusicVariable

When set to `y`, music files are processed by the Automated Media Center (AMC) script. A value of `n` does not process them.

Target
AMC_PROCESS_MUSIC
Default
y
Automated Media Center: Subtitle LanguagesVariable

Comma-separated list of subtitle languages to download. Example: `en,de,fr`.

Target
AMC_SUBTITLE_LANG
Automated Media Center: Custom OptionsVariable

Custom arguments to pass to the Automated Media Center (AMC) script.

Target
AMC_CUSTOM_OPTIONS
Automated Media Center: Input DirectoryVariable

Directory inside the container used as the input folder of the Automated Media Center (AMC) script.

Target
AMC_INPUT_DIR
Default
/watch
Automated Media Center: Output DirectoryVariable

Directory inside the container used as the output folder of the Automated Media Center (AMC) script.

Target
AMC_OUTPUT_DIR
Default
/output
WEB Port for GUI (Bridge Network Type)Porttcp

Port to access the application's GUI via the web interface. NOTE: This setting is relevant only when the Network Type is set to `Bridge`.

Target
5800
Default
7813
VNC Port for GUI (Bridge Network Type)Porttcp

Port to access the application's GUI via VNC protocol. Optional if no VNC client is used. NOTE: This setting is relevant only when the Network Type is set to `Bridge`.

Target
5900
Default
7913

Download Statistics

19,777,587
Total Downloads
67,874
This Month
67,214
Avg / Month

Total Downloads Over Time

Loading chart...

Details

Repository
jlesage/filebot
Last Updated2026-03-14
First Seen2018-09-18

Run FileBot on Unraid.

FileBot is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.