LinuxGSM

Description / name	Input element
Your domain name

Overview

LinuxGSM is a command-line tool for quick and simple deployment and management of Linux dedicated game servers. It aims to make the process of managing game servers hassle-free. With LinuxGSM, we can avoid spending hours trying to configure and manage game servers. It provides a streamlined and efficient solution for setting up and maintaining dedicated game servers on Linux.

Manual

Releases

Community

---

Configuration

To add instances, add the following to the inventory. See these instructions on inventory here.

Inventory

lgsm_instances: ["lgsm_valheim", "lgsm_rust"] # (1)!
lgsm_valheim_docker_image_tag: "vh" # (2)!
lgsm_valheim_docker_ports_defaults: ["2456:2456/udp","2457:2457/udp"] # (3)!
lgsm_rust_docker_ports_defaults: ["28015:28015/udp","28017:28017/udp","28082:28082/udp"] # (4)!

1. Example setting image tag to correct shortcode from https://github.com/GameServerManagers/LinuxGSM/blob/master/lgsm/data/serverlist.csv using lgsm_shortcode will automatically pull the correct image tag
2. This is the valheim server shortcode
3. ports for valheim need to be exposed. Notice that rust is the image tag for the rust server. This means we don't have to specify it here.
4. The ports for the rust server need to be exposed as well.

Then run:

Deployment

sb install sandbox-lgsm

Usage

Visit https://lgsm.iYOUR_DOMAIN_NAMEi.

Basics

LinuxGSM config files are the configuration files used by the game server to store various game server settings, such as the server name, maximum players, map cycle, etc. These settings can be edited to customise a game server. Different game server configs can use different syntax and work slightly differently, but all do the same basic job of editing a game server settings.

The configs for the lgsm servers are in /opt/CONTAINERNAME/config-lgsm/LGSMSERVERNAME/ For our valheim example the config would be /opt/lgsm_valheim/config-lgsm/vhserver/vhserver.cfg which is the lgsm instance config for that server.

/opt/lgsm_valheim/config-lgsm/vhserver/common.cfg works as well. Can read more here

Any actual game server configs will be in the /opt/CONTAINERNAME/serverfiles/ and are all dependant on the game server installed.

In your game, connect to your ip and default ports for the server. Make sure you set the UDP and TCP for the ports correctly. If everything was setup correctly the game should connect to the server.

Role Defaults

Use the Inventory to customize variables. (1)

1. This role supports multiple instances via lgsm_instances.

   Example override

   Role-levelInstance-level

   lgsm_role_web_subdomain: "custom"
   

   Applies to all instances of lgsm

   lgsm2_web_subdomain: "custom2"
   

   Applies to the instance named lgsm2

   Avoid overriding variables ending in _default

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

BasicsWebDNSDockerDocker+Global Override Options

lgsm_instances

# Type: list
lgsm_instances: []

Example Override

# Type: list
lgsm_instances: ["lgsm", "lgsm2"]

lgsm_role_web_subdomainlgsm2_web_subdomain

# Type: string
lgsm_role_web_subdomain: "{{ lgsm_name }}"

# Type: string
lgsm2_web_subdomain: "{{ lgsm_name }}"

lgsm_role_web_domainlgsm2_web_domain

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

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

lgsm_role_dns_recordlgsm2_dns_record

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

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

lgsm_role_dns_zonelgsm2_dns_zone

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

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

lgsm_role_dns_proxylgsm2_dns_proxy

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

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

Container

lgsm_role_docker_containerlgsm2_docker_container

# Type: string
lgsm_role_docker_container: "{{ lgsm_name }}"

# Type: string
lgsm2_docker_container: "{{ lgsm_name }}"

Image

lgsm_role_docker_image_pulllgsm2_docker_image_pull

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

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

lgsm_role_docker_image_repolgsm2_docker_image_repo

# Type: string
lgsm_role_docker_image_repo: "gameservermanagers/gameserver"

# Type: string
lgsm2_docker_image_repo: "gameservermanagers/gameserver"

lgsm_role_docker_image_taglgsm2_docker_image_tag

# Type: string
lgsm_role_docker_image_tag: "{{ lgsm_name | replace('lgsm_', '') }}"

