Developers Getting Started With i2b2
Developers Getting Started With i2b2
getstarted
- Download the new v1.8.x Web Client release.
- Create a new hosting directory (http://hostname/legacy) in Apache that will contain your currently existing deployment.
- Move the files for the existing web client deployment into this new hosting directory
- Copy the new v1.8 web client into the root deployment directory (http://hostname/).
- Edit proxy.php and setup the whitelist and blacklist entries.
- Edit i2b2_config_domains.js file and change the “urlProxy” entry to “/proxy.php”.
- Copy the i2b2 domains from your legacy deployment into the i2b2_config_domains.js file. See “Apache Install Guide for i2b2 Release v1.8+” section “I2B2 CONFIGURATION”.
- Configure any SAML (Shibboleth) authentication within the i2b2 domains if needed.
- Download any additional “modern” plugins and move into the /plugins directory.
- Edit /plugins/plugins.json file and add the new plugins. See “Apache Install Guide for i2b2 Release v1.8+” section “CONFIGURATION OF MODERN PLUGINS”.
- Copy into /js-i2b2/cells/LEGACYPLUGIN/legacy_plugin directory any legacy plugins from the /legacy deployment.
- Register the copied plugins (from the previous step) into the following file:
/js-i2b2/cells/LEGACYPLUGIN/legacy_plugin/js-i2b2/i2b2_loader.js
See “Install Guide for i2b2 Release v1.8+” section “CONFIGURATION OF LEGACY PLUGINS” for examples and more information. - Edit the login screen template:
- Set the URL address for the “classic i2b2” link to “/legacy”.
- Set the URL address for the “Forgot password” link if you have a custom page to reset a user’s password. Remove this linkfrom the HTML template if you do not offer this service.
- Add any additional SAML authentication service links if you use something besides Shibboleth or Okta.
- Apply any logos, color schemes or additional branding to the template files. See the document titled “Applying Branding Styles to the i2b2 Release v1.8+” for more details.
