Windows

Follow these instructions to install and configure the Babel Licensing Service on Windows 11.

Prerequisites

To successfully install Babel Licensing Service on Windows 11, you will need to ensure that the following prerequisites are met.

• Ensure that Windows 11 has been updated to the latest version
• Microsoft SQL Server, or MySQL/MariaDB (the .NET 10 service is tested with MySQL 8.4 and MariaDB 11.4)
• The ASP.NET Core runtime that matches the service package (for example .NET 10 for babel_service_net100_x.y.z.w.zip)
• Babel Licensing Service ZIP package (e.g., babel_service_net100_x.y.z.w.zip). The same package serves both editions.
• Babel Licensing Server or Data Center edition license file (babel.licenses)
• If running the install script, PowerShell version 7 or greater is required

Install Script

The BabelLicensingService.ps1 PowerShell script is designed to automate the installation and configuration process of the Babel Licensing Service on Windows environments described in this paragraph.

This script ensures prerequisites such as administrative privileges, correct PowerShell version, and the MariaDB CLI command are met before initiating the installation process. It lets you install the service and query its status.

During the installation, it handles tasks like extracting the installation ZIP, copying the license file, creating the database, modifying the appsettings.json for accurate connection strings, and installing the service with the correct configuration, so you avoid the errors of a manual setup.

To use the BabelLicensingService.ps1 script, follow the steps below:

Set-ExecutionPolicy -ExecutionPolicy Unrestricted

If you prefer not to use the BabelLicensingService.ps1 script, you can continue reading for step-by-step instructions on how to manually set up the service.

Setup Files

Setting up the Babel Licensing Service requires extracting the necessary service assemblies and configurations from the provided ZIP file, babel_service_net100_x.y.z.w.zip, to the appropriate directory on your Windows machine. Below are the step-by-step instructions to extract the ZIP file using Windows Explorer to the C:\BabelSvc directory.

In Windows Explorer, go to the folder where babel_service_net100_x.y.z.w.zip is saved.

The Babel Licensing Service files from babel_service_net100_x.y.z.w.zip are now in the C:\BabelSvc directory.

License File

Copy the license file babel.licenses, into the extract folder. This step ensures that the service can access the required licensing information.

Creating Database

When setting up the Babel Licensing Service, creating a dedicated database and user is essential. Below are the step-by-step instructions for creating the Babel Licensing database with Microsoft SQL Server and MySQL MariaDB.

Microsoft SQL Server

To manage Babel Licensing Service licenses with SQL Server, setting up a dedicated database is essential. This guide provides steps to configure the database for seamless operation.

Launch SQL Server Management Studio (SSMS).

1. Connect to your SQL Server instance.
2. Open a new query window to execute the SQL commands.

Run the following SQL commands to create the database and configure the user

-- Create the licenses database
CREATE DATABASE licenses;
GO
 
-- Create a new SQL Server login for the Babel Licensing Service
CREATE LOGIN babel WITH PASSWORD = 'YourUniquePassword';
GO
 
-- Create a database user linked to the login
USE licenses;
CREATE USER babel FOR LOGIN babel;
GO
 
-- Grant the necessary privileges to the user
ALTER ROLE db_owner ADD MEMBER babel;
GO

MySQL MariaDB

HeidiSQL, a powerful and easy-to-use open-source database management tool, can be used in conjunction with MariaDB to facilitate this process. Below are the step-by-step instructions to create a database using HeidiSQL and MariaDB.

Start by launching HeidiSQL and switch to the SQL tab to run the following SQL commands:

CREATE DATABASE licenses;
CREATE USER babel@localhost IDENTIFIED BY 'YourUniquePassword';
GRANT ALL PRIVILEGES ON licenses.* TO babel@localhost;
FLUSH PRIVILEGES;

After executing the above steps, verify that the licenses database has been created successfully and that the babel user has the correct privileges assigned. You can do this by logging in with the babel user credentials and trying to access the licenses database.

Configuring Babel Licensing Service

Configuring the Babel Licensing Service is a crucial step to ensure its proper functionality and integration with your environment. This involves modifying the appsettings.json file located in the extracted folder and adjusting various settings to match your specific requirements.

Editing appsettings.json

Navigate to the extracted folder and locate the appsettings.json file. Open the file using your preferred text editor and update the database configuration to match the database server you selected for setting up the Babel Licensing database.

Microsoft SQL Server

To set up the Babel Licensing database on Microsoft SQL Server, please configure the Database Provider and SQLServer connection string as follows:

"Database": {
  "Provider": "SQLServer"
},
"ConnectionStrings": {
  "SQLServer": "Data Source=SQLSERVER_INSTANCE_NAME;User Id=babel;Password=YourUniquePassword;Encrypt=false;Initial Catalog=licenses",
  "MySQL": "",
  "SQLite": ""
},

Replace SQLSERVER_INSTANCE_NAME with the name of your SQL Server instance as displayed in SQL Server Object Explorer or your SQL Server Management Studio (SSMS) connection.

