GemsTracker

GEneric Medical Survey Tracker

User Tools

Site Tools


devzone:requirements:softwarerequirements

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
devzone:requirements:softwarerequirements [2016/10/31 13:36]
Matijs Added mcrypt
devzone:requirements:softwarerequirements [2020/03/12 12:06] (current)
Line 1: Line 1:
 ====== Software requirements ====== ====== Software requirements ======
-GemsTracker is built in PHP 5.5 on top of the Zend Framework 1 and uses MySQL 5.5 or higher. The development team runs the software on both Windows and Unix systems using both Apache 2 and IIS 7 as servers. Additional web publication environments that support PHP 5.5 and MySQL should work, but we have not tested them so you are on your own.+GemsTracker is built in PHP 5.5 on top of the Zend Framework 1 and uses MySQL 5.5 or higher. ​As of version 1.8 GemsTracker is stored on [[https://​github.com/​GemsTracker|GitHub]]. 
 + 
 +The development team runs the software on both Windows and Unix systems using both Apache 2, Nginx and IIS 7 as servers. Additional web publication environments that support PHP 5.5 and MySQL should work, but we have not tested them so you are on your own.
  
 To use GemsTracker you need: To use GemsTracker you need:
  
-  * a working Webserver ([[http://​httpd.apache.org|Apache]] or IIS) +  * a working Webserver ([[http://​httpd.apache.org|Apache]] ​or Nginx or IIS) 
-  * [[http://​www.php.net|PHP]] 5.5 or higher+  * [[http://​www.php.net|PHP]] 5.5 or higher ​
   * [[https://​getcomposer.org/​|Composer]]   * [[https://​getcomposer.org/​|Composer]]
   * [[https://​www.git-scm.com|Git]]   * [[https://​www.git-scm.com|Git]]
-  * access to a database on a [[http://​www.mysql.com|MySQL server]] version 5.5 or higher +  * access to a database on a [[http://​www.mysql.com|MySQL server]] version 5.5 or higher ​(in version 5.7 strict mode must be disabled) 
-  * (optionally) a [[http://​www.limesurvey.org|LimeSurvey]] 2.00 or higher installation+  * (optionally) a [[http://​www.limesurvey.org|LimeSurvey]] 2.06/​lts ​
  
 GemsTracker is built for plug-in survey engines, but the only survey engine currently available in open source is LimeSurvey. At least one other survey system has been implemented but it is not available in open source. GemsTracker is built for plug-in survey engines, but the only survey engine currently available in open source is LimeSurvey. At least one other survey system has been implemented but it is not available in open source.
Line 15: Line 17:
 === PHP Requirements === === PHP Requirements ===
  
-As of version 1.8 GemsTracker requires PHP 5.5 or higher. ​PHP 7 should work but we have no systems ​using PHP 7 at the moment ​so it is untested at the moment.+As of version 1.8 GemsTracker requires PHP 5.5 or higher. ​We advise ​using the latest PHP 5.6 version or the latest ​PHP 7 version, but at the moment ​PHP 7 has only been used on development and test systems.
  
 In PHP 5 these modules are required unless stated otherwise: In PHP 5 these modules are required unless stated otherwise:
Line 25: Line 27:
   * Fileinfo   * Fileinfo
   * GD   * GD
 +  * Iconv
   * Intl   * Intl
   * Json   * Json
 +  * libXML
   * Mcrypt   * Mcrypt
   * Multi-Byte string   * Multi-Byte string
Line 35: Line 39:
   * XMLWriter   * XMLWriter
   * Zip   * Zip
 +
 +=== MySQL Requirements ===
 +
 +Both GemsTracker and LimeSurvey require access to MySQL databases. MySQL version 5.5 or higher is required. We advise MySQL version 5.6. MySQL version 5.7 has a strict mode that is enabled by default, but that causes know problems with GemsTracker. Using MySQL 5.7 with strict mode **disabled** should work fine.
  
 ===== General Installation notes ===== ===== General Installation notes =====
Line 41: Line 49:
  
 The use ''​composer install''​ to install all required libraries and modules not part of the PHP installation. The use ''​composer install''​ to install all required libraries and modules not part of the PHP installation.
 +
 +The alternative to using git and composer on a server is to install both packages on another machine, download the software on that machine and transfer the files to the server. However: //we strongly advise against this// as this complicates future updates.
 +
 +===== LimeSurvey Installation notes =====
 +
 +We advise GemsTracker users to us the 2.06lts version of LimeSurvey. You can either download the zipfile from 
 +[[https://​github.com/​LimeSurvey/​LimeSurvey/​tree/​2.06lts]] or clone the GitHub repository and switch to the 2.06lts version.
 +
 +Usually we install LimeSurvey in an ls subdirectory of the webroot of the GemsTracker installation. Browsing to the ls/admin page starts the installation wizard.
  
 ===== Windows Installation notes ===== ===== Windows Installation notes =====
Line 76: Line 93:
 Of course you should use the correct password you wrote down in the previous paragraph. Of course you should use the correct password you wrote down in the previous paragraph.
  
-This installation is sufficient for GemsTracker,​ but requires you to perform certain installation task using the MySQL command line. So usually the next step is to download the latest stable release of **phpMyAdmin** from [[www.phpmyadmin.net/]]. After download extract he files e.g. to ''​C:​\inetpub\wwwroot\myadmin'',​ copy ''​config.sample.inc.php''​ to ''​config.inc.php''​ and while you may want to edit some settings in this file, you should now be able to get a login screen using this link [[http://​localhost/​myadmin]] on a browser on your server. You can then log in using the name ''​root''​ and you password. ​+This installation is sufficient for GemsTracker,​ but requires you to perform certain installation task using the MySQL command line. So usually the next step is to download the latest stable release of **phpMyAdmin** from [[https://www.phpmyadmin.net]]. After download extract he files e.g. to ''​C:​\inetpub\wwwroot\myadmin'',​ copy ''​config.sample.inc.php''​ to ''​config.inc.php''​ and while you may want to edit some settings in this file, you should now be able to get a login screen using this link [[http://​localhost/​myadmin]] on a browser on your server. You can then log in using the name ''​root''​ and you password. ​
  
 Using phpMyAdmin you can then create databases and users that can the be used by both GemsTracker and LimeSurvey. Using phpMyAdmin you can then create databases and users that can the be used by both GemsTracker and LimeSurvey.
  
 Note: use a secure password and preferable use another directory name than ''​admin'',​ ''​myadmin''​ or ''​phpmyadmin''​ as these are favorite hacker targets. The best option would be to configure your web server so that access to this page is only possible from your own network and not from other locations. Note: use a secure password and preferable use another directory name than ''​admin'',​ ''​myadmin''​ or ''​phpmyadmin''​ as these are favorite hacker targets. The best option would be to configure your web server so that access to this page is only possible from your own network and not from other locations.
devzone/requirements/softwarerequirements.1477917396.txt.gz · Last modified: 2020/03/12 12:08 (external edit)