Skip to content

Installation

Raymond Meester edited this page Dec 1, 2022 · 4 revisions

Installation

Prerequisites

Java (Version 11)

Standalone

  1. Get the latest release.
  2. Open a terminal.
  3. CD to the directory which contains "gateway-[version].jar" (for example: cd C:\users\user\Download).
  4. Start the application:

java -jar gateway-[version].jar

Assimbly can also be started by double-clicking the jar file. To use double-clicking the JAVA_HOME environment variable must be set. If you cannot double-click the jar file, you may try jarfix. When starting Assimbly by double-click the logs can only be viewed from the file system (i.e. tail -f) or the GUI.

Windows Powershell

Install Assimbly including Java using a Powershell script:

  1. Download the script.
  2. Open a Powershell and cd to download directory (for example cd "C:\users\myusername\Downloads").
  3. Run the script:

.\install_assimbly.ps1

Windows Service

Assimbly can also be installed as a Windows Service.

  1. Download winsw
  2. Rename "gateway-version.jar" to "gateway.jar"
  3. Rename winsw file WinSW.NET4 to "gateway.exe"
  4. Create a configuration XML file:
 <configuration>
	<!-- Mandatory fields -->
	<id>assimbly-gateway</id>
	<name>Assimbly Gateway</name>
	<description>Message gateway</description>
	<!-- Set alternative path to Java executable -->
    <!--<executable>D:\gateway\java\jdk11\bin\java.exe</executable>-->
	<executable>java</executable>
	<!-- Optional fields. For all options check: https://github.com/kohsuke/winsw -->
    <arguments>-Dserver.port=8090 -jar "gateway.jar"</arguments>	
	<startmode>Automatic</startmode>
	<logpath>%BASE%\logs</logpath>
	<log mode="roll-by-time">
	  <pattern>yyyyMMdd</pattern>
	</log>
 </configuration>
  1. Open CMD as administrator and cd to the gateway directory then use following command:

gateway.exe install

Note: Alternatively you can use nssm to install Assimbly as a Windows service.

Docker

Assimbly can also be started from Docker:

docker run --rm -p 8080:8080 --name assimbly assimbly/gateway-full

When started, the gateway can be reached at the following URL:

http://localhost:8080

More info on using Docker

Clone this wiki locally