Installation with Composer

Use this guide if you choose to install ConfigBox on the command line using Composer. You also have the option to purchase ConfigBox on the Magento Marketplace and install using the Web Setup Wizard.

For Updates see the Update Help Page.

Pre-Install checklist

  • Check ConfigBox technical requirements prior installation and adapt the server if needed
  • Create a backup of your site before installation
  • Run all composer upgrades and resolve any current issues on your Magento installation
  • Check if your Magento installation runs in developer or production mode - this guide shows installation steps for each mode separately.


Once you know if your site is in Developer or Production mode, pick the guide below:

Installation in Developer Mode


Enable Maintenance Mode

In the Magento 2 root directory, run the following command: 

bin/magento maintenance:enable

Install the ConfigBox module

Note: If you use composer 2 you need to add the line "canonical": false to the repo.magento.com repository settings in Magento's composer.json.

"repositories": [
        {
            "type": "composer",
            "url": "https://repo.magento.com/",
            "canonical": false
        }
    ],


Run the following command in the Magento root directory:

composer require rovexo/configbox-magento2:"^3" -w




Note: If you see warnings like 'Your Magento authentication keys are invalid.' or 'Package … is abandoned..', mind these are not related to ConfigBox. Check with Magento support or your IT service provider to deal with these. The installation of ConfigBox normally isn't affected by these issues.

Run the Magento Setup Routine

Run the following command:

bin/magento setup:upgrade

The above command will enable the rovexo module and runs any necessary setup routines. This command may take a few mins.

Flush the Magento cache

Run the following command:

bin/magento cache:flush

The above command is to clear the cache so that new changes take effect.

Disable Maintenance Mode

Run the following command:

bin/magento maintenance:disable

The above command will disable the maintenance mode and allow users to see the upgraded site.

Summary of the commands to run in Developer Mode

bin/magento maintenance:enable
composer require rovexo/configbox-magento2:"^3" 
php bin/magento setup:upgrade
php bin/magento cache:flush
bin/magento maintenance:disable


Done, you are ready to visit the Magento admin area and navigate to ConfigBox to start the post-installation assistant.


Installation in Production Mode


Enable Maintenance Mode

In the Magento 2 root directory, run the following command: 

bin/magento maintenance:enable

Install the ConfigBox module

Note: If you use Composer 2 you need to add the line "canonical": false to the repo.magento.com repository settings in Magento's composer.json.

"repositories": [
        {
            "type": "composer",
            "url": "https://repo.magento.com/",
            "canonical": false
        }
    ],


Run the following command in the Magento root directory:

composer require rovexo/configbox-magento2:"^3" -w




Note: If you see warnings like 'Your Magento authentication keys are invalid.' or 'Package … is abandoned..', mind these are not related to ConfigBox. Check with Magento support or your IT service provider to deal with these. The installation of ConfigBox normally isn't affected by these issues.

Run the Magento Setup Routine

Run the following command:

bin/magento setup:upgrade

The above command will enable the rovexo module and runs any necessary setup routines. This command may take a few minutes.

Deploy static content

Run the following command:

bin/magento setup:static-content:deploy

The above command is to match the deployed version. This command may take a few minutes.

Flush the Magento cache

Run the following command:

bin/magento cache:flush

The above command is to clear the cache so that new changes take effect.

Disable Maintenance Mode

Run the following command:

bin/magento maintenance:disable

The above command will disable the maintenance mode and allow users to see the upgraded site.

Summary of the commands to run in Production Mode

bin/magento maintenance:enable
composer require rovexo/configbox-magento2:"^3"
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
php bin/magento cache:flush
bin/magento maintenance:disable


Done, you are ready to visit the Magento admin area and navigate to ConfigBox to start the post installation assistant.

Next Steps

Head to the Magento admin area and navigate to ConfigBox to start the post installation assistant.

Troubleshooting

In case any errors, restore the site from your backup and contact your IT service provider.