m2-setup-wizard

Magento 2 Extension for adding Web Setup Wizard

The idea behind this module/extension is to fix issue with missing Web Wizard button when static files are served from pub/ folder and when Nginx as a web server is used. After installation button is located at the CONTENT --> Custom Tools section within Dashboard.

--Installing the Extension--

While you're free to manually install the webwizard extension (and the use of the app/code folder structure supports this -- pleaese download and upload webwizard.tar archive or simply clone this GitHub repostiory directly), we recommend using Magento's PHP composer integration to install the extension (https://getcomposer.org/). All Magento 2 systems have a composer.json file, and this file is how developers and Magento Marketplace users get new packages in and out of their system.

Installing the extension is a X step process:

1. Add this GitHub repository to your project as a composer repository
2. Add the Neman/Webwizard composer package to your project
3. Update your project's composer dependencies
4. Install the downloaded package via Magento's standard command line tool

--Quick Start-- After backing up your composer.json file

cp composer.json composer.json.bak

Then Run
composer config repositories.neman vcs https://github.com/nemke82/m2-setup-wizard
composer require neman/webwizard --no-update
composer update neman/webwizard

Note: Now if you see message "Could not find package neman/webwizard at any version for your minimum-stability (alpha). Check the package spelling or your minimum-stability", edit composer.json file and change:

FROM: "minimum-stability": "alpha",

TO: "minimum-stability": "dev",

Does not happen often, but this is a fix.

--FINAL STEPS--

1. composer require neman/webwizard
   
2. php bin/magento module:enable Neman_Webwizard
   
3. php bin/magento setup:upgrade
   

After running the above, the Neman/Webwizard extension will be installed, and ready for configuration.

You may at any time run the following command to update module/extension version:
composer update neman/webwizard

Updates any composer packages that match the string neman/webwizard. This is what triggers the download of the Neman/Webwizard extension source code to app/code/Neman directory.

Things after module is enabled needs to be done:

1. php bin/magento cache:clean
2. php bin/magento cache:flush
3. rm -rf var/di/* var/generation/* var/cache/* var/log/* var/page_cache/*
4. php bin/magento setup:static-content:deploy

NOTE: YOU NEED TO SYMLINK setup/ and update/ folder from folder where your script is settled to pub/ folder, you can follow my example here with full paths:
ln -s /home/nemanja/public_html/setup /home/nemanja/public_html/pub/
ln -s /home/nemanja/public_html/update /home/nemanja/public_html/pub/

** Adjust paths with the real one used **

Important: Changing a Magento system running in production is not a recommended practice. Depending on your system software, or other running extensions, running setup:upgrade may trigger undesired behaviors. As will installing any new software on your system, don't forget to take appropriate backup steps, and to test your new module in a development or staging enviornment before deploying to production.