Skip to content

Commit 2579385

Browse files
author
Rafael Grigorian
committed
Updated README.md
1 parent c3f8678 commit 2579385

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

README.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,15 @@
1-
# varnish
2-
Magento 2 - Manage Varnish Cache
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.
34

5+
## Installation
46

5-
sudo apachectl restart && sudo pkill varnishd && sleep 2 ; sudo varnishd -a 127.0.0.1:80 -T 127.0.0.1:6082 -f /usr/local/etc/varnish/default.vcl -s file,/tmp,500M
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.
68

7-
varnishadm "vcl.load default /usr/local/etc/varnish/default.vcl"
8-
varnishadm "vcl.use default"
9+
## Command Line Interface
910

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.
1012

11-
varnish:config
12-
varnish:status
13-
varnish:status:set <enable / disable>
14-
varnish:purge:url <url>
15-
varnish:purge:store <store_view_id>
16-
varnish:purge:all
13+
## Things to add in the future
1714

18-
primer:config
19-
primer:status
20-
primer:status:set <enable / disable>
21-
primer:queue
22-
primer:queue:show
23-
24-
25-
26-
THings that need to be added, hole punching based on block path
15+
- Implement varnish hole punching based on block class path

0 commit comments

Comments
 (0)