Sshwifty¶

Description / name	Input element
Your domain name

Overview¶

Sshwifty is an SSH and Telnet connector made for the Web. It can be deployed on your computer or server to provide SSH and Telnet access interface for any compatible (standard) web browser.

Manual

Releases

Community

Deployment¶

sb install sandbox-sshwifty

Usage¶

Visit https://sshwifty.iYOUR_DOMAIN_NAMEi.

Basics¶

The pre-configured password is taken from your Saltbox accounts.yml file located in /srv/git/saltbox/accounts.yml

Role Defaults¶

Use the Inventory to customize variables. (1)

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

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

sshwifty_name

# Type: string
sshwifty_name: sshwifty

sshwifty_role_web_subdomain

# Type: string
sshwifty_role_web_subdomain: "{{ sshwifty_name }}"

sshwifty_role_web_domain

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

sshwifty_role_web_port

# Type: string
sshwifty_role_web_port: "8182"

sshwifty_role_web_url

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

sshwifty_role_dns_record

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

sshwifty_role_dns_zone

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

sshwifty_role_dns_proxy

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

sshwifty_role_traefik_sso_middleware

# Type: string
sshwifty_role_traefik_sso_middleware: ""

sshwifty_role_traefik_middleware_default

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

sshwifty_role_traefik_middleware_custom

# Type: string
sshwifty_role_traefik_middleware_custom: ""

sshwifty_role_traefik_certresolver

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

sshwifty_role_traefik_enabled

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

sshwifty_role_traefik_api_enabled

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

sshwifty_role_traefik_api_endpoint

# Type: string
sshwifty_role_traefik_api_endpoint: ""

sshwifty_role_traefik_error_pages_enabled

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

Container

sshwifty_role_docker_container

# Type: string
sshwifty_role_docker_container: "{{ sshwifty_name }}"

Image

sshwifty_role_docker_image_pull

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

sshwifty_role_docker_image_repo

# Type: string
sshwifty_role_docker_image_repo: "niruix/sshwifty"

sshwifty_role_docker_image_tag

# Type: string
sshwifty_role_docker_image_tag: "latest"

sshwifty_role_docker_image

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

Envs

sshwifty_role_docker_envs_default

# Type: dict
sshwifty_role_docker_envs_default:
  SSHWIFTY_CONFIG: "/config/sshwifty.conf.json"

sshwifty_role_docker_envs_custom

# Type: dict
sshwifty_role_docker_envs_custom: {}

Volumes

sshwifty_role_docker_volumes_default

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

sshwifty_role_docker_volumes_custom

# Type: list
sshwifty_role_docker_volumes_custom: []

Hostname

sshwifty_role_docker_hostname

# Type: string
sshwifty_role_docker_hostname: "{{ sshwifty_name }}"

Networks

sshwifty_role_docker_networks_alias

# Type: string
sshwifty_role_docker_networks_alias: "{{ sshwifty_name }}"

sshwifty_role_docker_networks_default

# Type: list
sshwifty_role_docker_networks_default: []

sshwifty_role_docker_networks_custom

# Type: list
sshwifty_role_docker_networks_custom: []

Restart Policy

sshwifty_role_docker_restart_policy

# Type: string
sshwifty_role_docker_restart_policy: unless-stopped

State

sshwifty_role_docker_state

# Type: string
sshwifty_role_docker_state: started

User

sshwifty_role_docker_user

# Type: string
sshwifty_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

sshwifty_role_docker_blkio_weight

# Type: int
sshwifty_role_docker_blkio_weight:

sshwifty_role_docker_cpu_period

# Type: int
sshwifty_role_docker_cpu_period:

sshwifty_role_docker_cpu_quota

# Type: int
sshwifty_role_docker_cpu_quota:

sshwifty_role_docker_cpu_shares

# Type: int
sshwifty_role_docker_cpu_shares:

sshwifty_role_docker_cpus

# Type: string
sshwifty_role_docker_cpus:

sshwifty_role_docker_cpuset_cpus

# Type: string
sshwifty_role_docker_cpuset_cpus:

sshwifty_role_docker_cpuset_mems

# Type: string
sshwifty_role_docker_cpuset_mems:

sshwifty_role_docker_kernel_memory

# Type: string
sshwifty_role_docker_kernel_memory:

sshwifty_role_docker_memory

# Type: string
sshwifty_role_docker_memory:

sshwifty_role_docker_memory_reservation

# Type: string
sshwifty_role_docker_memory_reservation:

sshwifty_role_docker_memory_swap

# Type: string
sshwifty_role_docker_memory_swap:

sshwifty_role_docker_memory_swappiness

# Type: int
sshwifty_role_docker_memory_swappiness:

sshwifty_role_docker_shm_size

# Type: string
sshwifty_role_docker_shm_size:

Security & Devices

sshwifty_role_docker_cap_drop

# Type: list
sshwifty_role_docker_cap_drop:

sshwifty_role_docker_cgroupns_mode

# Type: string
sshwifty_role_docker_cgroupns_mode:

sshwifty_role_docker_device_cgroup_rules

# Type: list
sshwifty_role_docker_device_cgroup_rules:

sshwifty_role_docker_device_read_bps

# Type: list
sshwifty_role_docker_device_read_bps:

sshwifty_role_docker_device_read_iops

# Type: list
sshwifty_role_docker_device_read_iops:

sshwifty_role_docker_device_requests

# Type: list
sshwifty_role_docker_device_requests:

sshwifty_role_docker_device_write_bps

# Type: list
sshwifty_role_docker_device_write_bps:

sshwifty_role_docker_device_write_iops

# Type: list
sshwifty_role_docker_device_write_iops:

sshwifty_role_docker_devices

# Type: list
sshwifty_role_docker_devices:

sshwifty_role_docker_devices_default

# Type: string
sshwifty_role_docker_devices_default:

sshwifty_role_docker_groups

# Type: list
sshwifty_role_docker_groups:

sshwifty_role_docker_privileged

# Type: bool (true/false)
sshwifty_role_docker_privileged:

sshwifty_role_docker_security_opts

# Type: list
sshwifty_role_docker_security_opts:

sshwifty_role_docker_userns_mode

# Type: string
sshwifty_role_docker_userns_mode:

Networking

sshwifty_role_docker_dns_opts

# Type: list
sshwifty_role_docker_dns_opts:

sshwifty_role_docker_dns_search_domains

# Type: list
sshwifty_role_docker_dns_search_domains:

sshwifty_role_docker_dns_servers

# Type: list
sshwifty_role_docker_dns_servers:

sshwifty_role_docker_domainname

# Type: string
sshwifty_role_docker_domainname:

sshwifty_role_docker_exposed_ports

# Type: list
sshwifty_role_docker_exposed_ports:

sshwifty_role_docker_hosts

# Type: dict
sshwifty_role_docker_hosts:

sshwifty_role_docker_hosts_use_common

# Type: bool (true/false)
sshwifty_role_docker_hosts_use_common:

sshwifty_role_docker_ipc_mode

# Type: string
sshwifty_role_docker_ipc_mode:

sshwifty_role_docker_links

# Type: list
sshwifty_role_docker_links:

sshwifty_role_docker_network_mode

# Type: string
sshwifty_role_docker_network_mode:

sshwifty_role_docker_pid_mode

# Type: string
sshwifty_role_docker_pid_mode:

sshwifty_role_docker_ports

# Type: list
sshwifty_role_docker_ports:

sshwifty_role_docker_uts

# Type: string
sshwifty_role_docker_uts:

Storage

sshwifty_role_docker_keep_volumes

# Type: bool (true/false)
sshwifty_role_docker_keep_volumes:

sshwifty_role_docker_mounts

# Type: list
sshwifty_role_docker_mounts:

sshwifty_role_docker_storage_opts

# Type: dict
sshwifty_role_docker_storage_opts:

sshwifty_role_docker_tmpfs

# Type: list
sshwifty_role_docker_tmpfs:

sshwifty_role_docker_volume_driver

# Type: string
sshwifty_role_docker_volume_driver:

sshwifty_role_docker_volumes_from

# Type: list
sshwifty_role_docker_volumes_from:

sshwifty_role_docker_volumes_global

# Type: bool (true/false)
sshwifty_role_docker_volumes_global:

sshwifty_role_docker_working_dir

# Type: string
sshwifty_role_docker_working_dir:

Monitoring & Lifecycle

sshwifty_role_docker_auto_remove

# Type: bool (true/false)
sshwifty_role_docker_auto_remove:

sshwifty_role_docker_cleanup

# Type: bool (true/false)
sshwifty_role_docker_cleanup:

sshwifty_role_docker_force_kill

# Type: string
sshwifty_role_docker_force_kill:

sshwifty_role_docker_healthcheck

# Type: dict
sshwifty_role_docker_healthcheck:

sshwifty_role_docker_healthy_wait_timeout

# Type: int
sshwifty_role_docker_healthy_wait_timeout:

sshwifty_role_docker_init

# Type: bool (true/false)
sshwifty_role_docker_init:

sshwifty_role_docker_kill_signal

# Type: string
sshwifty_role_docker_kill_signal:

sshwifty_role_docker_log_driver

# Type: string
sshwifty_role_docker_log_driver:

sshwifty_role_docker_log_options

# Type: dict
sshwifty_role_docker_log_options:

sshwifty_role_docker_oom_killer

# Type: bool (true/false)
sshwifty_role_docker_oom_killer:

sshwifty_role_docker_oom_score_adj

# Type: int
sshwifty_role_docker_oom_score_adj:

sshwifty_role_docker_output_logs

# Type: bool (true/false)
sshwifty_role_docker_output_logs:

sshwifty_role_docker_paused

# Type: bool (true/false)
sshwifty_role_docker_paused:

sshwifty_role_docker_recreate

# Type: bool (true/false)
sshwifty_role_docker_recreate:

sshwifty_role_docker_restart_retries

# Type: int
sshwifty_role_docker_restart_retries:

sshwifty_role_docker_stop_timeout

# Type: int
sshwifty_role_docker_stop_timeout:

Other Options

sshwifty_role_docker_capabilities

# Type: list
sshwifty_role_docker_capabilities:

sshwifty_role_docker_cgroup_parent

# Type: string
sshwifty_role_docker_cgroup_parent:

sshwifty_role_docker_commands

# Type: list
sshwifty_role_docker_commands:

sshwifty_role_docker_create_timeout

# Type: int
sshwifty_role_docker_create_timeout:

sshwifty_role_docker_entrypoint

# Type: string
sshwifty_role_docker_entrypoint:

sshwifty_role_docker_env_file

# Type: string
sshwifty_role_docker_env_file:

sshwifty_role_docker_labels

# Type: dict
sshwifty_role_docker_labels:

sshwifty_role_docker_labels_use_common

# Type: bool (true/false)
sshwifty_role_docker_labels_use_common:

sshwifty_role_docker_read_only

# Type: bool (true/false)
sshwifty_role_docker_read_only:

sshwifty_role_docker_runtime

# Type: string
sshwifty_role_docker_runtime:

sshwifty_role_docker_sysctls

# Type: list
sshwifty_role_docker_sysctls:

sshwifty_role_docker_ulimits

# Type: list
sshwifty_role_docker_ulimits:

sshwifty_role_autoheal_enabled

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

sshwifty_role_depends_on

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

sshwifty_role_depends_on_delay

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

sshwifty_role_depends_on_healthchecks

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

sshwifty_role_diun_enabled

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

sshwifty_role_dns_enabled

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

sshwifty_role_docker_controller

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

sshwifty_role_docker_image_repo

# Type: string
sshwifty_role_docker_image_repo:

sshwifty_role_docker_image_tag

# Type: string
sshwifty_role_docker_image_tag:

sshwifty_role_docker_volumes_download

# Type: bool (true/false)
sshwifty_role_docker_volumes_download:

sshwifty_role_paths_location

# Type: string
sshwifty_role_paths_location:

sshwifty_role_themepark_addons

# Type: string
sshwifty_role_themepark_addons:

sshwifty_role_themepark_app

# Type: string
sshwifty_role_themepark_app:

sshwifty_role_themepark_theme

# Type: string
sshwifty_role_themepark_theme:

sshwifty_role_traefik_api_endpoint

# Type: dict/omit
sshwifty_role_traefik_api_endpoint:

sshwifty_role_traefik_api_middleware

# Type: string
sshwifty_role_traefik_api_middleware:

sshwifty_role_traefik_api_middleware_http

# Type: string
sshwifty_role_traefik_api_middleware_http:

sshwifty_role_traefik_autodetect_enabled

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

sshwifty_role_traefik_certresolver

# Type: string
sshwifty_role_traefik_certresolver:

sshwifty_role_traefik_crowdsec_enabled

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

sshwifty_role_traefik_error_pages_enabled

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

sshwifty_role_traefik_gzip_enabled

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

sshwifty_role_traefik_middleware_http

# Type: string
sshwifty_role_traefik_middleware_http:

sshwifty_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
sshwifty_role_traefik_middleware_http_api_insecure:

sshwifty_role_traefik_middleware_http_insecure

# Type: bool (true/false)
sshwifty_role_traefik_middleware_http_insecure:

sshwifty_role_traefik_priority

# Type: string
sshwifty_role_traefik_priority:

sshwifty_role_traefik_robot_enabled

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

sshwifty_role_traefik_tailscale_enabled

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

sshwifty_role_traefik_wildcard_enabled

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

sshwifty_role_web_domain

# Type: string
sshwifty_role_web_domain:

sshwifty_role_web_fqdn_override

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

Example Override

sshwifty_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "sshwifty2.{{ user.domain }}"
  - "sshwifty.otherdomain.tld"

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

sshwifty_role_web_host_override

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

Example Override

sshwifty_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'sshwifty2.' + user.domain }}`)"

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

sshwifty_role_web_http_port

# Type: string (quoted number)
sshwifty_role_web_http_port:

sshwifty_role_web_http_scheme

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

sshwifty_role_web_http_serverstransport

# Type: dict/omit
sshwifty_role_web_http_serverstransport:

sshwifty_role_web_scheme

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

sshwifty_role_web_serverstransport

# Type: dict/omit
sshwifty_role_web_serverstransport:

sshwifty_role_web_subdomain

# Type: string
sshwifty_role_web_subdomain: