From: Sachin Joshi <satchin.joshi@gmail.com>
Date: Fri, 19 Jul 2019 06:05:47 +0000 (+0545)
Subject: update the docs
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=581756ccc50cc08823957a2f24f506bf23c7cd22;p=akkoma

update the docs
---

diff --git a/docs/config/howto_set_richmedia_cache_ttl_based_on_image.md b/docs/config/howto_set_richmedia_cache_ttl_based_on_image.md
index 5846b6ab0..bfee5a9e6 100644
--- a/docs/config/howto_set_richmedia_cache_ttl_based_on_image.md
+++ b/docs/config/howto_set_richmedia_cache_ttl_based_on_image.md
@@ -4,20 +4,21 @@
 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 moddule that will set ttl based on image.
-
-The module must have a `run` function and it should be registered in the config.
+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
-  def run(data, url) 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
-    # ttl is unix time
-    ttl = parse_ttl_from_url(image_url)  
-    Cachex.expire_at(:rich_media_cache, url, ttl * 1000)
+    # return ttl is unix time
+    parse_ttl_from_url(image_url)
   end
 end
 ```