summaryrefslogtreecommitdiff
path: root/docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md
diff options
context:
space:
mode:
authorfeld <feld@feld.me>2019-10-04 14:16:28 +0000
committerfeld <feld@feld.me>2019-10-04 14:16:28 +0000
commit31e57cd1b34798afb07a8de4c0c95ef3c15e22ed (patch)
tree461d3d50b855d080eb17f0946213168a87ac7625 /docs/configuration/howto_set_richmedia_cache_ttl_based_on_image.md
parentb8b98ac40f042a8c3d2562edc095f0e1a309760f (diff)
parent27110793a7d8e3aa6434bde63a1f687424ae779c (diff)
downloadpleroma-31e57cd1b34798afb07a8de4c0c95ef3c15e22ed.tar.gz
pleroma-31e57cd1b34798afb07a8de4c0c95ef3c15e22ed.zip
Merge branch 'develop' into 'fix/extended-nickname-format-default-config'
# 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.