# Type: string
lgsm2_docker_image_tag: "{{ lgsm_name | replace('lgsm_', '') }}"

lgsm_role_docker_imagelgsm2_docker_image

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

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

Volumes

lgsm_role_docker_volumes_defaultlgsm2_docker_volumes_default

# Type: list
lgsm_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='lgsm') }}:/data"

# Type: list
lgsm2_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='lgsm') }}:/data"

lgsm_role_docker_volumes_customlgsm2_docker_volumes_custom

# Type: list
lgsm_role_docker_volumes_custom: []

# Type: list
lgsm2_docker_volumes_custom: []

Hostname

lgsm_role_docker_hostnamelgsm2_docker_hostname

# Type: string
lgsm_role_docker_hostname: "{{ lgsm_name }}"

# Type: string
lgsm2_docker_hostname: "{{ lgsm_name }}"

Networks

lgsm_role_docker_networks_aliaslgsm2_docker_networks_alias

# Type: string
lgsm_role_docker_networks_alias: "{{ lgsm_name }}"

# Type: string
lgsm2_docker_networks_alias: "{{ lgsm_name }}"

lgsm_role_docker_networks_defaultlgsm2_docker_networks_default

# Type: list
lgsm_role_docker_networks_default: []

# Type: list
lgsm2_docker_networks_default: []

lgsm_role_docker_networks_customlgsm2_docker_networks_custom

# Type: list
lgsm_role_docker_networks_custom: []

# Type: list
lgsm2_docker_networks_custom: []

Restart Policy

lgsm_role_docker_restart_policylgsm2_docker_restart_policy

# Type: string
lgsm_role_docker_restart_policy: unless-stopped

# Type: string
lgsm2_docker_restart_policy: unless-stopped

State

lgsm_role_docker_statelgsm2_docker_state

# Type: string
lgsm_role_docker_state: started

# Type: string
lgsm2_docker_state: started

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

Resource Limits

lgsm_role_docker_blkio_weightlgsm2_docker_blkio_weight

# Type: int
lgsm_role_docker_blkio_weight:

# Type: int
lgsm2_docker_blkio_weight:

lgsm_role_docker_cpu_periodlgsm2_docker_cpu_period

# Type: int
lgsm_role_docker_cpu_period:

# Type: int
lgsm2_docker_cpu_period:

lgsm_role_docker_cpu_quotalgsm2_docker_cpu_quota

# Type: int
lgsm_role_docker_cpu_quota:

# Type: int
lgsm2_docker_cpu_quota:

lgsm_role_docker_cpu_shareslgsm2_docker_cpu_shares

# Type: int
lgsm_role_docker_cpu_shares:

# Type: int
lgsm2_docker_cpu_shares:

lgsm_role_docker_cpuslgsm2_docker_cpus

# Type: string
lgsm_role_docker_cpus:

# Type: string
lgsm2_docker_cpus:

lgsm_role_docker_cpuset_cpuslgsm2_docker_cpuset_cpus

# Type: string
lgsm_role_docker_cpuset_cpus:

# Type: string
lgsm2_docker_cpuset_cpus:

lgsm_role_docker_cpuset_memslgsm2_docker_cpuset_mems

# Type: string
lgsm_role_docker_cpuset_mems:

# Type: string
lgsm2_docker_cpuset_mems:

lgsm_role_docker_kernel_memorylgsm2_docker_kernel_memory

# Type: string
lgsm_role_docker_kernel_memory:

# Type: string
lgsm2_docker_kernel_memory:

lgsm_role_docker_memorylgsm2_docker_memory

# Type: string
lgsm_role_docker_memory:

# Type: string
lgsm2_docker_memory:

lgsm_role_docker_memory_reservationlgsm2_docker_memory_reservation

# Type: string
lgsm_role_docker_memory_reservation:

# Type: string
lgsm2_docker_memory_reservation:

lgsm_role_docker_memory_swaplgsm2_docker_memory_swap

# Type: string
lgsm_role_docker_memory_swap:

# Type: string
lgsm2_docker_memory_swap:

