Skip to content
Snippets Groups Projects
README.md 2.52 KiB
Newer Older
Pietsch, Martin's avatar
Pietsch, Martin committed
## Description

This role installs, enables and configures the PHP module `apcu`.
Pietsch, Martin's avatar
Pietsch, Martin committed

## Requirements

### Variables

* php_mod_apcu_enabled
  * description:
    * This option enables or disables the APC.
  * choices: [false, true]
  * default: true

* php_mod_apcu_shm_segments
  * description:
    * This option specifies the number of shared memory segments to allocate for the compiler cache.
  * default: 1

* php_mod_apcu_shm_size
  * description:
    * This option specifies the size of each shared memory segment given.
  * default: "32M"

* php_mod_apcu_entries_hint
  * description:
    * This option specifies a "hint" about the number of distinct variables that might be stored.
  * default: 4096

* php_mod_apcu_ttl
  * description:
    * This option specifies the number of seconds a cache entry is allowed to idle in a slot in case this cache entry slot is needed by another entry.
  * default: 0

* php_mod_apcu_gc_ttl
  * description:
    * This option specifies the number of seconds that a cache entry may remain on the garbage-collection list.
  * default: 3600

* php_mod_apcu_mmap_file_mask
  * description:
    * This option specifies the mktemp-style file_mask to pass to the mmap module for determining whether your mmap'ed memory region is going to be file-backed or shared memory backed.  
  * default: ""

* php_mod_apcu_slam_defense
  * description:
    * This option sets the percentage of processes that will skip trying to cache an uncached file.
    * Setting this to 0 disables this feature.
    * Setting this to 75 would mean that there is a 75% chance that the process will not cache an uncached file.
  * default: 1

* php_mod_apcu_enable_cli
  * description:
    * This option enables the APC for the CLI version of PHP.
  * choices: [false, true]
  * default: false

* php_mod_apcu_use_request_time
  * description:
    * This option specifies the use of the SAPI request start time for TTL.  
  * choices: [false, true]
  * default: false

* php_mod_apcu_serializer
  * description:
    * This option is used to configure APC to use a third party serializer.
  * default: "php"

* php_mod_apcu_coredump_unmap
  * description:
    * This option enables APC handling of signals, such as SIGSEGV, that write core files when signaled.
  * choices: [false, true]
  * default: false

* php_mod_apcu_preload_path
  * description:
    * This option set a path to the directory that APC will load cache data at startup.
  * default: ""

Pietsch, Martin's avatar
Pietsch, Martin committed
## Processes

None

## License

BSD-3-Clause

## Contributors 

- Martin Pietsch \<martin.pietsch@tu-dresden.de\>