|
26 | 26 | <h3>Set Caching Application<span><?= $enabled ? "Complete" : "Pending" ?></span></h3> |
27 | 27 | <p>The current caching application is set to <code><?= $enabled ? "Varnish Cache" : "Built-In Cache" ?></code>.</p> |
28 | 28 | <p> |
29 | | - On this step, we change the default caching application from Magento's Built-In Cache to Varnish Cache. |
| 29 | + The default caching application needs to be changed from Magento's Built-In Cache to Varnish Cache. |
30 | 30 | This change can be made through the <b>Command-Line</b> or <b>Magento Admin Dashboard</b>. |
31 | 31 | </p> |
32 | 32 | <div class="tray-labels" > |
|
44 | 44 | This can be done by navigating to <a href="<?= $block->getUrl ("adminhtml/system_config/edit/section/system") ?>" target="_blank" >Stores ❯ Settings ❯ Configuration ❯ Advanced ❯ System</a> ❯ Full Page Cache ❯ Caching Application. |
45 | 45 | Once there you can change the caching application from <b>Built-In Cache</b> to <b>Varnish Cache</b>. |
46 | 46 | </p> |
| 47 | + <img src="<?= $block->getViewFileUrl ("JetRails_Varnish::images/step-1.gif") ?>" /> |
47 | 48 | </div> |
48 | 49 | </fieldset> |
49 | 50 | </div> |
|
53 | 54 | <fieldset class="method-container" > |
54 | 55 | <h3>Configure Varnish Server(s)<span><?= $edited ? "Complete" : "Pending" ?></span></h3> |
55 | 56 | <p> |
56 | | - On this step, we will configure the available Varnish server(s). |
| 57 | + We need to configure our Varnish server(s). |
57 | 58 | This change can be made through the <b>Command-Line</b> or <b>Env Config File</b>. |
58 | 59 | </p> |
59 | 60 | <table> |
|
107 | 108 | <div class="card <?= $installed ? "done" : "" ?>" data-section="Download Custom VCL" > |
108 | 109 | <div class="methods" > |
109 | 110 | <fieldset class="method-container" > |
110 | | - <h3>Install Varnish Config File<span><?= $installed ? "Complete" : "Pending" ?></span></h3> |
| 111 | + <h3>Install Varnish Configuration File<span><?= $installed ? "Complete" : "Pending" ?></span></h3> |
| 112 | + <p> |
| 113 | + Each configured Varnish server needs to have their configuration file (usually found in <code>/etc/varnish/default.vcl</code>) updated. Once updated, the Varnish service on said server needs to be restarted so our configuration changes can be put into place. Generating the configuration contents can be done via <b>Command-Line</b> or <b>Admin-Dashboard</b>. |
| 114 | + </p> |
111 | 115 | <table> |
112 | 116 | <tr> |
113 | 117 | <th width="33.33%" >Varnish Server</th> |
|
148 | 152 | <div class="tray" data-tray="dashboard" > |
149 | 153 | <p> |
150 | 154 | This can be done by navigating to <a href="<?= $block->getUrl ("adminhtml/system_config/edit/section/system") ?>" target="_blank" >Stores ❯ Settings ❯ Configuration ❯ Advanced ❯ System</a> ❯ <b>Full Page Cache</b> ❯ <b>Varnish Configuration</b>. |
151 | | - Once there you can configure your desired backend and download the VCL under <b>Export Configuration</b>. |
| 155 | + Once there you can configure your desired backend and download the configuration file by clicking <b>Export Configuration</b>. |
152 | 156 | </p> |
| 157 | + <img src="<?= $block->getViewFileUrl ("JetRails_Varnish::images/step-3.gif") ?>" /> |
153 | 158 | </div> |
154 | 159 | </fieldset> |
155 | 160 | </div> |
|
161 | 166 | <p>Currently debug mode is <b><?= $debug ? "Enabled" : "Disabled" ?></b>.</p> |
162 | 167 | <p> |
163 | 168 | When Debug Mode is enabled, extra HTTP parameter will be sent in the response header of every page. |
164 | | - These parameters will be prefixed with <code>JR-</code>. |
165 | | - In addition to exclusion rule debug headers being present, the following will also be present: |
166 | | - <ul> |
167 | | - <li><code>JR-Hit-Miss</code>, will either be <b>HIT</b> or <b>MISS</b></li> |
168 | | - <li><code>JR-Hit-Count</code>, will display the number of hits in cache</li> |
169 | | - <li><code>JR-Current-Url</code>, will display the current page's full URL that is used with exclusion rules</li> |
170 | | - <li><code>JR-Current-Path</code>, will display the current page's URL path that is used with exclusion rules</li> |
171 | | - <li><code>JR-Current-Route</code>, will display the current page's route that is used with exclusion rules</li> |
172 | | - </ul> |
| 169 | + These parameters will be prefixed with <code>JR-</code>. You can see these response headers by opening the dev-console in your favorite browser. |
173 | 170 | </p> |
174 | 171 | <form method="post" action="<?= $block->getUrl ('varnish/configuration/save') ?>" > |
175 | 172 | <?php echo $block->getBlockHtml ("formkey") ?> |
176 | 173 | <input type="hidden" name="debug" value="<?= $debug ? "disable" : "enable" ?>" /> |
177 | 174 | <button type="submit" ><span><?= $debug ? "Disable" : "Enable" ?></span></button> |
178 | 175 | </form> |
| 176 | + <div class="tray-labels" > |
| 177 | + <div data-tray="more-info" >More-Info<span>▸</span></div> |
| 178 | + </div> |
| 179 | + <div class="tray" data-tray="more-info" > |
| 180 | + <p> |
| 181 | + In addition to exclusion rule debug headers being present, the following will also be present: |
| 182 | + <ul> |
| 183 | + <li><code>JR-Hit-Miss</code>, will either be <b>HIT</b> or <b>MISS</b></li> |
| 184 | + <li><code>JR-Hit-Count</code>, will display the number of hits in cache</li> |
| 185 | + <li><code>JR-Current-Url</code>, will display the current page's full URL that is used with exclusion rules</li> |
| 186 | + <li><code>JR-Current-Path</code>, will display the current page's URL path that is used with exclusion rules</li> |
| 187 | + <li><code>JR-Current-Route</code>, will display the current page's route that is used with exclusion rules</li> |
| 188 | + </ul> |
| 189 | + </p> |
| 190 | + <img src="<?= $block->getViewFileUrl ("JetRails_Varnish::images/dev-console.gif") ?>" /> |
| 191 | + </div> |
179 | 192 | </fieldset> |
180 | 193 | </div> |
181 | 194 | </div> |
|
0 commit comments