Manual installation requires following dependencies before continue to install
DotNet Core 6.0 (https://dotnet.microsoft.com/download/dotnet/6.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 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;
{ "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.
4. Install Services (Windows Only)
Emakin Agent service is main executable for web access and scheduler for background jobs.
Dependent Services
Emakin Agent also provides utility commands to install other dependent services
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.
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