Importing a file

ConfigPort imports the settings of components, plugins, modules and template styles from a file that ConfigPort exported. A preview shows what the import would do, item by item and setting by setting, before anything changes.

Who can import

Importing needs the Import and restore settings permission. Super Users have it. The permission reaches the settings of every extension on the site, so it is close to Super User for settings. See Permissions.

Upload a file

1. Open Components → ConfigPort → Import.

2. Choose a .configport.json file.

   

3. Click Upload and preview.

The upload form shows the largest file this site accepts. It is the smallest of these limits: 5 MB, the PHP settings upload_max_filesize and post_max_size, and about three quarters of the database setting max_allowed_packet, because the file is stored in the database as base64. Ask your host to raise a PHP or database setting if a file is too large.

The upload refuses a file that is too large, a file that starts with a byte order mark, and a file that is not UTF-8 JSON with an object at the top. The upload form shows the reason.

Any other file is kept and checked as a whole on the preview page. If it is not a ConfigPort file, or a part of it is not valid, the preview lists the problems and their place in the file, and the file cannot be imported.

The uploaded file is kept in the database for 24 hours, for your user only. Cancel deletes it at once.

Read the preview

The preview starts with a summary: the file name, the Joomla version the file comes from, the Joomla version of this site and the number of items in each group.

Each item of the file is in one group:

Open an item to see its settings. The table shows each setting the import would add, change or remove, with its value now and after the import.

Values that look secret are hidden. If this site cannot read the settings form of an item, the preview hides every current value of that item and says so. A setting marked Check: this site only? holds a value that may only make sense on the site the file comes from, such as a web address, a folder or a menu item.

Each item is imported with Merge unless you tick Replace for it. See Merge or replace. Tick Leave this item out for an item you do not want.

Change the choices of an item, then click Check again. The preview changes nothing on this site. When your choices are right, click Continue. See Applying an import.

A file with many items gives a long page. PHP accepts a limited number of fields per form (max_input_vars). If some fields of the page do not reach the server, the preview says that some choices may be lost. Use a smaller file, or ask your host to raise max_input_vars.

Joomla versions

You can import a file from the same Joomla major version or from an older one. For a file from an older major version, the preview warns you to check every item, because extensions can change their settings between major versions.

A file from a newer major version, for example Joomla 6 on a Joomla 5 site, can be previewed but not imported. See Importing older Joomla exports.

Import into one item from its edit screen

The Options screen of a component and the edit screens of plugins, modules and template styles have an Import button. It opens this flow for that one item, with no target to choose. See Quick actions on edit screens.