lgsm_role_docker_memory_swappinesslgsm2_docker_memory_swappiness

# Type: int
lgsm_role_docker_memory_swappiness:

# Type: int
lgsm2_docker_memory_swappiness:

lgsm_role_docker_shm_sizelgsm2_docker_shm_size

# Type: string
lgsm_role_docker_shm_size:

# Type: string
lgsm2_docker_shm_size:

Security & Devices

lgsm_role_docker_cap_droplgsm2_docker_cap_drop

# Type: list
lgsm_role_docker_cap_drop:

# Type: list
lgsm2_docker_cap_drop:

lgsm_role_docker_cgroupns_modelgsm2_docker_cgroupns_mode

# Type: string
lgsm_role_docker_cgroupns_mode:

# Type: string
lgsm2_docker_cgroupns_mode:

lgsm_role_docker_device_cgroup_ruleslgsm2_docker_device_cgroup_rules

# Type: list
lgsm_role_docker_device_cgroup_rules:

# Type: list
lgsm2_docker_device_cgroup_rules:

lgsm_role_docker_device_read_bpslgsm2_docker_device_read_bps

# Type: list
lgsm_role_docker_device_read_bps:

# Type: list
lgsm2_docker_device_read_bps:

lgsm_role_docker_device_read_iopslgsm2_docker_device_read_iops

# Type: list
lgsm_role_docker_device_read_iops:

# Type: list
lgsm2_docker_device_read_iops:

lgsm_role_docker_device_requestslgsm2_docker_device_requests

# Type: list
lgsm_role_docker_device_requests:

# Type: list
lgsm2_docker_device_requests:

lgsm_role_docker_device_write_bpslgsm2_docker_device_write_bps

# Type: list
lgsm_role_docker_device_write_bps:

# Type: list
lgsm2_docker_device_write_bps:

lgsm_role_docker_device_write_iopslgsm2_docker_device_write_iops

# Type: list
lgsm_role_docker_device_write_iops:

# Type: list
lgsm2_docker_device_write_iops:

lgsm_role_docker_deviceslgsm2_docker_devices

# Type: list
lgsm_role_docker_devices:

# Type: list
lgsm2_docker_devices:

lgsm_role_docker_devices_defaultlgsm2_docker_devices_default

# Type: string
lgsm_role_docker_devices_default:

# Type: string
lgsm2_docker_devices_default:

lgsm_role_docker_groupslgsm2_docker_groups

# Type: list
lgsm_role_docker_groups:

# Type: list
lgsm2_docker_groups:

lgsm_role_docker_privilegedlgsm2_docker_privileged

# Type: bool (true/false)
lgsm_role_docker_privileged:

# Type: bool (true/false)
lgsm2_docker_privileged:

lgsm_role_docker_security_optslgsm2_docker_security_opts

# Type: list
lgsm_role_docker_security_opts:

# Type: list
lgsm2_docker_security_opts:

lgsm_role_docker_userlgsm2_docker_user

# Type: string
lgsm_role_docker_user:

# Type: string
lgsm2_docker_user:

lgsm_role_docker_userns_modelgsm2_docker_userns_mode

# Type: string
lgsm_role_docker_userns_mode:

# Type: string
lgsm2_docker_userns_mode:

Networking

lgsm_role_docker_dns_optslgsm2_docker_dns_opts

# Type: list
lgsm_role_docker_dns_opts:

# Type: list
lgsm2_docker_dns_opts:

lgsm_role_docker_dns_search_domainslgsm2_docker_dns_search_domains

# Type: list
lgsm_role_docker_dns_search_domains:

# Type: list
lgsm2_docker_dns_search_domains:

lgsm_role_docker_dns_serverslgsm2_docker_dns_servers

# Type: list
lgsm_role_docker_dns_servers:

# Type: list
lgsm2_docker_dns_servers:

lgsm_role_docker_domainnamelgsm2_docker_domainname

# Type: string
lgsm_role_docker_domainname:

# Type: string
lgsm2_docker_domainname:

lgsm_role_docker_exposed_portslgsm2_docker_exposed_ports

# Type: list
lgsm_role_docker_exposed_ports:

# Type: list
lgsm2_docker_exposed_ports:

