Static File Cache

https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/
Admin
The Static File Cache is a TYPO3 extension that provides a flexible and fast cache by creating...
Tokens:30,613
Snippets:412
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install StaticFileCache Extension with Composer

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Installation/Index.html

Use this command to install the staticfilecache extension via Composer. Ensure Composer is available in your project.

```bash
composer require lochmueller/staticfilecache
```

--------------------------------

### Blacklist File Content Example

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Nginx.html

This is an example of the content for the OPcache blacklist file. It specifies the directory where static PHP files are generated, ensuring OPcache does not cache outdated content from this location.

```text
/absolute/path/to/typo3/web/typo3temp/assets/tx_staticfilecache/*
```

--------------------------------

### Configure LocalConfiguration.php for helhum/typo3-secure-web

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Installation/Index.html

Set the 'overrideCacheDirectory' in your LocalConfiguration.php to point to the correct path within your helhum/typo3-secure-web setup. This ensures static cache files are stored where they are accessible.

```php
'overrideCacheDirectory' => '../typo3-secure-web/typo3temp/assets/tx_staticfilecache/',
```

--------------------------------

### RewriteRule for Subdirectory Installation

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

When TYPO3 is installed in a subdirectory (e.g., /t3site), modify the RewriteRule to include the subdirectory path after %{DOCUMENT_ROOT}.

```apache
RewriteRule .* - [E=SFC_ROOT:%{DOCUMENT_ROOT}/t3site]
```

--------------------------------

### Benchmark Static HTML Page with ApacheBench

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/_sources/NeedSpeed/Index.rst.txt

Simulates 100 simultaneous users requesting 1000 times a static HTML page served via mod_rewrite. Use this to measure the performance of static content delivery.

```bash
ab -c 100 -n 1000 http://some.fictive.domain.org/gnu-gpl-short/
```

```text
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking some.fictive.domain.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Finished 500 requests


Server Software:        Apache
Server Hostname:        some.fictive.domain.org
Server Port:            80

Document Path:          /gnu-gpl-short/
Document Length:        12038 bytes

Concurrency Level:      10
Time taken for tests:   3.697 seconds
Complete requests:      500
Failed requests:        0
Write errors:           0
Total transferred:      6194000 bytes
HTML transferred:       6019000 bytes
Requests per second:    135.24 [#/sec] (mean)
Time per request:       73.945 [ms] (mean)
Time per request:       7.394 [ms] (mean, across all concurrent requests)
Transfer rate:          1636.04 [Kbytes/sec] received

Connection Times (ms)
                min  mean[+/-sd] median   max
Connect:       12   20   6.8     19      83
Processing:    38   53  17.3     49     149
Waiting:       19   30  13.8     28     126
Total:         55   73  18.4     69     168

Percentage of the requests served within a certain time (ms)
  50%     69
  66%     72
  75%     74
  80%     75
  90%     83
  95%    116
  98%    157
  99%    163
  100%    168 (longest request)

```

--------------------------------

### ApacheBench Benchmark Results (Nginx, Optimized)

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/_sources/NeedSpeed/Index.rst.txt

This ApacheBench output demonstrates improved performance with zero failed requests, indicating successful optimization. It provides key metrics for Nginx serving a static page, including higher requests per second and lower average times.

```bash
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking www.typofree.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Completed 600 requests
Completed 700 requests
Completed 800 requests
Completed 900 requests
Completed 1000 requests
Finished 1000 requests


Server Software:		nginx
Server Hostname:	www.typofree.org
Server Port:		80

Document Path:		/articles/optimizing-typo3-backend-responsiveness/
Document Length:	63588 bytes

Concurrency Level:	100
Time taken for tests:	11.679 seconds
Complete requests:	1000
Failed requests:		0
Write errors:		0
Total transferred:	64305368 bytes
HTML transferred:	64006704 bytes
Requests per second:	85.63 [#/sec] (mean)
Time per request:	1167.861 [ms] (mean)
Time per request:	11.679 [ms] (mean, across all concurrent requests)
Transfer rate:		5377.20 [Kbytes/sec] received

Connection Times (ms)
             min  mean[+/-sd] median   max
Connect:       30  191 592.3     58    4191
Processing:   330  920 350.0    837    3245
Waiting:       30   72  68.2     61    1929
Total:        494 1111 689.3    917    5254

Percentage of the requests served within a certain time (ms)
  50%	    917
  66%	   1106
  75%	   1232
  80%	   1324
  90%	   1553
  95%	   2216
  98%	   3821
  99%	   4270
 100%	   5254 (longest request)

```

--------------------------------

### Configure Default GET Variables for TYPO3 Page Caching

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/KnownProblems/Index.html

This configuration prevents duplicate page caching when TYPO3 creates new URLs. It ensures the insertPageIncache hook is called appropriately by setting the language GET variable.

```typoscript
config.linkVars = L
config.defaultGetVars {
    L = 0
}

```

--------------------------------

### Configure Default GET Variables for Language

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/singlehtml/Index.html

This configuration prevents the insertPageIncache hook from being called multiple times for pages with different language URLs, ensuring static caching works as expected. It sets the default GET variable for language to 0.

```typoscript
config.linkVars = L
config.defaultGetVars {
	L = 0
}
```

--------------------------------

### Benchmark TYPO3 Cached Page with ApacheBench

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/_sources/NeedSpeed/Index.rst.txt

Simulates 10 simultaneous users requesting 100 times a TYPO3 cached page. Use this to measure the performance of dynamic content generation.

```bash
ab -c 10 -n 100 http://some.fictive.domain.org/gnu-gpl-short/
```

```text
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking some.fictive.domain.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Finished 500 requests


Server Software:        Apache
Server Hostname:        some.fictive.domain.org
Server Port:            80

Document Path:          /gnu-gpl-short/
Document Length:        12088 bytes

Concurrency Level:      10
Time taken for tests:   48.854 seconds
Complete requests:      500
Failed requests:        28
   (Connect: 0, Receive: 0, Length: 28, Exceptions: 0)
Write errors:           0
Total transferred:      6240528 bytes
HTML transferred:       6044028 bytes
Requests per second:    10.23 [#/sec] (mean)
Time per request:       977.077 [ms] (mean)
Time per request:       97.708 [ms] (mean, across all concurrent requests)
Transfer rate:          124.74 [Kbytes/sec] received

Connection Times (ms)
                min  mean[+/-sd] median   max
Connect:       12   25  15.5     19     117
Processing:   492  945 182.0    924    1624
Waiting:      462  903 174.3    874    1546
Total:        520  970 184.1    944    1673

Percentage of the requests served within a certain time (ms)
  50%    944
  66%   1021
  75%   1071
  80%   1104
  90%   1217
  95%   1314
  98%   1414
  99%   1553
  100%   1673 (longest request)

```

--------------------------------

### ApacheBench Benchmark: Static HTML Page Served by Nginx

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/NeedSpeed/Index.html

This ApacheBench (ab) output demonstrates the performance metrics when Nginx serves a static HTML file, which is a scenario optimized by StaticFileCache. It details requests per second, time per request, and connection times.

```text
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking www.typofree.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Completed 600 requests
Completed 700 requests
Completed 800 requests
Completed 900 requests
Completed 1000 requests
Finished 1000 requests


Server Software:        nginx
Server Hostname:        www.typofree.org
Server Port:            80

Document Path:          /articles/optimizing-typo3-backend-responsiveness/
Document Length:        63588 bytes

Concurrency Level:      100
Time taken for tests:   11.679 seconds
Complete requests:      1000
Failed requests:        0
Write errors:           0
Total transferred:      64305368 bytes
HTML transferred:       64006704 bytes
Requests per second:    85.63 [#/sec] (mean)
Time per request:       1167.861 [ms] (mean)
Time per request:       11.679 [ms] (mean, across all concurrent requests)
Transfer rate:          5377.20 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:       30  191 592.3     58    4191
Processing:   330  920 350.0    837    3245
Waiting:       30   72  68.2     61    1929
Total:        494 1111 689.3    917    5254

Percentage of the requests served within a certain time (ms)
  50%    917
  66%   1106
  75%   1232
  80%   1324
  90%   1553
  95%   2216
  98%   3821
  99%   4270
 100%   5254 (longest request)

```

--------------------------------

### StaticFileCache .htaccess Main Cache Rules

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/singlehtml/Index.html

This section handles the main logic for serving cached static files. It redirects GET requests to existing static files, provided no user is logged in and certain cookies are not present, and prevents direct access to cache files.

