Creating your own Confluence space file

Owned by Iryna Ihnatiuk
Aug 23, 2021

This section contains the instructions to create your own Confluence space files.

A Confluence space can be stored in a file, and provided to Gaia as a template space which will be used to automatically generate a predefined Confluence space when creating a new Jira project.

Pre-requisites

This tutorial was written considering that:

  • you have a Confluence instance installed and running on your server or you are using the Confluence Cloud service from Atlassian;
  • you have an administrator account on that Confluence instance.

Creating your own Confluence space file

In this section, you will export a Confluence space into a file.

Note

Please consider this before exporting a space :

  • Minimum Confluence version required. Please note that the minimum Confluence version supported is, as of this writing, 5.2.
  • Users. The export procedure does not include any user accounts.
  • Groups and permissions. The export procedure does not include any groups that have been granted specific space permissions in your source Confluence site. You must make sure those groups exist in your instance and create them if they do not exist.

To export a Confluence space into a file, do the following:

  1. Open the Space you want to export.  Go to Space tools menu at the bottom left of the page and select Content Tools.



2. Under the Export tab select XML as the export format and click Next.


3. You can choose from two options, either a "Full Export":

or a "Custom Export":

Important

The home page must be included in order for the space to be generated when the exported file is included in a Gaia template and a Jira project is created.


4. Once you click Export, the export operation will start creating a zip file. Wait for the operation to complete and click on the Download here link to download the zipped XML file. This file can be used as a Confluence space template.


There you go, you have a new Confluence space file to use in a Gaia Template!

Important

Do NOT unzip or alter the file before including it in your Gaia template. Import may NOT work if you unzip the file or modify the zipped files.

What's next

Now that you have your own Confluence space file, use it in a Gaia template. See how to create a template guide for more information.