Wiki source code of Get Started

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

Show last authors
1 {{velocity output="false"}}
2 #set ($latestVersion = '1.9.1')
3 ##set ($latestRCVersion = { 'name': '1.2.0-rc-1', 'tag': '1.2.0-rc-1'})
4 #set ($latestVersionParts = $stringtool.split($latestVersion, '.'))
5 #if ($latestVersionParts.size() == 2)
6 #set ($latestVersionFull = $latestVersion + '.0')
7 #else
8 #set ($latestVersionFull = $latestVersion)
9 #end
10 {{/velocity}}
11
12 {{box cssClass="floatinginfobox" title="**Contents**"}}
13 {{toc/}}
14 {{/box}}
15
16 {{version product="Cristal" since="1.9"}}
17 {{warning}}
18 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.
19
20 Since Cristal 1.9.1, you can [[build your own instance>>.OwnInstance.WebHome]] 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.
21 {{/warning}}
22 {{/version}}
23
24
25 {{velocity}}
26 #if ($latestRCVersion.name)
27 {{warning}}
28 All the artifacts for $latestRCVersion.name are available at [[release page>>https://github.com/xwiki-contrib/cristal/releases/tag/${latestRCVersion.tag}]].
29 {{/warning}}
30 #end
31 {{/velocity}}
32
33 = Desktop =
34
35 {{velocity}}
36 Latest version: $latestVersion
37
38 * Linux
39 ** [[deb>>https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-linux-amd64.deb]] (159 MB)
40 ** [[AppImage >>https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-linux-x86_64.AppImage]] (220 MB)
41 ** [[rpm>>https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-linux-x86_64.rpm]] (126 MB)
42 ** [[flatpak>>https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-linux-x86_64.flatpak]] (128 MB)
43 * Windows
44 ** [[x64/exe>>url:https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-win-x64.exe]] (167 MB)
45 ** [[x64/msi >>url:https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-win-x64.msi]] (170 MB)
46 ** [[ia32/exe >>url:https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-win-ia32.exe]] (157 MB)
47 ** [[ia32/msi>>url:https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-win-ia32.msi]] (159 MB)
48 * Mac
49 ** [[arm64>>url:https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-mac-arm64.dmg]] (211 MB)
50 ** [[x86>>url:https://github.com/xwiki-contrib/cristal/releases/download/${latestVersion}/cristal-${latestVersionFull}-mac-x64.dmg]] (213 MB)
51
52 More artifacts are available on the [[release page>>https://github.com/xwiki-contrib/cristal/releases/tag/${latestVersion}]].
53 {{/velocity}}
54
55 = Web =
56
57 There are several ways to use Cristal in the web. Either by using Cristal as an independent web application, using our [[flagship instance>>||anchor="web-flagship"]], or by deploying [[your own>>||anchor="web-own-instance"]]. Or, by embedding Cristal inside [[another service UI>>||anchor="web-embedded"]].
58
59 (% id="web-flagship" %)
60 == Demo instance ==
61
62 [[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/>>https://www.xwikiplayground.org/]].
63
64 (% id="web-own-instance" %)
65 == Using you own instance ==
66
67 [[Build Your own Instance Tutorial>>.OwnInstance.WebHome]]
68
69 (% id="web-embedded" %)
70 == Embedded ==
71
72 {{warning}}
73 Work in progress.
74 Examples for embedding:
75
76 * Alternative UI for [[XWiki>>xwiki:Main.WebHome]]
77 * [[Nextcloud>>https://nextcloud.com/]] extension
78 {{/warning}}
79
80 === Custom Router ===
81
82 {{version since="0.23" product="Cristal"}}
83 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:
84
85 {{code language="typescript"}}
86 /**
87 * A factory to initialize an instance of Vue router.
88 * By default, no implementation is provided. If there is one available,
89 * it will be used instead of the default initialization. Use the
90 * "RouterFactory" role to bind your custom implementation.
91 * @since 0.23
92 */
93 interface RouterFactory {
94 initializeRouter(routes: RouteRecordRaw[]): Router;
95 }
96 {{/code}}
97
98 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.
99 {{/version}}
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 - node1. Hosted and managed by XWiki SAS

Get Connected