Skip to content

Commit 9d9d8bf

Browse files
authored
Merge pull request #307 from skokhan-x/master
Rename HTCache to "full .htaccess caching" in documentation
2 parents 34a84ad + 43ee6da commit 9d9d8bf

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/cloudlinuxos/shared-pro/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1293,7 +1293,7 @@ This design eliminates per-request regex compilation in `.htaccess`, resulting i
12931293
12941294
AccelerateWP uses this module to serve the correct static page without invoking PHP or writing complex RewriteRule-based configurations. This document summarizes the module's directives and describes how any page cache plugin can integrate with the same capabilities.
12951295
1296-
The module includes two independent subsystems: **cache serving** (serves pre-generated static HTML files, bypassing PHP) and **HTCache** (caches parsed `.htaccess` files in shared memory, eliminating per-request disk I/O). Both are included in the same `ea-apache24-mod_maxcache` package and can be enabled independently.
1296+
The module includes two independent subsystems: **cache serving** (serves pre-generated static HTML files, bypassing PHP) and **full .htaccess caching** (caches parsed `.htaccess` files in shared memory, eliminating per-request disk I/O). Both are included in the same `ea-apache24-mod_maxcache` package and can be enabled independently.
12971297
12981298
:::warning Note:
12991299
MAx Cache is currently supported on cPanel control panels only.
@@ -1312,11 +1312,11 @@ yum install ea-apache24-mod_maxcache --enablerepo=cl-ea4-testing
13121312
13131313
| Package | Description |
13141314
| --- | --- |
1315-
| `ea-apache24-mod_maxcache` | Apache module with cache serving and HTCache subsystems |
1315+
| `ea-apache24-mod_maxcache` | Apache module with cache serving and full .htaccess caching subsystems |
13161316
| `maxcache-htcache-watchd` | Filesystem watcher daemon for real-time `.htaccess` change detection |
13171317
| `libmaxcache` | Shared C library for device detection, WebP, cookie/QS handling |
13181318
1319-
After installation, the HTCache subsystem is enabled by default (`MaxCacheHTCache On`) and the `maxcache-htcache-watchd` daemon is automatically started and enabled on boot.
1319+
After installation, the full .htaccess caching subsystem is enabled by default (`MaxCacheHTCache On`) and the `maxcache-htcache-watchd` daemon is automatically started and enabled on boot.
13201320
13211321
### MAx Cache Activation Guide
13221322
@@ -1898,19 +1898,19 @@ MAx Cache will not work in AccelerateWP when:
18981898
* Using the AccelerateWP PHP filter to replace dots with underscores.
18991899
* Using the AccelerateWP PHP filter forces the full path to cache files instead of using DOCUMENT_ROOT.
19001900
1901-
### HTCache (.htaccess caching)
1901+
### Full .htaccess caching
19021902
1903-
HTCache is the second subsystem of `mod_maxcache`. It caches parsed `.htaccess` files in shared memory, so Apache does not re-read and re-parse them from disk on every request. On shared-hosting servers with thousands of sites, this eliminates thousands of `stat()` and `open()` syscalls per second.
1903+
Full .htaccess caching is the second subsystem of `mod_maxcache`. It caches parsed `.htaccess` files in shared memory, so Apache does not re-read and re-parse them from disk on every request. On shared-hosting servers with thousands of sites, this eliminates thousands of `stat()` and `open()` syscalls per second.
19041904
1905-
HTCache benefits **all** `.htaccess`-heavy sites regardless of whether MAx Cache page caching is enabled.
1905+
Full .htaccess caching benefits **all** `.htaccess`-heavy sites regardless of whether MAx Cache page caching is enabled.
19061906
19071907
#### How it works
19081908
1909-
By default, Apache re-reads and re-parses `.htaccess` files from disk on every request. On shared-hosting servers with thousands of sites, this creates significant disk I/O overhead. HTCache parses each `.htaccess` once (on first request) and stores the result in shared memory so all Apache workers can reuse it without touching the disk again. The cache populates lazily as traffic arrives.
1909+
By default, Apache re-reads and re-parses `.htaccess` files from disk on every request. On shared-hosting servers with thousands of sites, this creates significant disk I/O overhead. Full .htaccess caching parses each `.htaccess` once (on first request) and stores the result in shared memory so all Apache workers can reuse it without touching the disk again. The cache populates lazily as traffic arrives.
19101910
19111911
#### Change detection
19121912
1913-
HTCache detects `.htaccess` changes through two mechanisms:
1913+
Full .htaccess caching detects `.htaccess` changes through two mechanisms:
19141914
19151915
| Mode | Detection latency | When active |
19161916
| --- | --- | --- |
@@ -1927,14 +1927,14 @@ On CloudLinux 9+ (kernel 5.14+), all change types — including deletes, renames
19271927
19281928
#### Configuration directives
19291929
1930-
All HTCache directives go inside `<IfModule mod_maxcache.c>` in the Apache configuration. HTCache is configured in `/etc/apache2/conf.d/maxcache_htcache.conf`.
1930+
All full .htaccess caching directives go inside `<IfModule mod_maxcache.c>` in the Apache configuration. Full .htaccess caching is configured in `/etc/apache2/conf.d/maxcache_htcache.conf`.
19311931
19321932
#### MaxCacheHTCache
19331933
19341934
* **Syntax**: `MaxCacheHTCache On|Off`
19351935
* **Default**: On (in shipped config)
19361936
* **Context**: server config, virtual host
1937-
* **Description**: Master enable/disable switch for the HTCache subsystem.
1937+
* **Description**: Master enable/disable switch for the full .htaccess caching subsystem.
19381938
19391939
#### MaxCacheHTCacheRevalidateInterval
19401940
@@ -1965,7 +1965,7 @@ All HTCache directives go inside `<IfModule mod_maxcache.c>` in the Apache confi
19651965
* **Syntax**: `MaxCacheHTCacheExclude <path> [path2] ...`
19661966
* **Default**: none
19671967
* **Context**: server config, virtual host
1968-
* **Description**: Exclude directory trees from HTCache. The path is matched as a prefix.
1968+
* **Description**: Exclude directory trees from full .htaccess caching. The path is matched as a prefix.
19691969
* **Example**:
19701970
```
19711971
MaxCacheHTCacheExclude /home/staging /tmp
@@ -1977,7 +1977,7 @@ MaxCacheHTCacheExclude /home/staging /tmp
19771977
* **Default**: 256
19781978
* **Range**: 0–10240
19791979
* **Context**: server config, virtual host
1980-
* **Description**: Maximum `.htaccess` file size (in KB) that HTCache will process. Files exceeding this limit are skipped and served via Apache's standard processing. Set to `0` for unlimited.
1980+
* **Description**: Maximum `.htaccess` file size (in KB) that full .htaccess caching will process. Files exceeding this limit are skipped and served via Apache's standard processing. Set to `0` for unlimited.
19811981
19821982
#### MaxCacheHTCacheMaxEntriesPerDocroot
19831983
@@ -1995,7 +1995,7 @@ MaxCacheHTCacheExclude /home/staging /tmp
19951995
MaxCacheHTCache On
19961996
```
19971997
1998-
Enables HTCache globally with default settings (50,000 max entries, 60-second revalidation).
1998+
Enables full .htaccess caching globally with default settings (50,000 max entries, 60-second revalidation).
19991999
20002000
##### Production shared hosting
20012001
@@ -2021,7 +2021,7 @@ For a server with ~5,000 WordPress sites:
20212021
</VirtualHost>
20222022
```
20232023
2024-
##### Disable HTCache for a specific vhost
2024+
##### Disable full .htaccess caching for a specific vhost
20252025
20262026
Enable globally but opt out specific vhosts:
20272027
@@ -2038,7 +2038,7 @@ MaxCacheHTCache On
20382038
20392039
#### Status endpoint
20402040
2041-
HTCache provides a status handler for monitoring. To enable it, add a `<Location>` block to your Apache configuration:
2041+
Full .htaccess caching provides a status handler for monitoring. To enable it, add a `<Location>` block to your Apache configuration:
20422042
20432043
```
20442044
<Location /htcache-status>
@@ -2086,12 +2086,12 @@ Key fields to check:
20862086
20872087
| Field | Healthy value | Problem indicator |
20882088
| --- | --- | --- |
2089-
| Enabled | `yes` | `no` — HTCache is turned off in config |
2089+
| Enabled | `yes` | `no` — full .htaccess caching is turned off in config |
20902090
| Ready | `yes` | `no` — engine failed to initialize |
20912091
| Entries | below max | at max — increase `MaxCacheHTCacheEntries` |
20922092
| Arena usage | below 90% | above 90% — increase `MaxCacheHTCacheMemorySize` |
20932093
| Invalidation SHM | `connected` | `not available` — watchd is not running or SHM file is missing |
2094-
| Hits | increasing | staying at 0 — HTCache is not serving cached results |
2094+
| Hits | increasing | staying at 0 — full .htaccess caching is not serving cached results |
20952095
20962096
:::warning
20972097
The status endpoint should be restricted to localhost or trusted IPs. Remove or restrict the `<Location>` block in production.

0 commit comments

Comments
 (0)