Installation, configuration, and implementation guide for the Kowal TrustedUs module
Purpose of the module
Kowal TrustedUs is a universal Magento 2 module for presenting companies, customers, partners, suppliers, brands, and case studies in the store.
The module can be used as:
- a 'Trusted Us' section,
- a list of partners or suppliers,
- a project portfolio,
- a case study database,
- a section showing product applications,
- a tool that strengthens internal linking in the store.
After the latest expansion, widgets can lead to internal case study pages, for example:
/trusted-us/vitcas
Such a page displays entries from the same group and the products assigned to them.
Requirements
Before installation, make sure the store meets the requirements:
- runs on Magento 2,
- has access to Composer,
- has access to the module repository,
- has a configured GitHub token if the repository is private,
- can run
bin/magento commands, - has a backup of the code and database before production deployment.
Installation via Composer
1. Adding the Composer repository
In the Magento root directory, run:
composer config repositories.kowal.trusted.us vcs https://github.com/kowalco/trusted-us
2. Adding the access token
If the repository is private, add a GitHub token:
composer config --global --auth github-oauth.github.com
3. Installing the module
composer require kowal/module-trustedus
4. Enabling the module
Magento module name:
Kowal_TrustedUs
Enable the module:
php bin/magento module:enable Kowal_TrustedUs
5. Updating the database schema
php bin/magento setup:upgrade
This command will create or update the module tables, including the group_slug field used for internal case study pages.
6. Clearing cache
php bin/magento cache:flush
Installation in production mode
In a production environment, the standard Magento deployment process is recommended.
Example sequence:
composer require kowal/module-trustedusphp bin/magento module:enable Kowal_TrustedUsphp bin/magento setup:upgrade --keep-generatedphp bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -fphp bin/magento cache:flush
If the store has its own CI/CD pipeline, the steps above should be adjusted to the store’s deployment process.
Updating an existing installation
If the module is already installed, update it via Composer:
composer update kowal/module-trustedus
Then run:
php bin/magento setup:upgradephp bin/magento cache:flush
In production mode:
php bin/magento setup:upgrade --keep-generatedphp bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -fphp bin/magento cache:flush
Configuration in the admin panel
Go to the company list
After installation, go in the Magento panel to:
Content -> Zaufali nam -> Firmy
Depending on the menu configuration, the entry may also be available in the section:
Trusted Us -> Firmy
Adding a company or case study
When adding a new entry, fill in the basic data:
- Company name - the name of the customer, partner, supplier, brand, or project.
- Website address (URL) - optional external address; currently, widgets link internally if the entry has a group slug set.
- Case study group / URL slug - global slug used for grouping entries and building the internal link.
- Project name - the title of the project or descriptive case study.
- Short project description - content displayed with the entry.
- Icon - company or brand logo.
- Active - determines whether the entry is visible on the frontend.
- Show in featured companies widget - determines whether the entry will appear in the featured widget.
- Order - entry sorting.
- Products - products linked with the entry.
Configuring grouping and internal links
The Case study group / URL slug field is used to combine several entries from the same company on one internal page.
Example:
vitcas
All active entries with the same slug will be visible on the page:
/trusted-us/vitcas
If you enter a value with spaces or uppercase letters, the module will save it as a safe slug.
Example:
Tandem Baits
will be saved as:
tandem-baits
Configuring related products
In the Related products / modules section, select the products that should be assigned to a given company, project, or case study.
These relations are used in two places:
- on the product page, where the module can show related companies or projects,
- on the case study page
/trusted-us/{slug}, where products are presented in a grid similar to a product category.
When editing a CMS page, home page, landing page, or CMS block, add the widget:
Kowal: Zaufali nam
Available parameters:
- Title - section heading.
- Limit - maximum number of displayed entries.
- Show project name - whether the project name should be visible under the logo.
If the entry has the group_slug field filled in, clicking the logo leads to the internal page:
/trusted-us/{slug}
If group_slug is empty, the entry remains without a link.
When editing CMS content, add the widget:
Kowal: Zaufali nam - wyróżnione firmy
Available parameters:
- Heading - main section text.
- Limit - maximum number of displayed entries.
The widget shows only active entries that have the following option selected:
Pokaż w widgecie wyróżnionych firm
Just like the standard widget, it can link to internal case study pages based on the group_slug field.
Section on the product page
If a product has assigned companies or case studies, the module can automatically show a section on the product page.
The section presents:
- company logo,
- company name,
- project name,
- short project description.
This makes it possible to show real product usage and strengthen the credibility of the offer.
Case study pages
Case study pages are available at:
/trusted-us/{slug}
Example:
/trusted-us/vitcas
The page displays:
- all active entries with the same
group_slug, - case study descriptions,
- company logo,
- products assigned to each entry,
- a product grid similar to a category grid.
These pages increase the number of internal links and create an additional path:
widget -> case study -> produkt
Support for multiple store views
The module supports store view dependent content for the fields:
- project name,
- short project description.
Global fields, such as company name, logo, activity status, sorting, related products, and group_slug, are shared for the entire entry.
Media directory
Logos are saved in the directory:
pub/media/kowal/trustedus/
Before deployment, make sure the pub/media directory is properly shared or synchronized between environments if the store runs in a multi-server architecture.
Deployment checklist
Before deployment:
- create a database backup,
- create a code backup or make sure the deployment is reproducible from the repository,
- check access to the Composer repository,
- check the GitHub token if required,
- plan a deployment window if the store is running in production.
After deployment:
- run
setup:upgrade, - clear cache,
- in production mode, run DI compilation and static content deployment,
- check whether the module is active,
- add or edit a test company,
- set
group_slug, - assign a product,
- add the widget on a test CMS page,
- click the logo and check the
/trusted-us/{slug} page, - check whether the product grid displays products assigned to the case study,
- check the product page with assigned entries.
Diagnostic commands
Checking module status:
php bin/magento module:status Kowal_TrustedUs
Checking the list of Kowal modules:
php bin/magento module:status | grep Kowal
Clearing cache:
php bin/magento cache:flush
Recompiling DI:
php bin/magento setup:di:compile
Most common issues
Check whether the entry has the field filled in:
Grupa case study / slug URL
An element without group_slug is not linked to an internal page.
The /trusted-us/{slug} page does not work
Check:
- whether an active entry with the given
group_slug exists, - whether
setup:upgrade has been run, - whether cache has been cleared,
- whether the
Kowal_TrustedUs module is active.
Products do not appear on the case study page
Check:
- whether products are assigned to the company entry,
- whether products are active,
- whether products are visible in the catalog or search,
- whether products are available in the current store view.
Changes are not visible after deployment
Clear Magento cache:
php bin/magento cache:flush
In production mode, also run:
php bin/magento setup:di:compilephp bin/magento setup:static-content:deploy -f
Uninstallation
Disabling the module:
php bin/magento module:disable Kowal_TrustedUsphp bin/magento setup:upgradephp bin/magento cache:flush
Removing the Composer package:
composer remove kowal/module-trustedus
Before removing the module from production, check whether the store uses widgets, CMS blocks, or content dependent on the module.