Skip to main content

Install Akabot Center 4X and PostgreSQL on Microsoft Windows

This guide provides instructions to installing a single instance of akaBot Center version 4.x with MSSQL as the database engine. The target Operating System (OS) in this guideline is Microsoft Windows.

1. Prerequisites​

1.1. Hardware and OS Requirements

ConfigurationRequirements
HardwareRAM: 32GB or higher
Core: 8 CPU or higher
SSD: 512 GB
Operating SystemWindows 10, 11, Server 2012 R2/2016/2019

1.2. Software Packages

The installation must be performed using an account with Administrator (root) privileges on the target machine.
You need to prepare the installation package according to the following list.

Note:

  • If the computer where you're installing Center does not have an internet connection, please download the installation package externally and copy it to the machine.
  • To avoid errors during installation with command line execution, please use a dedicated folder for akaBot Center installation and name the installation package directory without any spaces. For example: C:\akaBot
#NameFile NameVersionDescriptionDownload Link
1akaBot CenterakaBot-center- 4.x.x.x.warNewest versionakaBot Center installation packageakaBot provides through email after the customer makes a purchase.
2Java Developer Kitopenlogic-openjdk-17.0.1617.0.16Open logic JDK 17.0.16Download
3Apache tomcatapache-tomcat-10.1.52.exe10.1.52Web server Apache TomcatDownload
4ActiveMQapache-activemq- 5.15.1-bin.zip5.15.1ActiveMQ for Queue functionality in akaBot CenterDownload
5PostgreSQLpostgresql-18.3-2-windows-x6418.3The database engine of akaBot CenterReadSection 3.1for more details

2. Java JDK 17 Installation​

Run the installer -openlogic-openjdk-17.0.16 you have downloaded. After that, click "Next" to proceed.

1773026436457-662.png

1773026455322-826.png

1773026480063-797.png

1773026504396-498.png

  • After Installation is complete, you will see the Complete Notification below. Simply click Finish. You have successfully installed JDK.

1773026554098-998.png

Note: Make sure that JAVA_HOME presents in your environment variables by typing command echo %JAVA_HOME%, the output should be a path that point to jdk 17 ex: C:\Program Files\OpenLogic\jdk-17.0.16.8-hotspot

3. PostgreSQL installation​

3.1. Install PostgreSQL​

Download link: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

Step 1: Open file

  • Open setup file from your computer
  • Follow these steps below:

1773111578739-129.png

1773114333220-825.png

1773114368791-509.png

1773114465751-567.png

Step 2: Set up your password

  • Note: This password will be used in next steps, thus remember this one.

1773114546424-196.png

Step 3: Install

  • Use default port code

1773114627305-610.png

1773114687711-726.png

  • Click button "Next" to install

1773114744583-571.png

  • Here is the successful screen. Click "Finish" to close the window.

1773114856970-621.png

3.2.Setup Stack builder

  • Click "Next"

1773131442848-150.png

1773131458317-548.png

1773115130094-189.png

  • Here is the screen announcing that all the installation files have now been successfully downloaded. Click "Next" and "Finish"

1773130004131-273.png

  • You can double check whether PostgreSQL is running through Services.

1773130089004-725.png

3.3. Create database

Step 1: Open pgAdmin4

Step 2: Right click "Databases" > Create > Database...

1773128994191-351.png

  • Input new database: aka_orchestrator in Generaltab, then click "Save"

1773129095687-215.png

1773129157904-918.png

4. Apache Tomcat installation​

4.1. Install Apache Tomcat​

Apache Tomcat installation:

  • Uncheck "Run Apache Tomcat"
  • Uncheck "Show Readme"
  • Click the "Finish" button to complete the installation.pe your information message here.

1773039471617-579.png

1773039448180-898.png

1773039436317-278.png

The installation path for Apache Tomcat: %TOMCAT_PATH% = C:\Program Files\Apache Software Foundation\Tomcat 10.1

4.2. Apache Tomcat Configuration​

4.2.1. Configure log settings

**Step 1: **Open the file %TOMCAT_PATH%\conf\logging.properties