lgsm_role_docker_hostslgsm2_docker_hosts

# Type: dict
lgsm_role_docker_hosts:

# Type: dict
lgsm2_docker_hosts:

lgsm_role_docker_hosts_use_commonlgsm2_docker_hosts_use_common

# Type: bool (true/false)
lgsm_role_docker_hosts_use_common:

# Type: bool (true/false)
lgsm2_docker_hosts_use_common:

lgsm_role_docker_ipc_modelgsm2_docker_ipc_mode

# Type: string
lgsm_role_docker_ipc_mode:

# Type: string
lgsm2_docker_ipc_mode:

lgsm_role_docker_linkslgsm2_docker_links

# Type: list
lgsm_role_docker_links:

# Type: list
lgsm2_docker_links:

lgsm_role_docker_network_modelgsm2_docker_network_mode

# Type: string
lgsm_role_docker_network_mode:

# Type: string
lgsm2_docker_network_mode:

lgsm_role_docker_pid_modelgsm2_docker_pid_mode

# Type: string
lgsm_role_docker_pid_mode:

# Type: string
lgsm2_docker_pid_mode:

lgsm_role_docker_portslgsm2_docker_ports

# Type: list
lgsm_role_docker_ports:

# Type: list
lgsm2_docker_ports:

lgsm_role_docker_utslgsm2_docker_uts

# Type: string
lgsm_role_docker_uts:

# Type: string
lgsm2_docker_uts:

Storage

lgsm_role_docker_keep_volumeslgsm2_docker_keep_volumes

# Type: bool (true/false)
lgsm_role_docker_keep_volumes:

# Type: bool (true/false)
lgsm2_docker_keep_volumes:

lgsm_role_docker_mountslgsm2_docker_mounts

# Type: list
lgsm_role_docker_mounts:

# Type: list
lgsm2_docker_mounts:

lgsm_role_docker_storage_optslgsm2_docker_storage_opts

# Type: dict
lgsm_role_docker_storage_opts:

# Type: dict
lgsm2_docker_storage_opts:

lgsm_role_docker_tmpfslgsm2_docker_tmpfs

# Type: list
lgsm_role_docker_tmpfs:

# Type: list
lgsm2_docker_tmpfs:

lgsm_role_docker_volume_driverlgsm2_docker_volume_driver

# Type: string
lgsm_role_docker_volume_driver:

# Type: string
lgsm2_docker_volume_driver:

lgsm_role_docker_volumes_fromlgsm2_docker_volumes_from

# Type: list
lgsm_role_docker_volumes_from:

# Type: list
lgsm2_docker_volumes_from:

lgsm_role_docker_volumes_globallgsm2_docker_volumes_global

# Type: bool (true/false)
lgsm_role_docker_volumes_global:

# Type: bool (true/false)
lgsm2_docker_volumes_global:

lgsm_role_docker_working_dirlgsm2_docker_working_dir

# Type: string
lgsm_role_docker_working_dir:

# Type: string
lgsm2_docker_working_dir:

Monitoring & Lifecycle

lgsm_role_docker_auto_removelgsm2_docker_auto_remove

# Type: bool (true/false)
lgsm_role_docker_auto_remove:

# Type: bool (true/false)
lgsm2_docker_auto_remove:

lgsm_role_docker_cleanuplgsm2_docker_cleanup

# Type: bool (true/false)
lgsm_role_docker_cleanup:

# Type: bool (true/false)
lgsm2_docker_cleanup:

lgsm_role_docker_force_killlgsm2_docker_force_kill

# Type: string
lgsm_role_docker_force_kill:

# Type: string
lgsm2_docker_force_kill:

lgsm_role_docker_healthchecklgsm2_docker_healthcheck

# Type: dict
lgsm_role_docker_healthcheck:

# Type: dict
lgsm2_docker_healthcheck:

lgsm_role_docker_healthy_wait_timeoutlgsm2_docker_healthy_wait_timeout

# Type: int
lgsm_role_docker_healthy_wait_timeout:

# Type: int
lgsm2_docker_healthy_wait_timeout:

lgsm_role_docker_initlgsm2_docker_init