```apache
### Begin: StaticFileCache (main) ####

# We only redirect URI's without query strings
RewriteCond %{QUERY_STRING} ^$

# It only makes sense to do the other checks if a static file actually exists.
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH} -f

# NO frontend or backend user is logged in. Logged in users may see different
# information than anonymous users. But the anonymous version is cached. So
# don't show the anonymous version to logged in users.
RewriteCond %{HTTP_COOKIE} !staticfilecache [NC]

# Avoid cached versions for workspace preview links of users that are not
# logged in: https://github.com/lochmueller/staticfilecache/issues/395
RewriteCond %{HTTP_COOKIE} !ADMCMD_prev [NC]

# We only redirect GET requests
RewriteCond %{REQUEST_METHOD} GET

# Rewrite the request to the static file.
RewriteRule .* %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH} [L]

# Do not allow direct call the cache entries
RewriteCond %{ENV:SFC_URI} ^/typo3temp/assets/tx_staticfilecache/.*
RewriteCond %{ENV:REDIRECT_STATUS} ^$
RewriteRule .* - [F,L]

# Handle application cache
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule ^.*\.sfc$ %{ENV:CWD}index.php?eID=sfc_manifest [QSA,L]

### Begin: StaticFileCache (options) ####
```

--------------------------------

### ApacheBench Benchmark Results (Nginx)

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/_sources/NeedSpeed/Index.rst.txt

This output from ApacheBench shows the performance metrics of Nginx when serving a static HTML page. It includes details on completed requests, transfer rates, and connection times, with a small number of failed requests.

```bash
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking www.typofree.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Completed 600 requests
Completed 700 requests
Completed 800 requests
Completed 900 requests
Completed 1000 requests
Finished 1000 requests


Server Software:		nginx
Server Hostname:	www.typofree.org
Server Port:		80

Document Path:		/articles/optimizing-typo3-backend-responsiveness/
Document Length:	63637 bytes

Concurrency Level:	100
Time taken for tests:	12.341 seconds
Complete requests:	1000
Failed requests:		24
   (Connect: 0, Receive: 0, Length: 24, Exceptions: 0)
Write errors:		0
Total transferred:	64233296 bytes
HTML transferred:	63836716 bytes
Requests per second:	81.03 [#/sec] (mean)
Time per request:	1234.098 [ms] (mean)
Time per request:	12.341 [ms] (mean, across all concurrent requests)
Transfer rate:		5082.89 [Kbytes/sec] received

Connection Times (ms)
             min  mean[+/-sd] median   max
Connect:       27  104 403.0     47    3620
Processing:   387 1088 372.9   1015    2776
Waiting:       82  545 324.5    516    1553
Total:        422 1192 573.9   1061    5080

Percentage of the requests served within a certain time (ms)
  50%   1061
  66%   1139
  75%   1234
  80%   1310
  90%   1898
  95%   2030
  98%   2691
  99%   4376
 100%   5080 (longest request)

```

--------------------------------

### StaticFileCache Preparation Rules

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Configures environment variables for StaticFileCache, including document root, URI cleanup, host extraction, and protocol/port detection. It also disables caching for specific indexing requests.

```apache
RewriteRule .* - [E=SFC_ROOT:%{DOCUMENT_ROOT}]
# RewriteRule .* - [E=SFC_ROOT:%{DOCUMENT_ROOT}/t3site] # Example if your installation is installed in a directory
# NOTE: There are cases (apache versions and configuration) where DOCUMENT_ROOT do not exists. Please set the SFC_ROOT to the right directory without DOCUMENT_ROOT then!

# Cleanup URI
RewriteCond %{REQUEST_URI} ^.*$
RewriteRule .* - [E=SFC_URI:/%{REQUEST_URI}]
RewriteCond %{REQUEST_URI} ^/.*
RewriteRule .* - [E=SFC_URI:%{REQUEST_URI}]
RewriteCond %{REQUEST_URI} ^/?$
RewriteRule .* - [E=SFC_URI:/]

# Cleanup HOST
RewriteCond %{HTTP_HOST} ^([^:]+)(:[0-9]+)?$
RewriteRule .* - [E=SFC_HOST:%1]

# Disable cache for EXT:solr indexing requests
RewriteCond %{HTTP:X-Tx-Solr-Iq} .+
RewriteRule .* - [E=SFC_HOST:invalid-host]

# Disable cache for EXT:crawler indexing requests
RewriteCond %{HTTP:X-T3Crawler} .+
RewriteRule .* - [E=SFC_HOST:invalid-host]

# Important Note for scheme and port. TYPO3 handle Reverse proxies by respect
# X-Forwarded-For headers. The Apache do not know this configuration. If there
# is a reverse proxy that e.g. terminate SSL and all requests are "http", please
# Adapt the following lines to force "http".

# Get scheme
RewriteRule .* - [E=SFC_PROTOCOL:http]
RewriteCond %{SERVER_PORT} ^443$ [OR]
RewriteCond %{HTTP:X-Forwarded-Proto} https
RewriteRule .* - [E=SFC_PROTOCOL:https]

# Get port
RewriteRule .* - [E=SFC_PORT:80]
RewriteCond %{ENV:SFC_PROTOCOL} ^https$ [NC]
RewriteRule .* - [E=SFC_PORT:443]
RewriteCond %{SERVER_PORT} ^[0-9]+$
RewriteRule .* - [E=SFC_PORT:%{SERVER_PORT}]
RewriteCond %{HTTP:X-Forwarded-Port} ^[0-9]+$
RewriteRule .* - [E=SFC_PORT:%{HTTP:X-Forwarded-Port}]

# Full path for redirect
RewriteRule .* - [E=SFC_FULLPATH:typo3temp/assets/tx_staticfilecache/%{ENV:SFC_PROTOCOL}_%{ENV:SFC_HOST}_%{ENV:SFC_PORT}%{ENV:SFC_URI}/index]

# Extension (Order: br, gzip, php, default)
RewriteRule .* - [E=SFC_EXT:]
RewriteCond %{HTTP:Accept-Encoding} br [NC]
RewriteRule .* - [E=SFC_EXT:.br]
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT} !-f
RewriteRule .* - [E=SFC_EXT:]
RewriteCond %{ENV:SFC_EXT} ^$
RewriteCond %{HTTP:Accept-Encoding} gzip [NC]
RewriteRule .* - [E=SFC_EXT:.gz]
RewriteCond %{ENV:SFC_EXT} ^\.gz$
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT} !-f
RewriteRule .* - [E=SFC_EXT:]
RewriteCond %{ENV:SFC_EXT} ^$
RewriteRule .* - [E=SFC_EXT:.php]
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT} !-f
RewriteRule .* - [E=SFC_EXT:]

# Write Extension to SFC_FULLPATH
RewriteRule .* - [E=SFC_FULLPATH:%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT}]
```

--------------------------------

### StaticFileCache Main Caching Rules

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Handles the redirection to static cached files for GET requests without query strings, provided the file exists and the user is not logged in. It also prevents direct access to cache entries and handles application cache manifest requests.

```apache
# We only redirect URI's without query strings
RewriteCond %{QUERY_STRING} ^$

# It only makes sense to do the other checks if a static file actually exists.
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH} -f

# NO frontend or backend user is logged in. Logged in users may see different
# information than anonymous users. But the anonymous version is cached. So
# don't show the anonymous version to logged in users.
RewriteCond %{HTTP_COOKIE} !staticfilecache [NC]

# Avoid cached versions for workspace preview links of users that are not
# logged in: https://github.com/lochmueller/staticfilecache/issues/395
RewriteCond %{HTTP_COOKIE} !ADMCMD_prev [NC]

# We only redirect GET requests
RewriteCond %{REQUEST_METHOD} GET

# Rewrite the request to the static file.
RewriteRule .* %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH} [L]

# Do not allow direct call the cache entries
RewriteCond %{ENV:SFC_URI} ^/typo3temp/assets/tx_staticfilecache/.*
RewriteCond %{ENV:REDIRECT_STATUS} ^$
RewriteRule .* - [F,L]

# Handle application cache
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule ^.*\.sfc$ %{ENV:CWD}index.php?eID=sfc_manifest [QSA,L]
```

--------------------------------

### Benchmark TYPO3 Cached Page with ApacheBench

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/NeedSpeed/Index.html

Simulates 10 concurrent users making 100 requests to a TYPO3 cached page. Use this to assess the performance of TYPO3's caching mechanism under moderate load.

```bash
ab -c 10 -n 100 http://some.fictive.domain.org/gnu-gpl-short/

This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking some.fictive.domain.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Finished 500 requests


Server Software:		Apache
Server Hostname:		some.fictive.domain.org
Server Port:			80

Document Path:			/gnu-gpl-short/
Document Length:		12088 bytes

Concurrency Level:		10
Time taken for tests:	   48.854 seconds
Complete requests:	      500
Failed requests:	        28
   (Connect: 0, Receive: 0, Length: 28, Exceptions: 0)
Write errors:		           0
Total transferred:	      6240528 bytes
HTML transferred:	      6044028 bytes
Requests per second:	    10.23 [#/sec] (mean)
Time per request:	    977.077 [ms] (mean)
Time per request:	     97.708 [ms] (mean, across all concurrent requests)
Transfer rate:		    124.74 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:	       12   25  15.5     19     117
Processing:	   492  945 182.0    924    1624
Waiting:	   462  903 174.3    874    1546
Total:		   520  970 184.1    944    1673

Percentage of the requests served within a certain time (ms)
  50%	    944
  66%	   1021
  75%	   1071
  80%	   1104
  90%	   1217
  95%	   1314
  98%	   1414
  99%	   1553
 100%	   1673 (longest request)

```

--------------------------------

### ApacheBench Test for TYPO3 Cached Page

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/singlehtml/Index.html

This command simulates 10 concurrent users making 100 requests to a TYPO3-generated cached page. It is used to measure the performance of TYPO3's caching mechanism.

```bash
ab -c 10 -n 100 http://some.fictive.domain.org/gnu-gpl-short/

This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking some.fictive.domain.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Finished 500 requests


Server Software:        Apache
Server Hostname:        some.fictive.domain.org
Server Port:            80

Document Path:          /gnu-gpl-short/
Document Length:        12088 bytes

Concurrency Level:      10
Time taken for tests:   48.854 seconds
Complete requests:      500
Failed requests:        28
   (Connect: 0, Receive: 0, Length: 28, Exceptions: 0)
Write errors:           0
Total transferred:      6240528 bytes
HTML transferred:       6044028 bytes
Requests per second:    10.23 [#/sec] (mean)
Time per request:       977.077 [ms] (mean)
Time per request:       97.708 [ms] (mean, across all concurrent requests)
Transfer rate:          124.74 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:       12   25  15.5     19     117
Processing:   492  945 182.0    924    1624
Waiting:      462  903 174.3    874    1546
Total:        520  970 184.1    944    1673

Percentage of the requests served within a certain time (ms)
  50%    944
  66%   1021
  75%   1071
  80%   1104
  90%   1217
  95%   1314
  98%   1414
  99%   1553
  100%   1673 (longest request)

```

--------------------------------

### Set Content Type for Gzipped CSS (gz)

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Configure ForceType to deliver .css.gz files as text/css.

```apache
<FilesMatch "\.css\.gz$">
   ForceType text/css
   # AddType "text/css" .gz
</FilesMatch>
```

--------------------------------

### Set Content Type for JavaScript Files (gz)

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Configure ForceType to deliver .js.gz files as text/javascript.

```apache
<FilesMatch "\.js\.gz$">
   ForceType text/javascript
   # AddType "text/javascript" .gz
</FilesMatch>
```

--------------------------------

### Set Content Type for Brotli Compressed XML

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Configure ForceType to deliver .xml.br files as text/xml.

```apache
<FilesMatch "\.xml\.br$">
   ForceType text/xml
   # AddType "text/xml" .br
</FilesMatch>
```

--------------------------------

### Base .htaccess Configuration for StaticFileCache

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/_sources/Configuration/Htaccess.rst.txt

This is the foundational .htaccess configuration for StaticFileCache. It sets up environment variables for the document root, URI, host, protocol, and port, and determines the appropriate file extension for cached assets (e.g., .br, .gz, .php).

