Apache Module mod_cache

Директива CacheDefaultExpire

CacheDefaultExpire seconds

CacheDefaultExpire 3600 (one hour)

Директива CacheDefaultExpire указывает время по умолчанию (в секундах) для кэширования документа, если ни дата истечения срока, ни дата последнего изменения не указаны в документе. Значение, указанное с помощью директивы CacheMaxExpire , не переопределяет это значение.

CacheDefaultExpire 86400

Директива CacheDetailHeader

CacheDetailHeader on|off

CacheDetailHeader off

При включенной директиве CacheDetailHeader, в ответ будет добавлен заголовок X-Cache-Detail, содержащий подробное объяснение причины конкретного решения о кэшировании.

Это может быть полезно во время разработки кэшированных RESTful-сервисов для получения дополнительной информации о решении о кэшировании в заголовках ответа, чтобы подтвердить, что Cache-Control и другие заголовки были правильно использованы сервисом и клиентом.

Если используется обычный обработчик, эта директива может находиться в директиве <Directory> или <Location>. Если используется быстрый обработчик, эта директива должна находиться в контексте сервера или виртуального хоста, иначе настройка будет проигнорирована.

# Enable the X-Cache-Detail header
CacheDetailHeader on

X-Cache-Detail: "conditional cache hit: entity refreshed" from localhost

Директива CacheDisable

CacheDisable url-string | on

Директива CacheDisable указывает mod_cache не кэшировать URL-адреса на уровне и ниже url-string.

CacheDisable "/local_files"

Если используется в директиве <Location>, путь должен быть указан ниже Location, или, если используется слово "on", кэширование для всего расположения будет отключено.

<Location "/foo">
    CacheDisable on
</Location>

Переменная среды no-cache может быть установлена для отключения кэширования на более детальном уровне ресурсов в версиях 2.2.12 и более поздних.

См. также

• Переменные среды в Apache

Директива CacheEnable

CacheEnable cache_type [url-string]

Директива CacheEnable указывает mod_cache кэшировать URL-адреса на уровне и ниже url-string. Менеджер кэш-хранилища задается аргументом cache_type. Директива CacheEnable может быть альтернативно помещена в разделы <Location> или <LocationMatch> для указания кешируемости содержимого. cache_type disk указывает mod_cache использовать менеджер хранения на диске, реализованный mod_cache_disk. cache_type socache указывает mod_cache использовать менеджер хранения на основе кэша общих объектов, реализованный mod_cache_socache.

В случае перекрытия пространства URL-адресов между различными директивами CacheEnable (как в примере ниже), каждый возможный менеджер хранения будет запущен, пока не будет найден первый, который действительно обработает запрос. Порядок запуска менеджеров хранения определяется порядком директивы CacheEnable в файле конфигурации. Директивы CacheEnable в разделах <Location> или <LocationMatch> обрабатываются до глобально определенных директивы CacheEnable.

При работе как прокси-сервера, url-string должен, по меньшей мере, начинаться с протокола, для которого должно быть включено кэширование.

# Cache content (normal handler only)
CacheQuickHandler off
<Location "/foo">
    CacheEnable disk
</Location>

# Cache regex (normal handler only)
CacheQuickHandler off
<LocationMatch "foo$">
    CacheEnable disk
</LocationMatch>

# Cache all but forward proxy url's (normal or quick handler)
CacheEnable  disk  /

# Cache FTP-proxied url's (normal or quick handler)
CacheEnable  disk  ftp://

# Cache forward proxy content from www.example.org (normal or quick handler)
CacheEnable  disk  http://www.example.org/

Имя хоста, начинающееся с "*", соответствует всем именам хостов с таким суффиксом. Имя хоста, начинающееся с ".", соответствует всем именам хостов, содержащим следующие компоненты домена.

# Match www.example.org, and fooexample.org
CacheEnable  disk  "http://*example.org/"
# Match www.example.org, but not fooexample.org
CacheEnable  disk  "http://.example.org/"

Переменная среды no-cache может быть установлена для отключения кэширования на более детальном уровне ресурсов в версиях 2.2.12 и более поздних.

См. также

• Переменные среды в Apache

Директива CacheHeader

CacheHeader on|off

CacheHeader off

При включенной директиве CacheHeader, в ответ будет добавлен заголовок X-Cache со статусом кэша этого ответа. Если используется обычный обработчик, эта директива может находиться в директиве <Directory> или <Location> . Если используется быстрый обработчик, эта директива должна находиться в контексте сервера или виртуального хоста, иначе настройка будет проигнорирована.

HIT

Сущность была актуальной и была получена из кэша.

REVALIDATE

Сущность была устаревшей, успешно перевалидирована и была получена из кэша.

MISS

Сущность была получена с сервера-источника и не была получена из кэша.

# Enable the X-Cache header
CacheHeader on

X-Cache: HIT from localhost

Директива CacheIgnoreCacheControl

CacheIgnoreCacheControl On|Off

CacheIgnoreCacheControl Off

В обычном режиме запросы, содержащие заголовок Cache-Control: no-cache или Pragma: no-cache, не будут выведены из кэша. Директива CacheIgnoreCacheControl позволяет переопределить это поведение. CacheIgnoreCacheControl On указывает серверу попытаться вывести ресурс из кэша, даже если запрос содержит заголовки no-cache. Ресурсы, требующие авторизации, никогда не будут кэшироваться.

CacheIgnoreCacheControl On

См. также

• CacheStorePrivate
• CacheStoreNoStore

Директива CacheIgnoreHeaders

CacheIgnoreHeaders header-string [header-string] ...

CacheIgnoreHeaders None

Согласно RFC 2616, заголовки HTTP, передаваемые поэтапно, не сохраняются в кэше. Следующие заголовки HTTP являются такими заголовками и, следовательно, не сохраняются в кэше в любом случае, независимо от настроек CacheIgnoreHeaders:

• Connection
• Keep-Alive
• Proxy-Authenticate
• Proxy-Authorization
• TE
• Trailers
• Transfer-Encoding
• Upgrade

CacheIgnoreHeaders указывает дополнительные HTTP-заголовки, которые не должны сохраняться в кэше. Например, в некоторых случаях имеет смысл предотвратить сохранение cookie в кэше.

CacheIgnoreHeaders принимает список HTTP-заголовков, разделенных пробелами, которые не должны сохраняться в кэше. Если необходимо сохранить только заголовки, передаваемые поэтапно (соответствующее поведению RFC 2616), CacheIgnoreHeaders может быть установлено на None.

CacheIgnoreHeaders Set-Cookie

CacheIgnoreHeaders None

Директива CacheIgnoreNoLastMod

CacheIgnoreNoLastMod On|Off

CacheIgnoreNoLastMod Off

Обычно документы без даты последнего изменения не кешируются. В некоторых случаях дата последнего изменения удаляется (например, во время обработки mod_include ) или вообще не предоставляется. Директива CacheIgnoreNoLastMod предоставляет способ указать, что документы без дат последнего изменения должны рассматриваться для кеширования, даже без даты последнего изменения. Если ни дата последнего изменения, ни дата срока действия не указаны для документа, то значение, заданное директивой CacheDefaultExpire, будет использовано для генерации даты срока действия.

CacheIgnoreNoLastMod On

Директива CacheIgnoreQueryString

CacheIgnoreQueryString On|Off

CacheIgnoreQueryString Off

Обычно запросы со строками запроса кешируются отдельно для каждой уникальной строки запроса. Это выполняется согласно RFC 2616/13.9 только если указано время срока действия. Директива CacheIgnoreQueryString сообщает кешу о кешировании запросов даже если время срока действия не указано и отвечает кэшированным ответом, даже если строка запроса отличается. С точки зрения кеширования запрос обрабатывается как если бы у него не было строки запроса, когда эта директива включена.

