FileBot
Docker app from Djoss' Repository
Overview
Runtime arguments
- Web UI
http://[IP]:[PORT:5800]- Network
bridge- Privileged
- false
Template configuration
Stores the application's configuration, state, logs, and any files requiring persistency.
- Target
- /config
- Default
- /mnt/user/appdata/filebot
Contains files from the host that need to be accessible to the application.
- Target
- /storage
- Default
- /mnt/user
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
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
ID of the user the application runs as.
- Target
- USER_ID
- Default
- 99
ID of the group the application runs as.
- Target
- GROUP_ID
- Default
- 100
Mask controlling permissions for newly created files and folders, specified in octal notation.
- Target
- UMASK
- Default
- 0000
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
Width (in pixels) of the application's window.
- Target
- DISPLAY_WIDTH
- Default
- 1920
Height (in pixels) of the application's window.
- Target
- DISPLAY_HEIGHT
- Default
- 1080
When set to `1`, enables dark mode for the application.
- Target
- DARK_MODE
- Default
- 0
When set to `1`, enables audio support, allowing audio produced by the application to play through the browser.
- Target
- WEB_AUDIO
- Default
- 0
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
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
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
When set to `1`, enables the web notification service, allowing the browser to display desktop notifications from the application.
- Target
- WEB_NOTIFICATION
- Default
- 0
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
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
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
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
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
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
Method used for encrypted VNC connection. Possible values are `SSL` or `TLS`.
- Target
- SECURE_CONNECTION_VNC_METHOD
- Default
- SSL
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
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
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
Setting this to `1` enables the FileBot GUI, `0` disables it.
- Target
- FILEBOT_GUI
- Default
- 1
Setting this to `1` enables the Automated Media Center (AMC) script, `0` disables it.
- Target
- AMC_ENABLED
- Default
- 1
Username of your OpenSubtitles (https://www.opensubtitles.com) account. Required to download subtitles.
- Target
- OPENSUBTITLES_USERNAME
Password of your OpenSubtitles (https://www.opensubtitles.com) account. Required to download subtitles.
- Target
- OPENSUBTITLES_PASSWORD
Custom arguments to pass to FileBot. This applies to the UI only.
- Target
- FILEBOT_CUSTOM_OPTIONS
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
Time (in seconds) between each invocation of the Automated Media Center (AMC) script.
- Target
- AMC_INTERVAL
- Default
- 1800
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
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
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
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
When set to `y`, artwork is fetched and NFO file is generated by the Automated Media Center (AMC) script.
- Target
- AMC_ARTWORK
- Default
- n
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
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}
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}
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}
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}
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
Comma-separated list of subtitle languages to download. Example: `en,de,fr`.
- Target
- AMC_SUBTITLE_LANG
Custom arguments to pass to the Automated Media Center (AMC) script.
- Target
- AMC_CUSTOM_OPTIONS
Directory inside the container used as the input folder of the Automated Media Center (AMC) script.
- Target
- AMC_INPUT_DIR
- Default
- /watch
Directory inside the container used as the output folder of the Automated Media Center (AMC) script.
- Target
- AMC_OUTPUT_DIR
- Default
- /output
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
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
Categories
Download Statistics
Total Downloads Over Time
Details
jlesage/filebotRun FileBot on Unraid.
FileBot is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.