AMI Set Up

From 3forge Documentation
Revision as of 02:45, 5 February 2024 by Wesley Chen (talk | contribs) (Add detached mode arg)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


3forge AMI is a high performance platform for developers to rapidly build enterprise applications and solutions.

With the power of 3forge, your ingenuity and exceptionalism is amplified. 3forge AMI will help you meet the needs of your users in a fraction of the time and will help you roll-out a harmonized GUI strategy.

This page will go through the necessary steps to get started with using 3forge AMI.

Registering an account on 3forge Website

1. Visit to create an account if you do not already have one for your current organization.

2. Fill out as many fields as you can:

Creating an Account
First name Your preferred name
Last name Your last name
Phone number Contact number
Company Your current employer
Title/Role Your Title/Role at your organization
Intended Use Your intended use, if you are part of an existing group, select Other and provide the name of your team and your manager's full name.
Email Address Your email address at your organization, this is your account id. Please ensure your email is able to receive external emails.

3. After you submit, 3forge will send you an email to activate your account.

4. Your 3forge account is ready to use once it is activated.

3forge AMI Resources, Documentation and Tutorials

Visit and check out our 3forge AMI documentation

Visit and check out the video tutorials

Visit to get started using AMI

Email for questions or other support related issues

AMI Installation Instructions

Minimum Operating Environment

OPERATING SYSTEM Ubuntu, Fedora/Red Hat, CentOS, Mac OS X, Windows Certified (Full support for Java 1.8 or later)
PROCESSOR 2GHZ CPU (Intel & AMD Certified)
CLIENT BROWSER Up-to-date version of: Microsoft Edge, Chrome, Firefox or Safari
ACCESS Must have permissions to install software
NETWORK Server must have access to data sources. Firewalls should also be enabled to allow connections to port 33332

Suggested Operating Environment

OPERATING SYSTEM Unix environment with Java 1.8 or later
RAM 32GB or more
DISK 100GB or more
PROCESSOR 3GHZ CPU, 8 cores or more
CLIENT BROWSER Up-to-date version of: Microsoft Edge, Chrome, Firefox or Safari
ACCESS Must have permissions to install software (often requiring Admin rights on Windows)
NETWORK Server must have access to data sources. Firewalls should also be enabled to allow connections to port 33332

How to Install

1. Register an Account on 3forge if you have not done so already at

2. Once you receive a separate email informing you that the account has been enabled for downloading the software, please re-login at

3. Click on the Files link to the left and download the version appropriate for your operating system:

  • For Mac: ami_macos_some_version.dmg
  • For Windows: ami_windows-x64_some_version.exe
  • For Unix:

4. If installing on a server, copy the downloaded file from step 3 onto the server and logon to that server

5. Run the downloaded file from step 3 and follow the installation wizard instructions

6. After startup is complete visit http://localhost:33332 on browser, (if installed on separate server replace "localhost" with the server's hostname or ip address)

  • The default login for username & password is: demo & demo123

To Stop and Start AMI

  • Unix or Mac: Run the amione/scripts/ and amione/scripts/ script files
  • Windows: Run the amione/scripts/stop.bat and amione/scripts/start.bat script files

Side note: When launching AMI on Linux operating system, if you ever run into errors on the terminal upon running "./", saying "Starting 3Forge AMI ONE.log/stderr.log:Error: Could not create the Java Virtual Machine."


We could go to the /ami/log/stderr.log and see the detailed error message. In this case, it might be something like this: where this command is not recognized by JVM

Sol1.jpg E1.1.jpg
The solution will be: go to /amione/scripts/ , get rid of "-XX:+UseConcMarkSweepCG" in the and launch again.

Sol2.jpg Sol2.2.jpg

Advanced Java Configurations

Running AMI on Java 18

If you were to run AMI on Java 18 and ever come across any Java exceptions, please add something like this to your

      -XX:+PrintGCDetails \
      -Xloggc:log/gc.log --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.text=ALL-UNNAMED --add-opens java.base/ --add-opens --add-opens java.base/ --add-opens java.desktop/com.sun.imageio.plugins.png=ALL-UNNAMED\
       $* -classpath $CP $APPCLASS >> log/stdout.log 2> log/stderr.log &

Using Java G1GC garbage collector

