Welcome to the caNanoLab 2.4 Installation Guide.
Print the Guide
If you want to print or export content from the guide, refer to Printing and Exporting to Different Formats.
Topics in this document include:
Introduction to caNanoLab
For more information about the 2.4 updates, refer to the caNanoLab 2.4 Release Note.
Open Source Technologies
Download each of the following tools and follow the installation instructions provided with each respective product for your environment. Assistance from a MySQL database administrator is expected to properly configure the MySQL database. For MySQL database configuration and maintenance, it is also helpful to download the MySQL workbench (suite of GUI tools) at the following page:
Java Software Development Kit (JDK) version 8.0 and set JAVA_HOME
Wildfly version 8.2.0.Final
Jakarta Ant version 1.9.x and set ANT_HOME environment variable
MySQL version 5.1.x
|Apache Maven 3.3.x or higher|
Obtaining the caNanoLab Source Code
Downloads for caNanoLab are available at the caNanoLab GitHub Repository:
The caNanoLab Software License applies.
Ant Build Properties
Follow these steps to set the build and deploy properties required for building and deploying caNanoLab.
Step 1. Extract caNanoLab
Download the following file:
Extract the above file to a location on your local system, for example, C:\caNanoLab_2.3. and navigate into the “software” directory to reach the source. (This location is referred as <CANANOLAB_SOURCE> throughout the document). Verify that the following five folders exist in the directory <CANANOLAB_SOURCE>:
Step 2. Edit Ant Properties
Edit the Ant properties file, build.properties, at <CANANOLAB_SOURCE>/build by specifying values for the following properties.
A directory on the system that hosts the Wildfly application server for storing uploaded files, for example,
Create this directory prior to starting the application, and ensure that the user who starts the Wildfly server has Write access. If working on Windows platform, use either double back slashes
The email address that receives requests for new user accounts, for example, the NCI CBIIT application support email for the NCI CBIIT installation, for example, NCIAppSupport@nih.gov.
A Boolean flag to indicate whether or not to use LDAP for user authentication. caNanoLab 2.1.1 and beyond does not support LDAP authentication. Set this to
The name of the server hosting the database, for example,
The database port number, for example,
The database user name used in the caNanoLab application, for example,
The password for the database that the user specified above, for example,
The system database user name with privileges to create a database, create tables, and grant user accesses to a database, for example,
The password for the system database that the user specified above, for example,
The Wildfly server directory, for example:
Installation and Deployment
Step 1. To migrate from caNanoLab 2.3 to caNanoLab 2.4
a Execute the following script:
Step 2. caNanoLab installation instructions to upgrade to 2.3
a Follow these steps to deploy the caNanoLab application.
Set up an environment variable JBOSS_HOME to point to the Wildfly installation directory.
If working on the Windows platform, use either double back slashes
Execute the Ant build script build.xml located at <CANANOLAB_SOURCE>/software/cananolab-webapp/build.xml with the target dist.
Example: Issue the following commands to execute the Ant script:
Successful execution of the Ant script generates the following artifacts that include two deployable web archive war files, configuration files and libraries for running the web application in the Wildfly environment, and also places these artifacts in the appropriate directories under <JBOSS_HOME>. Artifacts generated are also available in the following folder under <CANANOLAB_SOURCE>:
We recommend increasing the JBoss JVM heap size to 2G bytes and permanent generation (permgen) memory space to 256M bytes by updating the file <JBOSS_HOME>/bin/standalone.conf with the following JAVA_OPTS:
This configuration file is read when Wildfly server starts.
For a standalone server, pass in the JVM settings either as command line arguments when executing the
Create a new directory structure
Create a new directory structure
Start JBoss application server in Standalone mode.
The cli scripts assumes the CLI port is running at 19990. If it is different, update the port number at the second line in the script.
For Windows environment:
For Linux environment:
Run the remaining
After successful completion, the following output appears in the window.
c Restart the application server after the above step to migrate data is completed.
Once the deployment artifacts are deployed and the Wildfly application server is correctly configured, shutdown and restart the Wildfly application server, which in turn starts the caNanoLab application.
Open the URL,
http://<APP_SERVER_URL>/caNanoLab/, for example:
The Welcome/Login page appears.