Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexkainzinger/strapi-middleware-upload-plugin-cache
Adds middleware for caching uploaded assets when using strapi-provider-upload-local
https://github.com/alexkainzinger/strapi-middleware-upload-plugin-cache
strapi
Last synced: 9 days ago
JSON representation
Adds middleware for caching uploaded assets when using strapi-provider-upload-local
- Host: GitHub
- URL: https://github.com/alexkainzinger/strapi-middleware-upload-plugin-cache
- Owner: alexkainzinger
- License: mit
- Created: 2020-12-30T18:29:16.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-22T16:35:58.000Z (about 2 years ago)
- Last Synced: 2024-09-17T03:09:38.576Z (about 2 months ago)
- Topics: strapi
- Language: JavaScript
- Homepage:
- Size: 22.5 KB
- Stars: 20
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# strapi-middleware-upload-plugin-cache
## Use case
- `@strapi/provider-upload-local` is in use for uploading assets via `Media Library` in Strapi (default)
- The need for configurable cache-control HTTP response headers (e.g. `cache-control: max-age=1234`) + [ETag HTTP response header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) for each asset
- More information and differences between `koa-static` (used in `@strapi/provider-upload-local`) and `koa-static-cache` (used in this middleware-plugin) can be found [here](https://github.com/koajs/static-cache)
## Installing
### For Strapi 4.3+
[Strapi 4.3](https://github.com/strapi/strapi/releases/tag/v4.3.0) had breaking changes with asset organization through folders.
Make sure you are using at least v2.1.0 of this library with Strapi 4.3+!
Using npm
```
npm install strapi-middleware-upload-plugin-cache
```
Using yarn
```
yarn add strapi-middleware-upload-plugin-cache
```
### For Strapi 4.0.0 - 4.2.X
Using npm
```
npm install [email protected]
```
Using yarn
```
yarn add [email protected]
```
### For Strapi 3
Version 2.X.X+ of this library is **NOT** compatible with Strapi v3!
Please make sure to check out the [Strapi v3 Docs](docs/v3/README.md) for the installation & setup.
## Setup
For Strapi, add a `plugins.js` file within the config folder
e.g.
```
touch config/plugins.js
```
containing
```
module.exports = {
"upload-plugin-cache": {
enabled: true,
config: {
maxAge: 86_400_000,
},
}
};
```
Starting Strapi in dev-mode should log the following:
```
[2022-02-22 22:22:22.222] debug: [upload-plugin-cache] Initializing ...
[2022-02-22 22:22:22.222] debug: [upload-plugin-cache] Middleware initialized for endpoint='/uploads/(.*)' [maxAge=300000]
```
## Configuration Options
With the option `dynamic: true` files which are not cached on initializations are dynamically loaded. To avoid OOM errors a [LRU-cache can be used](https://www.npmjs.com/package/@zhennann/koa-static-cache#using-a-lru-cache-to-avoid-oom-when-dynamic-mode-enabled). For config options of lru-cache use these [docs](https://www.npmjs.com/package/lru-cache) and insert them at `lruCache`.
```
module.exports = {
"upload-plugin-cache": {
enabled: true,
config: {
maxAge: 86_400_000,
dynamic: true,
lruCache: {
max: 1000
},
},
}
};
```
## Resources
- [License](LICENSE)
## Links
- [Strapi website](http://strapi.io/)
- [Strapi community on Slack](http://slack.strapi.io)
- [Strapi news on Twitter](https://twitter.com/strapijs)