axesFlip REST Server configuration guide

Version: 1.1.37

This guide details the available configuration settings for the axesFlip REST Server application, which uses a standard JSON format for its configuration file (flip.config.json).

To use the application, create a configuration file named flip.config.json tailored to your environment and place it in the same directory as axesflip.exe. 

The download package includes example configuration files that you can use as a starting point or adapt to your needs:

• example-flip.config.json
• minimal-example-flip.config.json

Table of contents

• Overview
• Configuration structure
• Configuration sections
  • Logging
  • FileLog
  • Kestrel (web server)
  • Cors
  • Swagger (API documentation)
  • RestApi settings
  • Template settings
• Root-level settings
• Complete configuration example
• Minimal configuration example

Overview

The configuration file is typically loaded by the application at startup. The settings define logging behavior, web server endpoints (Kestrel), API behaviors, CORS policies, and template locations.

Configuration structure

The configuration file uses a nested JSON structure. Keys represent configuration sections and individual settings.

Configuration sections

Logging

Configures standard console and system logging levels for different application namespaces.

FileLog

Configures the application's dedicated file-based logging mechanism. This is independent of the standard Logging section.

Kestrel (web server)

Configures the Kestrel web server endpoints and SSL certificates.

• For Linux: If running Kestrel directly, configure the file path to your PFX certificate and its password.
• For Windows: Configure settings to load the certificate directly from the Windows Certificate Trust Store.

For more information, check the Kestrel documentation.

Cors

Swagger (API documentation)

RestApi settings

Template settings

Root-level settings

Complete configuration example

{
  "Logging": {
    "LogLevel": {
      "A4.Flip.Clients.Api": "Information",
      "A4.*": "Warning",
      "Default": "Warning",
      "System": "Error",
      "Microsoft": "Error"
    },
    "EnableConsoleLogging": false
  },
  "FileLog": {
    "Enabled": true,
    "Path": "/var/log/axesFlip",
    "Folder": "axes4",
    "FileName": "flipWebServer.log",
    "MaxFileSizeMb": 10,
    "MaxFiles": 10,
    "LogLevel": "Info"
  },
  "Kestrel": {
    "EndPoints": {
      "Http": {
        "Url": "https://*:29375",
        "Certificate": {
          "Path": "/etc/ssl/certs/mycert.pem",
          "Password": "pwd"
        }
      }
    }
  },
  "Cors": {
    "AllowedOrigins": ["https://*:29375"]
  },
  "Swagger": {
    "Enabled": true
  },
  "AllowedHosts": "*",
  "RestApi": {
    "MaxRequestBodySizeMb": 40,
    "CheckRequestBodySize": false
  },
  "Template": {
    "BaseTemplatePath": "./Store/Templates",
    "Templates": [
      {
        "Id": "sample",
        "Status": "Active",
        "TemplatePath": "../../sample.json"
      },
      {
        "Id": "demo",
        "Status": "Active",
        "TemplatePath": "path/to/template.json"
      }
    ]
  },
  "Environment": "Development",
  "LicenseFilePath": "./path/to/license/file"
}

Minimal configuration example

{
  "Logging": {
    "LogLevel": {
		"Default": "Information"
    },
    "EnableConsoleLogging": true
  },
  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "http://localhost:29375",
      }
    }
  },
  "Cors": {
    "AllowedOrigins": [ "http://localhost:29375"]
  },
  "AllowedHosts": "*",
  "Template": {
    "BaseTemplatePath": "Templates",
  }
}