Skip to content

Commit 20b0139

Browse files
committed
doc: Add some information about caching
1 parent 1c45b93 commit 20b0139

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/guide/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ reduce the friction and manual typing when using `tus-php` with Symfony.
1010

1111
## Versions Support
1212

13-
The Bundle currently supports Symfony **4.4** and **5.x**, changes to this will be published here in and in the release
14-
notes.
13+
The Bundle currently supports Symfony **6.x**, changes to this will be published here
14+
in and in the release notes.
1515

1616
## Installation and Quickstart
1717

@@ -41,7 +41,7 @@ tus_bundle:
4141
4242
to your `routes.yaml`.
4343

44-
If you need to make adjustments to the [default configuration](#default-configuration), you can run
44+
You can run
4545

4646
```shell
4747
php bin/console config:dump TusBundle
@@ -56,14 +56,17 @@ at `config/packages/tus.yaml`.
5656
|------------|----------------------|-------------|
5757
| upload_dir | `%kernel.project_dir%/public/uploads` | Storage directory for finished uploads |
5858
| api_path | `/_tus/upload` | Routing path to direct tus clients to |
59-
| cache_ttl | 300 | Seconds until a cache entry gets invalidated |
59+
| cache_type | not selected | Caching provider to use |
6060

6161
## Caching
6262

63-
You **MUST** configure a caching provider. It is recommended, to use the `native` cache which will use whatever cache
63+
You **MUST** configure a caching provider. It is recommended, to
64+
use the `native` cache which will use whatever cache
6465
provider you configured in your Symfony application.
6566

66-
Tus uses the cache to store
67+
**FYI**: Tus uses the cache to store information about the uploads. If you
68+
run into any problems with your upload mechanics, make sure to clear the
69+
configured tus cache when debugging them.
6770

6871
### Available Caching Providers
6972

0 commit comments

Comments
 (0)