mirrors/bonfire-app
1
0
Fork 0
mirror of https://github.com/bonfire-networks/bonfire-app.git synced 2024-05-17 08:32:41 +00:00
Code Issues Projects Releases Wiki Activity
bonfire-app/extension-activity_pub.html
mayel 8c4192f0be deploy: f0e6222a43
2024-04-16 21:21:08 +00:00

240 lines
16 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.31.2">
<meta name="project" content="bonfire_umbrella v0.9.10-cooperation-beta.62">
<title>ActivityPub — bonfire_umbrella v0.9.10-cooperation-beta.62</title>
<link rel="stylesheet" href="dist/html-elixir-JKHCEBPC.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-A7S2WMC7.js"></script>
<script src="dist/sidebar_items-0AD831F9.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-JRPQ5PR6.js"></script>
</head>
<body data-type="extras" class="page-extra">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<div class="background-layer"></div>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<a href="https://bonfirenetworks.org" class="sidebar-projectImage">
<img src="assets/logo.png" alt="bonfire_umbrella" />
</a>
<div>
<a href="https://bonfirenetworks.org" class="sidebar-projectName" translate="no">
bonfire_umbrella
</a>
<div class="sidebar-projectVersion" translate="no">
v0.9.10-cooperation-beta.62
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of bonfire_umbrella</span>
<input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<h1>
<a href="https://github.com/bonfire-networks/activity_pub/blob/main/README.md#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span>ActivityPub</span>
</h1>
<p>ActivityPub Library for elixir.</p><p><strong>WORK IN PROGRESS, TESTING FEDERATION WITH DIFFERENT IMPLEMENTATIONS IS UNDERWAY</strong></p><h2 id="installation" class="section-heading">
<a href="#installation" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Installation</span>
</h2>
<ol><li>Add this library to your dependencies in <code class="inline">mix.exs</code></li></ol><pre><code class="makeup elixir" translate="no"><span class="kd">defp</span><span class="w"> </span><span class="nf">deps</span><span class="w"> </span><span class="k" data-group-id="4906101351-1">do</span><span class="w">
</span><span class="p" data-group-id="4906101351-2">[</span><span class="n">...</span><span class="p" data-group-id="4906101351-2">]</span><span class="w">
</span><span class="p" data-group-id="4906101351-3">{</span><span class="ss">:activity_pub</span><span class="p">,</span><span class="w"> </span><span class="ss">git</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;https://github.com/bonfire-networks/activity_pub.git&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">branch</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;stable&quot;</span><span class="p" data-group-id="4906101351-3">}</span><span class="w"> </span><span class="c1"># branch can &quot;stable&quot;, or &quot;develop&quot; for the bleeding edge</span><span class="w">
</span><span class="k" data-group-id="4906101351-1">end</span></code></pre><ol start="2"><li>Create an adapter module. To start, one created at
<code class="inline">lib/my_app/adapter.ex</code> might look like</li></ol><pre><code class="makeup elixir" translate="no"><span class="kd">defmodule</span><span class="w"> </span><span class="nc">MyApp.Adapter</span><span class="w"> </span><span class="k" data-group-id="6681543654-1">do</span><span class="w">
</span><span class="na">@moduledoc</span><span class="w"> </span><span class="s">&quot;&quot;&quot;
Adapter functions delegated from the `ActivityPub` Library
&quot;&quot;&quot;</span><span class="w">
</span><span class="na">@behaviour</span><span class="w"> </span><span class="nc">ActivityPub.Federator.Adapter</span><span class="w">
</span><span class="k" data-group-id="6681543654-1">end</span></code></pre><p>Note that, due to the defined <code class="inline">@behavior</code>, Elixir will warn you that
the required functions</p><ul><li><code class="inline">base_url/0</code></li><li><code class="inline">get_actor_by_id/1</code></li><li><code class="inline">get_actor_by_username/1</code></li><li><code class="inline">get_follower_local_ids/1</code></li><li><code class="inline">get_following_local_ids/1</code></li><li><code class="inline">get_redirect_url/1</code></li><li><code class="inline">handle_activity/1</code></li><li><code class="inline">maybe_create_remote_actor/1</code></li><li><code class="inline">maybe_publish_object/2</code></li><li><code class="inline">update_local_actor/2</code></li><li><code class="inline">update_remote_actor/1</code></li></ul><p>have not yet been implemented though you will be able to start your
app. Defining these allows <a href="https://hexdocs.pm/activity_pub/0.1.0/ActivityPub.html"><code class="inline">ActivityPub</code></a> to handle ActivityPub HTTP
and database calls and operations. An example of an implemented
adaptor can be found
<a href="https://github.com/bonfire-networks/bonfire_federate_activitypub/tree/main/lib/adapter
"Link to file hosted on GitHub"">here</a>.</p><p>Then set it in config</p><pre><code class="makeup elixir" translate="no"><span class="n">config</span><span class="w"> </span><span class="ss">:activity_pub</span><span class="p">,</span><span class="w"> </span><span class="ss">:adapter</span><span class="p">,</span><span class="w"> </span><span class="nc">MyApp.Adapter</span></code></pre><ol start="3"><li>Set your application repo in config</li></ol><pre><code class="makeup elixir" translate="no"><span class="n">config</span><span class="w"> </span><span class="ss">:activity_pub</span><span class="p">,</span><span class="w"> </span><span class="ss">:repo</span><span class="p">,</span><span class="w"> </span><span class="nc">MyApp.Repo</span></code></pre><ol start="4"><li><p>Create a new ecto migration and call <code class="inline">ActivityPub.Migration.up/0</code> from it</p></li><li><p>Inject AP routes to your router by adding <code class="inline">use ActivityPub.Web.Router</code> to your app's router module</p></li><li><p>Copy the default AP config to your app's confix.exs</p></li></ol><pre><code class="makeup elixir" translate="no"><span class="n">config</span><span class="w"> </span><span class="ss">:activity_pub</span><span class="p">,</span><span class="w"> </span><span class="ss">:mrf_simple</span><span class="p">,</span><span class="w">
</span><span class="ss">media_removal</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-1">[</span><span class="p" data-group-id="5418599052-1">]</span><span class="p">,</span><span class="w">
</span><span class="ss">media_nsfw</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-2">[</span><span class="p" data-group-id="5418599052-2">]</span><span class="p">,</span><span class="w">
</span><span class="ss">report_removal</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-3">[</span><span class="p" data-group-id="5418599052-3">]</span><span class="p">,</span><span class="w">
</span><span class="ss">accept</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-4">[</span><span class="p" data-group-id="5418599052-4">]</span><span class="p">,</span><span class="w">
</span><span class="ss">avatar_removal</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-5">[</span><span class="p" data-group-id="5418599052-5">]</span><span class="p">,</span><span class="w">
</span><span class="ss">banner_removal</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-6">[</span><span class="p" data-group-id="5418599052-6">]</span><span class="w">
</span><span class="n">config</span><span class="w"> </span><span class="ss">:activity_pub</span><span class="p">,</span><span class="w"> </span><span class="ss">:instance</span><span class="p">,</span><span class="w">
</span><span class="ss">hostname</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;example.com&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">federation_publisher_modules</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-7">[</span><span class="nc">ActivityPub.Federator.APPublisher</span><span class="p" data-group-id="5418599052-7">]</span><span class="p">,</span><span class="w">
</span><span class="ss">federation_reachability_timeout_days</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span><span class="w">
</span><span class="ss">federating</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p">,</span><span class="w">
</span><span class="ss">rewrite_policy</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-8">[</span><span class="p" data-group-id="5418599052-8">]</span><span class="w">
</span><span class="n">config</span><span class="w"> </span><span class="ss">:activity_pub</span><span class="p">,</span><span class="w"> </span><span class="ss">:http</span><span class="p">,</span><span class="w">
</span><span class="ss">proxy_url</span><span class="p">:</span><span class="w"> </span><span class="no">nil</span><span class="p">,</span><span class="w">
</span><span class="ss">user_agent</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Your app name&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">send_user_agent</span><span class="p">:</span><span class="w"> </span><span class="no">true</span><span class="p">,</span><span class="w">
</span><span class="ss">adapter</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-9">[</span><span class="w">
</span><span class="ss">ssl_options</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-10">[</span><span class="w">
</span><span class="c1"># Workaround for remote server certificate chain issues</span><span class="w">
</span><span class="ss">partial_chain</span><span class="p">:</span><span class="w"> </span><span class="o">&amp;</span><span class="nc">:hackney_connect</span><span class="o">.</span><span class="n">partial_chain</span><span class="o">/</span><span class="mi">1</span><span class="p">,</span><span class="w">
</span><span class="c1"># We don&#39;t support TLS v1.3 yet</span><span class="w">
</span><span class="ss">versions</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="5418599052-11">[</span><span class="ss">:tlsv1</span><span class="p">,</span><span class="w"> </span><span class="ss">:&quot;tlsv1.1&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">:&quot;tlsv1.2&quot;</span><span class="p" data-group-id="5418599052-11">]</span><span class="w">
</span><span class="p" data-group-id="5418599052-10">]</span><span class="w">
</span><span class="p" data-group-id="5418599052-9">]</span></code></pre><ol start="7"><li><p>Change the hostname value in the instance config block to your instance's hostname </p></li><li><p>If you don't already have Oban set up, follow the <a href="https://hexdocs.pm/oban/installation.html#content">Oban installation intructions</a> and add the AP queues:</p></li></ol><pre><code class="makeup elixir" translate="no"><span class="n">config</span><span class="w"> </span><span class="ss">:my_app</span><span class="p">,</span><span class="w"> </span><span class="nc">Oban</span><span class="p">,</span><span class="w"> </span><span class="ss">queues</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="7694691737-1">[</span><span class="ss">federator_incoming</span><span class="p">:</span><span class="w"> </span><span class="mi">50</span><span class="p">,</span><span class="w"> </span><span class="ss">federator_outgoing</span><span class="p">:</span><span class="w"> </span><span class="mi">50</span><span class="p">,</span><span class="w"> </span><span class="ss">remote_fetcher</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p" data-group-id="7694691737-1">]</span></code></pre><p>Now you should be able to compile and run your app and move over to integration.</p>
<div class="bottom-actions">
<div class="bottom-actions-item">
<a href="extension-bonfire_open_id.html" class="bottom-actions-button" rel="prev">
<span class="subheader">
← Previous Page
</span>
<span class="title">
Bonfire.OpenID
</span>
</a>
</div>
<div class="bottom-actions-item">
<a href="extension-iconify_ex.html" class="bottom-actions-button" rel="next">
<span class="subheader">
Next Page →
</span>
<span class="title">
Iconify for Phoenix
</span>
</a>
</div>
</div>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="bonfire_umbrella.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.2) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink