https://github.com/ostark/craft-relax
Less database I/O - faster Craft sites
https://github.com/ostark/craft-relax
craft-plugin craftcms performance
Last synced: 11 months ago
JSON representation
Less database I/O - faster Craft sites
- Host: GitHub
- URL: https://github.com/ostark/craft-relax
- Owner: ostark
- License: mit
- Created: 2021-12-13T21:46:17.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-18T09:48:48.000Z (about 2 years ago)
- Last Synced: 2024-11-11T17:50:13.696Z (over 1 year ago)
- Topics: craft-plugin, craftcms, performance
- Language: PHP
- Homepage:
- Size: 87.9 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Craft relax! Less database I/O
[](https://packagist.org/packages/ostark/craft-relax)
[](https://packagist.org/packages/ostark/craft-relax)
[](https://plant.treeware.earth/ostark/craft-relax)
The plugin tries to reduce write I/O on the database in multiple ways.
It prevents servers from being overwhelmed by too many queue messages, the search index becomes leaner by skipping useless terms, and deprecation notices are written in dev environments only.
In result the database is more relaxed and can handle more queries faster, which leads to faster sites.
## Installation
You can install the package via composer:
```bash
composer require ostark/craft-relax
php craft plugin/install relax
```
The first time plugin is installed, a config file `config/relax.php` is created. All config settings are documented in this file.
## Update search index
To optimize the search index you need to resave elements. Use the build-in resave commands of the `craft` cli
```
php craft resave/entries --update-search-index
php craft resave/assets --update-search-index
php craft resave/matrix-blocks --update-search-index
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Oliver Stark](https://github.com/ostark)
- [All Contributors](../../contributors)
## License
License: MIT
Please see [License File](LICENSE.md) for more information.