> For the complete documentation index, see [llms.txt](https://docs.licensespring.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.licensespring.com/floating-server/floating-server-v1/deployment-methods/executable/installation-steps.md).

# Installation Steps

{% stepper %}
{% step %}

### Step 1: Download the Executable

Download the executable from [this link](https://floating-server.s3.eu-central-1.amazonaws.com/index.html) and unzip the file. After unzipping, you will find a directory named `web` and the executable file.
{% endstep %}

{% step %}

### 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
database:
  type: redis
  addresses: 
    - localhost:6379
```

**File-Based Database:**

```yaml
database:
  type: file
  addresses: 
    - database
```

This creates a `database` directory in the current location to store the data.
{% endstep %}

{% step %}

### 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.
  {% endstep %}

{% step %}

### Step 4: Run the Executable

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

{% tabs %}
{% tab title="Windows" %}

```powershell
./floating-server.exe
```

{% endtab %}

{% tab title="Linux" %}

```bash
./floating-server
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

### (Optional) Customize the Run Command

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

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

For more information on configuring
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.licensespring.com/floating-server/floating-server-v1/deployment-methods/executable/installation-steps.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.