Manual Installation

Manual installation requires the following dependencies before continuing to install

DotNet Core 8.0 (https://dotnet.microsoft.com/download/dotnet/8.0)
Redis (https://redis.io/download)
BaseX Server (https://basex.org/download/)
Database Server (Postgres, Oracle, MS SQL Server is supported)

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 an installation directory with full permissions. Avoid using space or special characters in directory names. This directory will be referenced as <installdir> in next steps.

Extract the zip package to the 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 a database connection for host administration;

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

Please see the Configuration Settings page for further details.

3. Check ports available.

Emakin listens from 80, 443, and 7180 port numbers by default. 80 and 443 are used for standard web access. 7180 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 the same ports, you need to change port numbers from <installdir>/Configuration/appsettings.json configuration file.

Edit <installdir>/Configuration/appsettings.json file.
Add the following setting in the configuration file and change (http) 80 or (SSL) 443 numbers to free ports on your server. In this example, we change the http port to 800 and SSL port to 4430.
{ "Web": { "Kestrel": { "Endpoints": { "Http": { "Url": "http://*:800" }, "Https": { "Url": "https://*:4430" } } }, } }

Edit <installdir>/Configuration/appsettings.json file.
Add the following setting in the configuration file and change host administration (7180) to free ports on your server. In this example, we change host administration to 7181.
{ "HostAdmin": { "Kestrel": { "Endpoints": { "Http": { "Url": "http://*:7181" } } }, } }

4. Install Services (Windows Only)

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

Execute the following command to install the emakin agent as a service.

Dependent Services

Emakin Agent also provides utility commands to install other dependent services

Execute the following command to install the BaseX service.

5. Start Web Server in Console Mode

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

Emakin Documentation