Difference between revisions of "AMI Set Up"
George Lin (talk | contribs) |
|||
Line 1: | Line 1: | ||
+ | =Introduction= | ||
+ | |||
+ | <big>3forge AMI is a high performance platform for developers to rapidly build enterprise applications and solutions.</big> | ||
+ | |||
+ | <big>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.</big> | ||
+ | |||
+ | |||
+ | ''This page will go through the necessary steps to get started with using 3forge AMI.'' | ||
+ | |||
+ | =Registering an account on 3forge Website= | ||
+ | |||
+ | 1. Visit https://3forge.com/signup.html to create an account if you do not already have one for your current organization. | ||
+ | |||
+ | 2. Fill out as many fields as you can: | ||
+ | {| class="wikitable" | ||
+ | |+ 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. Once you have activated your account. Your 3forge account is ready. | ||
+ | |||
+ | =3forge AMI Resources, Documentation and Tutorials= | ||
+ | |||
+ | Visit https://3forge.com/wiki and check out our 3forge AMI documentation | ||
+ | |||
+ | Visit https://3forge.com/videos.htm and check out the video tutorials | ||
+ | |||
+ | Visit http://docs.3forge.com/mediawiki/GUI to get started using AMI | ||
+ | |||
+ | Email support@3forge.com for questions or other support related issues | ||
+ | |||
=AMI Installation Instructions= | =AMI Installation Instructions= | ||
+ | |||
+ | |||
+ | |||
==Minimum Operating Environment== | ==Minimum Operating Environment== | ||
Line 41: | Line 90: | ||
==How to Install== | ==How to Install== | ||
− | 1. | + | 1. Register an Account on 3forge if you have not done so already at https://3forge.com/signup.html |
2. Once you receive a separate email informing you that the account has been enabled for downloading the software, please re-login at https://3forge.com/login.html | 2. Once you receive a separate email informing you that the account has been enabled for downloading the software, please re-login at https://3forge.com/login.html | ||
Line 82: | Line 131: | ||
[[File:IntroAMI.9.jpg|600px]] | [[File:IntroAMI.9.jpg|600px]] | ||
− | + | ||
− | |||
− | |||
− | |||
=Creating a License from AMI= | =Creating a License from AMI= |
Revision as of 22:50, 29 September 2022
Introduction
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 https://3forge.com/signup.html to create an account if you do not already have one for your current organization.
2. Fill out as many fields as you can:
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. Once you have activated your account. Your 3forge account is ready.
3forge AMI Resources, Documentation and Tutorials
Visit https://3forge.com/wiki and check out our 3forge AMI documentation
Visit https://3forge.com/videos.htm and check out the video tutorials
Visit http://docs.3forge.com/mediawiki/GUI to get started using AMI
Email support@3forge.com 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.7 or later) |
RAM | 4GB |
DISK | 20GB |
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.7 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 https://3forge.com/signup.html
2. Once you receive a separate email informing you that the account has been enabled for downloading the software, please re-login at https://3forge.com/login.html
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: ami_unix_some_version.sh
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/stop.sh and amione/scripts/start.sh script files
- Windows: Run the amione/scripts/stop.bat and amione/scripts/start.bat script files
Creating a License from the Website
1. Visit https://3forge.com/secure_licenses
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 support@3forge.com
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 local.properties of AMI:
ami.port.keystore.file=/path/to/server.jks
ami.port.keystore.password=serverpass
- 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):
f1.console.port=3285
- If running the center, you must replace the following default ports with new, unique ports:
ami.center.port=3270
ami.db.jdbc.port=3280
ami.db.console.port=3290
- If running the relay, you must replace the following default port with a new, unique port:
ami.port=3289
- If running the web with secure https socket, you must replace the following default port with new, unique ports:
https.port=33332
- If running the web with non-secure http socket, you must replace the following default port with new, unique ports:
http.port=33332
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/local.properties to control what is run. If the local.properties 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
ami.components=relay,center,web
ami.center.port=3270
ami.center.host=localhost
- Run the center
ami.components=center
ami.center.port=3270
- Run the relay
ami.components=relay
ami.center.port=3270
ami.center.host=host.running.center
- Run the web
ami.components=web
ami.center.port=3270
ami.center.host=host.running.center
- Run the center,web
ami.components=center,web
ami.center.port=3270
ami.center.host=localhost
- Run the center,relay
ami.components=center,relay
ami.center.port=3270
ami.center.host=localhost
- Run the web,relay
ami.components=web,relay
ami.center.port=3270
ami.center.host=host.running.center
- Run the relay connected to multiple centers
ami.components=relay
ami.centers=center1=host.running.center1:3270,center2=host.running.center2:3270,center3=host.running.center3:3270
ami.center.port=
ami.center.host=
- Run the web connected to multiple centers
ami.components=web
ami.centers=center1=host.running.center1:3270,center2=host.running.center2:3270,center3=host.running.center3:3270
ami.center.port=
ami.center.host=