Manual Installation¶

Manual installation requires several prerequisites before proceeding.

Prerequisites¶

• DotNet Core 8.0: Download from https://dotnet.microsoft.com/download/dotnet/8.0
• Redis: Download from https://redis.io/download
• BaseX Server: Download from https://basex.org/download/
• Database Server: A supported database server (PostgreSQL, Oracle, or MS SQL Server) must be installed and configured.

Installation Steps¶

1. Download the Installation Package¶

Download the appropriate zip file for your operating system (Windows or Linux).

2. Extract the Package¶

Create a new directory (the installation directory, referred to as <installdir> below) with appropriate permissions. Avoid using spaces or special characters in the directory name.

Extract the downloaded zip file into the <installdir> directory.

3. Configure Database Connection¶

The default configuration is in <installdir>/appsettings.json. Modifying this file directly is not recommended.

Create a new file named appsettings.json in the <installdir>/Configuration directory. Configure database settings within this file.

Example (<installdir>/Configuration/appsettings.json):

1
2
3
4

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

Refer to the Node Configuration Settings page for detailed configuration options.

4. Verify Port Availability¶

Emakin uses ports 80, 443, and 7180 by default (80/443 for web access, 7180 for host administration). If these ports are in use, modify the port numbers in <installdir>/Configuration/appsettings.json.

Example: Changing Web Access Ports:

1. Edit <installdir>/Configuration/appsettings.json.
2. Modify the Web section to use different ports:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
  "Web": {
    "Kestrel": {
      "Endpoints": {
        "Http": {
          "Url": "http://*:8080" // Changed HTTP port
        },
        "Https": {
          "Url": "https://*:8443" // Changed HTTPS port
        }
      }
    }
   }
}

Example: Changing Host Administration Port:

1. Edit <installdir>/Configuration/appsettings.json.
2. Modify the HostAdmin section to use a different port:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "HostAdmin": {
    "Kestrel": {
      "Endpoints": {
        "Http": {
          "Url": "http://*:7181" // Changed HostAdmin port
        }
      }
    }
   }
}

5. Install Services (Windows Only)¶

On Windows, install the Emakin Agent service using the following command:

1

.\AltiKare.Workflow.Agent.exe install

This installs the main executable for web access and background job scheduling. Install the BaseX and Redis services (if needed) using .\AltiKare.Workflow.Agent.exe basex and .\AltiKare.Workflow.Agent.exe redis respectively.

6. Initial Web Server Test (Console Mode)¶

For initial testing, run the agent in console mode with only the web server active:

1

.\AltiKare.Workflow.Agent.exe web

This allows for verifying configuration without starting the full agent service. Access the web interface using the configured HTTP address (e.g., http://localhost:8080 if you changed the port in step 4).

7. Start the Agent Service¶

After verifying the web server configuration, start the full Emakin Agent service.

• Windows: Use the Windows Services Manager.
• Linux: Use the appropriate service manager command for your distribution.

This completes the manual installation. Refer to the Node Configuration Settings page for details on additional configuration options.