# Type: bool (true/false)
lgsm_role_docker_init:

# Type: bool (true/false)
lgsm2_docker_init:

lgsm_role_docker_kill_signallgsm2_docker_kill_signal

# Type: string
lgsm_role_docker_kill_signal:

# Type: string
lgsm2_docker_kill_signal:

lgsm_role_docker_log_driverlgsm2_docker_log_driver

# Type: string
lgsm_role_docker_log_driver:

# Type: string
lgsm2_docker_log_driver:

lgsm_role_docker_log_optionslgsm2_docker_log_options

# Type: dict
lgsm_role_docker_log_options:

# Type: dict
lgsm2_docker_log_options:

lgsm_role_docker_oom_killerlgsm2_docker_oom_killer

# Type: bool (true/false)
lgsm_role_docker_oom_killer:

# Type: bool (true/false)
lgsm2_docker_oom_killer:

lgsm_role_docker_oom_score_adjlgsm2_docker_oom_score_adj

# Type: int
lgsm_role_docker_oom_score_adj:

# Type: int
lgsm2_docker_oom_score_adj:

lgsm_role_docker_output_logslgsm2_docker_output_logs

# Type: bool (true/false)
lgsm_role_docker_output_logs:

# Type: bool (true/false)
lgsm2_docker_output_logs:

lgsm_role_docker_pausedlgsm2_docker_paused

# Type: bool (true/false)
lgsm_role_docker_paused:

# Type: bool (true/false)
lgsm2_docker_paused:

lgsm_role_docker_recreatelgsm2_docker_recreate

# Type: bool (true/false)
lgsm_role_docker_recreate:

# Type: bool (true/false)
lgsm2_docker_recreate:

lgsm_role_docker_restart_retrieslgsm2_docker_restart_retries

# Type: int
lgsm_role_docker_restart_retries:

# Type: int
lgsm2_docker_restart_retries:

lgsm_role_docker_stop_timeoutlgsm2_docker_stop_timeout

# Type: int
lgsm_role_docker_stop_timeout:

# Type: int
lgsm2_docker_stop_timeout:

Other Options

lgsm_role_docker_capabilitieslgsm2_docker_capabilities

# Type: list
lgsm_role_docker_capabilities:

# Type: list
lgsm2_docker_capabilities:

lgsm_role_docker_cgroup_parentlgsm2_docker_cgroup_parent

# Type: string
lgsm_role_docker_cgroup_parent:

# Type: string
lgsm2_docker_cgroup_parent:

lgsm_role_docker_commandslgsm2_docker_commands

# Type: list
lgsm_role_docker_commands:

# Type: list
lgsm2_docker_commands:

lgsm_role_docker_create_timeoutlgsm2_docker_create_timeout

# Type: int
lgsm_role_docker_create_timeout:

# Type: int
lgsm2_docker_create_timeout:

lgsm_role_docker_entrypointlgsm2_docker_entrypoint

# Type: string
lgsm_role_docker_entrypoint:

# Type: string
lgsm2_docker_entrypoint:

lgsm_role_docker_env_filelgsm2_docker_env_file

# Type: string
lgsm_role_docker_env_file:

# Type: string
lgsm2_docker_env_file:

lgsm_role_docker_envslgsm2_docker_envs

# Type: dict
lgsm_role_docker_envs:

# Type: dict
lgsm2_docker_envs:

lgsm_role_docker_labelslgsm2_docker_labels

# Type: dict
lgsm_role_docker_labels:

# Type: dict
lgsm2_docker_labels:

lgsm_role_docker_labels_use_commonlgsm2_docker_labels_use_common

# Type: bool (true/false)
lgsm_role_docker_labels_use_common:

# Type: bool (true/false)
lgsm2_docker_labels_use_common:

lgsm_role_docker_read_onlylgsm2_docker_read_only

# Type: bool (true/false)
lgsm_role_docker_read_only:

# Type: bool (true/false)
lgsm2_docker_read_only:

lgsm_role_docker_runtimelgsm2_docker_runtime

# Type: string
lgsm_role_docker_runtime:

# Type: string
lgsm2_docker_runtime:

