File Browser

Description / name	Input element
Your domain name

Overview

File Browser is is a create-your-own-cloud-kind of software where you can install it on a server, direct it to a path and then access your files through a nice web interface. You have many available features!.

Manual

Releases

Community

---

Deployment

sb install sandbox-filebrowser

Usage

Visit https://filebrowser.iYOUR_DOMAIN_NAMEi.

Info

The initial admin user has a randomly generated password. You may retrieve this password in the container logs via docker logs filebrowser. We recommend changing the credentials promptly upon deployment.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   filebrowser_name: "custom_value"
   

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like filebrowser_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

   Instead, use the corresponding _custom variable (like filebrowser_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

filebrowser_name

# Type: string
filebrowser_name: filebrowser

filebrowser_role_web_subdomain

# Type: string
filebrowser_role_web_subdomain: "{{ filebrowser_name }}"

filebrowser_role_web_domain

# Type: string
filebrowser_role_web_domain: "{{ user.domain }}"

filebrowser_role_web_port

# Type: string
filebrowser_role_web_port: "80"

filebrowser_role_web_url

# Type: string
filebrowser_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='filebrowser') + '.' + lookup('role_var', '_web_domain', role='filebrowser')
                           if (lookup('role_var', '_web_subdomain', role='filebrowser') | length > 0)
                           else lookup('role_var', '_web_domain', role='filebrowser')) }}"

filebrowser_role_dns_record

# Type: string
filebrowser_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='filebrowser') }}"

filebrowser_role_dns_zone

# Type: string
filebrowser_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='filebrowser') }}"

filebrowser_role_dns_proxy

# Type: bool (true/false)
filebrowser_role_dns_proxy: "{{ dns_proxied }}"

filebrowser_role_traefik_sso_middleware

# Type: string
filebrowser_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

filebrowser_role_traefik_middleware_default

# Type: string
filebrowser_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

filebrowser_role_traefik_middleware_custom

# Type: string
filebrowser_role_traefik_middleware_custom: ""

filebrowser_role_traefik_certresolver

# Type: string
filebrowser_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

filebrowser_role_traefik_enabled

# Type: bool (true/false)
filebrowser_role_traefik_enabled: true

filebrowser_role_traefik_api_enabled

# Type: bool (true/false)
filebrowser_role_traefik_api_enabled: true

filebrowser_role_traefik_api_endpoint

# Type: string
filebrowser_role_traefik_api_endpoint: "PathPrefix(`/api`) || PathPrefix(`/share`) || PathPrefix(`/static`) || PathPrefix(`/api/public`)"

Container

filebrowser_role_docker_container

# Type: string
filebrowser_role_docker_container: "{{ filebrowser_name }}"

Image

filebrowser_role_docker_image_pull

# Type: bool (true/false)
filebrowser_role_docker_image_pull: true

filebrowser_role_docker_image_repo

# Type: string
filebrowser_role_docker_image_repo: "filebrowser/filebrowser"

filebrowser_role_docker_image_tag

# Type: string
filebrowser_role_docker_image_tag: "latest"

filebrowser_role_docker_image

# Type: string
filebrowser_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='filebrowser') }}:{{ lookup('role_var', '_docker_image_tag', role='filebrowser') }}"

Envs

filebrowser_role_docker_envs_default

# Type: dict
filebrowser_role_docker_envs_default:
  TZ: "{{ tz }}"

filebrowser_role_docker_envs_custom

# Type: dict
filebrowser_role_docker_envs_custom: {}

Volumes

filebrowser_role_docker_volumes_default

# Type: list
filebrowser_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_db_folder', role='filebrowser') }}:/database"
  - "{{ lookup('role_var', '_paths_config_folder', role='filebrowser') }}:/config"
  - "/mnt/unionfs:/srv:rslave"

filebrowser_role_docker_volumes_custom

# Type: list
filebrowser_role_docker_volumes_custom: []

Hostname

filebrowser_role_docker_hostname

# Type: string
filebrowser_role_docker_hostname: "{{ filebrowser_name }}"

Networks

filebrowser_role_docker_networks_alias

# Type: string
filebrowser_role_docker_networks_alias: "{{ filebrowser_name }}"

filebrowser_role_docker_networks_default

# Type: list
filebrowser_role_docker_networks_default: []

filebrowser_role_docker_networks_custom

# Type: list
filebrowser_role_docker_networks_custom: []

Restart Policy

filebrowser_role_docker_restart_policy

# Type: string
filebrowser_role_docker_restart_policy: unless-stopped

State

filebrowser_role_docker_state

# Type: string
filebrowser_role_docker_state: started

User

filebrowser_role_docker_user

# Type: string
filebrowser_role_docker_user: "{{ uid }}:{{ gid }}"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

filebrowser_role_docker_blkio_weight

# Type: int
filebrowser_role_docker_blkio_weight:

filebrowser_role_docker_cpu_period

# Type: int
filebrowser_role_docker_cpu_period:

filebrowser_role_docker_cpu_quota

# Type: int
filebrowser_role_docker_cpu_quota:

filebrowser_role_docker_cpu_shares

# Type: int
filebrowser_role_docker_cpu_shares:

filebrowser_role_docker_cpus

# Type: string
filebrowser_role_docker_cpus:

filebrowser_role_docker_cpuset_cpus

# Type: string
filebrowser_role_docker_cpuset_cpus:

filebrowser_role_docker_cpuset_mems

# Type: string
filebrowser_role_docker_cpuset_mems:

filebrowser_role_docker_kernel_memory

# Type: string
filebrowser_role_docker_kernel_memory:

filebrowser_role_docker_memory

# Type: string
filebrowser_role_docker_memory:

filebrowser_role_docker_memory_reservation

# Type: string
filebrowser_role_docker_memory_reservation:

filebrowser_role_docker_memory_swap

# Type: string
filebrowser_role_docker_memory_swap:

filebrowser_role_docker_memory_swappiness

# Type: int
filebrowser_role_docker_memory_swappiness:

filebrowser_role_docker_shm_size

# Type: string
filebrowser_role_docker_shm_size:

Security & Devices

filebrowser_role_docker_cap_drop

# Type: list
filebrowser_role_docker_cap_drop:

filebrowser_role_docker_cgroupns_mode

# Type: string
filebrowser_role_docker_cgroupns_mode:

filebrowser_role_docker_device_cgroup_rules

# Type: list
filebrowser_role_docker_device_cgroup_rules:

filebrowser_role_docker_device_read_bps

# Type: list
filebrowser_role_docker_device_read_bps:

filebrowser_role_docker_device_read_iops

# Type: list
filebrowser_role_docker_device_read_iops:

filebrowser_role_docker_device_requests

# Type: list
filebrowser_role_docker_device_requests:

filebrowser_role_docker_device_write_bps

# Type: list
filebrowser_role_docker_device_write_bps:

filebrowser_role_docker_device_write_iops

# Type: list
filebrowser_role_docker_device_write_iops:

filebrowser_role_docker_devices

# Type: list
filebrowser_role_docker_devices:

filebrowser_role_docker_devices_default

# Type: string
filebrowser_role_docker_devices_default:

filebrowser_role_docker_groups

# Type: list
filebrowser_role_docker_groups:

filebrowser_role_docker_privileged

# Type: bool (true/false)
filebrowser_role_docker_privileged:

filebrowser_role_docker_security_opts

# Type: list
filebrowser_role_docker_security_opts:

filebrowser_role_docker_userns_mode

# Type: string
filebrowser_role_docker_userns_mode:

Networking

filebrowser_role_docker_dns_opts

# Type: list
filebrowser_role_docker_dns_opts:

filebrowser_role_docker_dns_search_domains

# Type: list
filebrowser_role_docker_dns_search_domains:

filebrowser_role_docker_dns_servers

# Type: list
filebrowser_role_docker_dns_servers:

filebrowser_role_docker_domainname

# Type: string
filebrowser_role_docker_domainname:

filebrowser_role_docker_exposed_ports

# Type: list
filebrowser_role_docker_exposed_ports:

filebrowser_role_docker_hosts

