https://github.com/friendsofshopware/froshtools
A collection of useful tools for Shopware 6
https://github.com/friendsofshopware/froshtools
Last synced: 23 days ago
JSON representation
A collection of useful tools for Shopware 6
- Host: GitHub
- URL: https://github.com/friendsofshopware/froshtools
- Owner: FriendsOfShopware
- License: mit
- Created: 2020-07-21T18:12:58.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T21:07:09.000Z (about 1 month ago)
- Last Synced: 2025-04-12T01:07:42.032Z (23 days ago)
- Language: PHP
- Homepage:
- Size: 8.88 MB
- Stars: 70
- Watchers: 4
- Forks: 30
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Frosh Tools
This plugin contains some utility functions for managing a Shopware 6 shop.
The current feature set consists of:
- **System-Status**
- Checks PHP Version, MySQL, Queue is working etc.
- Checks for performance optimizations and links documentation
- **Cache Manager**
- Lists App and Http Cache and all folders in var/cache
- Clear specific caches
- Compile theme
- **Scheduled Task Manager**
- Shows all Scheduled Tasks and can execute one specific
- Edit interval and next execution
- Register Scheduled Tasks
- **Queue Manager**
- Shows the amount of messages in the queue
- Reset queue
- **Elasticsearch Manager**
- Shows the current status of the Elasticsearch nodes & cluster
- Lists all indices of the Elasticsearch instance
- Quick actions for index handling
- Execute Elasticsearch console commands
- **Log Viewer**
- Shows the entries of /var/log/*.log files
- **Shopware File Checker**
- Checks if core files have been changed
- **State Machine Viewer**
- basic view of order, transaction and delivery states
- **Override system config by config files**
- Overwrite any system config value with static or environment values
## Installation
### Git
- Clone this repository into custom/plugins of your Shopware 6 installation
- Install composer dependencies `shopware-cli extension prepare custom/plugins/FroshTools`
- Build the assets with `shopware-cli extension build custom/plugins/FroshTools`
### Packagist
composer require frosh/tools
### Store (Bearer token required from packages.shopware.com)
composer require store.shopware.com/froshtools
## Commands
### `frosh:env:list` - Listing of all environment variables
```bash
bin/console frosh:env:list
```
Lists as json output:
```bash
bin/console frosh:env:list --json
```
### `frosh:env:get` - Get environment variables
```bash
bin/console frosh:env:get APP_URL
http://localhost
```
```bash
bin/console frosh:env:get APP_URL --key-value
APP_URL=http://localhost
```
```bash
bin/console frosh:env:get APP_URL --json
{
"APP_URL": "http:\/\/localhost"
}
```
### `frosh:env:set` - Set environment variables
```bash
bin/console frosh:env:set VARIABLE VALUE
```
### `frosh:env:del` - Delete environment variables
```bash
bin/console frosh:env:del VARIABLE
```
### `frosh:dev:robots-txt` - For testshops - add/change robots.txt to stop crawlers
```bash
bin/console frosh:dev:robots-txt
```
### `frosh:dev:robots-txt -r` - For testshops - revert changes in robots.txt
```bash
bin/console frosh:dev:robots-txt -r
```
### `frosh:plugin:update` - update plugins with available updates at once
```bash
bin/console frosh:plugin:update
```
### `frosh:composer-plugin:update` - update plugins managed by composer
```bash
bin/console frosh:composer-plugin:update
```
### `frosh:user:change:password` - updates user password
```bash
bin/console frosh:user:change:password []
```
### `frosh:monitor` - Monitor your scheduled tasks and queue with this command and get notified via email.
```bash
bin/console frosh:monitor
```
## Suppress files from being restorable in FileChecker
```yaml
# config/packages/frosh_tools.yaml
frosh_tools:
file_checker:
exclude_files:
- vendor/shopware/core/FirstFile.php
- vendor/shopware/core/SecondFile.php
```
## Override system_config with config files
```yaml
# config/packages/frosh_tools.yaml
frosh_tools:
system_config:
default:
core.listing.allowBuyInListing: true
```
The key `default` is the sales channel scope, default is `null` which is the global scope. You can specify a specific salesChannelId to overwrite the value
```yaml
# config/packages/frosh_tools.yaml
frosh_tools:
system_config:
default:
core.listing.allowBuyInListing: true
# Disable it for the specific sales channel
0188da12724970b9b4a708298259b171:
core.listing.allowBuyInListing: false
```
As it is a normal Symfony config, you can of course use also environment variables
```yaml
# config/packages/frosh_tools.yaml
frosh_tools:
system_config:
default:
core.listing.allowBuyInListing: '%env(bool:ALLOW_BUY_IN_LISTING)%'
```
```
# .env.local
ALLOW_BUY_IN_LISTING=true
```
## Screenshots
