lowolf/phpCacheAdmin

A web dashboard for your favorite caching system.

Installation

Simply extract the content. If you use the defaults, everything should work out of the box.

To customize the configuration file, do not edit config.dist.php directly, but copy it into config.php.

Optional but highly recommended, run composer install before use.

Updating

Replace all files and delete the tmp folder (this folder contains only compiled Twig templates).

Docker

https://hub.docker.com/r/robinn/phpcacheadmin

Run with single command:

docker run -p 8080:80 -d --name phpcacheadmin -e "PCA_REDIS_0_HOST=redis_host" -e "PCA_REDIS_0_PORT=6379" -e "PCA_MEMCACHED_0_HOST=memcached_host" -e "PCA_MEMCACHED_0_PORT=11211" robinn/phpcacheadmin

Or simply use it in docker-compose.yml

version: '3'
services:
  phpcacheadmin:
    image: robinn/phpcacheadmin
    ports:
      - "8080:80"
    #volumes:
    # If you want to use config.php instead of ENV variables
    #  - "./config.php:/var/www/html/config.php"
    environment:
      - PCA_REDIS_0_HOST=redis
      - PCA_REDIS_0_PORT=6379
      - PCA_MEMCACHED_0_HOST=memcached
      - PCA_MEMCACHED_0_PORT=11211
    links:
      - redis
      - memcached
  redis:
    image: redis
  memcached:
    image: memcached

Note

It is not required to have both Redis and Memcached.

Environment variables

Redis:

PCA_REDIS_0_NAME The server name (optional).
PCA_REDIS_0_HOST Optional when a path is specified.
PCA_REDIS_0_PORT Optional when the default port is used.
PCA_REDIS_0_SCHEME Connection scheme (optional).
PCA_REDIS_0_SSL SSL options for TLS - requires Redis >= 6.0 (optional). You can set value as JSON {"local_cert":"path/to/redis.crt","local_pk":"path/to/redis.key","cafile":"path/to/ca.crt","verify_peer_name":false}.
PCA_REDIS_0_DATABASE Default database (optional).
PCA_REDIS_0_USERNAME ACL - requires Redis >= 6.0 (optional).
PCA_REDIS_0_PASSWORD Optional.
PCA_REDIS_0_AUTHFILE File with a password, e.g. Docker secrets (optional).
PCA_REDIS_0_PATH Unix domain socket (optional).
PCA_REDIS_0_DATABASES Number of databases, use this if the CONFIG command is disabled (optional).
PCA_REDIS_0_SCANSIZE Number of keys, the server will use the SCAN command instead of KEYS (optional).

Memcached:

PCA_MEMCACHED_0_NAME The server name (optional).
PCA_MEMCACHED_0_HOST Optional when a path is specified.
PCA_MEMCACHED_0_PORT Optional when the default port is used.
PCA_MEMCACHED_0_PATH Unix domain socket (optional).

To add another server, add the same environment variables, but change 0 to 1 (2 for third server and so on).

All keys from the config file are supported ENV variables, they just must start with PCA_ prefix.

Requirements

PHP >= 7.4
redis, memcache(d), opcache or apcu php extensions
Redis server >= 3.0.0
Memcached server >= 1.4.31 If you do not see the keys, you need to enable lru_crawler. (SASL is not supported because there is no way to get the keys.)

Note

For better performance, always use extensions, however:

If the Redis extension is not installed, the system will use a Predis client (if you are using composer, install Predis manually via composer require predis/predis).

If the Memcache(d) extension is not installed, the system will use a custom PHPMem client.

Custom Dashboards

FileCache (robinn/cache) dashboard.

Testing

PHPUnit

composer test

PHPStan

composer phpstan

Development

For compiling Tailwind CSS run npm install and then npm run build or npm run watch for auto-compiling.

lowolf / phpCacheAdmin