Skip to content

cachetool.md

Latest commit

 

History

History
153 lines (106 loc) · 4.95 KB

cachetool.md

File metadata and controls

153 lines (106 loc) · 4.95 KB

Cachetool Recipe

require 'contrib/cachetool.php';

Source

Configuration

  • cachetool (optional): accepts a string or an array of strings with the unix socket or ip address to php-fpm. If cachetool is not given, then the application will look for a configuration file. The file must be named .cachetool.yml or .cachetool.yaml. CacheTool will look for this file on the current directory and in any parent directory until it finds one. If the paths above fail it will try to load /etc/cachetool.yml or /etc/cachetool.yaml configuration file. 
    set('cachetool', '/var/run/php-fpm.sock');
// or
set('cachetool', '127.0.0.1:9000');
// or
set('cachetool', ['/var/run/php-fpm.sock', '/var/run/php-fpm-other.sock']);

You can also specify different cachetool settings for each host:

host('staging')
    ->set('cachetool', '127.0.0.1:9000');
host('production')
    ->set('cachetool', '/var/run/php-fpm.sock');

By default, if no cachetool parameter is provided, this recipe will fallback to the global setting. If your deployment user does not have permission to access the php-fpm.sock, you can alternatively use the web adapter that creates a temporary php file and makes a web request to it with a configuration like

set('cachetool_args', '--web --web-path=./public --web-url=https://{{hostname}}');

Usage

Since APCu and OPcache deal with compiling and caching files, they should be executed right after the symlink is created for the new release:

after('deploy:symlink', 'cachetool:clear:opcache');
or
after('deploy:symlink', 'cachetool:clear:apcu');

Read more

Read more information about cachetool on the website: http://gordalina.github.io/cachetool/

Configuration

cachetool

Source

Configuration

  • cachetool (optional): accepts a string or an array of strings with the unix socket or ip address to php-fpm. If cachetool is not given, then the application will look for a configuration file. The file must be named .cachetool.yml or .cachetool.yaml. CacheTool will look for this file on the current directory and in any parent directory until it finds one. If the paths above fail it will try to load /etc/cachetool.yml or /etc/cachetool.yaml configuration file. 
    set('cachetool', '/var/run/php-fpm.sock');
// or
set('cachetool', '127.0.0.1:9000');
// or
set('cachetool', ['/var/run/php-fpm.sock', '/var/run/php-fpm-other.sock']);

You can also specify different cachetool settings for each host:

host('staging')
    ->set('cachetool', '127.0.0.1:9000');
host('production')
    ->set('cachetool', '/var/run/php-fpm.sock');

By default, if no cachetool parameter is provided, this recipe will fallback to the global setting. If your deployment user does not have permission to access the php-fpm.sock, you can alternatively use the web adapter that creates a temporary php file and makes a web request to it with a configuration like

set('cachetool_args', '--web --web-path=./public --web-url=https://{{hostname}}');

Usage

Since APCu and OPcache deal with compiling and caching files, they should be executed right after the symlink is created for the new release:

after('deploy:symlink', 'cachetool:clear:opcache');
or
after('deploy:symlink', 'cachetool:clear:apcu');

Read more

Read more information about cachetool on the website: http://gordalina.github.io/cachetool/

cachetool_args

Source

cachetool_version

Source

null

bin/cachetool

Source

Returns Cachetool binary path if found. Otherwise, tries to install Cachetool to .dep/cachetool.phar. :::info Autogenerated The value of this configuration is autogenerated on access. :::

cachetool_options

Source

:::info Autogenerated The value of this configuration is autogenerated on access. :::

Tasks

cachetool:clear:opcache {#cachetool-clear-opcache}

Source

Clears OPcode cache.

Clear opcache cache

cachetool:clear:apcu {#cachetool-clear-apcu}

Source

Clears APCu system cache.

Clear APCu cache

cachetool:clear:stat {#cachetool-clear-stat}

Source

Clears file status and realpath caches.

Clear file status cache, including the realpath cache