Krusader¶

Description / name	Input element
Your domain name

Overview¶

Krusader is an advanced orthodox file manager for KDE and other desktops in the Unix world. It is similar to the console-based GNU Midnight Commander, GNOME Commander for the GNOME desktop environment, or Total Commander for Windows, all of which can trace their paradigmatic features to the original Norton Commander for DOS. It supports extensive archive handling, mounted filesystem support, FTP, advanced search, viewer/editor, directory synchronisation, file content comparisons, batch renaming, etc.

Manual

Releases

Community

Deployment¶

sb install sandbox-krusader

Usage¶

Visit https://krusader.iYOUR_DOMAIN_NAMEi. - Now you can click on vnc.html or vnc_lite.html

Basics¶

The configured password are taken from your Saltbox accounts.yml file located in /srv/git/saltbox/accounts.yml
/mnt is already mounted to /mnt

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
krusader_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like krusader_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 krusader_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsDocker Socket ProxyWebDNSTraefikDockerDocker+Global Override Options

krusader_name

# Type: string
krusader_name: krusader

krusader_role_docker_socket_proxy_envs

# Type: dict
krusader_role_docker_socket_proxy_envs:
  CONTAINERS: "1"
  POST: "0"

krusader_role_web_subdomain

# Type: string
krusader_role_web_subdomain: "{{ krusader_name }}"

krusader_role_web_domain

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

krusader_role_web_port

# Type: string
krusader_role_web_port: "6080"

krusader_role_web_url

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

krusader_role_dns_record

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

krusader_role_dns_zone

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

krusader_role_dns_proxy

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

krusader_role_traefik_sso_middleware

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

krusader_role_traefik_middleware_default

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

krusader_role_traefik_middleware_api

# Type: string
krusader_role_traefik_middleware_api: "{{ traefik_global_middleware }}"

krusader_role_traefik_certresolver

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

krusader_role_traefik_enabled

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

krusader_role_traefik_api_enabled

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

krusader_role_traefik_api_endpoint

# Type: string
krusader_role_traefik_api_endpoint: ""

Container

krusader_role_docker_container

# Type: string
krusader_role_docker_container: "{{ krusader_name }}"

Image

krusader_role_docker_image_pull

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

krusader_role_docker_image_tag

# Type: string
krusader_role_docker_image_tag: "latest"

krusader_role_docker_image_repo

# Type: string
krusader_role_docker_image_repo: "binhex/arch-krusader"

krusader_role_docker_image

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

Envs

krusader_role_docker_envs_default

# Type: dict
krusader_role_docker_envs_default:
  TZ: "{{ tz }}"
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  VNC_PASSWORD: "{{ user.pass }}"
  DOCKER_HOST: "tcp://{{ krusader_name }}-docker-socket-proxy:2375"
  WEBPAGE_TITLE: "Krusader File Manager Web"
  TEMP_FOLDER: "/tmp"

krusader_role_docker_envs_custom

# Type: dict
krusader_role_docker_envs_custom: {}

Volumes

krusader_role_docker_volumes_default

# Type: list
krusader_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='krusader') }}/config:/config"

krusader_role_docker_volumes_custom

# Type: list
krusader_role_docker_volumes_custom: []

Hostname

krusader_role_docker_hostname

# Type: string
krusader_role_docker_hostname: "{{ krusader_name }}"

Networks

krusader_role_docker_networks_alias

# Type: string
krusader_role_docker_networks_alias: "{{ krusader_name }}"

krusader_role_docker_networks_default

# Type: list
krusader_role_docker_networks_default: []

krusader_role_docker_networks_custom

# Type: list
krusader_role_docker_networks_custom: []

Restart Policy

krusader_role_docker_restart_policy

# Type: string
krusader_role_docker_restart_policy: unless-stopped

State

krusader_role_docker_state

# Type: string
krusader_role_docker_state: started

Dependencies

krusader_role_depends_on

# Type: string
krusader_role_depends_on: "{{ krusader_name }}-docker-socket-proxy"

krusader_role_depends_on_delay

# Type: string (quoted number)
krusader_role_depends_on_delay: "0"

krusader_role_depends_on_healthchecks

# Type: string ("true"/"false")
krusader_role_depends_on_healthchecks: "false"

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

Resource Limits

krusader_role_docker_blkio_weight

# Type: int
krusader_role_docker_blkio_weight:

krusader_role_docker_cpu_period

# Type: int
krusader_role_docker_cpu_period:

krusader_role_docker_cpu_quota

# Type: int
krusader_role_docker_cpu_quota:

krusader_role_docker_cpu_shares

# Type: int
krusader_role_docker_cpu_shares:

krusader_role_docker_cpus

# Type: string
krusader_role_docker_cpus:

krusader_role_docker_cpuset_cpus

