Get Started

Last modified by Manuel Leduc on 2026/11/03 17:29

Cristal 1.9+

Warning

Cristal 1.9 relies on new XWiki APIs introduced in XWiki 18.2. As such, the XWiki backend no longer supports previous XWiki versions by default.

Since Cristal 1.9.1, you can build your own instance with the VITE_CRISTAL_XWIKI_LEGACY_REST environment variable set to true to connect to an XWiki older than 18.2. That XWiki must have cristal-integration-rest-server 1.4.0 or older installed. The desktop applications is not built with this flag.

Desktop

Latest version: 1.9.1

More artifacts are available on the release page.

Web

There are several ways to use Cristal in the web. Either by using Cristal as an independent web application, using our flagship instance, or by deploying your own. Or, by embedding Cristal inside another service UI.

Demo instance

https://cristal.demo.xwiki.com/ is an instance of Cristal we keep up to date. It connects to a pre-configured XWiki backend (https://cristal-backend.demo.xwiki.com/) that is reset every night, the same way as https://www.xwikiplayground.org/.

Using you own instance

Build Your own Instance Tutorial

Embedded

Warning

Work in progress.
Examples for embedding:

Custom Router

Cristal 0.23+

If you need to customize the vue-router component used by the Cristal instance you want to embed, the @xwiki/cristal-lib package exports a RouterFactory interface:

/**
 * A factory to initialize an instance of Vue router.
 * By default, no implementation is provided. If there is one available,
 * it will be used instead of the default initialization. Use the
 * "RouterFactory" role to bind your custom implementation.
 * @since 0.23
 */
interface RouterFactory {
  initializeRouter(routes: RouteRecordRaw[]): Router;
}

You can create and bind your own implementation to the inversify role RouterFactory, and it will be used automatically instead of the default router initialization.

France 2030 Logo

This project is being financed by the French State as part of the France 2030 program

Ce projet est financé par l’État Français dans le cadre de France 2030

  • Powered by XWiki 18.4.6 - node2. Hosted and managed by XWiki SAS

Get Connected