Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Manual installation requires following dependencies before continue to install

Installation steps

1. Download the installation package

Download the zip page depending on your environment, Linux or Windows packages distributed separately.

2. Extract the zip package

Create installation directory with full permissions. Avoid using space or special characters in directory name. This directory will be referenced as <installdir> in next steps.

Extract the zip package to installation directory.

3. Set database connection

Default configuration settings are stored in appsettings.json file. Emakin uses layered multiple JSON configuration files to override configuration settings and changing any default setting in <installdir>/appsettings.json file is not recommended.

Create a new file in <installdir>/Configuration directory with appsettings.json name and set updated configuration setting in this file.

Example <installdir>/Configuration/appsettings.json file to set database connection for host administration;

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

Please see Configuration Settings page for further details.

3. Check ports available.

Emakin listens from 80, 443, 5000 port numbers by default. 80 and 443 used for standard web access. 5000 port is used for host administration panel access and must be accessible only from localhost.

If you have another application running on your server using same ports, you need to change port numbers from <installdir>/Configuration/appsettings.json configuration file.

Expand
titleHow to set web access port numbers
  1. Edit <installdir>/Configuration/appsettings.json file.

  2. Add following setting in configuration file and change (http) 80 or (ssl) 443 numbers to free ports on your server. In this example we change http port to 800 and ssl port to 4430.

    Code Block
    {
      "Web": {
        "Kestrel": {
          "Endpoints": {
            "Http": {
              "Url": "http://*:800"
            },
            "Https": {
              "Url": "https://*:4430"
            }
          }
        },
       }
    }
Expand
titleHow to set host administration port number
  1. Edit <installdir>/Configuration/appsettings.json file.

  2. Add following setting in configuration file and change host administration (5000) to free ports on your server. In this example we change host administration to 5001.

    Code Block
    {
      "HostAdmin": {
        "Kestrel": {
          "Endpoints": {
            "Http": {
              "Url": "http://*:5001"
            }
          }
        },
       }
    }

4. Install Services (Windows Only)

Emakin Agent service is main executable for web access and scheduler for background jobs. 

Expand
titleInstall Emakin Agent Service

Execute the following command to install emakin agent as service.

Code Block
languagebash
.\AltiKare.Workflow.Agent.exe install

Dependent Services

Emakin Agent also provides utility commands to install other dependent services

Expand
titleInstall BaseX Service

Execute following command to install BaseX service.

Code Block
languagebash
.\AltiKare.Workflow.Agent.exe basex
Expand
titleInstall Redis Service

Execute following command to install BaseX service.

Code Block
languagebash
.\AltiKare.Workflow.Agent.exe redis

5. Start Web Server in Console Mode

Its recommended to start agent in console mode with only web server for first run to ensure all configuration is valid. This is ensures all connections are properly configured and helps to resolve any configuration errors.

Expand
titleStart Web Server

Execute agent in web server mode

Code Block
languagebash
.\AltiKare.Workflow.Agent.exe web

After agent started in web server mode you can open web interface from with http://localhost address.

6. Start Service

Starting service (Windows Only)

Open windows services from task manager / services tab or service manager.

Starting service (Linux)

Execute the service from shell

Expand
titleStart Service

Execute agent

Code Block
languagebash
.\AltiKare.Workflow.Agent.exe