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.
Once you know if your site is in Developer or Production mode, pick the guide below:
In the Magento 2 root directory, run the following command:
bin/magento maintenance:enable
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 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.
Run the following command:
bin/magento cache:flush
The above command is to clear the cache so that new changes take effect.
Run the following command:
bin/magento maintenance:disable
The above command will disable the maintenance mode and allow users to see the upgraded site.
bin/magento maintenance:enable |
Done, you are ready to visit the Magento admin area and navigate to ConfigBox to start the post-installation assistant.
In the Magento 2 root directory, run the following command:
bin/magento maintenance:enable
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 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.
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.
Run the following command:
bin/magento cache:flush
The above command is to clear the cache so that new changes take effect.
Run the following command:
bin/magento maintenance:disable
The above command will disable the maintenance mode and allow users to see the upgraded site.
bin/magento maintenance:enable |
Done, you are ready to visit the Magento admin area and navigate to ConfigBox to start the post installation assistant.
Head to the Magento admin area and navigate to ConfigBox to start the post installation assistant.
In case any errors, restore the site from your backup and contact your IT service provider.