Magento 2 Installation

Install with Composer (preferred method)

1. Open a console window for your server. (Generally this is done via an ssh connection.)
2. In the console window, navigate to your root magento directory.
NOTE: On most systems your magento files will be under 'var/www/html/'. if you aren't sure or the folder is empty, contact your hosting provider to ask what your default web directory is.
3. Next, simply execute the following commands in order.
composer require springbot/magento2-plugin dev-master php bin/magento module:enable Springbot_Queue php bin/magento module:enable Springbot_Main --clear-static-content; php bin/magento setup:upgrade php bin/magento indexer:reindex php bin/magento cache:clean php bin/magento setup:static-content:deploy
4. These commands will download both extensions using composer, enable both extensions, run the magento setup wizard, then re-cache, re-index, and re-deploy any static files for your store.
NOTE: If your store is running in production mode or you know compilation is enabled in the configuration, you will need to re-compile by using the following command.
php bin/magento setup:di:compile


5. Once you have executed all of the commands you should now see a springbot menu in your admin panel. Click this link then select Dashboard.


6. On this page, simply enter your springbot credentials and log in.
7. Once you see the syncing image, everything is complete.

Install with Magento Connect

1. To install using the magento connect method, please navigate to our Magento 2 Extension on the Magento Marketplace.
   
2. From the drop-down on the right, choose your magento edition and version. (we are compatible with almost every version of magento currently available)


3. Click "add to cart"
4. At the top of the page select the cart icon and click "Proceed to Checkout"
5. You will not be charged for our plugins so simply click "place order" and you will be directed to a page with an install button.
6. The install button will lead you to a page that lists two access keys.


7. log in to the magento admin panel
8. In the Magento admin menu, navigate to System -> Web Setup Wizard (under the tools section)


9. You may see a screen requesting you to login with a public/private key. Use the credentials from the magento marketplace page we left open in the previous step.
10. Click extension manager
11. On this page select "review and install" in the middle.
12. The extensions list can be pretty long so you may need to increase the number of results or click through the pages until you see "springbot/magento2-plugin" in the list. Select the version you want and select install. (the most up to date version is selected by default)
13. You should now see a page for installing springbot, simply click readiness check to confirm everything is working before the install.
14. Once the readiness check completes, you are presented with options to backup your files and configurations. It is higly recommended that you make a backup in case anything goes wrong.
NOTE: Depending on the size of your store, this process can take anywhere from minutes to hours.
15. On the next screen simply click install to begin the process.
16. This process can take several minutes but once it completes you should be presented with a success page
17. You should now see a springbot menu in your admin panel. Click this link then select Dashboard.


18. On this page, simply enter your springbot credentials and log in.
19. Once you see the syncing image, everything is complete.

Install Manually

We highly recommend against installing manually whenever possible. We understand that many times this is how an install must be completed, but we strongly encourage everyone to use the composer method outlined above.

1. First you will need download the latest extensions from github. (make sure you download both magento2-plugin and magento2-queue)
2. Unzip the folder(s) and place all plugin files in a folder titled Main and all queue files in a folder titled Queue
NOTE: The names are Case-Sensitive, ensure the folder you create has a capital for the first letter.
3. Open a sftp/ftp connection to your server.
4. If your magento app/ directory doesn't already have a code folder, create one now.
5. Next, under app/code/ create another new folder named Springbot
NOTE: The name is Case-Sensitive, ensure the folder you create has a capital "S" for the first letter.
6. Copy the "Main" and "Queue" folders to app/code/Springbot/
7. Next, open a console window for your server. (Generally this is done via an ssh connection.)
8. In the console window, navigate to your root magento directory.
NOTE: On most systems your magento files will be under 'var/www/html/'. if you aren't sure or the folder is empty, contact your hosting provider to ask what your default web directory is.
9. Next, simply execute the following commands in order.
php bin/magento module:enable Springbot_Queue php bin/magento module:enable Springbot_Main --clear-static-content; php bin/magento setup:upgrade php bin/magento cache:clean php bin/magento indexer:reindex php bin/magento setup:static-content:deploy
10. These commands will enable the plugins, run the magento setup wizard, deploy any static pages or scripts, re-cache, and re-index your store.
NOTE: If your store is running in production mode or you know compilation is enabled in the configuration, you may need to re-compile by using the following command.
php bin/magento setup:di:compile


11. Once you have executed all of the commands you should now see a springbot menu in your admin panel. Click this link then select Dashboard.


12. On this page, simply enter your springbot credentials and log in.
13. Once you see the syncing image, everything is complete.

Update with Composer (preferred method)

1. Open a console window for your server. (Generally this is done via an ssh connection.)
2. In the console window, navigate to your root magento directory.
NOTE: On most systems your magento files will be under 'var/www/html/'. if you aren't sure or the folder is empty, contact your hosting provider to ask what your default web directory is.
• Depending on your setup, you may need to define what version you would like to update to.
• You can run the 'outdated' command to find out what your version is set as.
composer outdated springbot/magento2-plugin
• It should print something like this:


• For this example, our version is set to 1.8, This means that even when we run the update command, you won't download a new version.
NOTE: If you see versions : * dev-master Then you can continue to the next step without having to run the composer require command.
• To fix this, you simply run the following command to set your version as dev-master (This means whatever the latest version is, you will update to that version)
composer require springbot/magento2-plugin dev-master
3. Next, simply execute the following commands in order.
composer update springbot/magento2-plugin php bin/magento setup:upgrade php bin/magento indexer:reindex php bin/magento cache:clean php bin/magento setup:static-content:deploy
4. These commands will download any updates using composer, run the magento setup wizard, then re-cache, and re-index your store.
NOTE: If your store is running in production mode or you know compilation is enabled in the configuration, you may need to re-compile by using the following command.
php bin/magento setup:di:compile

