This page last changed on Jul 13, 2007 by ivan@atlassian.com.
Currently Confluence does not support renaming or copying spaces through the user interface. You may wish to vote towards these feature requests:
Manually Clone Or Rename A Space
It is possible to manually clone or rename a space by modifying an XML backup of the target space.
Notes
- May require manually updating external links to that space
- The instructions have been confirmed for Confluence 2.2 onwards. Users running older versions are recommended to upgrade Confluence before continuing
- Where examples are given, they involve changing oldkey:Old Space Name into newkey:New Space Name
- When importing a space export for a space that already exists, the previous space content will be overwritten
- Read the process in full before beginning
Stage 1: Rename Space
- Select a new, unique space key and name for the second space. Space keys may only consist of ASCII letters or numbers (A-Z, a-z, 0-9) and no empty spaces are allowed in the key
- Clone your production Confluence instance to a test server on another computer now. You should now have a production server and test server both containing the same data and can avoid the risk of corrupting your production Confluence instance
- On the test server, login as an administrator
- Go to Browse Space -> Advanced -> Export Space and export the target space as XML including attachments.
- Save the space backup
- Open the space backup file with a zip file editor and find the file entities.xml
- Edit entities.xml in a text editor
- Do a 'Search & Replace' on the old space name as shown below. Swap out Old Space Name and New Space Name for the actual names
Search For |
Replace With |
[CDATA[Old Space Name] |
[CDATA[New Space Name] |
- Do a 'Search' for any occurrences of the old space name that occur in user content. You may wish to replace some or all of these references with the new space name. Replace Old Space Name and New Space Name with the actual names
Search For |
Old Space Name |
- Do four 'Search & Replaces' on each of the references to the old space key as shown below. Swap out oldkey and newkey for the actual keys
Search For |
Replace With |
[oldkey] |
[newkey] |
spaceKey=oldkey |
spaceKey=newkey |
[oldkey: |
[newkey: |
key=oldkey] |
key=newkey] |
For instance:
Space name : Test Space
Space key : test
Change the test oldkey to a newkey representing the new unique space key for the space name Test Space.
- Save the modified entities.xml
- Overwrite the original entities.xml in the space backup with the modified version
- Login to the test instance as a Confluence administrator
- Go to Administration -> Backup & Restore. Under 'Upload a zipped backup to Confluence', browse to select to the modified space backup. Check the 'Build index' option and select 'Upload & Restore'
- Once the restore process has completed, access the new space and test that you can access pages, embedded links and attachments. Any error in this step indicates that your search and replace was performed incorrectly and you should to retry from step 2
Stage 2: Restore On Production
- Backup your production instance now
- Login to the production instance as a Confluence administrator
- Go to Administration -> Backup & Restore. Under 'Upload a zipped backup to Confluence', browse to select to the modified space backup. Check the 'Build index' option and select 'Upload & Restore' If any data loss occurs as a result of using this workaround, immediately revert to the backup
- Once the restore process has completed, access the new space and test that you can access pages, embedded links and attachments. If any error occurs during this step, revert to the site backup
- If renaming a space, you can delete the old space by going to Browse Space -> Space Admin -> Remove Space. Click OK to remove the old space
Stage 3: Rename Space References
Links in other spaces to the old space will remain unchanged. If you are renaming a space, you will need to change these links to point to the new space. Users who are copying a space can leave the links pointing to the original space by skipping this stage.
Changing these links depends on if you want to change every link, or only some. If not all links must be changed or you are unwilling to stop your production instance, this must be done by editing each page individually. If all links must be changed, follow the instructions below.
- Create a site XML backup including attachments from Administration -> Backup & Restore
- Save the site XML backup file
- Stop the production instance
- Create two copies of the site backup. Keep one copy as the original, unmodified backup, the other will be modified. Rename the backups so that it is clear which is being modified.
- Open the copy for modification and edit entities.xml
- Do four 'Search & Replaces' on each of the references to the old space key as shown below. Swap out oldkey and newkey for the actual keys
Search For |
Replace With |
[oldkey] |
[newkey] |
spaceKey=oldkey |
spaceKey=newkey |
[oldkey: |
[newkey: |
key=oldkey] |
key=newkey] |
- Save the updated entities.xml back into the modified site XML backup file
- Start the production instance
- Import the modified site XML backup from Administration -> Backup & Restore. If you have any problems, revert to the original unmodified backup and redo the links manually instead
Done.
Copy Space Template
There is a feature request being tracked at CONF-4538.
Related
Copy Space Plugin to be released
|