akkoma-ipfs/README.md
Claudio Maradonna 95bc4713b3
fixing typos
2022-08-18 17:53:05 +02:00

31 lines
949 B
Markdown

# Akkoma module for IPFS as 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` Akkoma won't return the right base url back.**
### Installation
* 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
* `post_gateway_url`: URL with port of POST Gateway (unauthenticated)
* `get_gateway_url`: URL of public GET Gateway
### Example
*config.exs*
```elixir
config :pleroma, :modules, runtime_dir: "instance/modules"
config :pleroma, Pleroma.Uploaders.IPFS,
post_gateway_url: "http://localhost:5001",
get_gateway_url: "https://{CID}.ipfs.mydomain.com"
config :pleroma, Pleroma.Upload,
uploader: Pleroma.Uploaders.IPFS
```