Product Attachments

Add downloadable files and links (manuals, data sheets, certificates, size charts, videos) to your products. They are listed in a Downloads tab on Luma and a Downloads section on Hyvä, with optional sign-in, customer group and buyers-only restrictions. This guide covers installation, configuration and day-to-day use.

• Demo (Luma): https://demo.softawarecommerce.com/fusion-backpack.html (Downloads tab)
• Demo (Hyvä): https://demo.softawarecommerce.com/hyva/fusion-backpack.html
• Admin demo: https://demo.softawarecommerce.com/try-admin/product-attachments
• Changelog: Release notes · Questions: FAQ

1. Requirements

The checkout is not changed.

2. Installation

Install with Composer from the SoftAware Commerce repository. The access keys are in your account; see Composer access.

composer config repositories.softaware composer https://repo.softawarecommerce.com
composer config --auth http-basic.repo.softawarecommerce.com PUBLIC_KEY PRIVATE_KEY
composer require softaware/module-product-attachments
bin/magento setup:upgrade
bin/magento setup:di:compile            # production mode only
bin/magento setup:static-content:deploy # production mode only
bin/magento cache:flush

Hyvä: the module registers itself for Hyvä's Tailwind build (view/frontend/tailwind/tailwind-source.css). After installing, rebuild your theme CSS (npm run build in the theme's web/tailwind folder). Luma loads its own small CSS file.

To update later: composer update softaware/module-product-attachments, then the same bin/magento commands.

3. Quick start

1. Go to Softaware > Product Attachments > Manage Attachments and click Add New Attachment.
2. Enter a Title (shown to customers), choose Source: File upload and upload a PDF.
3. Under Visibility, keep All Store Views and leave Customer Groups empty for everybody.
4. Under Products and Categories, enter one or more SKUs or choose a category.
5. Click Save Attachment and open one of the products: the file is in the Downloads tab.

4. Managing attachments

Softaware > Product Attachments > Manage Attachments lists every attachment with its file or URL (with type icon and size), type, status, the products and categories it is assigned to, Sign-in Required, Show to Buyers, sort order, number of downloads and the last update. Mass actions: Enable, Disable and Delete (deleting an attachment also deletes its stored file).

Attachment settings

Visibility

Products and Categories

5. Assigning attachments to products

Besides the SKU list and categories in the attachment form, there are two more ways:

Product edit form. Catalog > Products > edit a product > Attachments shows the attachments assigned directly to the product. Add Existing Attachments opens a grid to pick from; drag rows to change their order and click Remove to unassign one. Under New Files, Upload New File lets you add a title and a file; the attachment is created and assigned when you save the product. Attachments assigned through categories are shown on the storefront too, but are managed under Softaware > Product Attachments.

Product grid. Select products in Catalog > Products, open Actions and choose Assign Attachment or Remove Attachment, then the attachment. Remove Attachment only removes direct assignments.

6. What your customers see

Product page. On Luma the files are in a tab (default title "Downloads") in the product details tabs; on Hyvä they are in a Downloads section of the product details. Each file shows its icon, title, type and size (for example "PDF, 471 KB") and the description. Files that need sign-in show "Sign in to download"; buyers-only files show "For customers who have bought this product".

Downloads. Clicking a file opens productattachments/download/file/id/<id>. The controller checks that the attachment is enabled and visible in the store view, the customer group, sign-in and (for buyers-only files) the purchase, adds one to the download counter and then streams the file or redirects to the external URL. Guests who need to sign in are sent to the sign-in page.

My Account. Product Downloads lists the attachments marked Show to Buyers or Only Customers Who Bought the Product for every product the customer has ordered (cancelled orders are left out), grouped by product.

Order emails. When Add Download Links to Order Emails is on, the "Show to Buyers" attachments are listed below the items in order confirmation emails. Files that need sign-in still ask guests to sign in.

Mobile. The file cards stack into one column on phones (Luma left, Hyvä right):

7. Configuration

Stores > Configuration > Softaware > Product Attachments (also under Softaware > Product Attachments > Configuration).

General (default, website and store view scope)

File Uploads (default scope)

Downloads for Bought Products (default, website and store view scope)

8. Files and security

• Uploaded files are stored in var/softaware_attachments with random names, outside the public web root. The real path is never shown; direct requests to the storage folder are not possible.
• Script and executable types are always rejected on upload, whatever the allowed list says, for example php, phtml, phar, html, htm, svg, js, xml, exe, sh, bat, jar, msi and dll.
• Download file names keep letters outside ASCII; quotes, semicolons and control characters are replaced.
• A daily cron job (03:40, softaware_product_attachments_cleanup) removes abandoned uploads older than a day.

9. Command line

bin/magento softaware:product-attachments:list                # all attachments with assignments and download counts
bin/magento softaware:product-attachments:list --sku=24-MB02  # only attachments of one product (direct or via category)
bin/magento softaware:product-attachments:cleanup --dry-run   # list abandoned uploads and stored files no attachment uses
bin/magento softaware:product-attachments:cleanup             # delete them

10. Permissions (ACL)

In System > Permissions > User Roles > Role Resources:

11. Troubleshooting

12. Uninstall

bin/magento module:disable Softaware_ProductAttachments
composer remove softaware/module-product-attachments
bin/magento setup:upgrade

The tables softaware_product_attachment, softaware_product_attachment_store, softaware_product_attachment_customer_group, softaware_product_attachment_product and softaware_product_attachment_category and the files in var/softaware_attachments (and custom icons in pub/media/softaware/attachments/icons) are not deleted by these commands; remove them by hand if you no longer need them.