Skip to main content

Installation and operation of axesSense On-Prem

Thomas Schempp
  • Updated

System requirements

  • axesSense requires the .NET8 Hosting Bundle. You can download it from Microsoft's Download .NET. page.

  • axesSense runs on all Windows versions on which the .NET 8 Hosting Bundle run.

  • axesSense runs on all Linux versions on which the .NET 8 Hosting Bundle run. However, this is not tested by us; please contact us if you want to run axesSense on Linux.

Software

We provide you with axesSense On-Prem as a ZIP file. You can unpack the ZIP file and copy it to a suitable location on your server.

Start and stop axesSense On-Prem

Open a command line, change to the axesSense On-Prem folder and start it by typing:

A4.Sense.Api.OnPrem.exe

A4.Sense.Api.OnPrem.exe is a Kestrel server that provides the functionality via a Web API.

Stop the the Kestrel server by typing Ctrl+C on your keyboard.

Install axesSense as a Windows service

You can install axesSense as a Windows service:

sc create axesSense.Api.OnPrem binPath="C:\path\to\the\axesSense.Api.OnPrem.exe" start=auto

API Swagger documentation

You can open a swagger documentation of the axesSense API at:

https://[HOSTNAME]:[PORT]/swagger/index.html

The default port is 29376.

This Swagger endpoint also allows you to “play” with the settings and some of your documents.

Licensing

axesSense only works with a valid license file. Please contact us if you are interested in a license or a demo license.

By default, the license file is located in the same folder as A4.Sense.Api.OnPrem.exe and is called axesSense.lic. The file path and the file name of the license file can be adjusted in the configuration if required.

https-Certificate

axesSense On-Prem runs exclusively with https; it does not work with http.

A certificate is required for https, which must be installed on your computer and is referenced in the configuration.

Configuration

In the program directory of axesSense On-Prem is the appsettings.json file, which can be used to configure axesSense:

Logging

The log file is written to this directory:

%localappdata%\axes4\Sense-API

Specify the level of detail of the logging in this section:

Logging": {
  "LogLevel": {
     "Default": "Trace | Information | Warning | Error",
     "Microsoft.AspNetCore": "Trace | Information | Warning | Error"

Server address and port

Edit the default server address and port in this section:

"Kestrel": {
  "EndPoints": {
    "Http": {
      "Url": "https://*:29376"

Certificate

Edit the certificate configuration in this section:

"Kestrel": {
  "EndPoints": {
    "Certificate": {
      "Subject": "localhost",                       [Name of the certificate]
      "Store": "My",                                [Certificate store]
      "Location": "LocalMachine | CurrentUser",
      "AllowInvalid": "false | true"

If you use a self-signed certificate that is not signed by a root authority, you must set AllowInvalid to false.

Path to the license file

Edit the default path “axesSense.lic” in this section:

"LicenseFilePath": "axesSense.lic"