Floating Server
...
Deployment Methods
Executable

Installation Steps

5min

Below are the steps for deploying the Floating Server using executable files.

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.

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:

YAML


File-Based Database:

YAML


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

Step 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:

  1. Redis: A fast, key-value database for efficient local storage.
  2. File-Based Database: Embedded, suitable for Windows environments.

Step 4: Run the Executable

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

Windows: ./floating-server.exe

Linux: ./floating-server

(Optional) Step 5: Customize the Run Command

You can customize how the server runs by specifying additional options, such as the port and configuration file path by customizing the run command.

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

For more information on configuring

Updated 12 Sep 2024
Doc contributor
Did this page help you?