bitegoDocs

Install, Upgrade, Uninstall the SnipWire Module Last update: 2020-03-04 15:59:26

The SnipWire plugin consists of 4 different modules: SnipWire (main module), ProcessSnipWire (admin area), MarkupSnipWire (product and cart rendering) and FieldtypeSnipWireTaxSelector. When the main module is installed, all other modules are automatically installed as well.

In addition to the 4 module packages you also need to install the Snipcart products package!
The products package contains product templates, files, fields and some demo pages required to build a Snipcart product catalogue. This additional step is needed to prevent unintended deletion of your Snipcart products catalogue when the main module is uninstalled. These resources need to be removed manually if you like to completely uninstall SnipWire!

To install the additional products package open the SnipWire module config page and click the Install Snipcart products package link under Additional Steps section.

SnipWire can be installed using one of the following methods

Add Module From Directory (recommended)

  1. Visit the ProcessWire admin area and select menu Modules > New.
  2. Scroll down to the section Add Module From Directory.
  3. Enter the module class name SnipWire and hit the Get Module Info button.
  4. On the following page hit the Download Now button and next Install Now.

Add Module From URL

  1. Visit the ProcessWire admin area and select menu Modules > New.
  2. Scroll down to the section Add Module From URL.
  3. Enter the SnipWire download link (GitHub master): https://github.com/gadgetto/SnipWire/archive/master.zip and hit Download button.
  4. After this, visit the ProcessWire Admin area and select menu Modules > Install.
  5. Look for the module SnipWire and hit the Install button.

Add Module From Upload

  1. Download the package via GitHub.
  2. Visit the ProcessWire Admin area and select menu Modules > New.
  3. Scroll down to the section Add Module From Upload.
  4. In the form upload field select the previously downloaded SnipWire zip file and hit the Upload button.
  5. After this, visit the ProcessWire Admin area and select menu Modules > Install.
  6. Look for the module SnipWire and hit the Install button.

Copying Package Files Manually

  1. Download the package via GitHub.
  2. Unpack the zip file and upload the module files to the /site/modules/SnipWire/ directory within your webspace.
  3. After this, visit the ProcessWire Admin area and select menu Modules > Install.
  4. Look for the module SnipWire and hit the Install button.

Install via Git Clone

  1. On command line go to your /site/modules/ directory.
  2. Type the following: git clone https://github.com/gadgetto/SnipWire.git
  3. Log in to your ProcessWire admin and go to the Modules page.
  4. Click the Refresh button. New modules are now listed under Recently Found and Installed Modules.
  5. Look for the module SnipWire and hit the Install button.

How to Upgrade SnipWire

The easiest way to stay up-to-date with SnipWire versions is to install the ProcessWire Upgrade module. This module will notify you when there are upgrades to SnipWire and provide a link to automatically upgrade.

Beside this you can upgrade by following the same processes as in described installation methods: Add Module From URL, Add Module From Upload, Copying Package Files Manually and Install via Git Clone.

How to Uninstall SnipWire

Uninstalling the main SnipWire module will also uninstall all dependent modules - ProcessSnipWire, MarkupSnipWire, FieldtypeSnipWireTaxSelector.
To preserve the full products catalogue and products data, all fields with the custom field type FieldtypeSnipWireTaxSelector are converted to FieldtypeText on uninstall. If yo want to reinstall SnipWire and reuse your previous products catalogue, you simply need to change the taxes field back to FieldtypeSnipWireTaxSelector.
  1. Log in to your ProcessWire admin and select menu Modules.
  2. Find and click the module name SnipWire. The module config page will open.
  3. Scroll down and expand the Uninstall section, check the Uninstall checkbox.
  4. Click the Submit button.

It is now safe to completely remove the SnipWire module folder from /site/modules/.