```apache
### Begin: StaticFileCache (preparation) ####

# Document root configuration
RewriteRule .* - [E=SFC_ROOT:%{DOCUMENT_ROOT}]
# RewriteRule .* - [E=SFC_ROOT:%{DOCUMENT_ROOT}/t3site] # Example if your installation is installed in a directory
# NOTE: There are cases (apache versions and configuration) where DOCUMENT_ROOT do not exists. Please set the SFC_ROOT to the right directory without DOCUMENT_ROOT then!

# Cleanup URI
RewriteCond %{REQUEST_URI} ^.*$
RewriteRule .* - [E=SFC_URI:/%{REQUEST_URI}]
RewriteCond %{REQUEST_URI} ^/.*
RewriteRule .* - [E=SFC_URI:%{REQUEST_URI}]
RewriteCond %{REQUEST_URI} ^/?$
RewriteRule .* - [E=SFC_URI:/]

# Cleanup HOST
RewriteCond %{HTTP_HOST} ^([^:]+)(:[0-9]+)?$
RewriteRule .* - [E=SFC_HOST:%1]

# Disable cache for EXT:solr indexing requests
RewriteCond %{HTTP:X-Tx-Solr-Iq} .+
RewriteRule .* - [E=SFC_HOST:invalid-host]

# Disable cache for EXT:crawler indexing requests
RewriteCond %{HTTP:X-T3Crawler} .+
RewriteRule .* - [E=SFC_HOST:invalid-host]

# Important Note for scheme and port. TYPO3 handle Reverse proxies by respect
# X-Forwarded-For headers. The Apache do not know this configuration. If there
# is a reverse proxy that e.g. terminate SSL and all requests are "http", please
# Adapt the following lines to force "http".

# Get scheme
RewriteRule .* - [E=SFC_PROTOCOL:http]
RewriteCond %{SERVER_PORT} ^443$ [OR]
RewriteCond %{HTTP:X-Forwarded-Proto} https
RewriteRule .* - [E=SFC_PROTOCOL:https]

# Get port
RewriteRule .* - [E=SFC_PORT:80]
RewriteCond %{ENV:SFC_PROTOCOL} ^https$ [NC]
RewriteRule .* - [E=SFC_PORT:443]
RewriteCond %{SERVER_PORT} ^[0-9]+$
RewriteRule .* - [E=SFC_PORT:%{SERVER_PORT}]
RewriteCond %{HTTP:X-Forwarded-Port} ^[0-9]+$
RewriteRule .* - [E=SFC_PORT:%{HTTP:X-Forwarded-Port}]

# Full path for redirect
RewriteRule .* - [E=SFC_FULLPATH:typo3temp/assets/tx_staticfilecache/%{ENV:SFC_PROTOCOL}_%{ENV:SFC_HOST}_%{ENV:SFC_PORT}%{ENV:SFC_URI}/index]

# Extension (Order: br, gzip, php, default)
RewriteRule .* - [E=SFC_EXT:]
RewriteCond %{HTTP:Accept-Encoding} br [NC]
RewriteRule .* - [E=SFC_EXT:.br]
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT} !-f
RewriteRule .* - [E=SFC_EXT:]
RewriteCond %{ENV:SFC_EXT} ^$
RewriteCond %{HTTP:Accept-Encoding} gzip [NC]
RewriteRule .* - [E=SFC_EXT:.gz]
RewriteCond %{ENV:SFC_EXT} ^\.gz$
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT} !-f
RewriteRule .* - [E=SFC_EXT:]
RewriteCond %{ENV:SFC_EXT} ^$
RewriteRule .* - [E=SFC_EXT:.php]
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT} !-f
RewriteRule .* - [E=SFC_EXT:]

# Write Extension to SFC_FULLPATH
RewriteRule .* - [E=SFC_FULLPATH:%{ENV:SFC_FULLPATH}%{ENV:SFC_EXT}]

### Begin: StaticFileCache (main) ####

# We only redirect URI's without query strings
RewriteCond %{QUERY_STRING} ^$

# It only makes sense to do the other checks if a static file actually exists.
RewriteCond %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH} -f

# NO frontend or backend user is logged in. Logged in users may see different
# information than anonymous users. But the anonymous version is cached. So
# don't show the anonymous version to logged in users.
RewriteCond %{HTTP_COOKIE} !staticfilecache [NC]

# Avoid cached versions for workspace preview links of users that are not
# logged in: https://github.com/lochmueller/staticfilecache/issues/395
RewriteCond %{HTTP_COOKIE} !ADMCMD_prev [NC]

# We only redirect GET requests
RewriteCond %{REQUEST_METHOD} GET

# Rewrite the request to the static file.
RewriteRule .* %{ENV:SFC_ROOT}/%{ENV:SFC_FULLPATH} [L]

# Do not allow direct call the cache entries
RewriteCond %{ENV:SFC_URI} ^/typo3temp/assets/tx_staticfilecache/.*
RewriteCond %{ENV:REDIRECT_STATUS} ^$
RewriteRule .* - [F,L]

# Handle application cache
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule ^.*\.sfc$ %{ENV:CWD}index.php?eID=sfc_manifest [QSA,L]

### Begin: StaticFileCache (options) ####
```

