Wiki source code of Import from Confluence

Last modified by Eleni Cojocariu on 2026/04/30 13:50

Hide last authors
Raphaël Jakse 1.1 1 {{warning}}
2 Importing a Confluence instance is a multi-step process. This tool allows to import an export from Confluence into XWiki pages, but additional specific actions need to be handled, including supporting standard or custom Confluence macros. For large instances, some specific issues might occur, such as too long page names or hierarchies that cannot be imported or unsupported macros.
3 {{/warning}}
4
5 {{info}}
6 XWiki SAS, a [[sponsoring company of the XWiki Open Source software>>xwiki:Main.Supporters.SponsoringCompanies.WebHome]], is providing software and services to help with the migration:
7
Clément Aubin 13.1 8 * A macro package has been released and is available on the XWiki SAS store: https://store.xwiki.com/xwiki/bin/view/Extension/ProMacros/
Clément Aubin 12.1 9 * XWiki SAS provides a migration package to handle all steps of the migration in one application. This extension is available on the XWiki SAS store : [[https:~~/~~/store.xwiki.com/xwiki/bin/view/Extension/Confluence%20Migration%20Toolkit/>>https://store.xwiki.com/xwiki/bin/view/Extension/Confluence%20Migration%20Toolkit/]]
Raphaël Jakse 1.1 10 * XWiki SAS can provide services to analyse a Confluence instance and study what is needed to migrate it (which package, which process, what macros are needed).
11
Clément Aubin 13.1 12 You can contact XWiki SAS on the XWiki SAS website: https://xwiki.com
Raphaël Jakse 1.1 13 {{/info}}
14
Raphaël Jakse 7.2 15 To get started with the Confluence Import, you will need to install the [[Filter Streams Converter Application>>doc:extensions:Extension.Filter Application]] and this [[Confluence XML module>>extensions:Extension.Filter Confluence XML module]]. You can install these apps using the [[Extension Manager>>doc:extensions:XWiki.ExtensionManager]].
Raphaël Jakse 1.1 16
17 You then need to export your confluence data from the Confluence administration and upload the zip file to the XWiki server. Make sure you make it accessible to the user running your java process.
18
Raphaël Jakse 14.1 19 {{image reference="extensions.png" size="medium" alt="Confluence XML and the Filter Streams Converter application listed in a screenshot of the extension manager, found with the ~"filter~" search query"/}}
Raphaël Jakse 1.1 20
21 After you have installed the two extensions, click on the **Filter Stream Converter** entry from the Applications panel.
22
Raphaël Jakse 14.1 23 {{image reference="extensions.png" size="medium" alt="Filter Streams Converter in the Application panel"/}}
Raphaël Jakse 1.1 24
25 Follow these steps on the screenshot below:
26
27 * Choose the "Confluence XML input stream (confluence+xml)" input type
28 * Fill in the source field which contains **"file:"** followed by the path of the **Confluence zip file**, located on the machine where XWiki is running
29 * Choose the "XWiki instance output stream (xwiki+instance)" output type to import the Confluence pages in your wiki
30
31 Note: in some cases, the Java Application server cannot access all the directories from your computer or server. You can try storing the file in a directory used by the application server (root directory of the application server or log directory). Alternatively it is also possible to make your file accessible on a web server and indicate the URL of that file.
32
33
Raphaël Jakse 9.1 34
Raphaël Jakse 14.1 35 {{image reference="filterconverter.png" size="large" alt="Confluence XML Input Stream (confluence+xml) used as an input filter in the Filter Streams Converter application"/}}
Raphaël Jakse 9.1 36
Raphaël Jakse 1.1 37 After you have completed these steps, click the "Convert" button. After that, you will see the conversion progress. For example:
38
Eleni Cojocariu 17.3 39 {{image reference="ws-mess.png" size="medium" alt="A screenshot of the conversion process"/}}
Raphaël Jakse 1.1 40
41 For example with the following **initial** page from Confluence:
42
Eleni Cojocariu 17.3 43 {{image reference="confluence-page.png" size="large" alt="A screenshot of a page in confluence"/}}
Raphaël Jakse 1.1 44
45 You'll get the following page in XWiki **after** you've made the import:
46
Eleni Cojocariu 17.3 47 {{image reference="wiki-page.png" size="large" alt="A screenshot of an imported page"/}}
Raphaël Jakse 1.1 48
Raphaël Jakse 10.1 49 You're all set! :)

Get Connected