The User Documentation for BIBBOX and the B3Africa eB3Kit is made by mkdocs, and can be found @ http://bibbox.readthedocs.io/en/latest/.
The developer documentation is at the specific bibbox repository. The repositories are structured according to the following naming conventions:
-
application-store repository describes all applications (applications.json) and annotated lists of application for a specific applicatoin doamin, called kits. Currently we provide one default kit, described in eB3kit.json.
-
KIT-.... repositories provide the blueprint to build a "kit". A kit is a VM providing the base BIBBOX framework together with a set of predefined tools (kit.json in the applications directory), pre-loaded docker images and (reference) databases. Currently we provide one default kit: kit-eb3kit.
-
APP-.... repositories provide the blueprint for APPs. Each BIBBOX application is made by set of either offical docker images or docker images from the BIBBOX docker hub BIBBOX docker hub.
-
SYS-.... repositories provides the source code running inside the virtual machine, which provides all services of the BIBBOX SaaS framework.
- sys-bibbox-backend-liferay backend of the BIBBOX portal, based on the liferay framwork. This provides functionaty for the management of applications instances, the application store and the central user management.
- sys-bibbox-frontend all frontend code (React libraries). They are loaded by the backend at runtime.
- sys-activities service, for logging and synchronisation of all high level activities (installation, dleeting, start/stop, etc.) running as a docker container.
- sys-idmapping service, for mapping of internal IDs and connection to external ID systems (B2Handle, EPIC) running a a docker container.
- sys-bibbox-vmscripts Collection of phyton scripts for
- management of applications, e.g. installation, port management, file management.
- setup script for the configuration of the portal, called after vagrant / puppet scripts are finished.
-
RES-.... repositories ressources. e.g. a common icon set for biobank applications.