Step 2: Add attribute maxDays to specify the maximum number of days that rotated access logs will be retained for before being deleted for the catalina, localhost, host-manager, manager logs. If not specified, the default value of -1 will be used which means never delete old files.

  • Example: keep 90 daysworth of history. Change the number at the end of the following rows:
    • 1catalina.org.apache.juli.AsyncFileHandler.maxDays = 90
    • 2localhost.org.apache.juli.AsyncFileHandler.maxDays =90
    • 3manager.org.apache.juli.AsyncFileHandler.maxDays =90
    • 4host-manager.org.apache.juli.AsyncFileHandler.maxDays =90

Step 3: Save changes and close the file.

1773039597849-397.png

Step 4: Open the file %TOMCAT_PATH%\conf\server.xml

Step 5: Un-Comment the line of log setting to turn on the log and add attribute maxDays as below:

1773039659797-700.png

Step 6: Save changes and close the file

4.2.2. Other settings

Step 1: Navigate to the path %TOMCAT_PATH%\bin and double-click the file Tomcat10w.exe to open the Apache Tomcat Service configuration.

1773039700842-636.png

Step 2: On the General tab

  • Select Startup type: Automatic
  • Choose Apply to apply the configuration changes.

1773039738250-351.png

Step 3: On the Logging tab

(1) Log prefix: Remove "commons-daemon"

(2) Redirect Stdout: Remove "auto"

(3) Redirect Stderror: Remove "auto"

(4) Choose Apply to apply the configuration changes.

1773039839582-669.png

Step 4: On the Java tab

a. Adjust the Java Heap configuration:

  • Initial memory pool: Enter a value <= 1/4of the server's RAM.

Example: Server RAM = 32 GB -> Initial memory pool should be <= 1/4 * 16 * 1024 MB

  • Maximum memory pool: Enter a value <= of the server's RAM.

Example: Server RAM = 32 GB -> Maximum memory pool should be <= 1/2 * 16 * 1024 MB

Note: If you enter a value that is too large, it may prevent Apache Tomcat service from starting and result in errors.

b. Choose Apply to apply the configuration changes.

1773039888230-493.png

Step 5: Start the Tomcat Service

On the General tab, select Start to initiate the Apache Tomcat service.

1773044980268-508.png

4.3. Check Apache Tomcat Installation​

Step 1: After installation and configuration, go to the Services screen and check the status of the Apache Tomcat service.

  • If the Status is not Running, start the Apache Tomcat service.
  • If the Status is Running, proceed to step 2.

1773045039977-189.png

Step 2: Access the URL http://localhost:8080 in Chrome to verify the successful installation of Apache Tomcat:

1773040793096-753.png

5. ActiveMQ installation​

5.1. Install ActiveMQ​

Step 1: Extract the file "apache-activemq-5.15.1-bin.zip" to the desired installation path.

For example: ACTIVEMQ_PATH = C:\akaBot\apache-activemq-5.15.1

Note: The installation path should not contain any spaces.

1773042407269-516.png

Step 2: Open Command Prompt with Administrator privileges.

1773042420627-885.png

Step 3: Run the file %ACTIVEMQ_PATH%\bin\win64\InstallService.bat to install the ActiveMQ service.

Run command:C:\Windows\System32>C:\akaBot\apache-activemq-5.15.1\bin\win64\InstallService.bat

1773042444158-931.png

Step 4: Start the ActiveMQ service.

1773042459471-219.png

5.2. Java Heap Configuration​

Step 1: Stop service ActiveMQ

Step 2: Open the file %ACTIVEMQ_PATH%\bin\win64\wrapper.conf and configure the parameters:

  • wrapper.java.initmemory: Enter the initial value for the Java Heap memory.

For example, if the server has 32 GB of RAM, you can enter 1024.

  • wrapper.java.maxmemory: Enter the maximum value for the Java Heap memory.

For example, with a server having 32 GB of RAM, you can enter 4096.

1773040188173-944.png

Step 3: Start ActiveMQ Service

1773045637327-680.png

5.3.Check ActiveMQ Installation​

