25 Apr
25Apr

Ready to implement back-in-stock alerts on your Magento 2 store to recapture lost sales and improve customer experience? Getting the extension up and running involves a standard process of installation and configuration. This guide walks you through the typical steps required to install and perform the initial setup for a Magento 2 Out of Stock Notification extension.


Please remember to always consult the official documentation provided by your specific extension vendor, as commands (especially for Composer installation), file paths, and exact configuration options may vary slightly. This guide outlines a common workflow, often similar to processes used by vendors like BSS Commerce.

Phase 1: Pre-Installation Checklist

Before installing any new Magento extension, follow these essential preparatory steps:

  1. Backup Your Store Completely: Create full backups of both your Magento filesystem (codebase) and your database. This is critical for recovery if anything goes wrong.
  2. Check Compatibility & Conflicts: Verify that the extension version is compatible with your Magento version and PHP version. Temporarily disable any other extensions known to potentially conflict.
  3. Disable Magento Cache: It's often recommended to disable caches before installation:php bin/magento cache:disable
  4. (Recommended) Enable Maintenance Mode: Prevent customer access during the installation:php bin/magento maintenance:enable

Phase 2: Installation Process

Choose one of the following installation methods based on your vendor's instructions:

  • Method 1: Composer Installation (Recommended)This is the standard method. You'll need SSH/CLI access to your server.
    1. Navigate to your Magento root directory.
    2. (Vendor Specific) Add the vendor's repository if required (e.g., composer config repositories.vendorname composer https://repo.vendor.com/).
    3. (Vendor Specific) Configure authentication keys if it's a paid extension (e.g., composer config http-basic.repo.vendor.com public_key private_key).
    4. Require the module package (replace with the correct name):composer require vendor/module-stock-notification
    5. Wait for Composer to finish downloading and installing the package.
  • Method 2: Manual Upload
    1. Download the extension's zip file from the vendor.
    2. Unzip the package.
    3. Connect to your server via FTP/SFTP.
    4. Upload the unzipped extension folder into the app/code/[VendorName]/[ModuleName] directory within your Magento installation (create the directories if they don't exist).

Phase 3: Post-Installation Commands

After the extension files are in place, run these essential commands from your Magento root directory via CLI:

  1. php bin/magento setup:upgrade (Registers the module, updates database schemas)
  2. php bin/magento setup:di:compile (Generates dependency injection configurations)
  3. php bin/magento setup:static-content:deploy -f (Deploys static view files; add language locales if needed, e.g., en_US fr_FR)
  4. php bin/magento cache:flush (Clears the Magento cache)

Phase 4: Initial Configuration in Magento Admin

Log in to your Magento Admin Panel to configure the extension's settings:

  1. Locate Configuration: Navigate to Stores > Configuration. Find the extension's settings, usually located under a tab named after the vendor (e.g., BSS Commerce) or under a general service tab.
  2. Enable Module: Find the main switch to enable the extension globally. Set it to "Yes".
  3. Frontend Options:
    • Configure the text for the "Notify Me" button (e.g., "Notify Me When Available", "Email me when back in stock").
    • Decide whether to display the subscription form/button for guest visitors or only logged-in customers. Enabling guest subscriptions is generally recommended to maximize sign-ups.
    • Adjust any styling or placement options available.
  4. Email Settings:
    • Select the transactional Email Sender identity (e.g., Sales, Support) that the notification emails should come from.
    • Choose the correct Email Template for the back-in-stock notification. Most extensions provide a default template you can customize under Marketing > Email Templates. The range and flexibility of options available in these configuration sections often depend heavily on the specific extension you have installed. As we outlined in our guide on "Key Features of an Effective Magento 2 Out of Stock Notification Extension", look for important capabilities like fully customizable email templates, broad product type support (handling Simple, Configurable variants, Grouped, Bundle), guest subscription options, and customer account integration. Ensuring your chosen module possesses these key features during selection allows for more effective and tailored configuration now to meet your specific needs.


  1. Cron Settings:
    • Stock checking and email dispatch rely on Magento's cron jobs running correctly. While cron is configured at the server level, the extension's configuration might provide information or status indicators related to its cron tasks. Ensure your main Magento cron is properly set up and running frequently.
  2. Subscription Management Options:
    • Configure settings related to how customer subscriptions are managed, such as whether customers can view/cancel their subscriptions in their account dashboard.

Phase 5: Testing and Final Steps

  1. Clear Magento Cache: After saving configuration changes, clear the cache again: php bin/magento cache:flush.
  2. Test Extensively!This is crucial.
    • Go to a product page that is out of stock.
    • Test the subscription process as a guest visitor.
    • Test the subscription process as a logged-in customer.
    • Repeat for different product types (Simple, Configurable - try a specific variant, Grouped if applicable).
    • Go to the Magento Admin, update the stock quantity for one of the test products to make it available.
    • Manually run the relevant Magento cron group or wait for it to execute automatically.
    • Check if the notification email is received correctly in the test email inboxes. Check the email content and links.
    • Verify the admin subscription list updates correctly.
    • If applicable, check the customer account section for subscription management.
  3. Disable Maintenance Mode (If Enabled):php bin/magento maintenance:disable
  4. (Optional) Re-enable Cache:php bin/magento cache:enable

By carefully following these installation, command-line, configuration, and thorough testing steps, you can successfully install and configure your Magento 2 Out of Stock extension. Remember that vendor documentation is your primary resource for specific details, and comprehensive testing is non-negotiable to ensure everything works flawlessly before going live. This Magento back in stock setup guide provides a solid foundation for getting started.

Comments
* The email will not be published on the website.
I BUILT MY SITE FOR FREE USING