PluginProbe
ActivityPub / 2.0.0
ActivityPub v2.0.0
9.3.1 9.3.0 9.2.2 9.2.1 9.2.0 9.1.0 9.0.2 9.0.1 9.0.0 8.3.0 8.2.1 8.2.0 8.1.1 1.0.5 1.0.6 1.0.7 1.0.8 1.0.9 1.1.0 1.2.0 1.3.0 2.0.0 2.0.1 2.1.0 2.1.1 All 160 releases
activitypub / readme.txt

readme.txt in ActivityPub 2.0.0, at readme.txt

547 lines 20.4 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === ActivityPub ===
2 Contributors: automattic, pfefferle, mediaformat, mattwiebe, akirk, jeherve, nuriapena, cavalierlife
3 Tags: OStatus, fediverse, activitypub, activitystream
4 Requires at least: 5.5
5 Tested up to: 6.4
6 Stable tag: 2.0.0
7 Requires PHP: 5.6
8 License: MIT
9 License URI: http://opensource.org/licenses/MIT
10
11 The ActivityPub protocol is a decentralized social networking protocol based upon the ActivityStreams 2.0 data format.
12
13 == Description ==
14
15 Enter the fediverse with **ActivityPub**, broadcasting your blog to a wider audience! Attract followers, deliver updates, and receive comments from a diverse user base of **ActivityPub**\-compliant platforms.
16
17 With the ActivityPub plugin installed, your WordPress blog itself function as a federated profile, along with profiles for each author. For instance, if your website is `example.com`, then the blog-wide profile can be found at `@example.com@example.com`, and authors like Jane and Bob would have their individual profiles at `@jane@example.com` and `@bobz@example.com`, respectively.
18
19 An example: I give you my Mastodon profile name: `@pfefferle@mastodon.social`. You search, see my profile, and hit follow. Now, any post I make appears in your Home feed. Similarly, with the ActivityPub plugin, you can find and follow Jane's profile at `@jane@example.com`.
20
21 Once you follow Jane's `@jane@example.com` profile, any blog post she crafts on `example.com` will land in your Home feed. Simultaneously, by following the blog-wide profile `@example.com@example.com`, you'll receive updates from all authors.
22
23 **Note**: if no one follows your author or blog instance, your posts remain unseen. The simplest method to verify the plugin's operation is by following your profile. If you possess a Mastodon profile, initiate by following your new one.
24
25 The plugin works with the following tested federated platforms, but there may be more that it works with as well:
26
27 * [Mastodon](https://joinmastodon.org/)
28 * [Pleroma](https://pleroma.social/)/[Akkoma](https://akkoma.social/)
29 * [friendica](https://friendi.ca/)
30 * [Hubzilla](https://hubzilla.org/)
31 * [Pixelfed](https://pixelfed.org/)
32 * [Socialhome](https://socialhome.network/)
33 * [Misskey](https://join.misskey.page/)
34 * [Firefish](https://joinfirefish.org/) (rebrand of Calckey)
35
36 Some things to note:
37
38 1. The blog-wide profile is only compatible with sites with rewrite rules enabled. If your site does not have rewrite rules enabled, the author-specific profiles may still work.
39 1. Many single-author blogs have chosen to turn off or redirect their author profile pages, usually via an SEO plugin like Yoast or Rank Math. This is usually done to avoid duplicate content with your blog’s home page. If your author page has been deactivated in this way, then ActivityPub author profiles won’t work for you. Instead, you can turn your author profile page back on, and then use the option in your SEO plugin to noindex the author page. This will still resolve duplicate content issues with search engines and will enable ActivityPub author profiles to work.
40 1. Once ActivityPub is installed, *only new posts going forward* will be available in the fediverse. Likewise, even if you’ve been using ActivityPub for a while, anyone who follows your site, will only see new posts you publish from that moment on. They will never see previously-published posts in their Home feed. This process is very similar to subscribing to a newsletter. If you subscribe to a newsletter, you will only receive future emails, but not the old archived ones. With ActivityPub, if someone follows your site, they will only receive new blog posts you publish from then on.
41
42 So what’s the process?
43
44 1. Install the ActivityPub plugin.
45 1. Go to the plugin’s settings page and adjust the settings to your liking. Click the Save button when ready.
46 1. Make sure your blog’s author profile page is active if you are using author profiles.
47 1. Go to Mastodon or any other federated platform, and search for your profile, and follow it. Your new profile will be in the form of either `@your_username@example.com` or `@example.com@example.com`, so that is what you’ll search for.
48 1. On your blog, publish a new post.
49 1. From Mastodon, check to see if the new post appears in your Home feed.
50
51 Please note that it may take up to 15 minutes or so for the new post to show up in your federated feed. This is because the messages are sent to the federated platforms using a delayed cron. This avoids breaking the publishing process for those cases where users might have lots of followers. So please don’t assume that just because you didn’t see it show up right away that something is broken. Give it some time. In most cases, it will show up within a few minutes, and you’ll know everything is working as expected.
52
53 == Frequently Asked Questions ==
54
55 = tl;dr =
56
57 This plugin connects your WordPress blog to popular social platforms like Mastodon, making your posts more accessible to a wider audience. Once installed, your blog can be followed by users on these platforms, allowing them to receive your new posts in their feeds.
58
59 = What is the status of this plugin? =
60
61 Implemented:
62
63 * blog profile pages (JSON representation)
64 * author profile pages (JSON representation)
65 * custom links
66 * functional inbox/outbox
67 * follow (accept follows)
68 * share posts
69 * receive comments/reactions
70 * signature verification
71 * threaded comments support
72
73 To implement:
74
75 * replace shortcodes with blocks for layout
76
77 = What is "ActivityPub for WordPress" =
78
79 *ActivityPub for WordPress* extends WordPress with some Fediverse features, but it does not compete with platforms like Friendica or Mastodon. If you want to run a **decentralized social network**, please use [Mastodon](https://joinmastodon.org/) or [GNU social](https://gnusocial.network/).
80
81 = What if you are running your blog in a subdirectory? =
82
83 In order for webfinger to work, it must be mapped to the root directory of the URL on which your blog resides.
84
85 **Apache**
86
87 Add the following to the .htaccess file in the root directory:
88
89 RedirectMatch "^\/\.well-known/(webfinger|nodeinfo|x-nodeinfo2)(.*)$" /blog/.well-known/$1$2
90
91 Where 'blog' is the path to the subdirectory at which your blog resides.
92
93 **Nginx**
94
95 Add the following to the site.conf in sites-available:
96
97 location ~* /.well-known {
98 allow all;
99 try_files $uri $uri/ /blog/?$args;
100 }
101
102 Where 'blog' is the path to the subdirectory at which your blog resides.
103
104 = What if you are running your blog in a subdirectory, but have a different [wp_siteurl](https://wordpress.org/documentation/article/giving-wordpress-its-own-directory/)? =
105
106 In that case you don't need the redirect, because the index.php will take care of that.
107
108 == Changelog ==
109
110 Project maintained on GitHub at [automattic/wordpress-activitypub](https://github.com/automattic/wordpress-activitypub).
111
112 = 2.0.0 =
113
114 * Added: Bidirectional Comment Federation
115 * Removed: Deprecated Classes
116 * Fixed: Normalize attributes that can have mixed value types
117 * Added: URL support for WebFinger
118 * Added: Make Post-Template filterable
119 * Added: CSS class for ActivityPub comments to allow custom designs
120 * Added: FEP-2677: Identifying the Application Actor
121 * Added: FEP-2c59: Discovery of a Webfinger address from an ActivityPub actor
122 * Added: Profile Update Activities
123 * Improved: WebFinger endpoints
124
125 = 1.3.0 =
126
127 * Added: Threaded-Comments support
128 * Improved: alt text for avatars in Follow Me/Followers blocks
129 * Improved: `Delete`, `Update` and `Follow` Activities
130 * Improved: better/more effective handling of `Delete` Activities
131 * Improved: allow `<p />` and `<br />` for Comments
132 * Fixed: removed default limit of WP_Query to send updates to all Inboxes and not only to the first 10
133
134 = 1.2.0 =
135
136 * Add: Search and order followerer lists
137 * Add: Have a filter to defer signature verification
138 * Improved: "Follow Me" styles for dark themes
139 * Improved: Allow `p` and `br` tags only for AP comments
140 * Fixed: Deduplicate attachments earlier to prevent incorrect max_media
141
142
143 = 1.1.0 =
144
145 * Improved: audio and video attachments are now supported!
146 * Improved: better error messages if remote profile is not accessible
147 * Improved: PHP 8.1 compatibility
148 * Fixed: don't try to parse mentions or hashtags for very large (>1MB) posts to prevent timeouts
149 * Fixed: better handling of ISO-639-1 locale codes
150 * Improved: more reliable [ap_author], props @uk3
151 * Improved: NodeInfo statistics
152
153 = 1.0.10 =
154
155 * Improved: better error messages if remote profile is not accessible
156
157 = 1.0.9 =
158
159 * Fixed: broken following endpoint
160
161 = 1.0.8 =
162
163 * Fixed: blocking of HEAD requests
164 * Fixed: PHP fatal error
165 * Fixed: several typos
166 * Fixed: error codes
167 * Improved: loading of shortcodes
168 * Updated: caching of followers
169 * Updated: Application-User is no longer "indexable"
170 * Updated: more consistent usage of the `application/activity+json` Content-Type
171 * Removed: featured tags endpoint
172
173 = 1.0.7 =
174
175 * Fixed: broken function call
176 * Add: filter to hook into "is blog public" check
177
178 = 1.0.6 =
179
180 * Fixed: more restrictive request verification
181
182 = 1.0.5 =
183
184 * Fixed: compatibility with WebFinger and NodeInfo plugin
185
186 = 1.0.4 =
187
188 * Fixed: Constants were not loaded early enough, resulting in a race condition
189 * Fixed: Featured image was ignored when using the block editor
190
191 = 1.0.3 =
192
193 * Fixed: compatibility with older WordPress/PHP versions
194 * Update: refactoring of the Plugin init process
195 * Update: better frontend UX and improved theme compat for blocks
196 * Compatibility: add a ACTIVITYPUB_DISABLE_REWRITES constant
197 * Compatibility: add pre-fetch hook to allow plugins to hang filters on
198
199 = 1.0.2 =
200
201 * Updated: improved hashtag visibility in default template
202 * Updated: reduced number of followers to be checked/updated via Cron, when System Cron is not set up
203 * Updated: check if username of Blog-User collides with an Authors name
204 * Compatibility: improved Group meta informations
205 * Fixed: detection of single user mode
206 * Fixed: remote delete
207 * Fixed: styles in Follow-Me block
208 * Fixed: various encoding and formatting issues
209 * Fixed: (health) check Author URLs only if Authors are enabled
210
211 = 1.0.1 =
212
213 * Update: improve image attachment detection using the block editor
214 * Update: better error code handling for API responses
215 * Update: use a tag stack instead of regex for protecting tags for Hashtags and @-Mentions
216 * Compatibility: better signature support for subpath-installations
217 * Compatibility: allow deactivating blocks registered by the plugin
218 * Compatibility: avoid Fatal Errors when using ClassicPress
219 * Compatibility: improve the Group-Actor to play nicely with existing implementations
220 * Fixed: truncate long blog titles and handles for the "Follow me" block
221 * Fixed: ensure that only a valid user can be selected for the "Follow me" block
222 * Fixed: fix a typo in a hook name
223 * Fixed: a problem with signatures when running WordPress in a sub-path
224
225 = 1.0.0 =
226
227 * Add: blog-wide Account (catchall, like `example.com@example.com`)
228 * Add: a Follow Me block (help visitors to follow your Profile)
229 * Add: Signature Verification: https://docs.joinmastodon.org/spec/security/
230 * Add: a Followers Block (show off your Followers)
231 * Add: Simple caching
232 * Add: Collection endpoints for Featured Tags and Featured Posts
233 * Add: Better handling of Hashtags in mobile apps
234 * Update: Complete rewrite of the Follower-System based on Custom Post Types
235 * Update: Improved linter (PHPCS)
236 * Compatibility: Add a new conditional, `\Activitypub\is_activitypub_request()`, to allow third-party plugins to detect ActivityPub requests
237 * Compatibility: Add hooks to allow modifying images returned in ActivityPub requests
238 * Compatibility: Indicate that the plugin is compatible and has been tested with the latest version of WordPress, 6.3
239 * Compatibility: Avoid PHP notice on sites using PHP 8.2
240 * Fixed: Load the plugin later in the WordPress code lifecycle to avoid errors in some requests
241 * Fixed: Updating posts
242 * Fixed: Hashtag now support CamelCase and UTF-8
243
244 = 0.17.0 =
245
246 * Fix type-selector
247 * Allow more HTML elements in Activity-Objects
248
249 = 0.16.5 =
250
251 * Return empty content/excerpt on password protected posts/pages
252
253 = 0.16.4 =
254
255 * Remove scripts later in the queue, to also handle scripts added by blocks
256 * Add published date to author profiles
257
258 = 0.16.3 =
259
260 * "cc", "to", ... fields can either be an array or a string
261 * Remove "style" and "script" HTML elements from content
262
263 = 0.16.2 =
264
265 * Fix fatal error in outbox
266
267 = 0.16.1 =
268
269 * Fix "update and create, posts appear blank on Mastodon" issue
270
271 = 0.16.0 =
272
273 * Add "Outgoing Mentions" ([#213](https://github.com/pfefferle/wordpress-activitypub/pull/213)) props [@akirk](https://github.com/akirk)
274 * Add configuration item for number of images to attach ([#248](https://github.com/pfefferle/wordpress-activitypub/pull/248)) props [@mexon](https://github.com/mexon)
275 * Use shortcodes instead of custom templates, to setup the Activity Post-Content ([#250](https://github.com/pfefferle/wordpress-activitypub/pull/250)) props [@toolstack](https://github.com/toolstack)
276 * Remove custom REST Server, because the needed changes are now merged into Core.
277 * Fix hashtags ([#261](https://github.com/pfefferle/wordpress-activitypub/pull/261)) props [@akirk](https://github.com/akirk)
278 * Change priorites, to maybe fix the hashtag issue
279
280 = 0.15.0 =
281
282 * Enable ActivityPub only for users that can `publish_posts`
283 * Persist only public Activities
284 * Fix remote-delete
285
286 = 0.14.3 =
287
288 * Better error handling. props [@akirk](https://github.com/akirk)
289
290 = 0.14.2 =
291
292 * Fix Critical error when using Friends Plugin and adding new URL to follow. props [@akirk](https://github.com/akirk)
293
294 = 0.14.1 =
295
296 * Fix "WebFinger not compatible with PHP < 8.0". props [@mexon](https://github.com/mexon)
297
298 = 0.14.0 =
299
300 * Friends support: https://wordpress.org/plugins/friends/ props [@akirk](https://github.com/akirk)
301 * Massive guidance improvements. props [mediaformat](https://github.com/mediaformat) & [@akirk](https://github.com/akirk)
302 * Add Custom Post Type support to outbox API. props [blueset](https://github.com/blueset)
303 * Better hash-tag support. props [bocops](https://github.com/bocops)
304 * Fix user-count (NodeInfo). props [mediaformat](https://github.com/mediaformat)
305
306 = 0.13.4 =
307
308 * fix webfinger for email identifiers
309
310 = 0.13.3 =
311
312 * fix: Create and Note should not have the same ActivityPub ID
313
314 = 0.13.2 =
315
316 * fix Follow issue AGAIN
317
318 = 0.13.1 =
319
320 * fix Inbox issue
321
322 = 0.13.0 =
323
324 * add Autor URL and WebFinger health checks
325 * fix NodeInfo endpoint
326
327 = 0.12.0 =
328
329 * use "pre_option_require_name_email" filter instead of "check_comment_flood". props [@akirk](https://github.com/akirk)
330 * save only comments/replies
331 * check for an explicit "undo -> follow" action. see https://wordpress.org/support/topic/qs-after-latest/
332
333 = 0.11.2 =
334
335 * fix inconsistent `%tags%` placeholder
336
337 = 0.11.1 =
338
339 * fix follow/unfollow actions
340
341 = 0.11.0 =
342
343 * add support for customizable post-content
344 * first try of a delete activity
345 * do not require email for AP entries. props [@akirk](https://github.com/akirk)
346 * fix [timezones](https://github.com/pfefferle/wordpress-activitypub/issues/63) bug. props [@mediaformat](https://github.com/mediaformat)
347 * fix [digest header](https://github.com/pfefferle/wordpress-activitypub/issues/104) bug. props [@mediaformat](https://github.com/mediaformat)
348
349
350 = 0.10.1 =
351
352 * fix inbox activities, like follow
353 * fix debug
354
355 = 0.10.0 =
356
357 * add image alt text to the ActivityStreams attachment property in a format that Mastodon can read. props [@BenLubar](https://github.com/BenLubar)
358 * use the "summary" property for a title as Mastodon does. props [@BenLubar](https://github.com/BenLubar)
359 * support authorized fetch to avoid having comments from "Anonymous". props [@BenLubar](https://github.com/BenLubar)
360 * add new post type: "title and link only". props [@bgcarlisle](https://github.com/bgcarlisle)
361
362 = 0.9.1 =
363
364 * disable shared inbox
365 * disable delete activity
366
367 = 0.9.0 =
368
369 * some code refactorings
370 * fix #73
371
372 = 0.8.3 =
373
374 * fixed accept header bug
375
376 = 0.8.2 =
377
378 * add all required accept header
379 * better/simpler accept-header handling
380 * add debugging mechanism
381 * Add setting to enable AP for different (public) Post-Types
382 * explicit use of global functions
383
384 = 0.8.1 =
385
386 * fixed PHP warnings
387
388 = 0.8.0 =
389
390 * Moved followers list to user-menu
391
392 = 0.7.4 =
393
394 * added admin_email to metadata, to be able to "Manage your instance" on https://fediverse.network/manage/
395
396 = 0.7.3 =
397
398 * refactorings
399 * fixed PHP warnings
400 * better hashtag regex
401
402 = 0.7.2 =
403
404 * fixed JSON representation of posts https://merveilles.town/@xuv/101907542498716956
405
406 = 0.7.1 =
407
408 * fixed inbox problems with pleroma
409
410 = 0.7.0 =
411
412 * finally fixed pleroma compatibility
413 * added "following" endpoint
414 * simplified "followers" endpoint
415 * fixed default value problem
416
417 = 0.6.0 =
418
419 * add tags as hashtags to the end of each activity
420 * fixed pleroma following issue
421 * followers-list improvements
422
423 = 0.5.1 =
424
425 * fixed name-collision that caused an infinite loop
426
427 = 0.5.0 =
428
429 * complete refactoring
430 * fixed bug #30: Password-protected posts are federated
431 * only send Activites when ActivityPub is enabled for this post-type
432
433 = 0.4.4 =
434
435 * show avatars
436
437 = 0.4.3 =
438
439 * finally fixed backlink in excerpt/summary posts
440
441 = 0.4.2 =
442
443 * fixed backlink in excerpt/summary posts (thanks @depone)
444
445 = 0.4.1 =
446
447 * finally fixed contact list
448
449 = 0.4.0 =
450
451 * added settings to enable/disable hashtag support
452 * fixed follower list
453 * send activities only for new posts, otherwise send updates
454
455 = 0.3.2 =
456
457 * added "followers" endpoint
458 * change activity content from blog 'excerpt' to blog 'content'
459
460 = 0.3.1 =
461
462 * better json encoding
463
464 = 0.3.0 =
465
466 * basic hashtag support
467 * temporarily deactivated likes and boosts
468 * added support for actor objects
469 * fixed encoding issue
470
471 = 0.2.1 =
472
473 * customizable backlink (permalink or shorturl)
474 * show profile-identifiers also on profile settings
475
476 = 0.2.0 =
477
478 * added option to switch between content and excerpt
479 * removed html and duplicate new-lines
480
481 = 0.1.1 =
482
483 * fixed "excerpt" in AS JSON
484 * added settings for the activity-summary and for the activity-object-type
485
486 = 0.1.0 =
487
488 * added basic WebFinger support
489 * added basic NodeInfo support
490 * fully functional "follow" activity
491 * send new posts to your followers
492 * receive comments from your followers
493
494 = 0.0.2 =
495
496 * refactoring
497 * functional inbox
498 * nicer profile views
499
500 = 0.0.1 =
501
502 * initial
503
504 == Upgrade Notice ==
505
506 = 1.0.0 =
507
508 For version 1.0.0 we have completely rebuilt the followers lists. There is a migration from the old format to the new, but it may take some time until the migration is complete. No data will be lost in the process, please give the migration some time.
509
510 == Installation ==
511
512 Follow the normal instructions for [installing WordPress plugins](https://wordpress.org/support/article/managing-plugins/).
513
514 = Automatic Plugin Installation =
515
516 To add a WordPress Plugin using the [built-in plugin installer](https://codex.wordpress.org/Administration_Screens#Add_New_Plugins):
517
518 1. Go to [Plugins](https://codex.wordpress.org/Administration_Screens#Plugins) > [Add New](https://codex.wordpress.org/Plugins_Add_New_Screen).
519 1. Type "`activitypub`" into the **Search Plugins** box.
520 1. Find the WordPress Plugin you wish to install.
521 1. Click **Details** for more information about the Plugin and instructions you may wish to print or save to help setup the Plugin.
522 1. Click **Install Now** to install the WordPress Plugin.
523 1. The resulting installation screen will list the installation as successful or note any problems during the install.
524 1. If successful, click **Activate Plugin** to activate it, or **Return to Plugin Installer** for further actions.
525
526 = Manual Plugin Installation =
527
528 There are a few cases when manually installing a WordPress Plugin is appropriate.
529
530 * If you wish to control the placement and the process of installing a WordPress Plugin.
531 * If your server does not permit automatic installation of a WordPress Plugin.
532 * If you want to try the [latest development version](https://github.com/pfefferle/wordpress-activitypub).
533
534 Installation of a WordPress Plugin manually requires FTP familiarity and the awareness that you may put your site at risk if you install a WordPress Plugin incompatible with the current version or from an unreliable source.
535
536 Backup your site completely before proceeding.
537
538 To install a WordPress Plugin manually:
539
540 * Download your WordPress Plugin to your desktop.
541 * Download from [the WordPress directory](https://wordpress.org/plugins/activitypub/)
542 * Download from [GitHub](https://github.com/pfefferle/wordpress-activitypub/releases)
543 * If downloaded as a zip archive, extract the Plugin folder to your desktop.
544 * With your FTP program, upload the Plugin folder to the `wp-content/plugins` folder in your WordPress directory online.
545 * Go to [Plugins screen](https://codex.wordpress.org/Administration_Screens#Plugins) and find the newly uploaded Plugin in the list.
546 * Click **Activate** to activate it.
547