Remote

Overview

Manages remote storage mounts.

---

Deployment

Saltbox dependency.

sb install mounts

Role Defaults

Info

Variables can be overridden in /srv/git/saltbox/inventories/host_vars/localhost.yml.

Example Override

user_agent: "custom_value"

GlobalRclone VFS RefreshNFSGlobal Override Options

user_agent

# Type: string
user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.131 Safari/537.36

rclone_config_path

# Type: string
rclone_config_path: "/home/{{ user.name }}/.config/rclone/rclone.conf"

rclone_vfs_cache_dir

# Type: string
rclone_vfs_cache_dir: ""

rclone_vfs_cache_dir_lookup

# Type: string
rclone_vfs_cache_dir_lookup: "{{ lookup('vars', 'rclone_remote_' + rclone_remote_name + '_vfs_cache_dir', default=rclone_vfs_cache_dir) }}"

rclone_vfs_cache_min_free_space

# Type: string
rclone_vfs_cache_min_free_space: "off"

rclone_vfs_cache_poll_interval

# Type: string
rclone_vfs_cache_poll_interval: "1m0s"

rclone_cloud_dir_cache_time

# Type: string
rclone_cloud_dir_cache_time: "8760h"

rclone_sftp_dir_cache_time

# Type: string
rclone_sftp_dir_cache_time: "1m"

rclone_sftp_chunk_size

# Read https://rclone.org/sftp/#sftp-chunk-size if you want to change the chunk size
# Type: string
rclone_sftp_chunk_size: "32Ki"

rclone_sftp_concurrency

# Type: string
rclone_sftp_concurrency: "64"

rclone_sftp_disable_hashcheck

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

rclone_service_template

# Type: string
rclone_service_template: "saltbox_managed_rclone_"

rclone_port_lookup

# Type: string
rclone_port_lookup: "{{ port_lookup_rclone.meta.port
                     if (port_lookup_rclone.meta.port is defined) and (port_lookup_rclone.meta.port | trim | length > 0)
                     else '5572' }}"

rclone_remort_port

# Type: string
rclone_remort_port: "{{ lookup('vars', 'rclone_remote_' + rclone_remote_name + '_port', default=rclone_port_lookup) }}"

rclone_remort_port_low_bound

# Type: int
rclone_remort_port_low_bound: 5572

rclone_remort_port_high_bound

# Type: int
rclone_remort_port_high_bound: 6072

rclone_remote_name

# Type: string
rclone_remote_name: "{{ item | filter_rclone_remote_name }}"

rclone_remote_with_path

# Type: string
rclone_remote_with_path: "{{ item | filter_rclone_remote_with_path }}"

rclone_first_remote_name

# Type: string
rclone_first_remote_name: "{{ rclone | filter_rclone_first_remote_name }}"

rclone_first_remote_name_with_path

# Type: string
rclone_first_remote_name_with_path: "{{ rclone | filter_rclone_first_remote_name_with_path }}"

remote_update_rclone

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

rclone_enable_metrics

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

rclone_vfs_refresh_interval

# Type: int
rclone_vfs_refresh_interval: 10800

rclone_vfs_refresh_command

# Type: string
rclone_vfs_refresh_command: |-
  /usr/bin/rclone rc vfs/refresh recursive=true --url http://localhost:{{ rclone_remort_port }} _async=true

nfs_opts

# Type: string
nfs_opts: "nofail,noatime,nolock,intr,tcp,actimeo=1800"

remote_role_autoheal_enabled

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

remote_role_depends_on

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

remote_role_depends_on_delay

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

remote_role_depends_on_healthchecks

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

remote_role_diun_enabled

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

remote_role_dns_enabled

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

remote_role_docker_controller

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

remote_role_traefik_autodetect_enabled

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

remote_role_traefik_crowdsec_enabled

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

remote_role_traefik_error_pages_enabled

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

remote_role_traefik_gzip_enabled

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

remote_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
remote_role_traefik_middleware_http_api_insecure:

remote_role_traefik_middleware_http_insecure

# Type: bool (true/false)
remote_role_traefik_middleware_http_insecure:

remote_role_traefik_robot_enabled

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

remote_role_traefik_tailscale_enabled

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

remote_role_traefik_wildcard_enabled

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

remote_role_web_fqdn_override

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

Example Override

remote_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "remote2.{{ user.domain }}"
  - "remote.otherdomain.tld"

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

remote_role_web_host_override

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

Example Override

remote_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'remote2.' + user.domain }}`)"

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

remote_role_web_scheme

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