Java G1GC is a garbage collector that is designed to improve the performance and scalability of Java applications by reducing pause times and improving throughput. Here is a detailed instruction on how you can set this up on ami:

1. From the root directory where you installed AMI_One, Open /amione/scripts/

2. Remove the following properties:


3. And add this property.


Creating a License from the Website

1. Visit

2. Check the AMIone checkbox

3. Enter the hostname in the Host(s) field (you can determine the hostname by reading the red warning below the AMI login page)

4. Click create

5. Copy and paste the contents into your clipboard

6. Create a file under the amione folder called f1license.txt and paste the content inside the file.

7. Restart AMI for the license to take effect.


Creating a License from AMI

In addition to creating licenses from the 3Forge website (as mentioned above in the installation instructions), new licenses can be created/updated from AMI itself. To use this feature, please make sure the account is enabled for creating licenses.

to open up the license prompt:

1. Click Help in the top menu bar and select Enter/Update License


2. If you already have a license key generated and copied from the 3Forge website, paste the key onto the Enter License Key field. Click on the submit button and restart AMI for the new license to take effect. Continue onto step 3 if you want to generate a new license key.


3. To generate a new license key, click on the Generate License Key button.

4. A login form will appear which asks for your 3Forge website credentials.


5. Enter the credentials and request a license key by clicking on the Request License Key button.

6. A dialog box with the new license key will appear. Click on the Update License Key button to apply the newly generated key.

7. Finally, click on the submit button to finish the license creation process.

Remember to restart AMI for the new license to take effect.

Any questions regarding licensing can be directed to

Manual Upgrade of AMI using .tar.gz file

1. unzip and extract the files.
2. Move the extracted files to the project directory where the old ami folder resides and overwrite it.
For linux machines, you can use the following command to do so:

tar -xf ami_unix_version<file_name>.tar.gz -c <your target directory> 

Note: This command is NOT REVERSIBLE and will overwrite your existing ami folder with the new one. You may want to backup your 3forge AMI project before proceeding to make rollback easier especially for a prod environment. This overwriting process includes the overwrite of the following files (subject to change):
(1). amione/lib
(2). amione/data
(3). amione/scripts
Note 1 : For the scripts directory, make sure to rename your start script if it gets modified
Note 2: These following properties files will be updated:,,, speedlogger.propertie, (Windows) AMI_One.vmoptions
Note 3: You can use tar -tvf to preview the contents of a zip.

Manual Upgrade of AMI using .sh file

Simply run the installer and select the option to update the existing installation.

Instructions for Secure Socket

  • You'll need to start by creating the certificates. To do this, keytool must be in your PATH.
  • First we create a server.jks file and a server.cer file which we will keep with the server. Note, replace serverpass with a password

keytool -genkeypair -deststoretype pkcs12 -keyalg RSA -alias 3forge_server -keystore server.jks -validity 1000 -keysize 2048 -keypass serverpass -storepass serverpass -dname "cn=3Forge Client"

keytool -export -alias 3forge_server -storepass serverpass -file server.cer -storetype pkcs12 -keystore server.jks

  • Now lets create a client.jks file using the server's certificate, if you have multiple clients you should run this for each client (such that each time the client.jks file is unique for that client).  Note, replace clientpass with a password

keytool -genkey -deststoretype pkcs12  -alias 3forge_client -keyalg RSA -keypass clientpass -storepass clientpass -keystore client.jks  -dname "cn=3Forge Client"

keytool -import -v -trustcacerts -alias 3forge_server -file server.cer -keystore client.jks -keypass clientpass -storepass clientpass -noprompt  

  • To configure the server, copy the server.jks file to the server, and add the following properties to your of AMI:



  • To configure the client, copy the client.jks file to the client and instead of calling the function AmiClient::start(host, port, loginId, options) call:

AmiClient client=new AmiClient();


client.start(host, port, loginId, options,new File("/path/to/client.jks"),"clientpass");

Configuring Multiple Instances on a Single Machine

Multiple instances of AMI can be run on the same machine. First, each entry should have it's own root directory. Next each additional instance must be configured to use different server ports. (Two processes can not have conflicting server ports). Below is a list of the server ports that need to be configured:

  • You must always replace the following default port with a new, unique port (or use -1 to disable the console):


  • If running the center, you must replace the following default ports with new, unique ports:



  • If running the relay, you must replace the following default port with a new, unique port:


  • If running the web with secure https socket, you must replace the following default port with new, unique ports:


  • If running the web with non-secure http socket, you must replace the following default port with new, unique ports:


Instructions for Running Center, Web and/or Relay Independently

The same AMI binary is configured to run as a center, relay, web or a combination of the three. Add one of the following configuration blocks to your amione/config/ to control what is run. If the file does not exist, please create it.  Note, that port 3270 is the default port that the center listens on and that the web/relay connect to, but can be changed. Also, the web server never connects to the relay directly (they both connect to the center).

Finally, keep in mind that the center starts up the server port and multiple clients (relays/web) can connect to a single center.

  • Default: Run the center,relay,web


  • Run the center


  • Run the relay


  • Run the web


  • Run the center,web


  • Run the center,relay


  • Run the web,relay


  • Run the relay connected to multiple centers



  • Run the web connected to multiple centers



Configuring Web, Relay and Center Ports

This guide describes what ports each AMI component listens or connects to.

Console Port

f1.console.port : default 3285 (Listens)

Admin console port all components listens on, to prevent port conflict you may need to change this.

AMI Center : default 3270 (Listens)

Sets the port of the primary instance of ami center, for more connections from other AMI Web and Relay instances.

Also sets the connecting port of relay & web components to this center if configured and launched together.

ami.db.console.port : default 3290 (Listens)

The port for connecting via telnet command line interface

ami.db.jdbc.port : default 3280 (Listens)

The port for connecting to AMI via the AMI JDBC driver

AMI Relay

ami.port : default 3289 (Listens)

Sets the port that applications connect to on the Relay's host machine. See AMI Realtime API : default 3270 (Connects) (e.g. localhost)

For relay components running separately from the center, to be configured with

Note: the relay can connect to multiple centers, with a comma-delimited list entry e.g.: ami.centers=center1=host.running.center1:3270,center2=host.running.center2:3270,center3=host.running.center3:3270


http.port : default 33332 (Listens)

Sets the port that web browsers use to connect to AMI Web (Default 33332)

https.port : default 33333, disabled (Listens)

Sets the port that web browsers use to connect securely to AMI Web.

https.keystore.file: the path to the key store file generated using java's keytool that will be used for secure web connections. : default 3270 (Connects) (e.g. localhost)

For web components running separately from the center, to be configured with

Web Manager

ami.webmanager.port : default 3271, disabled (Listens)

Optional location for where to access webmanager, used for remotely loading files.

Web Balancer

ami.webbalancer.http.port : default 33330 (Listens)

Optional, the http port to listen for insecure connections on. If not specified, http is not available.

Configure AMI properties from environment variables

Another alternative solution to configuring AMI properties is to use system variables.
For example, instead of in "", where you set:
You can set this up via environment variables by adding property_<AMI Property Name>=<value>
This will overwrite the existing property defined in and apply globally on all AMI instances running on the current machine.

Running AMI with Docker

AMI can be easily configured for use with docker using the following recommended folder configuration:

Folder Contents
./ami Unix installation of ami (ami/amione/...)
./docker Dockerfile provided below
./scripts script provided below

Sample Dockerfile

FROM ubuntu:20.04

RUN apt-get update
RUN apt-get install -y default-jre

COPY ami ami
COPY scripts scripts

EXPOSE 33332

CMD ["bash", "./scripts/"]



SCRIPTDIR=$(dirname "$0")

mkdir -p $SCRIPTDIR/../ami/amione/resources/

echo 'Starting AMI...'
sed -i -e 's/\r$//' $AMI_EXECUTABLE
sed -i -e 's/-XX:+PrintGCTimeStamps//g' $AMI_EXECUTABLE
$AMI_EXECUTABLE > exec.out

echo 'Checking for errors during launch...'
if grep -q error exec.out; then
    echo 'An Error Has Occured While Starting AMI, Dumping Error...'
    error_log=$(grep -o "[^ ]*/log/" exec.out)
    echo ''
    more $error_log/stderr.log
    echo ''
    rm exec.out
    echo 'Terminating Docker Start Script'
    exit 1
    rm exec.out
    echo 'AMI Successfully launched'

echo 'Completed Start Script'

tail -f /dev/null

To build the image:

docker build -t ami -f ./docker/Dockerfile . 

To run the image (the use of detached mode is optional):

docker run -d -p 33332:33332 ami