Skip to content

Manual Installation

Manual Installation is used when Emakin must be installed directly on a host instead of through containers or Helm. This path is suitable when you need close control over the runtime environment or service manager.

Prerequisites

The preserved documentation lists these prerequisites:

  • DotNet Core 10.0 from Microsoft
  • Dragonfly
  • BaseX Server
  • a supported database server: PostgreSQL, Oracle, or MS SQL Server

Installation Workflow

1. Download the Installation Package

Download the package for the target operating system.

2. Extract the Package

Create an installation directory, referred to below as <installdir>, and extract the package there.

The preserved documentation recommends avoiding spaces and special characters in the directory name.

3. Configure Database Connection

Do not edit <installdir>/appsettings.json directly unless necessary. Instead, create:

1
<installdir>/Configuration/appsettings.json

Example preserved from the current documentation:

1
2
3
4
{
    "DbConnStr": "Host=sqlserver;Database=EMAKIN;Username=emakin;Password=emakin;",
    "ProxyUri": ""
}

For broader configuration behavior, see Node Configuration.

Optional Custom Data Path

The agent stores node-local custom configuration, logs, and the FullText catalog under <installdir>/Configuration/Data by default. Define AK_CONFIGURATION_DATA_PATH only when this data must be kept in another location:

1
AK_CONFIGURATION_DATA_PATH=D:\EmakinData

Configure the variable in the Windows service environment or in the Linux service manager environment before starting the agent. The target directory must already be accessible and writable by the account running the agent. Use a persistent disk if the data must survive service replacement or host maintenance.

4. Verify Port Availability

The preserved defaults are:

  • 80 and 443 for web access
  • 7180 for host administration

If those ports are in use, update the relevant settings in <installdir>/Configuration/appsettings.json.

Example preserved for changing web ports:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "Web": {
    "Kestrel": {
      "Endpoints": {
        "Http": {
          "Url": "http://*:8080"
        },
        "Https": {
          "Url": "https://*:8443"
        }
      }
    }
  }
}

Example preserved for changing the host-administration port:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "HostAdmin": {
    "Kestrel": {
      "Endpoints": {
        "Http": {
          "Url": "http://*:7181"
        }
      }
    }
  }
}

5. Install Services on Windows

To install the main agent service on Windows:

1
.\AltiKare.Workflow.Agent.exe install

The preserved documentation also lists:

  • .\AltiKare.Workflow.Agent.exe basex
  • .\AltiKare.Workflow.Agent.exe redis

for installing the related services when needed.

6. Test in Console Mode

Before running the full service stack, test the web server in console mode:

1
.\AltiKare.Workflow.Agent.exe web

This starts web services without the full background-agent workload.

7. Start the Agent Service

After configuration is verified:

  • Windows: start the service through Windows Services
  • Linux: start it through the service manager used by the host distribution