Describo Online

Describo Online is a tool to describe folders of content as Research Object Crates.

This wiki describes how to develop, configure and use this application.

Conceptual Overview

The schematic above is a conceptual overview of Describo. Describo is an application that allows a user to create Research Object Crates on backend storage systems. Describo manages the data in a database and the data is sync'ed back to the storage on every change so the database can be completely wiped and no data is lost. An RO Crate in a folder on some storage is loaded into the database as required if it's not already there.

Users authenticate to Describo via a number of methods. And once authenticated to describo, they can log into a storage provider if the administrator of describo allows them to access that provider.

Configuring the application

• Setting up the configuration

Setting up authentication providers

• okta configuration
• reva configuration
• Localhost configuration

Setting up backends

• Microsoft OneDrive configuration
• Allowing ownCloud as a backend
• Allowing S3 as a backend
• Allowing Reva as a backend
• Allowing the localhost backend

Integrating Describo into other services

• Integrating describo online into an external service
• Integrating describo online into owncloud
• Setting up an S3 backend session from an external service

Profiles - for Describo administrators

• Writing a domain specific profile
• Testing your profile
• Deploying your profile

Developers

• Setting up for development
• Starting the development environment
• Running the API tests in watch mode
• Updating type definitions
• Building production containers

Production users

• Deploying describo online into production