PHPackages fahlgrendigital/packages-statamic-cache-server - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Caching](/categories/caching) 4. / 5. fahlgrendigital/packages-statamic-cache-server ActiveLibrary[Caching](/categories/caching) fahlgrendigital/packages-statamic-cache-server ============================================== Configure statamic application as a cache building server v1.0.4(2y ago)035PHPPHP ^8.2 Since Feb 13Pushed 2y ago5 watchersCompare [ Source](https://github.com/FahlgrenMortineDigital/packages-statamic-cache-server)[ Packagist](https://packagist.org/packages/fahlgrendigital/packages-statamic-cache-server)[ RSS](/packages/fahlgrendigital-packages-statamic-cache-server/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (3)Versions (10)Used By (0) Statamic Cache Server ===================== [](#statamic-cache-server) This package allows for configuration of a Statamic application to act as a caching server for page content. Installation ------------ [](#installation) ``` composer require fahlgrendigital/packages-statamic-cache-server ``` ``` php artisan vendor:publish --provider=FahlgrendigitalPackages\StatamicCacheServer\CacheServerProvider ``` ### Servers [](#servers) This package expects there to be a minimum of two servers: - Application server - Caching server Both servers should have access to the same source of truth for content, images and cache stores. The details of what this means will be outlined later in this documentation. ### Dev Ops [](#dev-ops) The above servers also need to sit behind an [Application Load Balancer](https://aws.amazon.com/elasticloadbalancing/features/)which functions different then a [Network Load Balancer](https://aws.amazon.com/elasticloadbalancing/features/). AWS has the ability to easily spin up ALBs for your EC2 instances. Usage ----- [](#usage) This package expects two types of utilization depending on the static caching strategy configured in the Statamic `static_caching` configuration: - half - full Depending on the strategy your application is using, the caching server will function a bit differently. Those differences will be outlined in the following sections. Before going into the strategy-specific details, we'll cover how the cache server package works in general. ### Overview [](#overview) This overview will cover the following high-level functions: - [Kick off](#kick-off) - [Cache building](#cache-building) - [Cache transfer](#cache-transfer) #### Kick Off [](#kick-off) ``` php artisan fm:static:warm ``` This package has a command which acts as the ignition for the content caching process. That command mimics most of the built-in Statamic cache-warming command `php please static:warm --user={username} --password={password} --queue`. The signature looks like the following: > This command accepts the same arguments as the core Statamic command. > It is recommended to run this request from the application server rather than the cache server to save server resources for solely building the cache. **Note:** This command does not clear the static cache beforehand. It is up to the caller to clear that cache, and it is highly recommended to do this otherwise the static cache will be built off of already-cached pages. This custom command improves on the base static:warm command by batching the page requests when the `--queue` flag is used. It also improves on the `--queue` option by making sure to pass in the user/password params into the Guzzle request. The native Statamic command does not do this. When the custom command is run, it kicks off a job which essentially just visits the configured page on the site, thereby triggering a cache of that page. This is where the magic of the cache server kicks in. > The batch containing all of the page requests has the following name: Statamic Custom FM Static Cache Warm **Page Requests** Page requests for the following content types are done by default in this command: - Entries - Taxonomies - Terms - Custom routes - Custom runway routes **Note:** The runway routes can be configured at `cache-server.include.runway` by supplying an array of Runway resource Models. It would look something like this: ``` 'include' => [ \App\Models\Product::class ] ``` #### Cache Building [](#cache-building) In order for page requests to be routed to the cache server instead of your application server, your ALB must be configured to route cache requests properly. This package allows for a customizable header to be sent with all your cache requests which you can use in your ALB to properly route requests. ``` 'header' => env('CACHE_SERVER_HEADER', 'X-Cache-Trigger') ``` You may also configure the expected header values for filtering and security in your ALB. ``` 'triggers' => [ CacheHeader::BUILD => env('CACHE_SERVER_HEADER_BUILD', CacheHeader::BUILD), CacheHeader::STATIC_CLEAR => env('CACHE_SERVER_HEADER_STATIC_CLEAR', CacheHeader::STATIC_CLEAR), ], ``` > The default values for build and static-clear are `build` and `static-clear`, respectively. **Cache Response** When the cache server detects a request for a page, it responds to the page like any other page, but at the end of the request this package has a terminable middleware which handles additional caching logic, particularly for the `full` caching strategy. **Half** Statamic includes [documentation](https://statamic.dev/static-caching#application-driver) on how this strategy works. See their documentation for more details. **Full** Statamic includes [documentation](https://statamic.dev/static-caching#file-driver) on how this strategy works. See their documentation for more details. #### Cache Transfer [](#cache-transfer) > This section only applies when using the `full` strategy as it generates flat html files which your web server will serve up. Once a page has been visited and a cache entry & flat file have been confirmed for that request, this package fires off two jobs in a chain which do the following in order: - Send the flat file to the configured remote store - Trigger the application server to download that flat file to its configured static cache file path Architecture ------------ [](#architecture) Getting the most out of this package will require some testing to see what server architecture works best for your situation. Whatever architecture is chosen, this package has some limitations which need to be taken into consideration: ### Limitations [](#limitations) - A central, remote cache store that the application and cache servers share. - A central, remote image store that the application and cache servers share. - A central DB that the application and cache servers share for content (if you are leveraging a DB for content storage) ### Recommendations [](#recommendations) **Cache** Statamic allows for the configuration of targeted redis database connections for storing things like: application cache, horizon data, pulse data, and glide data. Segmenting your data will make it easier to manage. > Recommendation: Redis **Images** When the caching server is building the cache, it will trigger glide image transformations and those glide images (and cached paths) need to be accessible to the application and cache servers. That's why it is necessary to have a central store for these images. > Recommendation: S3 ### DB Setup [](#db-setup) If your Statamic application is leveraging a DB to store content, that DB will need to be accessible by the application and cache servers. **Cache Queue** The cache server leverages the database queue connection type to manage the jobs responsible for uploading and triggering static cache file downloads after a successful page cache. To avoid conflicting database connections between the cache and application servers, it is highly recommend to set up a specific database connection for the cache server queue. Can be done by specifying a missing configuration within the `queue` configuration. Add the following line to the database queue connection: ``` 'connections' => [ 'database' => [ 'connection' => env('QUEUE_DB_CONNECTION', 'mysql'), // add this line 'driver' => 'database', 'table' => 'jobs', 'queue' => 'default', 'retry_after' => 90, 'after_commit' => false, ], ] ``` The `QUEUE_DB_CONNECTION` value will need to point to a specific database connection on the **cache server only**. For example if it is called `queue-mysql`, then in your `database` config the following section will need to be added: ``` 'connections' => [ 'queue-mysql' => [ 'driver' => 'mysql', 'url' => env('DATABASE_URL'), 'host' => env('QUEUE_DB_HOST', '127.0.0.1'), 'port' => env('QUEUE_DB_PORT', '3306'), 'database' => env('QUEUE_DB_DATABASE', 'forge'), 'username' => env('QUEUE_DB_USERNAME', 'forge'), 'password' => env('QUEUE_DB_PASSWORD', ''), 'unix_socket' => env('QUEUE_DB_SOCKET', ''), 'charset' => 'utf8mb4', 'collation' => 'utf8mb4_unicode_ci', 'prefix' => '', 'prefix_indexes' => true, 'strict' => true, 'engine' => null, 'options' => extension_loaded('pdo_mysql') ? array_filter([ PDO::MYSQL_ATTR_SSL_CA => env('MYSQL_ATTR_SSL_CA'), ]) : [], ], ] ``` **Failed Jobs Table** Similar to the specific queue db connection settings, a connection for the failed jobs table will need to be established so the correct application reruns those failed jobs. Within the `queue` config modify the following lines to point to the connection you configured in the above section: ``` 'failed' => [ 'driver' => env('QUEUE_FAILED_DRIVER', 'database-uuids'), 'database' => env('QUEUE_DB_CONNECTION', 'queue-mysql'), 'table' => 'failed_jobs', ], ``` **Migrations Note:** If your cache servers need to share a DB connection with the main application server for content, the `migrations` table will be shared as well. This means that the necessary `jobs` table required when using the database connection can get a bit squirrely. This table only needs to exist on the cache server. Depending on when and how your `php artisan migrate` is run that `jobs` table may end up on the wrong server and in the wrong database. Currently, we don't have an elegant solution for this other than export the `jobs` schema and importing it into the correct queue database. After fixing the location of this table, the cache queue should run as expected. SORRY! ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity7 Limited adoption so far Community9 Small or concentrated contributor base Maturity59 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 9 Last Release 814d ago Major Versions v0.0.4 → v1.0.02024-02-14 ### Community Maintainers ![](https://www.gravatar.com/avatar/60dfacae6ab4f80fadfea286b16ad311302ccef2c53d687b25248d242c4b0541?d=identicon)[fahlgren](/maintainers/fahlgren) --- Top Contributors [![panda4man](https://avatars.githubusercontent.com/u/3106756?v=4)](https://github.com/panda4man "panda4man (21 commits)") ### Embed Badge ![Health badge](/badges/fahlgrendigital-packages-statamic-cache-server/health.svg) ``` [![Health](https://phpackages.com/badges/fahlgrendigital-packages-statamic-cache-server/health.svg)](https://phpackages.com/packages/fahlgrendigital-packages-statamic-cache-server) ``` ### Alternatives [spatie/laravel-responsecache Speed up a Laravel application by caching the entire response 2.8k8.2M51](/packages/spatie-laravel-responsecache)[genealabs/laravel-model-caching Automatic caching for Eloquent models. 2.4k4.8M26](/packages/genealabs-laravel-model-caching)[mikebronner/laravel-model-caching Automatic caching for Eloquent models. 2.4k127.1k1](/packages/mikebronner-laravel-model-caching)[illuminate/cache The Illuminate Cache package. 12835.6M1.4k](/packages/illuminate-cache)[laragear/cache-query Remember your query results using only one method. Yes, only one. 272122.8k](/packages/laragear-cache-query)[namoshek/laravel-redis-sentinel An extension of Laravels Redis driver which supports connecting to a Redis master through Redis Sentinel. 38679.0k](/packages/namoshek-laravel-redis-sentinel) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)