CacheIgnoreQueryString On

Директива CacheIgnoreURLSessionIdentifiers

CacheIgnoreURLSessionIdentifiers identifier [identifier] ...

CacheIgnoreURLSessionIdentifiers None

Иногда приложения кодируют идентификатор сеанса в URL, как в следующих примерах:

• /someapplication/image.gif;jsessionid=123456789
• /someapplication/image.gif?PHPSESSIONID=12345678

Это приводит к тому, что кешируемые ресурсы хранятся отдельно для каждой сессии, чего часто нежелательно. CacheIgnoreURLSessionIdentifiers позволяет определить список идентификаторов, которые удаляются из ключа, используемого для идентификации объекта в кэше, таким образом, кешируемые ресурсы не хранятся отдельно для каждой сессии.

CacheIgnoreURLSessionIdentifiers None очищает список игнорируемых идентификаторов. В противном случае каждый идентификатор добавляется в список.

CacheIgnoreURLSessionIdentifiers jsessionid

CacheIgnoreURLSessionIdentifiers None

Директива CacheKeyBaseURL

CacheKeyBaseURL URL

Когда указана директива CacheKeyBaseURL, указанный URL будет использоваться в качестве базового URL для расчета URL ключей кеша в конфигурации обратного прокси. Если не указано, то схема, имя хоста и порт текущего виртуального хоста используются для построения ключа кеша. Когда присутствует кластер машин и все кэшированные записи должны быть кэшированы под одним ключом кеша, с помощью этой директивы можно указать новый базовый URL.

# Override the base URL of the cache key.
CacheKeyBaseURL "http://www.example.com/"

Директива CacheLastModifiedFactor

CacheLastModifiedFactor float

CacheLastModifiedFactor 0.1

В случае, если документ не предоставляет дату срока действия, но предоставляет дату последнего изменения, дату срока действия можно рассчитать на основе времени, прошедшего с момента последнего изменения документа. Директива CacheLastModifiedFactor указывает коэффициент, который будет использоваться для генерации этой даты срока действия по следующей формуле: expiry-period = time-since-last-modified-date * factor expiry-date = current-date + expiry-period Например, если документ был изменен 10 часов назад, а коэффициент равен 0,1, то период срока действия будет установлен на 10*0,1 = 1 час. Если текущее время было 15:00, то вычисленная дата срока действия будет 15:00 + 1 час = 16:00. Если период срока действия будет больше, чем тот, который задан CacheMaxExpire, то последний имеет приоритет.

CacheLastModifiedFactor 0.5

Директива CacheLock

CacheLock on|off

CacheLock off

Директива CacheLock включает блокировку thundering herd для заданного URL-пространства.

В минимальной конфигурации следующая директива необходима для включения блокировки thundering herd в стандартный системный временный каталог.

# Enable cache lock
CacheLock on

Директива CacheLockMaxAge

CacheLockMaxAge integer

CacheLockMaxAge 5

Директива CacheLockMaxAge указывает максимальный срок действия любой блокировки кеша.

Блокировка, старше этого значения в секундах, будет проигнорирована, и следующий входящий запрос получит возможность повторно установить блокировку. Этот механизм предотвращает медленный клиент, тратящий чрезмерное время на обновление сущности.

Директива CacheLockPath

CacheLockPath directory

CacheLockPath /tmp/mod_cache-lock

Директива CacheLockPath позволяет указать каталог, в котором создаются блокировки. По умолчанию используется временная папка системы. Блокировки представляют собой пустые файлы, которые существуют только для устаревших URL, находящихся в процессе обработки, поэтому они значительно менее ресурсоемки, чем традиционный кэш диска.

Директива CacheMaxExpire

CacheMaxExpire seconds

CacheMaxExpire 86400 (one day)

