docker run -p 7777:7777/tcp -p 29999:29999/udp --name some_name -d leapslabs/leaps_server:tag /app/leaps-server --cfg /app/config/leaps-server.conf
where some_name is the name you want to assign to your container and tag is the tag specifying the leaps-server version you want. See the list above for relevant tags.
The leaps_server instance is using port 7777 for TCP and port 29999 for UDP communication with the RTLS Gateways so these ports need to be remapped from the host to leaps_server instance with command -p 7777:7777/tcp -p 29999:29999/udp . It is not recommended to change the port numbers unless needed. If they need to be modified, please adapt accordingly the port settings on the RTLS Gateways.
Recommended run options
--user $(id -u):$(id -g) Run the instance under a specific user and group.--restart unless-stopped Restart automatically the instance in case the server would crash.The leaps_server needs a configuration file to run so the --cfg option needs to be set with the path to the configuration file needs to be specified. The container contains a default leaps-server.conf located in /app/config/ folder. If you need to modify this configuration file, you can do it within the container or you can create a custom configuration file and mount it from the host machine to the container.
For example, /my/custom/leaps-server.conf is the path to the custom configuration file. Then start the leaps_server container as follows:
docker run -p 7777:7777/tcp -p 29999:29999/udp --name some_name -v /my/custom:/app/config/ -d leapslabs/leaps_server:latest /app/leaps-server --cfg /app/config/leaps-server.conf
#######################################################################
# LEAPS Server settings
#
# -----------------------------------------------------------------
# Logging
# -----------------------------------------------------------------
#
# Logging level, default is 4 (0=none, 1=fatal, 2=error, 3=warning,
# 4=info, 5=debug, 6=verbose).
log_level = 4
# Path to log file. Comment out to disable logging to file (log to stdio instead).
# log = /app/data/leaps-server.log
# -----------------------------------------------------------------
# Certificate based SSL/TLS support
# -----------------------------------------------------------------
#
# cafile - Authority certificates that have signed your server certificate.
# certfile - Path to the PEM encoded server certificate.
# keyfile - Path to the PEM encoded keyfile.
# gw_auth - When using TLS on the interface with the gateways,
# this parameter configures TLS authentication between server
# and the gateway (0=server 1=mutual).
#
# cafile = /app/data/certs/cacert.pem
# certfile = /app/data/certs/servercert.pem
# keyfile = /app/data/certs/serverkey.pem
# gw_auth = 1
# Optional AES 128-bit private key as hexadecimal number. If specified, the key is used to encrypt sensitive data
# for example the WiFi password published on the MQTT interface.
# aes_128_key = 00112233445566778899aabbccddeeff
# -----------------------------------------------------------------
# MQTT Broker
# -----------------------------------------------------------------
#
# Version of the MQTT protocol. Supported versions are "3.1.1" or "5.0". Default is version "3.1.1".
# mqtt_version = 5.0
mqtt_clid = 1
mqtt_port = 1883
mqtt_host = localhost
# Include network ID (PAN ID) in the MQTT topics. Enabled by default.
# mqtt_with_panid = true
# Specifies an alias for particular UWB network that is then used in the MQTT topic instead of the network ID (pan ID) .
# Parameter can be used multiple times and there might be multiple definitions separated by spaces which are then added to the list of known aliases.
# Alias definitions must follow format <ID>:<ALIAS_STRING>. Multiple definitions must be separated with spaces.
# Network ID (PAN ID) can be hexadecimal number (withe prefix \"0x\") or decimal number.
# mqtt_panid_alias = [123:NetworkA] [0x0002:Net B]
# mqtt_panid_alias = [0XABCD:Network_C]
# MQTT API variant can be "=pans" or "=leaps" (default).
# mqtt_api = leaps
# Username / password
mqtt_user = leaps
mqtt_password = leaps
# For LEAPS RTLS
mqtt_topic_prefix = leaps
# For PANS PRO RTLS should use dwm to backward compatibility.
# mqtt_topic_prefix = dwm
# Certificates used on MQTT interface
# mqtt_cafile = /etc/leaps-server/cacert.pem
# mqtt_certfile = /etc/leaps-server/servercert.pem
# mqtt_keyfile = /etc/leaps-server/serverkey.pem
# Period in seconds after which all status and config topics are published regardless
# whether the content has changed or not. Disabled when set to 0. Disabled by default.
# mqtt_refresh = 10
# -----------------------------------------------------------------
# Secondary MQTT Broker
# -----------------------------------------------------------------
#
# mqtt_clid_sec = 2
# mqtt_port_sec = 1883
# mqtt_host_sec =
# Username / password for secondary
# mqtt_user_sec = usersec
# mqtt_password_sec = passsec
# Certificates used on MQTT interface
# mqtt_cafile_sec = /etc/leaps-server/cacert.pem
# mqtt_certfile_sec = /etc/leaps-server/servercert.pem
# mqtt_keyfile_sec = /etc/leaps-server/serverkey.pem
# -----------------------------------------------------------------
# TCP
# -----------------------------------------------------------------
#
tcp_port = 7777
# -----------------------------------------------------------------
# Location engine
# -----------------------------------------------------------------
# Enable publishing raw TDOA data to MQTT broker to use external location engine.
# Default is false.
# tdoa_external_le = true
# -----------------------------------------------------------------
# Tag location statistics
# -----------------------------------------------------------------
# Enable calculation of tag location statistics. Default is false.
# loc_stats_enable = true
# History window for calculation of tag location statistics. Default is 100.
# loc_stats_history_window = 100
# -----------------------------------------------------------------
# Other
# -----------------------------------------------------------------
# maximum number of attempts of configuration and service commands
cmd_att = 3
Content type
Image
Digest
sha256:47aa9ef29…
Size
31.1 MB
Last updated
about 2 months ago
docker pull leapslabs/leaps_server