|
Installation and Configuration
Package Deployment
Download and unzip the content of the installation package. The root of the created directory
hierachy will be referred as IRIS_HOME. To run the server you will also need Java Runtime 1.6.0
or later that must be downloaded and installed separately.
After unzipping the server package you should have the following subdirectories under
IRIS_HOME:
- /api
- Contains the jar files required to build applications.
- /html
- This is the root of the directory hierarchy published by the embedded HTTP server.
Contains the API JavaDocs (/api) and this guide (/guide).
- /demo
- This is the sample applications directory. All sample applications are
initially registered with the server.
- /server
- The server directory contains:
- iris.properties - this is the applications registry file. Edit this
file to add new applications or remove registered applications.
The sample applications are registered with the server by default and
you may want to unregister them when deploying your own application;
- /cfg - contains the server configuration files;
- /log - by default the server file logger creates the log files in this
subdirectory. Verify the content of the log files to troubleshoot the installation;
- /security - contains the java keystore file. You'll have to import
a server certificate to enable secure RPC communication and the HTTPS
service.
The next step is to verify the installation. Open a command line and go to
the IRIS_HOME/server subdirectory. To start the server execute the run script for your
platform and observe the messages logged to the console. If everything is running correctly
the server should log only informative messages. These are some common problems
with the installation:
- The Java runtime is not installed or the installed version is older than 1.6.0.
- The server port that the RPC server is trying to open is used by another application.
The next paragraph will explain how to configure the Iris server to use another port.
- The HTTP port is used by another application. You can still run the Iris server
by disabling the HTTP service. This will be explained in the next section.
- The HTTPS port is used by another application. You can still run the Iris server
by disabling the HTTPS service. This will be explained in the next section.
- The HTTPS service can not be started because a server certificate was not installed.
Server Configuration
The Iris server is configured using properties files located in the IRIS_HOME/server/cfg subdirectory.
The logging parameters are configured using the Java logging configuration file
logging.properties and by default Iris logs messages to the console.
The server parameters are specified in config.properties:
- server.host
-
The IP address or TCP/IP interface name used by the listening sockets.
If not set all available interfaces will be used.
- server.port
-
The port number of the RPC listening socket.
- server.http
-
The port number of the HTTP service.
- server.https
-
The port number of the HTTPS service. Set this value only after
installing a server certificate.
- server.socket_client_processors
-
The number of NIO selectors used to handle client connections.
Each selector is processed in a separate thread.
When setting this value you should take into consideration your environment:
- The number of CPUs that can be used by the server;
- The maximum number of sockets that can be added to
an NIO selector for your Java implementation. If this is limited
divide the number of client connections to this value to
calculate the number of required selectors.
A tipical value for the parameter is the maximum of the above values.
Setting a value larger than this may result in unnecessary
thread context switching. If the parameter is less than this value
the server may not use all CPUs or the number of clients that can be serviced
may be limited by the available selectors.
- server.dispatchers
-
This is the number of threads used to process the requests. Each incoming
request is assigned to a dispatcher and the dispatcher is free to process
another request only after the RPC call returned. This value should be as
least equal to the number of available CPUs and should be higher if the
applications installed on the server perform lengthy IO operations. When setting
this value monitor the CPU usage at peak application usage time and increase
the number of dispatchers until the CPU usage can not be increased anymore.
Lower CPU usage means that the requests are queued and waiting for dispatchers
to become available. If this parameter is too large the server will create
dispatcher threads that are not used.
Change the Administrator Password
The server creates the administrator user with the default password password.
After starting the server open the administration console http://localhost/admin
using a Java 1.6.0 enabled browser, login as administrator and change the password.
|