akkoma/docs/configuration/howto_mediaproxy.md
norm 74bc22ae50 Update configuration docs (#40)
Reviewed-on: AkkomaGang/akkoma#40
Co-authored-by: norm <normandy@biribiri.dev>
Co-committed-by: norm <normandy@biribiri.dev>
2022-07-03 15:21:21 +00:00

1.5 KiB

How to activate mediaproxy

Explanation

Without the mediaproxy function, Akkoma doesn't store any remote content like pictures, video etc. locally. So every time you open Akkoma, the content is loaded from the source server, from where the post is coming. This can result in slowly loading content or/and increased bandwidth usage on the source server. With the mediaproxy function you can use nginx to cache this content, so users can access it faster, because it's loaded from your server.

Activate it

  • Edit your nginx config and add the following location:
location /proxy {
        proxy_cache akkoma_media_cache;
        proxy_cache_lock on;
        proxy_pass http://localhost:4000;
}

Also add the following on top of the configuration, outside of the server block:

proxy_cache_path /tmp/akkoma-media-cache levels=1:2 keys_zone=akkoma_media_cache:10m max_size=10g inactive=720m use_temp_path=off;

If you came here from one of the installation guides, take a look at the example configuration /installation/akkoma.nginx, where this part is already included.

  • Append the following to your prod.secret.exs or dev.secret.exs (depends on which mode your instance is running):
config :pleroma, :media_proxy,
      enabled: true,
      proxy_opts: [
            redirect_on_failure: true
      ]
      #base_url: "https://cache.akkoma.social"

If you want to use a subdomain to serve the files, uncomment base_url, change the url and add a comma after true in the previous line.

  • Restart nginx and Akkoma