Maven is the easiest way to install the module. Add the following dependency to your bundle:
The module uses a filter to compress html responses to a minimum size.
The filter is highly configureable. Using bypasses and mappings just about any file could be compressed.
The module provides an additional filter extending from OncePerRequestAbstractMgnlFilter with two additional configurations:
Should the filter compress style blocks within HTML files.
Should the filter compress script blocks within HTML files.
There are four mapping configurations bootstrapped with the filter. These mappings help control which files should be minimized and which files should not be minimized.
extensions: This configuration controls which types of files should be minimized. By default only requests for HTML. Here you can add additional extensions as necessary.
This configuration has a not property reversing the logic and essentially turning the bypass into a mapping. In other words, do not bypass these allowed extensions. This is how to map requests using extension found in the AggregationState.
- admincentral: Requests to
/.magnolia/admincentralare not minimized.
- vaadin-resources: Requests to resources in a VAADIN folder are not minimized.
- minimized: Requests to resources which contain
.min.are not minimized. It's assumed that this is a flag in the filename indicating the file is already in a minimized state. Further processing is not needed.
By default there are not any mappings configured but you can map specific URIs to the filter. For example, rather than use an entire extension to map you can target specific files or folders by using a mapping configuration.
Here is an example using the contact page from the demo site.
- This module is at INCUBATOR level.
- Compression will add more time to the initial request of the page. However, it will reduce the size of the file in the cache.
- Careful when changing mappings. While it's possible to compress any file type in some cases, such as admincentral, minimizing supporting files can break the application.
- Version 5.7 - Initial release of the extensions version of the module.