--------------------------------

### Set Content Type for XML Files (gz)

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Ensure .xml.gz files are served as text/xml using ForceType.

```apache
<FilesMatch "\.xml\.gz$">
   ForceType text/xml
   # AddType "text/xml" .gz
</FilesMatch>
```

--------------------------------

### Set Content Type for RSS Files (gz)

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Configure ForceType to deliver .rss.gz files as text/xml.

```apache
<FilesMatch "\.rss\.gz$">
   ForceType text/xml
   # AddType "text/xml" .gz
</FilesMatch>
```

--------------------------------

### Sitemap Routing Configuration

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Routing.html

This configuration enables the creation of /sitemap.xml and sub-sitemaps, ensuring they are compatible with StaticFileCache by disabling cHash. It uses PageType, Simple, StaticValueMapper, and StaticRangeMapper route enhancers.

```yaml
routeEnhancers:
  PageTypeSuffix:
    type: PageType
    default: .html
    index: index
    map:
      sitemap.xml: '1533906435'
  SitemapNames:
    type: Simple
    routePath: '/s/{sitemap}'
    requirements:
      sitemap: '.*'
    _arguments:
      sitemap: 'sitemap'
    aspects:
      sitemap:
        type: StaticValueMapper
        map:
          pages: 'pages'
          news: 'news'
          xxxx: 'xxxxx'
  SitemapNamesPage:
    type: Simple
    routePath: '/s/{sitemap}/{page}'
    requirements:
      sitemap: '.*'
      page: '\d+'
    _arguments:
      sitemap: 'sitemap'
      page: page
    aspects:
      sitemap:
        type: StaticValueMapper
        map:
          pages: 'pages'
          news: 'news'
          xxxx: 'xxxxx'
      page:
        type: StaticRangeMapper
        start: '1'
        end: '100'
```

--------------------------------

### StaticFileCache Options for Compressed Files

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Sets the appropriate Content-Encoding header for gzipped (.gz) and Brotli (.br) compressed static files. This ensures browsers correctly decompress and display the content.

```apache
<FilesMatch "\.gzip$">
   SetEnv no-gzip 1
   SetEnv no-brotli 1
   <IfModule mod_headers.c>
      Header set Content-Encoding gzip
   </IfModule>
</FilesMatch>
<FilesMatch "\.gz$">
   SetEnv no-gzip 1
   SetEnv no-brotli 1
   <IfModule mod_headers.c>
      Header set Content-Encoding gzip
   </IfModule>
</FilesMatch>
<FilesMatch "\.br$">
   SetEnv no-gzip 1
   SetEnv no-brotli 1
   <IfModule mod_headers.c>
      Header set Content-Encoding br
   </IfModule>
</FilesMatch>
```

--------------------------------

### ApacheBench Benchmark: Cached Page Served by Nginx

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/NeedSpeed/Index.html

This output from ApacheBench (ab) shows the performance metrics when Nginx serves a cached TYPO3 page. It includes details on requests per second, time per request, and connection times.

```text
This is ApacheBench, Version 2.3 <$Revision: 655654 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking www.typofree.org (be patient)
Completed 100 requests
Completed 200 requests
Completed 300 requests
Completed 400 requests
Completed 500 requests
Completed 600 requests
Completed 700 requests
Completed 800 requests
Completed 900 requests
Completed 1000 requests
Finished 1000 requests


Server Software:        nginx
Server Hostname:        www.typofree.org
Server Port:            80

Document Path:          /articles/optimizing-typo3-backend-responsiveness/
Document Length:        63637 bytes

Concurrency Level:      100
Time taken for tests:   12.341 seconds
Complete requests:      1000
Failed requests:        24
   (Connect: 0, Receive: 0, Length: 24, Exceptions: 0)
Write errors:           0
Total transferred:      64233296 bytes
HTML transferred:       63836716 bytes
Requests per second:    81.03 [#/sec] (mean)
Time per request:       1234.098 [ms] (mean)
Time per request:       12.341 [ms] (mean, across all concurrent requests)
Transfer rate:          5082.89 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:       27  104 403.0     47    3620
Processing:   387 1088 372.9   1015    2776
Waiting:       82  545 324.5    516    1553
Total:        422 1192 573.9   1061    5080

Percentage of the requests served within a certain time (ms)
  50%   1061
  66%   1139
  75%   1234
  80%   1310
  90%   1898
  95%   2030
  98%   2691
  99%   4376
 100%   5080 (longest request)

```

