Installation Steps

1

Step 1: Download the Executable

Download the executable from this link and unzip the file. After unzipping, you will find a directory named web and the executable file.

2

Step 2: Create the Configuration File

The server requires a config.yaml file. This file is where you define the server settings, including the database and other optional parameters such as API URLs, product licenses, and login credentials.

Example Configurations

Redis:

database:
  type: redis
  addresses: 
    - localhost:6379

File-Based Database:

database:
  type: file
  addresses: 
    - database

This creates a database directory in the current location to store the data.

3

Choose a Database

Define the database type and address in your configuration file before running the server. You can choose between two database options:

• Redis: a fast, key-value database for efficient local storage.
• File-Based Database: embedded, suitable for Windows environments.

4

Step 4: Run the Executable

Once your configuration file is in place, run the executable:

Windows

./floating-server.exe

Linux

./floating-server

5

(Optional) Customize the Run Command

You can customize how the server runs by specifying additional options, such as the port and configuration file path:

./floating-server.exe -config /path/to/config.yaml

For more information on configuring