Community apps in collabs

Community apps are services developed by the EBRAINS community of users, yes, and that can be added to the navigation of any collab (by a collab's editors). For this, the app needs to be registered in a space called the "Apps Catalogue". Once the app is registered, adding such an app to a collab is as simple as creating a new Wiki page in the collab.

Becoming a contributor

The first step to creating community apps is for you to get the developer accreditation. Contributors can register and manage apps within the Community Apps Catalogue.

Send an email to support@ebrains.eu with a short motivation for your request.

The support team will apply the permissions to your user. Your account will be upgraded with developer privileges the next time you login.

Making your app available to users

In order for users to install your app, it needs to be registered in the Community Apps Catalogue.

If you are dealing with private data, or your users need to be authenticated, see managing authorisation in the Collaboratory  or OIDC clients explained and its sub-pages for a more detailed overview of OIDC clients.

Register your app in the Apps Catalogue

The Apps Catalogue is available at: https://wiki.ebrains.eu/bin/view/Apps/

App registration is only available to members of this group: https://wiki.ebrains.eu/bin/view/Identity/#/groups/app-collaboratory-iam--service-providers

To register an app, click on "Create App", if the button does not appear, you are probably not a member of the group previously mentioned. From that Group page, you can request to become a member which will in turn grant you permission to register apps.

Then create a new space in the Apps Catalogue for your app using the "Community Apps" type.

On the next step, fill the form to register your app. Note that only users registered in the "maintainers" field will be able to edit this form. Don't forget to add yourself. When done, click on the "Save & View" button; it displays a summary of information you have just filled. Your app is now available to be used in the Wiki.

Add a logo (optional)

Some of users like to add a logo to their app. The logo is only visible when browsing the catalogue. To do so, the user has to add a PNG file attachment with the filename "logo.png" in the attachment tab at the bottom of the summary page displayed after the "Save & View" action above.

Add an app to your collab

Adding an app to a collab is a simple as creating a new wiki page. As an admin or editor of a collab, a user can add a community app by clicking the "+ Create" button at the top of any wiki page, and selecting the "Community App" type.

Then click the Create button and the app will have been added in the collab's navigation menu.