Configuration File

Configuration file needs to be supplied to the server at the default or custom location. Server accepts .yaml files.

The only required configuration includes specifying the database config.

On versions prior to 1.4.9 the database settings were set via the redis config. In version 1.4.9 and later redis config was changed in favor for database.

Config files made for versions prior 1.4.9 will continue to be valid.

Changing the database type from redis to file and vice versa is not possible. To change the database type all licenses need to be reactivated!

Verbose Error Logging Enhancement (Starting from Version 1.4.12)

From version 1.4.12 onwards, verbose error logging has been introduced, providing more detailed insights into system behavior. By default, these logs are directed to stdout, making them easily accessible through Docker logs when using containers.

If you prefer to export the logs to a file, this behavior can be configured in the settings. Simply update the configuration file with the following directive:

logDestination: exportFile

Additional details can be supplied either in the configurations or through the Floating Server UI.

Configuration format:

config.yaml

# Database Settings - MANDATORY
database:
  type: redis | file # If not set redis is used by default
  addresses: 
    # If type set to redis enter your redis address and port
    # If type set to file, enter the relative path where to store the files
    - redis:6379
  # - database - creates a folder database in the location from which the executable was ran

# Database config for > 1.4.9 - only redis was supported

# redis:

#  addresses:

#    - "localhost:6379"

# Override for default License and Management APIs

# Do not configure if not instructed by vendor
apiUrl: https://subdomain.YOUR_WHITLABEL_DOMAIN.tld
managementUrl: https://subdomain.YOUR_WHITLABEL_DOMAIN.tld

# API and shared keys for talking to LS API
apiKey:  <your_api_key>
sharedKey: <your_shared_key>

# All products this user has licenses for
products:
  # add a key based license
  MicrosoftWord:
    licenseKey: GFEV-H2YD-63EK-LMAP
  # add an username based license 
  Skype:
    username: user
    password: pass

# Password hash for website login (e.g. https://bcrypt-generator.com/)
websitePassword: $2y$10$lsiMFX54HFoPbceInt3ppe4JW7wGxuYyRJSVLDgGX5RVv4m39aTyG
    
ui:
  disableUnregistration: false

Program Arguments

Argument Name	Default	Description
port	"8080"	Server port
config	"config/config.yaml"	Configuration file location
logfile	"logs/floating-server.log"	Log file location
data	"data/"	Local database location
logo		Logo file location
welcomeMessage		UI welcome message