Skip to content

Commit

Permalink
DOCS Filesystem capacity issue potential on caches
Browse files Browse the repository at this point in the history
  • Loading branch information
chillu committed Nov 25, 2020
1 parent d76dd25 commit 40d19d0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/en/00_Getting_Started/00_Server_Requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,17 @@ Depending on your hosting and deployment mechanisms,
you may need to configure the plugin to copy files instead.
See [silverstripe/vendor-plugin](https://github.com/silverstripe/vendor-plugin) for details.

### Caches

Silverstripe relies on various [caches](https://docs.silverstripe.org/en/4/developer_guides/performance/caching/)
to achieve performant responses. By default, those caches are stored in a temporary filesystem folder,
and are not shared between multiple server instances. Alternative cache backends such as Redis can be
[configured](https://docs.silverstripe.org/en/4/developer_guides/performance/caching/).

While cache objects can expire, when using filesystem caching the files are not actively pruned.
For long-lived server instances, this can become a capacity issue over time - see
[workaround](https://github.com/silverstripe/silverstripe-framework/issues/6678).

### Error pages

The default installation includes [silverstripe/errorpage](https://addons.silverstripe.org/add-ons/silverstripe/errorpage),
Expand Down
5 changes: 5 additions & 0 deletions docs/en/02_Developer_Guides/08_Performance/01_Caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ executing the action is limited to the following cases when performed via a web
* A user is logged in with ADMIN permissions
* An error occurs during startup

Caution: Not all caches are cleared through `flush=1`.
While cache objects can expire, when using filesystem caching the files are not actively pruned.
For long-lived server instances, this can become a capacity issue over time - see
[workaround](https://github.com/silverstripe/silverstripe-framework/issues/6678).

## Configuration

We are using the [PSR-16](http://www.php-fig.org/psr/psr-16/) standard ("SimpleCache")
Expand Down

0 comments on commit 40d19d0

Please sign in to comment.