License Generator

Overview

This is the redBorder License Generator. It's a simple script for generating demo licenses using a RESTful API.

The API can be used to request demo licenses valid for 30 days for a cluster. Only one license per cluster is allowed.

Install

A mariadb instance running is required. Just clone the repo and then:

npm install
npm run build

Configuration

The configuration is done using environment variables and a JSON file:

Environment Variables

• DB_DATABASE ("licenses"): Name of the database.
• DB_HOST ("mariadb"): Hostname where the database is running.
• DB_PASSWORD ("qwerty"): Password for the database connection.
• DB_PORT (3306): Port for the connection to the database.
• DB_USERNAME ("root"): Username for the connection to the database.
• LOG_LEVEL ("info"): Allowed: ["error", "warn", "info", "debug", "trace"].
• PORT (3000): Port to listen for HTTP connections.
• PRIVATE_KEY (""): Private key for signing licenses. Should be in PEM format.

Dynamic License Configuration (config/license.json)

You can customize the generated licenses by modifying config/license.json. This file is loaded at runtime:

• valid_days: Duration of the generated license (default: 30 days).
• sensors: A dictionary of sensor IDs and their respective counts.

Example config/license.json:

{
  "valid_days": 30,
  "sensors": {
    "199": 100,
    "191": 100,
    "flow": 100,
    "vault": 100
  }
}

Using Docker

The project is fully modernized for Node.js 22+ and ESM. Running with docker compose:

version: '3.8'

services:
  server:
    image: redborder/license-generator:0.5.0
    environment:
      - DB_PASSWORD=redborder
      - PRIVATE_KEY="<your private key here>"
    volumes:
      - ./config/license.json:/app/config/license.json:ro
    ports:
      - "80:3000"

  mariadb:
    image: mariadb:11
    environment:
      - MYSQL_DATABASE=licenses
      - MYSQL_ROOT_PASSWORD=redborder

Usage

First, you need to run the server:

env PRIVATE_KEY="PRIVATE KEY GOES HERE" npm run app

To get a license you can simply POST to the /api/v1/licenses sending a cluster UUID.

POST /api/v1/licenses
Content-Type: application/json

{"cluster_uuid": "dfe7e4a8-5d2d-4835-b381-926085802e98"}

You can test it with curl:

curl -X POST \
  http://localhost:3000/api/v1/licenses \
  -H 'content-type: application/json' \
  -d '{"cluster_uuid": "dfe7e4a8-5d2d-4835-b381-926085802e98"}'

For more information check documentation.