lgsm_role_docker_sysctlslgsm2_docker_sysctls

# Type: list
lgsm_role_docker_sysctls:

# Type: list
lgsm2_docker_sysctls:

lgsm_role_docker_ulimitslgsm2_docker_ulimits

# Type: list
lgsm_role_docker_ulimits:

# Type: list
lgsm2_docker_ulimits:

lgsm_role_autoheal_enabledlgsm2_autoheal_enabled

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
lgsm_role_autoheal_enabled: true

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
lgsm2_autoheal_enabled: true

lgsm_role_depends_onlgsm2_depends_on

# List of container dependencies that must be running before containers start
# Type: string
lgsm_role_depends_on: ""

# List of container dependencies that must be running before containers start
# Type: string
lgsm2_depends_on: ""

lgsm_role_depends_on_delaylgsm2_depends_on_delay

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
lgsm_role_depends_on_delay: "0"

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
lgsm2_depends_on_delay: "0"

lgsm_role_depends_on_healthcheckslgsm2_depends_on_healthchecks

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

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

lgsm_role_diun_enabledlgsm2_diun_enabled

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
lgsm_role_diun_enabled: true

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
lgsm2_diun_enabled: true

lgsm_role_dns_enabledlgsm2_dns_enabled

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
lgsm_role_dns_enabled: true

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
lgsm2_dns_enabled: true

lgsm_role_docker_controllerlgsm2_docker_controller

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
lgsm_role_docker_controller: true

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
lgsm2_docker_controller: true

lgsm_role_docker_image_repolgsm2_docker_image_repo

# Type: string
lgsm_role_docker_image_repo:

# Type: string
lgsm2_docker_image_repo:

lgsm_role_docker_image_taglgsm2_docker_image_tag

# Type: string
lgsm_role_docker_image_tag:

# Type: string
lgsm2_docker_image_tag:

lgsm_role_docker_volumes_downloadlgsm2_docker_volumes_download

# Type: bool (true/false)
lgsm_role_docker_volumes_download:

# Type: bool (true/false)
lgsm2_docker_volumes_download:

lgsm_role_paths_locationlgsm2_paths_location

# Type: string
lgsm_role_paths_location:

# Type: string
lgsm2_paths_location:

lgsm_role_web_domainlgsm2_web_domain

# Type: string
lgsm_role_web_domain:

# Type: string
lgsm2_web_domain:

lgsm_role_web_fqdn_overridelgsm2_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
lgsm_role_web_fqdn_override:

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
lgsm2_web_fqdn_override:

Example Override

lgsm_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "lgsm2.{{ user.domain }}"
  - "lgsm.otherdomain.tld"

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

Example Override

lgsm2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "lgsm2.{{ user.domain }}"
  - "lgsm.otherdomain.tld"

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

lgsm_role_web_host_overridelgsm2_web_host_override

# Override the Traefik web host configuration for containers
# Type: string
lgsm_role_web_host_override:

# Override the Traefik web host configuration for containers
# Type: string
lgsm2_web_host_override:

Example Override

lgsm_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'lgsm2.' + user.domain }}`)"

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

Example Override

lgsm2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'lgsm2.' + user.domain }}`)"

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

lgsm_role_web_http_portlgsm2_web_http_port

# Type: string (quoted number)
lgsm_role_web_http_port:

# Type: string (quoted number)
lgsm2_web_http_port:

lgsm_role_web_http_schemelgsm2_web_http_scheme

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

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

lgsm_role_web_http_serverstransportlgsm2_web_http_serverstransport

# Type: dict/omit
lgsm_role_web_http_serverstransport:

# Type: dict/omit
lgsm2_web_http_serverstransport:

lgsm_role_web_schemelgsm2_web_scheme

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
lgsm_role_web_scheme:

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
lgsm2_web_scheme:

lgsm_role_web_serverstransportlgsm2_web_serverstransport

# Type: dict/omit
lgsm_role_web_serverstransport:

# Type: dict/omit
lgsm2_web_serverstransport:

lgsm_role_web_subdomainlgsm2_web_subdomain

# Type: string
lgsm_role_web_subdomain:

# Type: string
lgsm2_web_subdomain: