diff --git a/README.md b/README.md index 83950a1..2d1ed91 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # Akkoma module for IPFS as uploader -## Important -This module replace the `upload.ex` file to implement the IPFS uploader, +## Important, please read +**This module replaces the default `upload.ex` file to implement the IPFS uploader, this because Elixir doesn't implement Monkey Patching and without the -modified `upload.ex` Akkom won't return the right base url back. +modified `upload.ex` Akkoma won't return the right base url back.** ### Installation -* Enter in the module folder of akkoma (defined in the `config.exs`) -* Clone this repo inside (only the .ex files will be loaded) +* Enter in the module folder of akkoma (defined in the `config.exs`, by default Akkoma uses this: `/var/lib/akkoma/modules`) +* Clone this repo inside (only the .ex files will be loaded by Akkoma) ### Cheatsheet @@ -17,14 +17,14 @@ modified `upload.ex` Akkom won't return the right base url back. ### Example -*config* +*config.exs* ```elixir config :pleroma, :modules, runtime_dir: "instance/modules" config :pleroma, Pleroma.Uploaders.IPFS, post_gateway_url: "http://localhost:5001", - get_gateway_url: "http://{CID}.ipfs.mydomain.com" + get_gateway_url: "https://{CID}.ipfs.mydomain.com" config :pleroma, Pleroma.Upload, uploader: Pleroma.Uploaders.IPFS