# Type: string
krusader_role_docker_cpuset_cpus:

krusader_role_docker_cpuset_mems

# Type: string
krusader_role_docker_cpuset_mems:

krusader_role_docker_kernel_memory

# Type: string
krusader_role_docker_kernel_memory:

krusader_role_docker_memory

# Type: string
krusader_role_docker_memory:

krusader_role_docker_memory_reservation

# Type: string
krusader_role_docker_memory_reservation:

krusader_role_docker_memory_swap

# Type: string
krusader_role_docker_memory_swap:

krusader_role_docker_memory_swappiness

# Type: int
krusader_role_docker_memory_swappiness:

krusader_role_docker_shm_size

# Type: string
krusader_role_docker_shm_size:

Security & Devices

krusader_role_docker_cap_drop

# Type: list
krusader_role_docker_cap_drop:

krusader_role_docker_cgroupns_mode

# Type: string
krusader_role_docker_cgroupns_mode:

krusader_role_docker_device_cgroup_rules

# Type: list
krusader_role_docker_device_cgroup_rules:

krusader_role_docker_device_read_bps

# Type: list
krusader_role_docker_device_read_bps:

krusader_role_docker_device_read_iops

# Type: list
krusader_role_docker_device_read_iops:

krusader_role_docker_device_requests

# Type: list
krusader_role_docker_device_requests:

krusader_role_docker_device_write_bps

# Type: list
krusader_role_docker_device_write_bps:

krusader_role_docker_device_write_iops

# Type: list
krusader_role_docker_device_write_iops:

krusader_role_docker_devices

# Type: list
krusader_role_docker_devices:

krusader_role_docker_devices_default

# Type: string
krusader_role_docker_devices_default:

krusader_role_docker_groups

# Type: list
krusader_role_docker_groups:

krusader_role_docker_privileged

# Type: bool (true/false)
krusader_role_docker_privileged:

krusader_role_docker_security_opts

# Type: list
krusader_role_docker_security_opts:

krusader_role_docker_user

# Type: string
krusader_role_docker_user:

krusader_role_docker_userns_mode

# Type: string
krusader_role_docker_userns_mode:

Networking

krusader_role_docker_dns_opts

# Type: list
krusader_role_docker_dns_opts:

krusader_role_docker_dns_search_domains

# Type: list
krusader_role_docker_dns_search_domains:

krusader_role_docker_dns_servers

# Type: list
krusader_role_docker_dns_servers:

krusader_role_docker_domainname

# Type: string
krusader_role_docker_domainname:

krusader_role_docker_exposed_ports

# Type: list
krusader_role_docker_exposed_ports:

krusader_role_docker_hosts

# Type: dict
krusader_role_docker_hosts:

krusader_role_docker_hosts_use_common

# Type: bool (true/false)
krusader_role_docker_hosts_use_common:

krusader_role_docker_ipc_mode

# Type: string
krusader_role_docker_ipc_mode:

krusader_role_docker_links

# Type: list
krusader_role_docker_links:

krusader_role_docker_network_mode

# Type: string
krusader_role_docker_network_mode:

krusader_role_docker_pid_mode

# Type: string
krusader_role_docker_pid_mode:

krusader_role_docker_ports

# Type: list
krusader_role_docker_ports:

krusader_role_docker_uts

# Type: string
krusader_role_docker_uts:

Storage

krusader_role_docker_keep_volumes

# Type: bool (true/false)
krusader_role_docker_keep_volumes:

krusader_role_docker_mounts

# Type: list
krusader_role_docker_mounts:

krusader_role_docker_storage_opts

# Type: dict
krusader_role_docker_storage_opts:

krusader_role_docker_tmpfs

# Type: list
krusader_role_docker_tmpfs:

krusader_role_docker_volume_driver

# Type: string
krusader_role_docker_volume_driver:

krusader_role_docker_volumes_from

# Type: list
krusader_role_docker_volumes_from:

krusader_role_docker_volumes_global

# Type: bool (true/false)
krusader_role_docker_volumes_global:

krusader_role_docker_working_dir

# Type: string
krusader_role_docker_working_dir:

Monitoring & Lifecycle

krusader_role_docker_auto_remove

# Type: bool (true/false)
krusader_role_docker_auto_remove:

krusader_role_docker_cleanup

# Type: bool (true/false)
krusader_role_docker_cleanup:

krusader_role_docker_force_kill

# Type: string
krusader_role_docker_force_kill:

krusader_role_docker_healthcheck

# Type: dict
krusader_role_docker_healthcheck:

krusader_role_docker_healthy_wait_timeout

# Type: int
krusader_role_docker_healthy_wait_timeout:

krusader_role_docker_init

# Type: bool (true/false)
krusader_role_docker_init:

krusader_role_docker_kill_signal

# Type: string
krusader_role_docker_kill_signal:

krusader_role_docker_log_driver

# Type: string
krusader_role_docker_log_driver:

krusader_role_docker_log_options

# Type: dict
krusader_role_docker_log_options:

krusader_role_docker_oom_killer

# Type: bool (true/false)
krusader_role_docker_oom_killer:

krusader_role_docker_oom_score_adj

# Type: int
krusader_role_docker_oom_score_adj:

krusader_role_docker_output_logs

# Type: bool (true/false)
krusader_role_docker_output_logs:

krusader_role_docker_paused

# Type: bool (true/false)
krusader_role_docker_paused:

krusader_role_docker_recreate

# Type: bool (true/false)
krusader_role_docker_recreate:

krusader_role_docker_restart_retries

# Type: int
krusader_role_docker_restart_retries:

krusader_role_docker_stop_timeout

# Type: int
krusader_role_docker_stop_timeout:

Other Options

krusader_role_docker_capabilities

# Type: list
krusader_role_docker_capabilities:

krusader_role_docker_cgroup_parent

# Type: string
krusader_role_docker_cgroup_parent:

krusader_role_docker_commands

# Type: list
krusader_role_docker_commands:

krusader_role_docker_create_timeout

# Type: int
krusader_role_docker_create_timeout:

krusader_role_docker_entrypoint

# Type: string
krusader_role_docker_entrypoint:

krusader_role_docker_env_file

# Type: string
krusader_role_docker_env_file:

krusader_role_docker_labels

# Type: dict
krusader_role_docker_labels:

krusader_role_docker_labels_use_common

# Type: bool (true/false)
krusader_role_docker_labels_use_common:

krusader_role_docker_read_only

# Type: bool (true/false)
krusader_role_docker_read_only:

krusader_role_docker_runtime

# Type: string
krusader_role_docker_runtime:

krusader_role_docker_sysctls

# Type: list
krusader_role_docker_sysctls:

krusader_role_docker_ulimits

# Type: list
krusader_role_docker_ulimits:

krusader_role_autoheal_enabled

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

krusader_role_depends_on

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

krusader_role_depends_on_delay

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

krusader_role_depends_on_healthchecks

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

krusader_role_diun_enabled

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

krusader_role_dns_enabled

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

krusader_role_docker_controller

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

krusader_role_docker_image_repo

# Type: string
krusader_role_docker_image_repo:

krusader_role_docker_image_tag

# Type: string
krusader_role_docker_image_tag:

krusader_role_docker_volumes_download

# Type: bool (true/false)
krusader_role_docker_volumes_download:

krusader_role_paths_location

# Type: string
krusader_role_paths_location:

krusader_role_themepark_addons

# Type: string
krusader_role_themepark_addons:

krusader_role_themepark_app

# Type: string
krusader_role_themepark_app:

krusader_role_themepark_theme

# Type: string
krusader_role_themepark_theme:

krusader_role_traefik_api_endpoint

# Type: dict/omit
krusader_role_traefik_api_endpoint:

krusader_role_traefik_api_middleware

# Type: string
krusader_role_traefik_api_middleware:

krusader_role_traefik_api_middleware_http

# Type: string
krusader_role_traefik_api_middleware_http:

krusader_role_traefik_autodetect_enabled

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

krusader_role_traefik_certresolver

# Type: string
krusader_role_traefik_certresolver:

krusader_role_traefik_crowdsec_enabled

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

krusader_role_traefik_error_pages_enabled

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

krusader_role_traefik_gzip_enabled

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

krusader_role_traefik_middleware_http

# Type: string
krusader_role_traefik_middleware_http:

krusader_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
krusader_role_traefik_middleware_http_api_insecure:

krusader_role_traefik_middleware_http_insecure

# Type: bool (true/false)
krusader_role_traefik_middleware_http_insecure:

krusader_role_traefik_priority

# Type: string
krusader_role_traefik_priority:

krusader_role_traefik_robot_enabled

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

krusader_role_traefik_tailscale_enabled

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

krusader_role_traefik_wildcard_enabled

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

krusader_role_web_domain

# Type: string
krusader_role_web_domain:

krusader_role_web_fqdn_override

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

Example Override

krusader_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "krusader2.{{ user.domain }}"
  - "krusader.otherdomain.tld"

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

krusader_role_web_host_override

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

Example Override

krusader_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'krusader2.' + user.domain }}`)"

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

krusader_role_web_http_port

# Type: string (quoted number)
krusader_role_web_http_port:

krusader_role_web_http_scheme

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

krusader_role_web_http_serverstransport

# Type: dict/omit
krusader_role_web_http_serverstransport:

krusader_role_web_scheme

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

krusader_role_web_serverstransport

# Type: dict/omit
krusader_role_web_serverstransport:

krusader_role_web_subdomain

# Type: string
krusader_role_web_subdomain: