Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
docs:1100_inst_guide:0400_deployment_options [2022/08/31 04:47] – administratordocs:1100_inst_guide:0400_deployment_options [2025/10/30 09:33] (current) – aware_support3
Line 1: Line 1:
 {{tag>Manuals Installation_Guide}} {{tag>Manuals Installation_Guide}}
 [<10>] [<10>]
-====== Aware IM deployment options ======+====== Deployment Options ======
  
-When you install //**Aware IM**// out-of-the-box as described in sections [[docs:1100_inst_guide:0100_windows]], [[docs:1100_inst_guide:0200_linux]] or [[docs:1100_inst_guide:0300_macos]] //**Aware IM**// is installed on a single machine. This is, however, not the only option of //**Aware IM**// deployment. //**Aware IM**// is a Client-Server system. From the deployment point of view it has 3 components that can be installed on the same or different computers. These components are:+When you install //**AwareIM**// out-of-the-box as described in sections [[docs:1100_inst_guide:0100_windows]], [[docs:1100_inst_guide:0200_linux]] or [[docs:1100_inst_guide:0300_macos]] //**AwareIM**// is installed on a single machine. This is, however, not the only option of //**AwareIM**// deployment. //**AwareIM**// is a Client-Server system. From the deployment point of view it has 3 components that can be installed on the same or different computers. These components are:
  
-  * The Aware IM server +  * The AwareIM server 
-  * The Aware IM Configuration Tool +  * The AwareIM Configuration Tool 
-  * The Aware IM web application managed by Tomcat+  * The AwareIM web application managed by Tomcat
  
  
-As mentioned above all the components may reside on the same computer – this is the default deployment configuration that you get when you use the default //**Aware IM**// installation. This option is suitable for the following categories of users:+As mentioned above all the components may reside on the same computer – this is the default deployment configuration that you get when you use the default //**AwareIM**// installation. This option is suitable for the following categories of users:
  
-  * Individual end users who run information systems configured with the //**Aware IM**// software for personal needs +  * Individual end users who run information systems configured with the //**AwareIM**// software for personal needs 
-  * Configurators who configure and test their //**Aware IM**// information systems on a single machine +  * Configurators who configure and test their //**AwareIM**// information systems on a single machine 
-  * Small to medium companies that run their information management systems configured with //**Aware IM**// for their internal office needs +  * Small to medium companies that run their information management systems configured with //**AwareIM**// for their internal office needs 
-  * Small to medium companies that run their information management systems configured with //**Aware IM**// for their internal office needs and/or provide access to these systems to their customers via Internet where the load of the server running //**Aware IM**// system is low to medium.+  * Small to medium companies that run their information management systems configured with //**AwareIM**// for their internal office needs and/or provide access to these systems to their customers via Internet where the load of the server running //**AwareIM**// system is low to medium.
  
  
  
-For larger companies who have more internal and external users with higher load of requests it may be beneficial to deploy //**Aware IM**// on separate computers for better scaling and performance. +For larger companies who have more internal and external users with higher load of requests it may be beneficial to deploy //**AwareIM**// on separate computers for better scaling and performance. 
  
-It is also possible that individual users or companies do not have direct access to the computer where //**Aware IM**// is running – for example, if they use 3<sup>rd</sup> party organizations to host their web needs (including //**Aware IM**//). These individuals and organizations however may need frequent and easy access to the Configuration Tool so that they can configure or modify their information systems whenever necessary.+It is also possible that individual users or companies do not have direct access to the computer where //**AwareIM**// is running – for example, if they use 3<sup>rd</sup> party organizations to host their web needs (including //**AwareIM**//). These individuals and organizations however may need frequent and easy access to the Configuration Tool so that they can configure or modify their information systems whenever necessary.
  
  
  
-//**Aware IM**// can be deployed to meet these needs. The following deployment options are available:+//**AwareIM**// can be deployed to meet these needs. The following deployment options are available:
  
-  - The Aware IM web application (Web Server) can be installed on a separate machine(s), which allows for better scaling and performance under heavy load. +  - The AwareIM web application (Web Server) can be installed on a separate machine(s), which allows for better scaling and performance under heavy load. 
-  - The Aware IM Configuration Tool can be deployed on a separate machine with access to the Aware IM server via internal LAN. This makes it possible to use the Configuration Tool by different users simultaneously. +  - The AwareIM Configuration Tool can be deployed on a separate machine with access to the AwareIM server via internal LAN. This makes it possible to use the Configuration Tool by different users simultaneously. 
-  - //**Aware IM**// server can be deployed on a remote machine. Configurators can upload applications from their local machines to the //**Aware IM**// server via the Web browser. Thus this option allows running //**Aware IM**// on a remote machine in a host environment and at the same time easily configuring and changing applications.+  - //**AwareIM**// server can be deployed on a remote machine. Configurators can upload applications from their local machines to the //**AwareIM**// server via the Web browser. Thus this option allows running //**AwareIM**// on a remote machine in a host environment and at the same time easily configuring and changing applications.
  
  
Line 35: Line 35:
 The required steps for each of these options are described below. The required steps for each of these options are described below.
  
-===== Running Aware IM Web Server on a separate machine =====+===== Running AwareIM Web Server on a separate machine =====
  
-To run //**Aware IM**// web application on a separate machine within a single LAN you have to make sure that the //**Aware IM**// server is deployed on your “server” machine(s) whereas //**Aware IM**// web application is deployed on a single or a cluster of “web server” machines. +To run //**AwareIM**// web application on a separate machine within a single LAN you have to make sure that the //**AwareIM**// server is deployed on your “server” machine(s) whereas //**AwareIM**// web application is deployed on a single or a cluster of “web server” machines. 
  
  
Line 43: Line 43:
 Make sure you do the following: Make sure you do the following:
  
-  - To deploy the //**Aware IM**// server on the “server” machine do the following:+  - To deploy the //**AwareIM**// server on the “server” machine do the following:
     - Make sure that the machine has the database engine of your choice installed (alternatively the database server may be deployed on yet another machine).      - Make sure that the machine has the database engine of your choice installed (alternatively the database server may be deployed on yet another machine). 
-    - Install //**Aware IM**// on your server machine as described in the previous sections.  +    - Install //**AwareIM**// on your server machine as described in the previous sections.  
-    - To start the //**Aware IM**// server change to AwareIM/bin directory on your server machine and run the Aware IM Control Panel as described in the previous sections. +    - To start the //**AwareIM**// server change to AwareIM/bin directory on your server machine and run the AwareIM Control Panel as described in the previous sections. 
-  - To deploy the //**Aware IM**// web application on the web server machine(s) do the following: +  - To deploy the //**AwareIM**// web application on the web server machine(s) do the following: 
-    - Install //**Aware IM**// on your web server machine as described in the previous section. +    - Install //**AwareIM**// on your web server machine as described in the previous section. 
     - Modify the file AwareIMInstallationDirectory/webapps/AwareIM/webapp.props to include the name of your “server” machine in the LAN. For example,\\ \\ <code>ServerName=myAwareIMServerName</code>     - Modify the file AwareIMInstallationDirectory/webapps/AwareIM/webapp.props to include the name of your “server” machine in the LAN. For example,\\ \\ <code>ServerName=myAwareIMServerName</code>
  
-===== Running Configuration Tool on a separate machine =====+===== Running Configuration Tool on a separate machine on a local area network (LAN)  =====
  
-To run the Configuration Tool on a machine different from the one where your //**Aware IM**// server is running do the following (it is assumed that the Configuration Tool and the //**Aware IM**// server are running on the machines connected by a Local Area Network (LAN). We will call the machine where the Configuration Tool is running, the “client” machine and the machine where the //**Aware IM**// server is running – the “server” machine.+To run the Configuration Tool on a machine different from the one where your //**AwareIM**// server is running do the following (it is assumed that the Configuration Tool and the //**AwareIM**// server are running on the machines connected by a Local Area Network (LAN). We will call the machine where the Configuration Tool is running, the “client” machine and the machine where the //**AwareIM**// server is running – the “server” machine.
  
-  - Perform the steps described in the section [[Reference source not found]] to deploy the //**Aware IM**// server on a “server” machine. +  - Install  //**AwareIM**// server on a “server” machine. 
-  - Replace references to ''localhost'' in the ''BASServer.props'' file located in the BIN directory of the Aware IM installation on the server machine with the network name of the server machine, for example:\\ \\ <code>DirectoryServiceProvider=tcp://localhost:61616+  - Replace references to ''localhost'' in the ''BASServer.props'' file located in the BIN directory of the AwareIM installation on the server machine with the network name of the server machine, for example:\\ \\ <code>DirectoryServiceProvider=tcp://localhost:61616
 JMS_BROKER_CONNECTOR=tcp://localhost:61616</code> JMS_BROKER_CONNECTOR=tcp://localhost:61616</code>
-  - Under the Windows operating system run the Configuration Tool setup program (ConfigTool.exe) located in the Windows directory of your Aware IM distribution disk from the client machine and follow the instructions of the program. You will need to specify the installation directory of the Configuration Tool and the network name of the server machine. After the Configuration Tool has been installed you can run it from the Startup menu.+  - Under the Windows operating system run the Configuration Tool setup program (ConfigTool.exe) located in the Windows directory of your AwareIM distribution disk from the client machine and follow the instructions of the program. You will need to specify the installation directory of the Configuration Tool and the network name of the server machine. After the Configuration Tool has been installed you can run it from the Startup menu.
   - Add the following line to the file ''UIConfig.props'' located in the ''BIN'' directory of the installation performed during the previous step (if the line already exists change it):\\ \\ <code>WebServer = NameOfTheMachineWhereAwareIMServerIsRunning</code>   - Add the following line to the file ''UIConfig.props'' located in the ''BIN'' directory of the installation performed during the previous step (if the line already exists change it):\\ \\ <code>WebServer = NameOfTheMachineWhereAwareIMServerIsRunning</code>
   - Under Linux operating system perform the following steps:   - Under Linux operating system perform the following steps:
Line 69: Line 69:
  
  
-<callout type="primary" icon="true" title="note"> If the Aware IM Server is running on the Linux or Mac OS X machine make sure that the file etc/hosts has the following entries:\\ \\ +<callout type="primary" icon="true" title="note"> If the AwareIM Server is running on the Linux or Mac OS X machine make sure that the file etc/hosts has the following entries:\\ \\ 
 <code> <code>
 127.0.0.1 localhost.localdomain localhost 127.0.0.1 localhost.localdomain localhost
 x.x.x.x serverName</code> x.x.x.x serverName</code>
-where x.x.x.x is the IP address of the server where Aware IM is running and serverName is the network name of the server.\\ \\ +where x.x.x.x is the IP address of the server where AwareIM is running and serverName is the network name of the server.\\ \\ 
 **Additionally if you are running the remote Configuration Tool from a Linux or Mac OS X workstation make sure that the ''etc/hosts'' file of each workstation has the same entries as the ''etc/hosts'' file on the server.**</callout> **Additionally if you are running the remote Configuration Tool from a Linux or Mac OS X workstation make sure that the ''etc/hosts'' file of each workstation has the same entries as the ''etc/hosts'' file on the server.**</callout>
  
 +===== Running the Configuration Tool Across the Internet =====
  
 +To run the Configuration Tool across the Internet where the Configuration Tool connects to a remote server located anywhere in the world perform the following steps:
 +  - Install  //**AwareIM**// server on a remote machine.
 +  - Install either the full version of AwareIM or the standalone Configuration Tool on the client machine
 +  - Modify the ''UIConfig.props'' file located in the ''BIN'' directory and add the following properties (in the example below the URL of the server is assumed to be https://www.myserverver.com:8080/MyWebApp)
 +<code>HttpServerConnection=true
 +WebServer=www.myserver.com
 +WebServerPort=8080
 +WebServerProtocol=https
 +WebAppBase=MyWebApp</code>
  
-===== Running Aware IM in a web hosting environment =====+===== Running AwareIM in a web hosting environment =====
  
-Organizations or individuals who for whatever reason cannot or do not want to run their application on their own server but still want web access to their //**Aware IM**// application can use web-hosting services of third-party companies (that we will call “web hosts” here). These companies offer their servers for companies to deploy their applications/web sites on. +Organizations or individuals who for whatever reason cannot or do not want to run their application on their own server but still want web access to their //**AwareIM**// application can use web-hosting services of third-party companies (that we will call “web hosts” here). These companies offer their servers for companies to deploy their applications/web sites on. 
  
  
Line 94: Line 104:
 The first option is usually the cheapest, while the third one is the most expensive. The first option is usually the cheapest, while the third one is the most expensive.
  
-Although it is theoretically possible to run //**Aware IM**// applications under standard shared hosting (option 1.), we do not recommend it as there are too many things that can potentially go wrong+Although it is theoretically possible to run //**AwareIM**// applications under standard shared hosting (option 1.), we do not recommend it as there are too many things that can potentially go wrong
  
  
  
-Option 3 is the safest option and is virtually equivalent to running //**Aware IM**// on your own server. The only problem with this option is the price – it can range from 100 to 300 (or more) dollars a month.+Option 3 is the safest option and is virtually equivalent to running //**AwareIM**// on your own server. The only problem with this option is the price – it can range from 100 to 300 (or more) dollars a month.
  
  
  
-Option 2 is, in our opinion, the most practical option for many users. It is relatively inexpensive (you can get VPS hosting for $30 a month or even less) and you essentially get your own server that you have full control of. The next section discusses running //**Aware IM**// applications under the VPS hosting environment.+Option 2 is, in our opinion, the most practical option for many users. It is relatively inexpensive (you can get VPS hosting for $30 a month or even less) and you essentially get your own server that you have full control of. The next section discusses running //**AwareIM**// applications under the VPS hosting environment.
  
-===== Running Aware IM under the VPS hosting environment =====+===== Running AwareIM under the VPS hosting environment =====
  
  
Line 110: Line 120:
  
  
-It is possible to run //**Aware IM**// applications under both operating systems. However, please see the following tables for the comparison of using Linux VPS versus Windows VPS:+It is possible to run //**AwareIM**// applications under both operating systems. However, please see the following tables for the comparison of using Linux VPS versus Windows VPS:
  
  
  
 ^ Linux VPS pro’s                                                                                                                                                                                         ^ Linux VPS con’s                                                                                                                                                                                                                                                               ^ ^ Linux VPS pro’s                                                                                                                                                                                         ^ Linux VPS con’s                                                                                                                                                                                                                                                               ^
-| Very common. There are a huge number of companies offering Linux VPS with different options and price range                                                                                             | Most web hosts offer non-graphical Linux. Running //**Aware IM**// under non-graphical Linux has two limitations:\\ \\ It is possible to install the graphical component for Linux, but it requires some Linux expertise (or you can possibly ask the host to do it for you)  |+| Very common. There are a huge number of companies offering Linux VPS with different options and price range                                                                                             | Most web hosts offer non-graphical Linux. Running //**AwareIM**// under non-graphical Linux has two limitations:\\ \\ It is possible to install the graphical component for Linux, but it requires some Linux expertise (or you can possibly ask the host to do it for you)  |
 | Usually cheaper than Windows VPS                                                                                                                                                                        | Usually Linux VPS offers remote access to the Linux server via command line interface only. However, if you install a Linux graphical component it is possible to set up a remote graphical interface to the server                                                           | | Usually cheaper than Windows VPS                                                                                                                                                                        | Usually Linux VPS offers remote access to the Linux server via command line interface only. However, if you install a Linux graphical component it is possible to set up a remote graphical interface to the server                                                           |
 ^ Windows VPS pro’s                                                                                                                                                                                       ^ Windows VPS con’s                                                                                                                                                                                                                                                             ^ ^ Windows VPS pro’s                                                                                                                                                                                       ^ Windows VPS con’s                                                                                                                                                                                                                                                             ^
-| The experience is literally equivalent to running Aware IM on your own server. You get a remote graphical interface to the server, which is like running Windows on your own machine. Very convenient.  | Slightly more expensive on average than Linux VPS (although, it is now possible to find a very good deal)                                                                                                                                                                     |+| The experience is literally equivalent to running AwareIM on your own server. You get a remote graphical interface to the server, which is like running Windows on your own machine. Very convenient.  | Slightly more expensive on average than Linux VPS (although, it is now possible to find a very good deal)                                                                                                                                                                     |
 |                                                                                                                                                                                                         | Not very common yet. Not many companies offering Windows VPS                                                                                                                                                                                                                  | |                                                                                                                                                                                                         | Not very common yet. Not many companies offering Windows VPS                                                                                                                                                                                                                  |
  
Line 131: Line 141:
  
  
-Once you have the VPS set up installing Aware IM is quite straightforward – transfer Aware IM installation files to your server and install it there. However, you need to watch out for these+Once you have the VPS set up installing AwareIM is quite straightforward – transfer AwareIM installation files to your server and install it there. However, you need to watch out for these two most commonly encountered problems when running //**AwareIM**// in the VPS environment:
  
-two most commonly encountered problems when running //**Aware IM**// in the VPS environment: 
  
- +  - //Not enough memory// – memory may be a scarce resource when you have to share the machine with others. You have to make sure that there is at least 256Mb of memory available to run //**AwareIM**//. If there is not enough memory all sorts of strange problems may be encountered. Usually companies that offer VPS services offer a certain amount of “guaranteed” memory (your own) and a certain amount of “burstable” memory (shared with others). 
-  - //Not enough memory// – memory may be a scarce resource when you have to share the machine with others. You have to make sure that there is at least 256Mb of memory available to run //**Aware IM**//. If there is not enough memory all sorts of strange problems may be encountered. Usually companies that offer VPS services offer a certain amount of “guaranteed” memory (your own) and a certain amount of “burstable” memory (shared with others). +
     - Do not pick web hosts that offer burstable memory only.     - Do not pick web hosts that offer burstable memory only.
     - Make sure that the amount of guaranteed memory is at least 256M     - Make sure that the amount of guaranteed memory is at least 256M
Line 153: Line 161:
  
  
-It is easy to set up //**Aware IM**// to work with load balancing. This is what you need to do:+It is easy to set up //**AwareIM**// to work with load balancing. This is what you need to do:
  
-  - Install //**Aware IM **//on each server that should participate in the load balancing chain. On Amazon you would allocate several server instances and install //**Aware IM**// on each of them+  - Install //**AwareIM **//on each server that should participate in the load balancing chain. On Amazon you would allocate several server instances and install //**AwareIM**// on each of them
   - Make sure that every server instance is set up to work with the single installation of the database. It has to be either MySQL, Maria DB, SQL Server/Azure, PostgreSQL or Oracle database. Apache Derby database cannot be used. The database may reside on one of the server instances or on a separate server altogether. To setup database connection modify the ''BASServer.props'' file on each server instance as described in the previous sections.   - Make sure that every server instance is set up to work with the single installation of the database. It has to be either MySQL, Maria DB, SQL Server/Azure, PostgreSQL or Oracle database. Apache Derby database cannot be used. The database may reside on one of the server instances or on a separate server altogether. To setup database connection modify the ''BASServer.props'' file on each server instance as described in the previous sections.
   - Make sure that every instance “sticks” to its user session. For example, Amazon offers a feature called “sticky sessions”. You must enable it so that the system will automatically route the request to the server that handles this particular user.   - Make sure that every instance “sticks” to its user session. For example, Amazon offers a feature called “sticky sessions”. You must enable it so that the system will automatically route the request to the server that handles this particular user.
Line 162: Line 170:
  
 Note that load balancing should only be used in production where the system just runs already developed applications. It shouldn’t be used for application development. Note that load balancing should only be used in production where the system just runs already developed applications. It shouldn’t be used for application development.
 +
 +See also
 +
 +{{page>docs:5000_videos:020_deployment_and_configuration}}
  • Last modified: 2022/09/13 18:09