Floating License Setup
======================

This guide will help you set up the TurboFloat License Server and configure ShapeFX Loki to lease licenses from it.

Overview
--------

A floating license allows you to share a limited number of licenses across multiple users. The TurboFloat server manages license distribution and ensures compliance. It can run on any platform—Windows or Linux—as long as it is accessible from the client machines.

Steps to set up floating licensing:

1. Download the TurboFloat License Server.
2. Configure the server.
3. Activate the server with your product key.
4. Start the server.
5. Configure ShapeFX Loki to connect to the license server.

Setting Up the License Server
-----------------------------

Windows
~~~~~~~

1. **Download TurboFloat:**
    - Download the Windows version of the TurboFloat License Server directly from your account on our site:
      `Download TurboFloat <https://shapefx.app/dashboard/downloads>`_.
    - Ensure you are logged in to access the downloads section.

2. **Extract and Configure:**
    - Extract the contents of ``shapefx_loki-turbo_float_server-win64.zip``.
    - Edit the ``TurboFloatServer-config.xml`` file to specify a port (default: ``13``). Keep this port number handy for client configuration.

3. **Activate the Server:**
    - Open a terminal (PowerShell or cmd) in the server directory.
    - Run the following command:
    ::
          
             TurboFloatServer.exe -a="YOUR-PRODUCT-KEY"

4. **Start the Server:**
    - Run the following command to launch the server:
    ::
          
             TurboFloatServer.exe -x

    - Optionally, you can install the server as a background service:
    ::
          
             TurboFloatServer.exe -i

Linux
~~~~~

1. **Download TurboFloat:**
    - Log in to your account on our site to download the TurboFloat License Server for Linux:
      `Download TurboFloat <https://shapefx.app/dashboard/downloads>`_.
    - After downloading the file (e.g., `shapefx_loki-turbo_float_server-linux64.tar.gz`), transfer it to the machine where the license server will run.

2. **Extract and Configure:**
    - Use the following commands to prepare the server:
    ::

             tar -xvzf shapefx_loki-turbo_float_server-linux64.tar.gz
             cd shapefx_loki-turbo_float_server-linux64
             chmod +x turbofloatserver

3. **Activate the Server:**
    - Run the following command to activate:
    ::

             ./turbofloatserver -a="YOUR-PRODUCT-KEY"

4. **Start the Server:**
    - Launch the server:
    ::

             ./turbofloatserver -x

    - For automatic startup, set up the server as a systemd service. See the `systemd guide <https://systemd.io/>`_.

Activating the Server
---------------------

You can activate the TurboFloat server online.

### Online Activation

1. Run the activation command in your server directory:
    ::
    
      TurboFloatServer.exe -a="YOUR-PRODUCT-KEY"

2. If successful, the server will display an activation confirmation message.

Connecting ShapeFX Loki to the Server
--------------------------------------

Follow these steps to configure ShapeFX Loki to lease licenses from the TurboFloat server:

Locate the Server Address
~~~~~~~~~~~~~~~~~~~~~~~~~~

Identify the server's IP address or hostname and port number (e.g., ``192.168.1.100:13``).

Set Environment Variables
~~~~~~~~~~~~~~~~~~~~~~~~~~

Based on your operating system, set the ``LOKI_LICENSE_SERVER`` environment variable as follows:

**Windows**

- **Using PowerShell:**

  .. code-block:: powershell

     $env:LOKI_LICENSE_SERVER = "192.168.1.100:13"

- **Using Command Prompt:**

  .. code-block:: batch

     set LOKI_LICENSE_SERVER=192.168.1.100:13

**Linux**

- Use the ``export`` command:

  .. code-block:: bash

     export LOKI_LICENSE_SERVER="192.168.1.100:13"

Test Connectivity
~~~~~~~~~~~~~~~~~

Start ShapeFX Loki. If configured correctly, it should successfully lease a license from the server.