With an update, you shouldn't need to log in again or make any other changes to your configuration.

Update with Magento Connect

1. log in to the magento admin panel
2. In the Magento admin menu, navigate to System -> Web Setup Wizard (under the tools section)

NOTE: You may see a screen requesting you to login with a public/private key. If you're not sure what your credentials for this page are, please see our guide on obtaining magento 2 marketplace credentials.
3. Click extension manager
4. On this page you should see a list of all your installed extensions. look for the springbot extension and select update from the drop down menu on the right


5. You should now be on a page titled Update springbot/magento2-plugin, click Start Readiness Check
6. Once the readiness check completes, you are presented with options to backup your files and configurations. It is highly recommended that you make a backup in case anything goes wrong.
NOTE: Depending on the size of your store, this process can take anywhere from minutes to hours.
7. On step 3, simply click update.
8. This process can take several minutes but once it completes you should be presented with a success page.



With an update, you shouldn't need to log in again or make any other changes to your configuration.

Update Manually

We highly recommend against updating manually whenever possible. We understand that many times this is how an install must be completed, but we strongly encourage everyone to use the composer method outlined above.

This process assumes you have completed your initial install using our manual installation method outlined on this page. If you find that something isn't right or you do not see the files mentioned in this guide, please don't continue and reach out to us for assistance.

1. First you will need download the updated extensions from github.
2. Unzip the folder(s) and place all plugin files in a folder titled Main and all queue files in a folder titled Queue
NOTE: The names are Case-Sensitive, ensure the folder you create has a capital for the first letter.
3. Open a sftp/ftp connection to your server.
4. Copy the "Main" and/or "Queue" folders to app/code/Springbot/ (depending one which plugins you are updating you may need one or both)
NOTE: You will have to override the current files. This is completely normal in the update process.
5. Next, open a console window for your server. (Generally this is done via an ssh connection.)
6. In the console window, navigate to your root magento directory.
NOTE: On most systems your magento files will be under 'var/www/html/'. if you aren't sure or the folder is empty, contact your hosting provider to ask what your default web directory is.
7. Next, simply execute the following commands in order.
php bin/magento setup:upgrade php bin/magento cache:clean php bin/magento indexer:reindex php bin/magento setup:static-content:deploy
8. These commands will run the magento setup wizard, deploy any static pages or scripts, re-cache, and re-index your store.
NOTE: If your store is running in production mode or you know compilation is enabled in the configuration, you may need to re-compile by using the following command.
php bin/magento setup:di:compile

With an update, you shouldn't need to log in again or make any other changes to your configuration.

Uninstall with Composer (preferred method)

1. Open a console window for your server. (Generally this is done via an ssh connection.)
2. In the console window, navigate to your root magento directory.
NOTE: On most systems your magento files will be under 'var/www/html/'. if you aren't sure or the folder is empty, contact your hosting provider to ask what your default web directory is.
3. Next, simply execute the following commands in order.
php bin/magento module:disable Springbot_Main php bin/magento module:disable Springbot_Queue composer remove springbot/magento2-plugin php bin/magento indexer:reindex php bin/magento cache:clean php bin/magento setup:static-content:deploy
4. These commands will disable both extensions, remove all springbot files and folders, then re-cache, re-index, and re-deploy any static files for your store.

Uninstall with Magento Connect

1. log in to the magento admin panel
2. In the Magento admin menu, navigate to System -> Web Setup Wizard (under the tools section)

NOTE: You may see a screen requesting you to login with a public/private key. If you're not sure what your credentials for this page are, please see our guide on obtaining magento 2 marketplace credentials.
3. Click extension manager
4. On this page you should see a list of all your installed extensions. look for the springbot extension and select uninstall from the drop down menu on the right


5. You should now be on a page titled Uninstall springbot/magento2-plugin, click Start Readiness Check
6. Now you are presented with options to backup your files and configurations. It is highly recommended that you make a backup in case anything goes wrong.
NOTE: Depending on the size of your store, this process can take anywhere from minutes to hours.
7. Springbot does not store any data so you can skip the "remove or keep data" step.
8. On step 4, simply click uninstall.
9. This process can take several minutes but once it completes you should be presented with a success page.

Uninstall Manually

You should only uninstall the extension manually if you original installed manually. This guide assumes you followed our previous instructions for installing manually. If you do not see the files it references or the directions don't make sense, we recommend using one of the other 2 methods to remove the extension. For this method, you will need SSH access to the server you have magento running on.

1. Open a console window for your server. (Generally this is done via an ssh connection.)
2. In the console window, navigate to your root magento directory.
NOTE: On most systems your magento files will be under 'var/www/html/'. if you aren't sure or the folder is empty, contact your hosting provider to ask what your default web directory is.
3. Next, simply execute the following commands in order.
php bin/magento module:disable Springbot_Main php bin/magento module:disable Springbot_Queue rm -rf app/code/Springbot php bin/magento indexer:reindex php bin/magento cache:clean php bin/magento setup:static-content:deploy
4. These commands will disable both extensions, remove all springbot files and folders, then re-cache, re-index, and re-deploy any static files for your store.