Get Started
Cristal 1.9+
Desktop
Latest version: 1.9.1
- Linux
- Windows
- Mac
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
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.

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