--------------------------------

### Set Content Type for Gzipped JavaScript (gz)

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Ensure .js.gz files are delivered with the correct content type (text/javascript) using ForceType.

```apache
<FilesMatch "\.js\.gz$">
   ForceType text/javascript
   # AddType "text/javascript" .gzip
</FilesMatch>
```

--------------------------------

### Set Content Type for Brotli Compressed Files

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Use ForceType to set text/html for .br files. This ensures brotli-compressed HTML is delivered correctly.

```apache
<FilesMatch "\.br$">
   ForceType text/html
   # AddType "text/html" .br
</FilesMatch>
```

--------------------------------

### Force Content Type for Gzipped and Brotli Files

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/_sources/Configuration/Htaccess.rst.txt

Ensures that gzipped (.gzip, .gz) and Brotli (.br) files are served with the correct MIME types, such as text/html, text/javascript, text/css, and text/xml.

```apache
<FilesMatch "\.gzip $">
   ForceType text/html
   # AddType "text/html" .gzip
</FilesMatch>
<FilesMatch "\.js\.gzip $">
   ForceType text/javascript
   # AddType "text/javascript" .gzip
</FilesMatch>
<FilesMatch "\.js\.gz $">
   ForceType text/javascript
   # AddType "text/javascript" .gzip
</FilesMatch>
<FilesMatch "\.css\.gzip $">
   ForceType text/css
   # AddType "text/css" .gzip
</FilesMatch>
<FilesMatch "\.css\.gz $">
   ForceType text/css
   # AddType "text/css" .gzip
</FilesMatch>
<FilesMatch "\.xml\.gzip $">
   ForceType text/xml
   # AddType "text/xml" .gzip
</FilesMatch>
<FilesMatch "\.rss\.gzip $">
   ForceType text/xml
   # AddType "text/xml" .gzip
</FilesMatch>
<FilesMatch "\.gz $">
   ForceType text/html
   # AddType "text/html" .gz
</FilesMatch>
<FilesMatch "\.js\.gz $">
   ForceType text/javascript
   # AddType "text/javascript" .gz
</FilesMatch>
<FilesMatch "\.css\.gz $">
   ForceType text/css
   # AddType "text/css" .gz
</FilesMatch>
<FilesMatch "\.xml\.gz $">
   ForceType text/xml
   # AddType "text/xml" .gz
</FilesMatch>
<FilesMatch "\.rss\.gz $">
   ForceType text/xml
   # AddType "text/xml" .gz
</FilesMatch>
<FilesMatch "\.br $">
   ForceType text/html
   # AddType "text/html" .br
</FilesMatch>
<FilesMatch "\.xml\.br $">
   ForceType text/xml
   # AddType "text/xml" .br
</FilesMatch>
<FilesMatch "\.rss\.br $">
   ForceType text/xml
   # AddType "text/xml" .br
</FilesMatch>
```

--------------------------------

### Set Content Type for Gzipped JavaScript

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Configure ForceType to serve .js.gzip files as text/javascript. This is crucial for correctly rendering JavaScript assets.

```apache
<FilesMatch "\.js\.gzip$">
   ForceType text/javascript
   # AddType "text/javascript" .gzip
</FilesMatch>
```

--------------------------------

### OPcache Blacklist Configuration

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/_sources/Configuration/Nginx.rst.txt

This configuration snippet shows how to add the static file cache directory to the PHP OPcache blacklist to prevent outdated content delivery when opcache.validate_timestamps is set to 0.

```ini
opcache.blacklist_filename = /path/to/blacklist.txt
```

```text
/absolute/path/to/typo3/web/typo3temp/assets/tx_staticfilecache/*
```

--------------------------------

### Set Content Type for Brotli Compressed RSS

Source: https://docs.typo3.org/p/lochmueller/staticfilecache/main/en-us/Configuration/Htaccess.html

Ensure .rss.br files are served as text/xml by using ForceType.

```apache
<FilesMatch "\.rss\.br$">
   ForceType text/xml
   # AddType "text/xml" .br
</FilesMatch>
```
Tokens:
Raw