Step 1: Check the Running status of the ActiveMQ service. If it is not running, start the service.

1773040234841-235.png

Step 2: Access the URL http://localhost:8161 to verify the successful installation of ActiveMQ.

1773040248186-927.png

6. akaBot Center Installation​

Download akaBot-center- 4.x.x.x.war.

6.1. Copy and extract war file​

Step 1: Stop Apache Tomcat service

1773045591703-739.png

Step 2: Delete all folders in %TOMCAT_PATH%/webapps.

1773041052691-659.png

Step 3: Copy the file akaBot-center-x.x.x.x.war to the %TOMCAT_PATH%/webapps/ directory

1773041088743-833.png

  • Rename it to ROOT.war.

1773041108270-318.png

Step 4: Restart the Apache Tomcat service and wait for the ROOT.war to be extracted into the ROOT directory.

1773041152285-315.png

Step 5: Stop the Apache Tomcat service.

6.2. akaBot Center configuration​

6.2.1. Configquartz.properties

Step 1: Stop the Apache Tomcat service (if the Apache Tomcat service is currently running).

Step 2: Modify the configuration in the file %TOMCAT_PATH%/webapps/ROOT/WEB-INF/classes/quartz.properties as follows:

1. Comment out the jobstore configuration for MySQL, MSSQL, Oracle.

2. Remove the "#" character at the beginning of the line for the jobstore configuration for PostgreSQL to uncomment it.

1773125144942-717.png

6.2.2.Configure the PostgreSQL Database Connection

Step 1: Navigate to the path %TOMCAT_PATH%/webapps/ROOT/WEB-INF/classes/config/

Step 2: Modify the configuration in both files: application-dev.yml and application-prod.yml

Remove the # characters at the beginning of the lines to uncomment the configuration and enable PostgreSQL usage. Add the "#" characters at the beginning of the lines to comment out the configuration and disable MySQL, MSSQL,...

Input your username and password that you created in 3.2>Step 3.

  • application-dev.yml

1773125613939-709.png

1773128009161-558.png

1773125955638-262.png

  • application-prod.yml

1773126830845-429.png

1773126055777-449.png

  • Save files after configuring.

6.2.3. Log setting

  1. Open the file %TOMCAT_PATH%/webapps/ROOT/WEB-INF/classes/logback-spring.xml

  2. Change the log level to ERROR

  3. Change the setting in rolling log file as below:

  • maxFileSize: Limit the size of each file. Ex: 200MB.
  • maxHistory: The optional maxHistory property controls the maximum number of archive files to keep. Ex: 20
  • totalSizeCap: The optional totalSizeCap property controls the total size of all archive files. Ex: 20GB

1773126136316-429.png

  1. Save changes and close file

  2. Start the Apache Tomcat service and access http://localhost:8080/ to verify the installation of akaBot Center.

1773045819506-903.png

1773044661288-968.png

  1. Log in using the following credentials:
  • username: admin
  • password: admin
  • You will be redirected to the dashboard as shown below.

1773044690105-331.png

7. Troubleshooting​

7.1. ActiveMQ​

7.1.1. Unable to execute Java command

  • Open the file %ACTIVEMQ_PATH%\bin\win64\wrapper.conf and configure the parameter:

wrapper.java.command=%JAVA_HOME%/bin/java.exe

7.1.2. Other Errors

Please check the error details in the log file of ActiveMQ: %ACTIVEMQ_PATH%\logs\data\wrapper.log

8. Backup for disaster recovery​

Information to be backed up for disaster recovery scenarios:

NoNamePathDescription
1akaBot CenterDatabaseDatabase (MSSQL) of akaBot Center
%TOMCAT_PATH%/filestorageFolder containing .nupkg files from akaBot Studio published to akaBot Center
%TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\application.yml %
TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\application-dev.yml %
%TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\application-prod.yml %
TOMCAT_PATH%\webapps\webapps\ROOT\WEB- INF\classes\config\quartz.propertiesConfiguration files for akaBot Center
2activeMQ%ACTIVEMQ_PATH%\dataactiveMQ data directory

9. Activate Licenses

Please follow the instruction via Activation