Welcome to the caNanoLab 2.2 Installation Guide.
For any general information about the application, application support, or to report a bug, contact Application Support. |
Topics in this document include:
For more information about the 2.2 updates, see the caNanoLab 2.2 Release Notes.
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 http://www.mysql.com/downloads/workbench/
Product | Link |
---|---|
Java Software Development Kit (JDK) version 8.0 and set JAVA_HOME | |
Wildfly version 8.2.0.Final | |
Jakarta Ant version 1.8.x and set ANT_HOME environment variable | |
MySQL version 5.1.x |
Downloads for caNanoLab are available at caNanoLab GitHub Repository.
The caNanoLab Software License applies.
Follow these steps to set the build and deploy properties required for building and deploying caNanoLab.
Extract the GitHub location to a location on your local system, for example, C:\caNanoLab_2.2
(This location is referred as <CANANOLAB_SOURCE> throughout the document). Verify that the following five folders exist in the directory <CANANOLAB_SOURCE>:
build
cananolab-db
cananolab-grid
cananolab-webapp
common
Edit the Ant properties file, build.properties, at <CANANOLAB_SOURCE>/build by specifying values for the following properties.
Property | Description | |
---|---|---|
file.repository.dir | A directory on the system that hosts the Wildfly application server for storing uploaded files, for example,
| |
admin.email | The email address that receives requests for new user accounts, for example, the NCI CBIIT application support email for the NCI CBIIT installation. | |
ldap.authentication.enabled | 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 | |
database.server | The name of the server hosting the database, for example, | |
database.port | The database port number, for example, | |
database.user | The database user name used in the caNanoLab application, for example, | |
database.password | The password for the database that the user specified above, for example, | |
database.system.user | The system database user name with privileges to create a database, create tables, and grant user accesses to a database, for example, | |
database.system.password | The password for the system database that the user specified above, for example, | |
jboss.server.dir | The Wildfly server directory, for example:
|
The migration of access control data has been implemented as a series of ReST services. These services must be invoked in the following order for all access data to be migrated from CSM to Spring Security.
Follow these steps to install and deploy caNanoLab.
# | Action | |
---|---|---|
1 | Set up an environment variable JBOSS_HOME to point to the Wildfly installation directory.
| |
2 | Execute the Ant build script build.xml located at <CANANOLAB_SOURCE>/build with the target deploy:cananolab-webpp. 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>:
| |
3 | 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 | |
4 | Create a new directory structure
Create a new directory structure
| |
5 | Start JBoss application server in Standalone mode. From
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, you should see following output in the window.
|
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, http://localhost:8080/caNanoLab . The Welcome/Login page displays.