{scrollbar:icons=false} |
Welcome to the caNanoLab 2.1.1 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.1.1 updates, see the caNanoLab 2.1.1 Release Note.
Download each of the following tools and follow the installation instructions provided with each respective product for your environment.
Contact a MySQL database administrator for proper configuration of the MySQL database. For MySQL database configuration and maintenance, we suggest downloading the MySQL workbench (Suite of GUI tools). |
Product | Link |
---|---|
Java Software Development Kit (JDK) version 7.0 and set JAVA_HOME | http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html |
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 the caNanoLab GitHub Repository.
The caNanoLab Software License applies.
Follow these steps to set the build and deploy properties required for building and deploying caNanoLab 2.1.1.
Download caNanoLab from the GitHub location to a location on your local system, for example, C:\caNanoLab_2.1.1
. This location is referred to as <CANANOLAB_SOURCE>
throughout the document. Verify that the following five folders exist in the directory <CANANOLAB_SOURCE>\software
:
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:
|
Follow these steps to build and deploy caNanoLab 2.1.1.
CREATE TABLE favorite_data (
favorite_data_id bigint(20) DEFAULT NULL,
data_id bigint(20) DEFAULT NULL,
data_type varchar(200) DEFAULT NULL,
data_name varchar(200) DEFAULT NULL,
login_name varchar(200) DEFAULT NULL,
protocol_file_id bigint(20) DEFAULT NULL,
pubmed_id bigint(20) DEFAULT NULL,
editable tinyint(1) DEFAULT '0',
description text,
protocol_file_title varchar(200) DEFAULT NULL
update csm_user set password = 'zJPWCwDeSgG8j2uyHEABIQ==';
update csm_user set first_time_login = 1;
c:\csm_52
). Note the folder name and location. c:\csm_52\csm_upgrade5.2
c:\csm_52\csm_upgrade5.2
.
ant -Dproperties.file=upgrade.properties migration:run
.Follow these steps to install and deploy caNanoLab.
# | Action | |
---|---|---|
1 | Set up an environment variable
| |
2 | Execute the Ant build script build.xml located at For 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. The Ant script also places these artifacts in the appropriate directories under
| |
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
| |
4 |
| |
5 | Start JBoss application server in Standalone mode. This script assumes the CLI port is running at 19990. If it is different, update the port number in the second line in the script. Windows environment:
Linux environment:
|
Once the deployment artifacts are deployed and the Wildfly application server is configured correctly, you can start 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.