App-Registry Service Configuration
Introduction
The Infinite Scale App-Registry service is the single point where all apps register themselves and their respective supported mime types.
Administrators can set default applications on a per MIME type basis and also allow the creation of new files for certain MIME types. This per MIME type configuration also features a description, file extension option and an icon.
MIME Type Configuration / Creation Allow List
The apps will register their supported MIME types automatically, so that users can open supported files with them.
Administrators can set default applications for each MIME type and also allow the creation of new files for certain mime types. This, per MIME type configuration, also features a description, file extension option and an icon.
MIME Type Configuration
Modifing the MIME type config can only be achieved via a yaml configuration. Using environment variables is not possible. For an example, see the ocis_wopi/config/ocis/app-registry.yaml at the Local Production Setup deployment example in the downloaded ocis-wopi example directory. The following is a brief structure and a field description:
- Structure
-
app_registry: mimetypes: - mime_type: application/vnd.oasis.opendocument.spreadsheet extension: ods name: OpenSpreadsheet description: OpenDocument spreadsheet document icon: https://some-website.test/opendocument-spreadsheet-icon.png default_app: Collabora allow_creation: true - mime_type: ... - Fields
-
-
mime_type
The MIME type you want to configure. -
extension
The file extension to be used for new files. -
name
The name of the file / MIME type. -
description
The human-readable description of the file / MIME type. -
icon
The URL to an icon which should be used for that MIME type. -
default_app
The name of the default app which opens this MIME type if the user doesn’t specify one. -
allow_creation
Whether a user should be able to create new files of that MIME type (true or false).
-
App Drivers
App drivers represent apps if the app is not able to register itself. Currently there is only the CS3org WOPI server app driver.
CS3org WOPI Server App Driver
The CS3org WOPI server app driver is included in Infinite Scale by default. It needs at least one WOPI-compliant app like Collabora, OnlyOffice or the Microsoft Online Server or a CS3org WOPI bridge supported app like CodiMD or Etherpad and the CS3org WOPI server.
App Provider Configuration
A configuration of the actual app provider can be found in the Local Production Setup deployment example in the downloaded ocis-wopi example directory especially in the config sections ocis-appprovider-collabora and ocis-appprovider-onlyoffice.
Configuration
Environment Variables
The app-registry service is configured via the following environment variables. Read the Environment Variable Types documentation for important details. Column IV shows with which release the environment variable has been introduced.
404: Not Found
YAML Example
-
Note the file shown below must be renamed and placed in the correct folder according to the Configuration File Naming conventions to be effective.
-
See the Notes for Environment Variables if you want to use environment variables in the yaml file.