Set up the Akula Server Environment
The following sections contain instructions on how to set up the Akula Server environment:
Set the Java memory requirements for the Akula Server
The Akula Server requires a maximum of 512 MBytes (or greater) of heap space and a maximum of 128 MBytes (or greater) of PermGen space. You can define this memory requirements by setting the
JAVA_OPTS environment variable as shown below:
- Microsoft Windows:
Set the AKULA_HOME environment variable
AKULA_HOME environment variable specifies where the Akula Server looks for configuration files and for deployed app scopes. You must set the value of the
AKULA_HOME environment variable before you start the Akula Server.
When setting the
On Windows, use Computer > Properties > Advanced system setting to set the system environment variable as shown below:
AKULA_HOME = c:/Users/nickdanger/Akula/home
On a Mac or UNIX system, you can set the
AKULA_HOME environment variable in your .profile file by adding the following command:
Note that the .profile file is a hidden file. Use the "ls -la" command to view hidden files. If you have not created a .profile file previously, you can create one.
Alternatively, set the value of
AKULA_HOME as a JVM property in your startup script or in your JVM configuration file (jvm.cfg). For example:
Restart your Java server after defining this environment variable.
Set up the Akula Server directories
If you are on a Mac or UNIX machine, make sure that the Akula Server directories are writable by the user account used to start your Java server.
To set up the Akula Server directories:
- Under the
AKULA_HOMEfolder, create the following directories:
- /apps - Where the Akula Server expands an AKZ file corresponding to an app scope.
- /db - The location of the default Akula configuration database.
- /deploy - Where you write an AKZ file corresponding to an app scope.
/global - The location of Akula configuration files.
- /licenses - The location of Akula license files.
/logs - The default location of Akula log files.
Copy the Akula Server configuration files
The Akula Server requires several configuration files that you must install before starting the server. To get you up and running quicky, Akula ships with a set of default configuration files:
- context.properties - Specifies the location of the Akula Server database.
- logback.xml - Configures the default logging mechanism.
- properties.xml - Sets global properties used by the Akula Server.
- security-template.xml - Specifies the security manager for the Akula Server.
- sqlite-directory.db - A sample security realm that lets you log in to the Akula Server.
The sqlite-directory.db file contains the SQLite database used as the default security realm as described in Before You Install the Akula Server.
To copy these files:
- Browse to the location where you unzipped the Akula Server ZIP file. If you have not done so already, download the Akula Server from the Downloads (you must log in to access this page).
- From the server-sdk/samples/akula-home-template/global dir, copy these files to the
You can deploy your own JAR files for use by any app scope in /global/lib. Remember that the Akula Server reserves the folder named /global/lib/system, so you should not create a folder with that name.
Deploy the AKZ Protocol Handler
Download the akz-protocol-handler-2.5.0.jar file.
For more efficient server operation, AKZ Protocol Handler has been added for release 2.5.0. At installation, the akz-protocol-handler-2.5.0.jar file is generated in the server. The exact location to place this jar file depends on the server being used, as described below.
The akz-protocol-handler-2.5.0.jar file needs to be copied to tomcat/lib/ for every instance of tomcat.
Create a setenv.sh file and place it in your tomcat/bin/ folder. Then, add the classpath to the setenv.sh file you've just created, as shown in the example below.
Create a setenv.bat file and place it in your tomcat/bin/ folder. Then, add the classpath to the setenv.bat file you've just created, as shown in the example below.
You need to use tomcat7w utility in order to set the classpath for the akz-protocol-handler jar file.
The akz-protocol-handler-2.5.0.jar file needs to be copied to the /home/builduser/Oracle/Middleware/user_projects/domains/akula/jaxb-jars.
Create a setenv.sh file and place it as follows:
Now, add the classpath to the setenv.sh file you've just created, as shown in the example below.
Create a setenv.bat file and place it as follows:
Now, add the classpath to the setenv.bat file you've just created, as shown in the example below.
The akz-protocol-handler-2.5.0.jar file needs to be copied to the /home/builduser/EAP-6.0.1/jboss-eap-6.0/standalone/lib/.