Директива CacheMaxExpire указывает максимальное количество секунд, в течение которых кешируемые HTTP-документы будут сохраняться без проверки сервера источника. Таким образом, документы могут быть неактуальны не более чем на это количество секунд. Это максимальное значение применяется даже если с документом была предоставлена дата срока действия.

CacheMaxExpire 604800

Директива CacheMinExpire

CacheMinExpire seconds

CacheMinExpire 0

Директива CacheMinExpire указывает минимальное количество секунд, в течение которых кешируемые HTTP-документы будут храниться без проверки сервера источника. Это используется только в том случае, если с документом не было предоставлено действительное время срока действия.

CacheMinExpire 3600

Директива CacheQuickHandler

CacheQuickHandler on|off

CacheQuickHandler on

Директива CacheQuickHandler управляет фазой обработки кеша.

В стандартной включенной конфигурации кеш работает в фазе быстрого обработчика. Эта фаза обходит большую часть обработки сервера и представляет собой наиболее производительный режим работы для типичного сервера. Кэш встраивается в начало сервера, и большая часть обработки сервера избегается.

При отключении кеш работает как обычный обработчик и подчиняется полному набору фаз при обработке запроса сервера. Хотя этот режим медленнее, чем по умолчанию, он позволяет использовать кэш в случаях, когда требуется полная обработка, например, когда контент подвержен авторизации.

# Run cache as a normal handler
CacheQuickHandler off

Также при отключенном быстром обработчике администратор может выбрать точное место в цепочке фильтров, где должно выполняться кеширование, добавив фильтр CACHE в цепочку.

# Cache content before mod_include and mod_deflate
CacheQuickHandler off
AddOutputFilterByType CACHE;INCLUDES;DEFLATE text/html

Если фильтр CACHE указан более одного раза, применяется последний экземпляр.

Директива CacheStaleOnError

CacheStaleOnError on|off

CacheStaleOnError on

Когда директива CacheStaleOnError включена и устаревшие данные доступны в кэше, кэш будет отвечать на ответы 5xx от бэкенда, возвращая устаревшие данные вместо ответа 5xx. Хотя заголовки Cache-Control, отправленные клиентами, будут соблюдаться, и исходные ответы 5xx будут возвращены клиенту по запросу, возвращаемый клиенту ответ 5xx не будет делать недействительным содержимое в кэше.

# Serve stale data on error.
CacheStaleOnError on

Директива CacheStoreExpired

CacheStoreExpired On|Off

CacheStoreExpired Off

Начиная с httpd 2.2.4, ответы, которые уже истекли, не сохраняются в кэше. Директива CacheStoreExpired позволяет переопределить это поведение. CacheStoreExpired Включение позволяет серверу пытаться кэшировать ресурс, если он устарел. Последующие запросы будут вызывать запрос If-Modified-Since к исходному серверу, и ответ может быть выполнен из кэша, если ресурс на бэкенде не изменился.

CacheStoreExpired On

Директива CacheStoreNoStore

CacheStoreNoStore On|Off

CacheStoreNoStore Off

Обычно запросы или ответы с заголовками Cache-Control: no-store не сохраняются в кэше. Директива CacheStoreNoStore позволяет переопределить это поведение. CacheStoreNoStore Включение позволяет серверу пытаться кэшировать ресурс, даже если он содержит заголовки no-store. Ресурсы, требующие авторизации, никогда не кэшируются.

CacheStoreNoStore On

См. также

• CacheIgnoreCacheControl
• CacheStorePrivate

Директива CacheStorePrivate

CacheStorePrivate On|Off

CacheStorePrivate Off

Обычно ответы с заголовками Cache-Control: private не сохраняются в кэше. Директива CacheStorePrivate позволяет переопределить это поведение. CacheStorePrivate Включение позволяет серверу пытаться кэшировать ресурс, даже если он содержит заголовки private. Ресурсы, требующие авторизации, никогда не кэшируются.

CacheStorePrivate On

См. также

• CacheIgnoreCacheControl
• CacheStoreNoStore