Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update caching documentation for Souin #1720

Open
wants to merge 1 commit into
base: 3.1
Choose a base branch
from

Conversation

JacquesDurand
Copy link

This is a documentation PR aiming to explain the future (see api-platform/api-platform#2383 ) integration of Souin as a HTTP Caching module for Caddy in the distribution

email you@domain.com
hostname domain.com
network your_network
provider fastly # available providers are fastly, varnish, or souin (default)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Akamai and cloudflare too

Comment on lines 18 to 19
If you are using the [API Platform distribution](../distribution/index.md), the Caddy server comes with an HTTP Cache module
called [Souin](https://github.com/darkweak/souin/). It enables Caddy to act as its own caching reverse proxy by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, the official HTTP cache module is the cache-handler. Souin is the development repository and the cache-handler is the very stable release.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought it was the other way around, my bad, i'll make the changes ! We should also build Caddy with the cache-handler instead of Souin directly I suppose

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose too but maybe we can add something in the documentation for those who want to use the development repository that is updated faster than the cache-handler one.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, I'll add some lines to explain this possibility

Copy link
Contributor

@darkweak darkweak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants