Getting started

Welcome to Djerba!

Djerba was developed by and for the CGI team at OICR; but its modular plugin structure is intended to enable external collaboration.

In other words: You are welcome to write your own plugins!

The first step is to run djerba-demo. This is a fork of production Djerba, with complete instructions for installation, testing, and generating example reports. It also includes a Frequently Asked Questions page.

Next Steps

Once you have successfully run djerba-demo, you are ready to try writing your own plugins.

The djerba-demo repo contains a fully functional version of the Djerba core code (version 1.6.4), but with a reduced set of plugins. If you wish to write your own plugins, we recommend forking djerba-demo and creating packages in the plugins directory. The Plugin Developer’s Guide provides further instructions and tips.

Production Djerba

The production Djerba code has a number of internal OICR dependencies. Deployment by external users is not currently supported. However, we have plans to reorganize the code and make production Djerba available externally by the end of 2024.

Questions and Troubleshooting

Support for external development is a work in progress. Known issues are listed on Github; feel free to contact the Djerba developers with any additional questions or concerns.