summaryrefslogtreecommitdiff
path: root/docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md
diff options
context:
space:
mode:
authorIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 09:30:49 +0300
committerIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 09:30:49 +0300
commitf459aabdfafa990b33610438650f882ccac072d2 (patch)
treee5bfcb4f8fc7c2dd06e08f90b3a841c4f9ad759a /docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md
parent6ffa2b5f661c2db424334c6fb5de6f4d1bfeb745 (diff)
parent9e34919dcdbeedf8eb623dc86b05f63ef44d8859 (diff)
downloadpleroma-f459aabdfafa990b33610438650f882ccac072d2.tar.gz
pleroma-f459aabdfafa990b33610438650f882ccac072d2.zip
Merge remote-tracking branch 'remotes/upstream/develop' into 1260-rate-limited-auth-actions
# Conflicts: # CHANGELOG.md
Diffstat (limited to 'docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md')
-rw-r--r--docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md b/docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md
new file mode 100644
index 000000000..bfee5a9e6
--- /dev/null
+++ b/docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md
@@ -0,0 +1,33 @@
+# How to set rich media cache ttl based on image ttl
+## Explanation
+
+Richmedia are cached without the ttl but the rich media may have image which can expire, like aws signed url.
+In such cases the old image url (expired) is returned from the media cache.
+
+So to avoid such situation we can define a module that will set ttl based on image.
+The module must adopt behaviour `Pleroma.Web.RichMedia.Parser.TTL`
+
+### Example
+
+```exs
+defmodule MyModule do
+ @behaviour Pleroma.Web.RichMedia.Parser.TTL
+
+ @impl Pleroma.Web.RichMedia.Parser.TTL
+ def ttl(data, url) do
+ image_url = Map.get(data, :image)
+ # do some parsing in the url and get the ttl of the image
+ # return ttl is unix time
+ parse_ttl_from_url(image_url)
+ end
+end
+```
+
+And update the config
+
+```exs
+config :pleroma, :rich_media,
+ ttl_setters: [Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl, MyModule]
+```
+
+> For reference there is a parser for AWS signed URL `Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl`, it's enabled by default.