# Type: dict
filebrowser_role_docker_hosts:

filebrowser_role_docker_hosts_use_common

# Type: bool (true/false)
filebrowser_role_docker_hosts_use_common:

filebrowser_role_docker_ipc_mode

# Type: string
filebrowser_role_docker_ipc_mode:

filebrowser_role_docker_links

# Type: list
filebrowser_role_docker_links:

filebrowser_role_docker_network_mode

# Type: string
filebrowser_role_docker_network_mode:

filebrowser_role_docker_pid_mode

# Type: string
filebrowser_role_docker_pid_mode:

filebrowser_role_docker_ports

# Type: list
filebrowser_role_docker_ports:

filebrowser_role_docker_uts

# Type: string
filebrowser_role_docker_uts:

Storage

filebrowser_role_docker_keep_volumes

# Type: bool (true/false)
filebrowser_role_docker_keep_volumes:

filebrowser_role_docker_mounts

# Type: list
filebrowser_role_docker_mounts:

filebrowser_role_docker_storage_opts

# Type: dict
filebrowser_role_docker_storage_opts:

filebrowser_role_docker_tmpfs

# Type: list
filebrowser_role_docker_tmpfs:

filebrowser_role_docker_volume_driver

# Type: string
filebrowser_role_docker_volume_driver:

filebrowser_role_docker_volumes_from

# Type: list
filebrowser_role_docker_volumes_from:

filebrowser_role_docker_volumes_global

# Type: bool (true/false)
filebrowser_role_docker_volumes_global:

filebrowser_role_docker_working_dir

# Type: string
filebrowser_role_docker_working_dir:

Monitoring & Lifecycle

filebrowser_role_docker_auto_remove

# Type: bool (true/false)
filebrowser_role_docker_auto_remove:

filebrowser_role_docker_cleanup

# Type: bool (true/false)
filebrowser_role_docker_cleanup:

filebrowser_role_docker_force_kill

# Type: string
filebrowser_role_docker_force_kill:

filebrowser_role_docker_healthcheck

# Type: dict
filebrowser_role_docker_healthcheck:

filebrowser_role_docker_healthy_wait_timeout

# Type: int
filebrowser_role_docker_healthy_wait_timeout:

filebrowser_role_docker_init

# Type: bool (true/false)
filebrowser_role_docker_init:

filebrowser_role_docker_kill_signal

# Type: string
filebrowser_role_docker_kill_signal:

filebrowser_role_docker_log_driver

# Type: string
filebrowser_role_docker_log_driver:

filebrowser_role_docker_log_options

# Type: dict
filebrowser_role_docker_log_options:

filebrowser_role_docker_oom_killer

# Type: bool (true/false)
filebrowser_role_docker_oom_killer:

filebrowser_role_docker_oom_score_adj

# Type: int
filebrowser_role_docker_oom_score_adj:

filebrowser_role_docker_output_logs

# Type: bool (true/false)
filebrowser_role_docker_output_logs:

filebrowser_role_docker_paused

# Type: bool (true/false)
filebrowser_role_docker_paused:

filebrowser_role_docker_recreate

# Type: bool (true/false)
filebrowser_role_docker_recreate:

filebrowser_role_docker_restart_retries

# Type: int
filebrowser_role_docker_restart_retries:

filebrowser_role_docker_stop_timeout

# Type: int
filebrowser_role_docker_stop_timeout:

Other Options

filebrowser_role_docker_capabilities

# Type: list
filebrowser_role_docker_capabilities:

filebrowser_role_docker_cgroup_parent

# Type: string
filebrowser_role_docker_cgroup_parent:

filebrowser_role_docker_commands

# Type: list
filebrowser_role_docker_commands:

filebrowser_role_docker_create_timeout

# Type: int
filebrowser_role_docker_create_timeout:

filebrowser_role_docker_entrypoint

# Type: string
filebrowser_role_docker_entrypoint:

filebrowser_role_docker_env_file

# Type: string
filebrowser_role_docker_env_file:

filebrowser_role_docker_labels

# Type: dict
filebrowser_role_docker_labels:

filebrowser_role_docker_labels_use_common

