From eb94db5fe90a84a1fbb26eea35eff540c07c27d9 Mon Sep 17 00:00:00 2001
From: rimu <3310831+rimu@users.noreply.github.com>
Date: Sat, 23 Mar 2024 15:24:34 +1300
Subject: [PATCH] add documentation about Cloudflare cache purging

---
 INSTALL.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/INSTALL.md b/INSTALL.md
index 1b403806..37f9f4d2 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -351,6 +351,16 @@ at ~/.aws/credentials or environment variables. Details at https://boto3.amazona
 
 In your .env you need to set the AWS region you're using for SES. Something like AWS_REGION = 'ap-southeast-2'.
 
+#### CDN
+
+A CDN like Cloudflare is recommended for instances with more than a handful of users. [Recommended caching settings](https://join.piefed.social/2024/02/20/how-much-difference-does-a-cdn-make-to-a-fediverse-instance/).
+
+PieFed has the capability to automatically remove file copies from the Cloudflare cache whenever
+ those files are deleted from the server. To enable this, set these variables in your .env file:
+
+- CLOUDFLARE_API_TOKEN - go to https://dash.cloudflare.com/profile/api-tokens and create a "Zone.Cache Purge" token.
+- CLOUDFLARE_ZONE_ID - this can be found in the right hand column of your Cloudflare dashboard in the API section.
+
 #### SMTP
 
 To use SMTP you need to set all the MAIL_* environment variables in you .env file. See env.sample for a list of them.