|
1 | | -Magento 2 - Varnish Module |
2 | | -============================= |
3 | | -This module helps manage varnish cache for your Magento 2 store. It supports a multiple varnish server configuration. Purge requests can be sent to all these servers in order to purge a specific URL, a whole store view, or simply to purge all the cache that is contained in said varnish server. |
| 1 | +# Magento 2 - Varnish |
| 2 | +> Magento 2 extension which interfaces with the Varnish caching application in order to manage it through the Magento backend |
4 | 3 |
|
5 | | -## Installation |
| 4 | + |
| 5 | + |
| 6 | + |
6 | 7 |
|
7 | | -To install, look into the 'releases' tab and download the version that you want. Alternatively, the latest version should be packaged in the __dist__ folder of this repository. Simply place that file in the base install directory of your Magento store and unzip the contents of that folder. Finally, run `php ./bin/magento setup:upgrade` inside your base Magento install directory. This will configure the module and everything should be installed after the command finished running. |
| 8 | +<p align="center" > |
| 9 | + <img src="docs/images/preview.png" width="100%" /> |
| 10 | +</p> |
8 | 11 |
|
9 | | -## Command Line Interface |
| 12 | +## About |
10 | 13 |
|
11 | | -Please run `php ./bin/magento list` inside your base install directory of your Magento store. Once the command runs, look under the __varnish__ category. There you will find all the possible CLI commands that can be run along with a description of what each one does. |
| 14 | +This module helps manage varnish cache for your Magento 2 store. It supports a multiple varnish server configuration. Purge requests can be sent to all these servers in order to purge a specific URL, a whole store view, or simply to purge all the cache that is contained in said varnish server. Additionally, the purge process can be executed automatically on product or CMS page save. Cache exclusion rules can be set to not cache paths or Magento routes. Finally, there exists a _debug_ mode that will display if Varnish FPC was used in loading the page and which exclusion rules should be blamed if the page is excluded. |
12 | 15 |
|
13 | | -## Things to add in the future |
| 16 | +## Documentation |
14 | 17 |
|
15 | | -- Implement varnish hole punching based on block class path |
| 18 | +A user guide can be found in the [docs](docs) folder. The information there goes over all the features that the extension offers. It also takes you through the installation and configuration process of setting this extension up. |
| 19 | + |
| 20 | +## Build System |
| 21 | + |
| 22 | +All JetRails® modules use __Grunt__ as a build system. Grunt is a package that can be easily downloaded using __NPM__. Once this repository is cloned, run `npm install grunt -g` followed by `npm install` to install Grunt and all Grunt modules used within this build system. Please refer to the following table for a description of some useful grunt build commands. A typical grunt command takes the following form: `grunt task:argument`. |
| 23 | + |
| 24 | +| Task | Description | |
| 25 | +|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 26 | +| `version` | Updates the version number in all __php__ and __xml__ files with the one defined in __package.json__. | |
| 27 | +| `release` | This command first runs __init__ and then __resolve__. It then compresses the source and dependencies and outputs the archive in __dist__. This command gets the repo ready for a git commit. | |
| 28 | +| `deploy` | Will upload dependencies and source code to a staging server. Credentials to this server can be configured in the __package.json__ file under the _staging_ attribute. | |
| 29 | +| `stream` | Will watch the __lib__ and __src__ folders for any changes. Once a change occurs it will run the __deploy__ task. | |
| 30 | +| | The default task is aliased to run the __release__ task. | |
| 31 | + |
| 32 | +## Docker Environment |
| 33 | + |
| 34 | +This project comes with a [docker-compose.yml](docker-compose.yml) file, which can be used to spin up a Magento CE 1.x environment. In order to use docker, please make sure you have **Docker** and **Docker Compose** installed. For information about configuring this docker environment, please refer to it's Github repository which can be found [here](https://github.com/jetrails/docker-magento). |
0 commit comments