# Type: bool (true/false)
filebrowser_role_docker_labels_use_common:

filebrowser_role_docker_read_only

# Type: bool (true/false)
filebrowser_role_docker_read_only:

filebrowser_role_docker_runtime

# Type: string
filebrowser_role_docker_runtime:

filebrowser_role_docker_sysctls

# Type: list
filebrowser_role_docker_sysctls:

filebrowser_role_docker_ulimits

# Type: list
filebrowser_role_docker_ulimits:

filebrowser_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
filebrowser_role_autoheal_enabled: true

filebrowser_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
filebrowser_role_depends_on: ""

filebrowser_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
filebrowser_role_depends_on_delay: "0"

filebrowser_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
filebrowser_role_depends_on_healthchecks:

filebrowser_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
filebrowser_role_diun_enabled: true

filebrowser_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
filebrowser_role_dns_enabled: true

filebrowser_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
filebrowser_role_docker_controller: true

filebrowser_role_docker_image_repo

# Type: string
filebrowser_role_docker_image_repo:

filebrowser_role_docker_image_tag

# Type: string
filebrowser_role_docker_image_tag:

filebrowser_role_docker_volumes_download

# Type: bool (true/false)
filebrowser_role_docker_volumes_download:

filebrowser_role_paths_config_folder

# Type: string
filebrowser_role_paths_config_folder:

filebrowser_role_paths_db_folder

# Type: string
filebrowser_role_paths_db_folder:

filebrowser_role_themepark_addons

# Type: string
filebrowser_role_themepark_addons:

filebrowser_role_themepark_app

# Type: string
filebrowser_role_themepark_app:

filebrowser_role_themepark_theme

# Type: string
filebrowser_role_themepark_theme:

filebrowser_role_traefik_api_endpoint

# Type: dict/omit
filebrowser_role_traefik_api_endpoint:

filebrowser_role_traefik_api_middleware

# Type: string
filebrowser_role_traefik_api_middleware:

filebrowser_role_traefik_api_middleware_http

# Type: string
filebrowser_role_traefik_api_middleware_http:

filebrowser_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
filebrowser_role_traefik_autodetect_enabled: false

filebrowser_role_traefik_certresolver

# Type: string
filebrowser_role_traefik_certresolver:

filebrowser_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
filebrowser_role_traefik_crowdsec_enabled: false

filebrowser_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
filebrowser_role_traefik_error_pages_enabled: false

filebrowser_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
filebrowser_role_traefik_gzip_enabled: false

filebrowser_role_traefik_middleware_http

# Type: string
filebrowser_role_traefik_middleware_http:

filebrowser_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
filebrowser_role_traefik_middleware_http_api_insecure:

filebrowser_role_traefik_middleware_http_insecure

# Type: bool (true/false)
filebrowser_role_traefik_middleware_http_insecure:

filebrowser_role_traefik_priority

# Type: string
filebrowser_role_traefik_priority:

filebrowser_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
filebrowser_role_traefik_robot_enabled: true

filebrowser_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
filebrowser_role_traefik_tailscale_enabled: false

filebrowser_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
filebrowser_role_traefik_wildcard_enabled: true

filebrowser_role_web_domain

# Type: string
filebrowser_role_web_domain:

filebrowser_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
filebrowser_role_web_fqdn_override:

Example Override

filebrowser_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "filebrowser2.{{ user.domain }}"
  - "filebrowser.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

filebrowser_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
filebrowser_role_web_host_override:

Example Override

filebrowser_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'filebrowser2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

filebrowser_role_web_http_port

# Type: string (quoted number)
filebrowser_role_web_http_port:

filebrowser_role_web_http_scheme

# Type: string ("http"/"https")
filebrowser_role_web_http_scheme:

filebrowser_role_web_http_serverstransport

# Type: dict/omit
filebrowser_role_web_http_serverstransport:

filebrowser_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
filebrowser_role_web_scheme:

filebrowser_role_web_serverstransport

# Type: dict/omit
filebrowser_role_web_serverstransport:

filebrowser_role_web_subdomain

# Type: string
filebrowser_role_web_subdomain: