AirDC++

Description / name	Input element
Your domain name

Overview

AirDC++ is an easy to use client for Advanced Direct Connect and Direct Connect networks. You are able to join "hubs" with other users, and chat, perform searches and browse the share of each user. It allows you to share files with friends and other people.

Manual

Releases

Community

---

Deployment

sb install sandbox-airdcpp

Usage

Visit https://airdcpp.iYOUR_DOMAIN_NAMEi. - Username / password for the default admin account is: admin / password

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   airdcpp_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

airdcpp_name

# Type: string
airdcpp_name: airdcpp

airdcpp_role_web_subdomain

# Type: string
airdcpp_role_web_subdomain: "{{ airdcpp_name }}"

airdcpp_role_web_domain

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

airdcpp_role_web_port

# Type: string
airdcpp_role_web_port: "5600"

airdcpp_role_web_url

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

airdcpp_role_dns_record

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

airdcpp_role_dns_zone

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

airdcpp_role_dns_proxy

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

airdcpp_role_traefik_sso_middleware

# Type: string
airdcpp_role_traefik_sso_middleware: ""

airdcpp_role_traefik_middleware_default

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

airdcpp_role_traefik_middleware_custom

# Type: string
airdcpp_role_traefik_middleware_custom: ""

airdcpp_role_traefik_certresolver

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

airdcpp_role_traefik_enabled

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

airdcpp_role_traefik_api_enabled

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

airdcpp_role_traefik_api_endpoint

# Type: string
airdcpp_role_traefik_api_endpoint: ""

Container

airdcpp_role_docker_container

# Type: string
airdcpp_role_docker_container: "{{ airdcpp_name }}"

Image

airdcpp_role_docker_image_pull

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

airdcpp_role_docker_image_repo

# Type: string
airdcpp_role_docker_image_repo: "gangefors/airdcpp-webclient"

airdcpp_role_docker_image_tag

# Type: string
airdcpp_role_docker_image_tag: "latest"

airdcpp_role_docker_image

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

Ports

airdcpp_role_docker_ports_default

# Type: list
airdcpp_role_docker_ports_default:
  - "21248:21248"
  - "21248:21248/udp"
  - "21249:21249"

airdcpp_role_docker_ports_custom

# Type: list
airdcpp_role_docker_ports_custom: []

Envs

airdcpp_role_docker_envs_default

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

airdcpp_role_docker_envs_custom

# Type: dict
airdcpp_role_docker_envs_custom: {}

Volumes

airdcpp_role_docker_volumes_default

# Type: list
airdcpp_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='airdcpp') }}:/.airdcpp"
  - "/mnt/unionfs/downloads/airdcpp:/Downloads"

airdcpp_role_docker_volumes_custom

# Type: list
airdcpp_role_docker_volumes_custom: []

Hostname

airdcpp_role_docker_hostname

# Type: string
airdcpp_role_docker_hostname: "{{ airdcpp_name }}"

Networks

airdcpp_role_docker_networks_alias

# Type: string
airdcpp_role_docker_networks_alias: "{{ airdcpp_name }}"

airdcpp_role_docker_networks_default

# Type: list
airdcpp_role_docker_networks_default: []

airdcpp_role_docker_networks_custom

# Type: list
airdcpp_role_docker_networks_custom: []

Restart Policy

airdcpp_role_docker_restart_policy

# Type: string
airdcpp_role_docker_restart_policy: unless-stopped

State

airdcpp_role_docker_state

# Type: string
airdcpp_role_docker_state: started

User

airdcpp_role_docker_user

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

airdcpp_role_docker_blkio_weight

# Type: int
airdcpp_role_docker_blkio_weight:

airdcpp_role_docker_cpu_period

# Type: int
airdcpp_role_docker_cpu_period:

airdcpp_role_docker_cpu_quota

# Type: int
airdcpp_role_docker_cpu_quota:

airdcpp_role_docker_cpu_shares

# Type: int
airdcpp_role_docker_cpu_shares:

airdcpp_role_docker_cpus

# Type: string
airdcpp_role_docker_cpus:

airdcpp_role_docker_cpuset_cpus

# Type: string
airdcpp_role_docker_cpuset_cpus:

airdcpp_role_docker_cpuset_mems

# Type: string
airdcpp_role_docker_cpuset_mems:

airdcpp_role_docker_kernel_memory

# Type: string
airdcpp_role_docker_kernel_memory:

airdcpp_role_docker_memory

# Type: string
airdcpp_role_docker_memory:

airdcpp_role_docker_memory_reservation

# Type: string
airdcpp_role_docker_memory_reservation:

airdcpp_role_docker_memory_swap

# Type: string
airdcpp_role_docker_memory_swap:

airdcpp_role_docker_memory_swappiness

# Type: int
airdcpp_role_docker_memory_swappiness:

airdcpp_role_docker_shm_size

# Type: string
airdcpp_role_docker_shm_size:

Security & Devices

airdcpp_role_docker_cap_drop

# Type: list
airdcpp_role_docker_cap_drop:

airdcpp_role_docker_cgroupns_mode

# Type: string
airdcpp_role_docker_cgroupns_mode:

airdcpp_role_docker_device_cgroup_rules

# Type: list
airdcpp_role_docker_device_cgroup_rules:

airdcpp_role_docker_device_read_bps

# Type: list
airdcpp_role_docker_device_read_bps:

airdcpp_role_docker_device_read_iops

# Type: list
airdcpp_role_docker_device_read_iops:

airdcpp_role_docker_device_requests

# Type: list
airdcpp_role_docker_device_requests:

airdcpp_role_docker_device_write_bps

# Type: list
airdcpp_role_docker_device_write_bps:

airdcpp_role_docker_device_write_iops

# Type: list
airdcpp_role_docker_device_write_iops:

airdcpp_role_docker_devices

# Type: list
airdcpp_role_docker_devices:

airdcpp_role_docker_devices_default

# Type: string
airdcpp_role_docker_devices_default:

airdcpp_role_docker_groups

# Type: list
airdcpp_role_docker_groups:

airdcpp_role_docker_privileged

# Type: bool (true/false)
airdcpp_role_docker_privileged:

airdcpp_role_docker_security_opts

# Type: list
airdcpp_role_docker_security_opts:

airdcpp_role_docker_userns_mode

# Type: string
airdcpp_role_docker_userns_mode:

Networking

airdcpp_role_docker_dns_opts

# Type: list
airdcpp_role_docker_dns_opts:

airdcpp_role_docker_dns_search_domains

# Type: list
airdcpp_role_docker_dns_search_domains:

airdcpp_role_docker_dns_servers

# Type: list
airdcpp_role_docker_dns_servers:

airdcpp_role_docker_domainname

# Type: string
airdcpp_role_docker_domainname:

airdcpp_role_docker_exposed_ports

# Type: list
airdcpp_role_docker_exposed_ports:

airdcpp_role_docker_hosts

# Type: dict
airdcpp_role_docker_hosts:

airdcpp_role_docker_hosts_use_common

# Type: bool (true/false)
airdcpp_role_docker_hosts_use_common:

airdcpp_role_docker_ipc_mode

# Type: string
airdcpp_role_docker_ipc_mode:

airdcpp_role_docker_links

# Type: list
airdcpp_role_docker_links:

airdcpp_role_docker_network_mode

# Type: string
airdcpp_role_docker_network_mode:

airdcpp_role_docker_pid_mode

# Type: string
airdcpp_role_docker_pid_mode:

airdcpp_role_docker_uts

# Type: string
airdcpp_role_docker_uts:

Storage

airdcpp_role_docker_keep_volumes

# Type: bool (true/false)
airdcpp_role_docker_keep_volumes:

airdcpp_role_docker_mounts

# Type: list
airdcpp_role_docker_mounts:

airdcpp_role_docker_storage_opts

# Type: dict
airdcpp_role_docker_storage_opts:

airdcpp_role_docker_tmpfs

# Type: list
airdcpp_role_docker_tmpfs:

airdcpp_role_docker_volume_driver

# Type: string
airdcpp_role_docker_volume_driver:

airdcpp_role_docker_volumes_from

# Type: list
airdcpp_role_docker_volumes_from:

airdcpp_role_docker_volumes_global

# Type: bool (true/false)
airdcpp_role_docker_volumes_global:

airdcpp_role_docker_working_dir

# Type: string
airdcpp_role_docker_working_dir:

Monitoring & Lifecycle

airdcpp_role_docker_auto_remove

# Type: bool (true/false)
airdcpp_role_docker_auto_remove:

airdcpp_role_docker_cleanup

# Type: bool (true/false)
airdcpp_role_docker_cleanup:

airdcpp_role_docker_force_kill

# Type: string
airdcpp_role_docker_force_kill:

airdcpp_role_docker_healthcheck

# Type: dict
airdcpp_role_docker_healthcheck:

airdcpp_role_docker_healthy_wait_timeout

# Type: int
airdcpp_role_docker_healthy_wait_timeout:

airdcpp_role_docker_init

# Type: bool (true/false)
airdcpp_role_docker_init:

airdcpp_role_docker_kill_signal

# Type: string
airdcpp_role_docker_kill_signal:

airdcpp_role_docker_log_driver

# Type: string
airdcpp_role_docker_log_driver:

airdcpp_role_docker_log_options

# Type: dict
airdcpp_role_docker_log_options:

airdcpp_role_docker_oom_killer

# Type: bool (true/false)
airdcpp_role_docker_oom_killer:

airdcpp_role_docker_oom_score_adj

# Type: int
airdcpp_role_docker_oom_score_adj:

airdcpp_role_docker_output_logs

# Type: bool (true/false)
airdcpp_role_docker_output_logs:

airdcpp_role_docker_paused

# Type: bool (true/false)
airdcpp_role_docker_paused:

airdcpp_role_docker_recreate

# Type: bool (true/false)
airdcpp_role_docker_recreate:

airdcpp_role_docker_restart_retries

# Type: int
airdcpp_role_docker_restart_retries:

airdcpp_role_docker_stop_timeout

# Type: int
airdcpp_role_docker_stop_timeout:

Other Options

airdcpp_role_docker_capabilities

# Type: list
airdcpp_role_docker_capabilities:

airdcpp_role_docker_cgroup_parent

# Type: string
airdcpp_role_docker_cgroup_parent:

airdcpp_role_docker_commands

# Type: list
airdcpp_role_docker_commands:

airdcpp_role_docker_create_timeout

# Type: int
airdcpp_role_docker_create_timeout:

airdcpp_role_docker_entrypoint

# Type: string
airdcpp_role_docker_entrypoint:

airdcpp_role_docker_env_file

# Type: string
airdcpp_role_docker_env_file:

airdcpp_role_docker_labels

# Type: dict
airdcpp_role_docker_labels:

airdcpp_role_docker_labels_use_common

# Type: bool (true/false)
airdcpp_role_docker_labels_use_common:

airdcpp_role_docker_read_only

# Type: bool (true/false)
airdcpp_role_docker_read_only:

airdcpp_role_docker_runtime

# Type: string
airdcpp_role_docker_runtime:

airdcpp_role_docker_sysctls

# Type: list
airdcpp_role_docker_sysctls:

airdcpp_role_docker_ulimits

# Type: list
airdcpp_role_docker_ulimits:

airdcpp_role_autoheal_enabled

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

airdcpp_role_depends_on

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

airdcpp_role_depends_on_delay

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

airdcpp_role_depends_on_healthchecks

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

airdcpp_role_diun_enabled

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

airdcpp_role_dns_enabled

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

airdcpp_role_docker_controller

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

airdcpp_role_docker_image_repo

# Type: string
airdcpp_role_docker_image_repo:

airdcpp_role_docker_image_tag

# Type: string
airdcpp_role_docker_image_tag:

airdcpp_role_docker_volumes_download

# Type: bool (true/false)
airdcpp_role_docker_volumes_download:

airdcpp_role_paths_location

# Type: string
airdcpp_role_paths_location:

airdcpp_role_themepark_addons

# Type: string
airdcpp_role_themepark_addons:

airdcpp_role_themepark_app

# Type: string
airdcpp_role_themepark_app:

airdcpp_role_themepark_theme

# Type: string
airdcpp_role_themepark_theme:

airdcpp_role_traefik_api_endpoint

# Type: dict/omit
airdcpp_role_traefik_api_endpoint:

airdcpp_role_traefik_api_middleware

# Type: string
airdcpp_role_traefik_api_middleware:

airdcpp_role_traefik_api_middleware_http

# Type: string
airdcpp_role_traefik_api_middleware_http:

airdcpp_role_traefik_autodetect_enabled

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

airdcpp_role_traefik_certresolver

# Type: string
airdcpp_role_traefik_certresolver:

airdcpp_role_traefik_crowdsec_enabled

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

airdcpp_role_traefik_error_pages_enabled

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

airdcpp_role_traefik_gzip_enabled

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

airdcpp_role_traefik_middleware_http

# Type: string
airdcpp_role_traefik_middleware_http:

airdcpp_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
airdcpp_role_traefik_middleware_http_api_insecure:

airdcpp_role_traefik_middleware_http_insecure

# Type: bool (true/false)
airdcpp_role_traefik_middleware_http_insecure:

airdcpp_role_traefik_priority

# Type: string
airdcpp_role_traefik_priority:

airdcpp_role_traefik_robot_enabled

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

airdcpp_role_traefik_tailscale_enabled

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

airdcpp_role_traefik_wildcard_enabled

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

airdcpp_role_web_domain

# Type: string
airdcpp_role_web_domain:

airdcpp_role_web_fqdn_override

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

Example Override

airdcpp_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "airdcpp2.{{ user.domain }}"
  - "airdcpp.otherdomain.tld"

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

airdcpp_role_web_host_override

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

Example Override

airdcpp_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'airdcpp2.' + user.domain }}`)"

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

airdcpp_role_web_http_port

# Type: string (quoted number)
airdcpp_role_web_http_port:

airdcpp_role_web_http_scheme

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

airdcpp_role_web_http_serverstransport

# Type: dict/omit
airdcpp_role_web_http_serverstransport:

airdcpp_role_web_scheme

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

airdcpp_role_web_serverstransport

# Type: dict/omit
airdcpp_role_web_serverstransport:

airdcpp_role_web_subdomain

# Type: string
airdcpp_role_web_subdomain: