Note: This page applies only for 5.0.2 and before. For post 5.0.2, refer to the below two pages:
For Enterprise customers: For download details, please email contact@openspecimen.org
For Community edition: Download the code from Github and follow steps on How to build from code?)
Please visit the respective download centres and download the latest version available for your operating system:
Refer to Database Configuration
MySQL:
mysqldump -u<username> -p<password> --routines [database_name] > dumpfilename.sql mysqldump -u<username> -p<password> --routines [database_name] | grep -v 'SQL SECURITY DEFINER' > dump.sql |
Note: Use the second command when the test server dump is to be imported into the production database.
mysql -u<username> -p<password> [database_name] < dumpfilename.sql |
Oracle:
expdp <username>/<password> full=y DIRECTORY=<DUMP_DIR> DUMPFILE=<dumpfilename.dmp> logfile=<logfile.log> |
impdp <username>/<password> DIRECTORY=<DUMP_DIR> DUMPFILE=<dumpfilename.dmp> REMAP_SCHEMA=<from_user>:<to_user> logfile=<logfile.log> transform=oid:n |
Deployment Instructions (for Enterprise Edition)
For Windows:
For Linux:
If MySQL, remember to perform steps here MySQL prerequisites on Linux
Give executable permission using following command
chmod +xopenspecimen.sh
1) GUI Mode
With this mode, you can install OpenSpecimen with graphical user interface as follow:
./openspecimen.sh |
2) Unattended mode
With this mode first you must need to fill all valid values in properties.varfile (present in zip).
sudo ./openspecimen.sh -q -varfile properties.varfile |
Properties.varfile
install_home | Valid directory path where OpenSpecimen needs to be installed. |
install_service | Whether to install tomcat as a service or not.yes- It will install tomcat service with name 'openspecimen' and will set it as an auto startup (Requires super admin privileges).no- It will not install tomcat service, but will start tomcat normally during installation. |
database_type | DB which you are going to use for installing OpenSpecimen (mysql / oracle). |
database_create | OnlyappliesforMySQLdatabase.yes- It will create a database with the specified name and will use same for OpenSpecimen.no- It won't create a new database, it will use existing database with the name provided in database_name. |
database_name | Name of the database will be used for OpenSpecimen. |
database_host | Hostname of the database server. |
database_port | The port on which database is running (default port are: MySQL - 3306 / Oracle - 1521). |
database_user | Database user name. |
database_password | Database password. |
app_server_port | The port on which Apache tomcat will start. |
app_host | Hostname of the application server. |
deployment_environment | development : It will set tomcat logging to Info, and will enable hibernate query logging. production : It will set tomcat logging to Error only, and will disable hibernate query logging. |
first_name | First name of the super admin user. |
last_name | Last name of the super admin user. |
The email address of the super admin user (This will be used as login name as well). | |
password | Password for super adminusertologinintoOpenSpecimen. |
institute | Name of the institute whichwillbecreatedinOpenSpecimenon which super admin will get registered. |
Below are the few assumptions made during installation/upgradation.
NOTE: So while upgrading OpenSpecimen using an installer, please make sure the directory structure should be same as described above.
Tomcat Configuration Overwrite Policy
This applies only if you are installing OpenSpecimen on an existing Tomcat OR you have made some configuration changes OR have other applications deployed.
This should not apply to most installations where Tomcat is used only to deploy OpenSpecimen.
In GUI mode: Select appropriate overwrite options.
For "command line mode"
./openspecimen.sh -q -varfile properties.varfile -overwrite |
Data Source property for upgrading OpenSpecimen from OS 1.x to OS X.x via installer is handled automatically, no need to take extra care for this, the installer will automatically use relevant data source property.
Installer by default will create data directory with name "os-data" in the installation directory.
<installer-dir>/os-data
If you are having different data directory other than this default one, then please perform any of the following operation:
1)Ifyouwantstousedefault data directory created by the installer, then please update the locations (like sprpath, consent path etc...) via "Settings" menu and move data manually from older location to newer one.
2) If you want to use existing data directory, make sure directory is present & same location is used in "Settings" menu.
Plugin Directory
Installer by default will create plugin directory with name "os-plugins" in installation directory & will use the plugin from there only.
<installer-dir>/os-plugins
The installer will create a super admin only if there is no super admin present in the system.
OpenSpecimen(v3.3 onwards) installer supports the installation of Apache tomcat service, which is optional.
If user wants to install the service (which requires root privileges) then installer will install tomcat service with name "openspecimen" and will set this service to auto-start.
If the user is not interested in installing service then it will start apache tomcat server once, and user will manually have to setup the service.
- It will start service with max heap size 2 GB.
For Windows:
-Set as service: Service can be started/stopped from windows services.
-Service not set: Use the below command:
For Linux:
-Set as a service:
-Service not set:
Refer to wiki page to create tomcat service manually
Download and copy the plugin jar under ${install_home}/os-plugin directory. After copying the plugin you need to restart the tomcat.
For email configuration, please refer: Email Configuration
For locale configuration, please refer: Locale Configuration
For LDAP configuration, please refer: LDAP Configuration