Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fediverse: Move Secure Fetch documentation to the 'Usage' section

This commit is contained in:
Valentin Lorentz 2021-04-17 20:08:33 +02:00
parent 3c1c4a69e9
commit b0cdf474a8
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
plugins/Fediverse/plugin.py
View File

@ -114,7 +114,30 @@ class FediverseHttp(httpserver.SupyHTTPServerCallback):
class Fediverse(callbacks.PluginRegexp):
"""Fetches information from ActivityPub servers."""
"""Fetches information from ActivityPub servers.
Enabling Secure Fetch
^^^^^^^^^^^^^^^^^^^^^
The default configuration works with most ActivityPub servers, but not
all of them, because they require an HTTP Signature to fetch profiles
and statuses.
Because of how HTTP Signatures work, you need to add some configuration
for Limnoria to support it.
First, you should set ``supybot.servers.http.port`` to a port you want
your bot to listen on (by default it's 8080). If there are already
plugins using it (eg. if Fediverse is already running), you should
either unload all of them and load them back, or restart your bot.
Then, you must configure a reverse-proxy in front of your bot (eg. nginx),
and it must support HTTPS.
Finally, set ``supybot.servers.http.publicUrl`` to the public URL of this
server (when opening this URL in your browser, it should show a page with
a title like "Supybot web server index").
"""
threaded = True
regexps = ["usernameSnarfer", "urlSnarfer_"]