Use YourUniquePassword as the password you set for the babel login in Microsoft SQL Server.

MySQL MariaDB

If you opted for MySQL and MariaDB when creating Babel Licensing database, configure the Database Provider and the MySQL connection string as follows:

"Database": {
  "Provider": "MySQL"
},
"ConnectionStrings": {
  "SQLServer": "",
  "MySQL": "Server=127.0.0.1;User=babel;Password=YourUniquePassword;Database=licenses",
  "SQLite": ""
},

Here, ensure that the Provider under Database is set to MySQL, and the MySQL connection string is correctly configured with the appropriate server address, user, password, and database name. Replace YourUniquePassword with the actual password you’ve set for the babel user in MariaDB.

Configuring Kestrel

In the EndpointDefaults section, the Protocols is set to Http1AndHttp2, allowing the server to communicate using both HTTP1 and HTTP2 protocols, providing flexibility and compatibility with different types of clients.

"Kestrel": {
  "EndpointDefaults": {
    "Protocols": "Http1AndHttp2"
  },
  "Endpoints": {
    "gRPC": {
      "Url": "http://*:5005",
      "Protocols": "Http2"
    }
  }
},

The Endpoints section is where you define specific endpoints for the service. Here, an endpoint named gRPC is configured with the Url set to http://*:5005, allowing the service to listen on all available network interfaces on port 5005. The Protocols for this endpoint is specifically set to Http2, optimizing it for gRPC communication.

When configuring Kestrel, ensure that the specified URLs and protocols align with your service requirements and network environment, and adjust them as necessary to achieve the desired behavior and performance of your service.

Configuring Serilog

Further, configure the Serilog section to set up logging preferences:

"Serilog": {
  "Using": ["Serilog.Sinks.Console", "Serilog.Sinks.File"],
  "MinimumLevel": {
    "Default": "Information",
    "Override": {
      "Microsoft": "Warning",
      "System": "Warning",
      "Grpc": "Warning"
    }
  },
  "Enrich": ["FromLogContext", "WithMachineName", "WithThreadId"],
  "WriteTo": [
    {"Name": "Console"},
    {
      "Name": "File",
      "Args": {
        "path": "C:\\BabelSvc\\log.txt",
        "rollingInterval": "Day"
      }
    }
  ]
},

Application Settings

Lastly, under the Application section, specify the LicenseFile, SigningKey, and TokenExpiration values:

"Application": {
  "AdminUsername": "your-admin-user",
  "AdminEmail": "admin@example.com",
  "AdminPassword": "<strong-initial-password>",
  "LicenseFile": "babel.licenses",
  "SigningKey": "Secret Token Key",
  "TokenExpiration": "00:30:00"
},

Here, LicenseFile should be set to babel.licenses. Customize the SigningKey by replacing Secret Token Key with your unique key, which will secure the communication between application clients and the Babel Licensing Service. Adjust the TokenExpiration value according to your requirements to set the token’s validity duration.

Start Babel Licensing Service

To start the Babel Licensing Service using PowerShell, follow these steps:

cd C:\BabelSvc

.\Babel.Licensing.Service.exe

Running as a Windows Service

To ensure Babel Licensing Service operates efficiently in the background and is available upon system startups, it is recommended to run it as a Windows service. Running as a service allows Babel Licensing Service to operate independently of user sessions, offering uninterrupted service availability and functionality.

To accomplish this, you can use PowerShell’s New-Service command, which is designed to create a new entry for a Windows service in the registry and the service database. Below is the adapted command using New-Service in PowerShell:

New-Service -Name "Babel.Licensing" -BinaryPathName "C:\BabelSvc\Babel.Licensing.Service.exe" -DisplayName "Babel Licensing" -StartupType "Automatic" -Description "Babel licensing and reporting network services."

In this command:

• -Name "Babel.Licensing" specifies the name of the service.
• -BinaryPathName ".\Babel.Licensing.Service.exe" defines the path to the service’s executable file, indicating the current directory.
• -DisplayName "Babel Licensing" assigns a display name to the service, which is how it will appear in the Services application or other user interfaces.
• -StartupType "Automatic" configures the service to start automatically with the system.
• -Description "Babel licensing and reporting network services." provides a description, offering insights into the service’s role and functionality.

This command should be run in a PowerShell session with administrative privileges to ensure the proper creation and configuration of the service. After executing the command, the Babel Licensing Service will be set up as a Windows service, ready to offer continuous operation and availability on the system.

Start the Service

Start-Service -Name "Babel.Licensing"

Stop the Service

Stop-Service -Name "Babel.Licensing"

Get Service Status

Get-Service -Name "Babel.Licensing" 

Uninstall the Service

Get-Service -Name "Babel.Licensing" | Remove-Service

Remember to run these commands in a PowerShell session with administrative privileges to ensure they execute correctly.