• Configuration format
  • General structure
  • Shared keys
  • Backends
    • XWiki
    • Nextcloud
    • Filesystem
    • Unsupported backends
      • Github
• Realtime

Configuration format

This section describes the configuration format of the backends. This is usually stored in a config.json file, but we plan to make it possible for users to edit their configuration directly in the user interface.

General structure

The configuration is an object of key and values, for instance:

See below for the detail of each sub-object.

Shared keys

• configType: the type of the backend. Accepted values: XWiki, Nextcloud, FileSystem, GitHub.
• serverRendering:
• offline: when true, each page is cached locally and is refresh in the background if the backend is accessible. This is useful to browse already visited pages when offline.
• baseURL: the base url to access the backend
• baseRestURL: a segment concatenated to baseURL to access the backend rest endpoint
• homePage: the page reference of the main page of the backend
• designSystem: the identifier of the design system to use. Accepted values: vuetify, and shoelace.
• realtimeURL: (optional) the URL of a real-time server. When this value is undefined, autosave is activated. When the value is defined, the editor connects to a real-time session on the provided server.

Backends

The sections below presents examples configurations for each supported backend.

XWiki

Nextcloud

Filesystem

Unsupported backends

Github

Realtime

Currently, Cristal supports a single real-time server based on hocuspocus.

An example can be found at https://github.com/xwiki-contrib/cristal/tree/main/realtime