Discuss PieFed project direction, provide feedback, ask questions, suggest improvements, and engage in conversations related to the platform organization, policies, features, and community dynamics.
\nKey updates include the addition of community icons for better identification, a notification management interface, and various enhancements to our API for eventual mobile app support. Below is a detailed overview of the changes we've made.
\n--
\nAs a free and open source project, PieFed receives no funding and developers are not paid. Any donations you can spare will help cover server and infrastructure costs - https://piefed.social/donate. Thanks!
\n", + "id": "https://piefed.social/post/317673", + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "name": "PieFed development update Oct/Nov 2024", + "published": "2024-11-09T00:36:19.078892+00:00", + "replies": [ + { + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "attributedTo": "https://piefed.social/u/imaqtpie", + "audience": "https://piefed.social/c/piefed_meta", + "cc": [ + "https://piefed.social/c/piefed_meta", + "https://piefed.social/u/imaqtpie/followers" + ], + "content": "Good work! Much thanks to all contributors, you are appreciated. The site is running smooth and looking great.
\n", + "distinguished": false, + "id": "https://piefed.social/comment/3526458", + "inReplyTo": "https://piefed.social/post/317673", + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "published": "2024-11-09T03:55:50.533858+00:00", + "source": { + "content": "Good work! Much thanks to all contributors, you are appreciated. The site is running smooth and looking great.", + "mediaType": "text/markdown" + }, + "to": [ + "https://www.w3.org/ns/activitystreams#Public", + "https://piefed.social/u/rimu" + ], + "type": "Note" + } + ], + "searchableBy": "https://www.w3.org/ns/activitystreams#Public", + "sensitive": false, + "source": { + "content": "Key updates include the addition of community icons for better identification, a notification management interface, and various enhancements to our API for eventual mobile app support. Below is a detailed overview of the changes we've made.\r\n\r\n##Jeena\r\n\r\n- Community icon alongside name in post teaser. This helps differentiate between communities with the same name and adds visual interest.\r\n\r\n##Freamon\r\n\r\n- Added a notification management interface to manage notifications from all the communities and posts you are subscribed to - https://piefed.social/alerts\r\n- Soft deletion of comments, so they can be un-deleted again.\r\n- Lots of API work for the mobile app. Lots!\r\n\r\n#Rimu\r\n\r\n- Generate YouTube thumbnails more reliably.\r\n- Instance overview pages which make it easy to see posts and people from any instance. Start exploring at https://piefed.social/instances.\r\n- FEP-268d: Search consent signals for objects. This FEP is a convention for how instances can signal to other instances which posts should be searchable.\r\n- Track who deleted which posts, for accountability among moderators.\r\n- Refactoring to support API work by Freamon.\r\n- Automatically delete voting data older than 6 months (aggregated totals are unaffected). Voting data consumes gigabytes of space and it only meaningfully affects ranking of posts in the first few days. The only other reason to keep this data is for vote manipulation analysis and 6 months worth of data should be plenty.\r\n- Instances with open registrations automatically close registrations after one week of having no admins log in. This will avoid abandoned instances becoming a vector for spam or a home of trolls.\r\n- Show instance name after display name. If you notice undesirable patterns of behaviour associated with certain instances you can block the whole instance.\r\n- Improve visibility of user-level instance blocking functionality. This is separate and in addition to defederation which is controlled by admins.\r\n- Display PeerTube licence info on video posts. This could be rolled out to other post types in future?\r\n- Topics now have an option to show posts from communities that are in child topics. E.g. https://piefed.social/topic/arts-craft only has two communities in it so the number of posts shown there is very low. However it\u2019s child topics (Arts, Craft and Photography) have quite a few communities so to populate the top-level topic it makes sense to display posts from all the child topics too. https://piefed.social/topic/tech/programming is a similar case.\r\n\r\n\r\n--\r\n\r\nAs a free and open source project, PieFed receives no funding and developers are not paid. Any donations you can spare will help cover server and infrastructure costs - https://piefed.social/donate. Thanks!", + "mediaType": "text/markdown" + }, + "stickied": false, + "tag": [ + { + "href": "https://piefed.social/tag/fediverse", + "name": "#fediverse", + "type": "Hashtag" + }, + { + "href": "https://piefed.social/tag/piefed", + "name": "#piefed", + "type": "Hashtag" + } + ], + "to": [ + "https://piefed.social/c/piefed_meta", + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Page" + }, + "to": [ + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Create" + }, + "to": [ + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Announce" + } + +``` \ No newline at end of file diff --git a/docs/activitypub_examples/posts.md b/docs/activitypub_examples/posts.md new file mode 100644 index 00000000..d2a5e9bb --- /dev/null +++ b/docs/activitypub_examples/posts.md @@ -0,0 +1,351 @@ +# Posts as ActivityPub Objects + +Piefed has the following kinds of posts for communities. + +## Discussion / Page + +This is a discussion post on the web: https://piefed.social/post/342105 + +You can also see it represented as a `Page` object in .json format. + +Run this curl command: +```bash +curl -H 'Accept: application/activity+json' https://piefed.social/post/342105 +``` + +The result should look something like this: +```json +{ + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "attachment": [], + "attributedTo": "https://jolly-piefed.jomandoa.net/u/jollyroberts", + "audience": "https://piefed.social/c/playground", + "cc": [], + "commentsEnabled": true, + "content": "Example Discussion Post Body
\n", + "id": "https://jolly-piefed.jomandoa.net/post/79757", + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "name": "Example Discussion Post Title", + "published": "2024-11-24T22:18:50.230305+00:00", + "replies": [], + "sensitive": false, + "source": { + "content": "Example Discussion Post Body", + "mediaType": "text/markdown" + }, + "stickied": false, + "tag": [ + { + "href": "https://piefed.social/tag/tagone", + "name": "#tagone", + "type": "Hashtag" + }, + { + "href": "https://piefed.social/tag/tagtwo", + "name": "#tagtwo", + "type": "Hashtag" + } + ], + "to": [ + "https://piefed.social/c/playground", + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Page" +} + +``` + +## Link / Page + +This is a link post on the web: https://piefed.social/post/342122 + +You can also see it represented as a `Page` object in .json format. + +Run this curl command: +```bash +curl -H 'Accept: application/activity+json' https://piefed.social/post/342122 +``` + +The result should look something like this: +```json +{ + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "attachment": [ + { + "href": "https://www.w3.org/TR/activitystreams-vocabulary", + "type": "Link" + } + ], + "attributedTo": "https://jolly-piefed.jomandoa.net/u/jollyroberts", + "audience": "https://piefed.social/c/playground", + "cc": [], + "commentsEnabled": true, + "content": "Example Link Post Body
\n", + "id": "https://jolly-piefed.jomandoa.net/post/79771", + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "name": "Example Link Post Title", + "published": "2024-11-24T22:34:56.000879+00:00", + "replies": [], + "sensitive": false, + "source": { + "content": "Example Link Post Body", + "mediaType": "text/markdown" + }, + "stickied": false, + "tag": [ + { + "href": "https://piefed.social/tag/tagone", + "name": "#tagone", + "type": "Hashtag" + }, + { + "href": "https://piefed.social/tag/tagtwo", + "name": "#tagtwo", + "type": "Hashtag" + } + ], + "to": [ + "https://piefed.social/c/playground", + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Page" +} +``` + + +## Image / Page + +This is a image post on the web: https://piefed.social/post/342166 + +You can also see it represented as a `Page` object in .json format. + +Run this curl command: +```bash +curl -H 'Accept: application/activity+json' https://piefed.social/post/342166 +``` + +The result should look something like this: +```json +{ + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "attachment": [ + { + "name": "a painting of a crystal flower, AI art, stable diffusion", + "type": "Image", + "url": "https://jolly-piefed.jomandoa.net/static/media/posts/Ef/lI/EflI4MtZdsQDOUP.png" + } + ], + "attributedTo": "https://jolly-piefed.jomandoa.net/u/jollyroberts", + "audience": "https://piefed.social/c/playground", + "cc": [], + "commentsEnabled": true, + "content": "Example Image Post Body
\n", + "id": "https://jolly-piefed.jomandoa.net/post/79799", + "image": { + "type": "Image", + "url": "https://jolly-piefed.jomandoa.net/static/media/posts/Ef/lI/EflI4MtZdsQDOUP.png" + }, + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "name": "Example Image Post Title", + "published": "2024-11-24T23:19:37.419801+00:00", + "replies": [], + "sensitive": false, + "source": { + "content": "Example Image Post Body", + "mediaType": "text/markdown" + }, + "stickied": false, + "tag": [], + "to": [ + "https://piefed.social/c/playground", + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Page" +} +``` + +## Video / Page + +This is a video post on the web: https://piefed.social/post/276328 + +You can also see it represented as a `Page` object in .json format. + +Run this curl command: +```bash +curl -H 'Accept: application/activity+json' https://piefed.social/post/276328 +``` + +The result should look something like this: +```json +{ + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "attachment": [ + { + "href": "https://files.catbox.moe/swf46b.mp4", + "type": "Link" + } + ], + "attributedTo": "https://piefed.social/u/Binzy_Boi", + "audience": "https://piefed.social/c/playground", + "cc": [], + "commentsEnabled": true, + "content": "", + "id": "https://piefed.social/post/276328", + "image": { + "type": "Image", + "url": "https://files.catbox.moe/swf46b.mp4" + }, + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "name": "Video post test 3", + "published": "2024-10-14T00:03:41.660107+00:00", + "replies": [], + "sensitive": false, + "source": { + "content": "", + "mediaType": "text/markdown" + }, + "stickied": false, + "tag": [], + "to": [ + "https://piefed.social/c/playground", + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Page" +} +``` + +## Poll / Question + +This is a poll post on the web: https://piefed.social/post/341021 + +You can also see it represented as a `Question` object in .json format. + +Run this curl command: +```bash +curl -H 'Accept: application/activity+json' https://piefed.social/post/341021 +``` + +The result should look something like this: +```json +{ + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "attachment": [], + "attributedTo": "https://jolly-piefed.jomandoa.net/u/jollyroberts", + "audience": "https://piefed.social/c/playground", + "cc": [], + "commentsEnabled": true, + "content": "this is the poll post body
\n", + "endTime": "2024-11-27T00:47:11.362544+00:00", + "id": "https://jolly-piefed.jomandoa.net/post/79247", + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "name": "Poll Post Test", + "oneOf": [ + { + "name": "Yes", + "replies": { + "totalItems": 2, + "type": "Collection" + }, + "type": "Note" + }, + { + "name": "No", + "replies": { + "totalItems": 0, + "type": "Collection" + }, + "type": "Note" + }, + { + "name": "Maybe", + "replies": { + "totalItems": 0, + "type": "Collection" + }, + "type": "Note" + } + ], + "published": "2024-11-24T00:47:11.789789+00:00", + "replies": [ + { + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "attributedTo": "https://hub.netzgemeinde.eu/channel/jupiter_rowland", + "audience": "https://piefed.social/c/playground", + "cc": [ + "https://piefed.social/c/playground", + "https://hub.netzgemeinde.eu/followers/jupiter_rowland" + ], + "content": "", + "distinguished": false, + "id": "https://hub.netzgemeinde.eu/item/73970039-849a-458e-b994-3014482fe0e9", + "inReplyTo": "https://jolly-piefed.jomandoa.net/post/79247", + "language": { + "identifier": "en", + "name": "English" + }, + "mediaType": "text/html", + "published": "2024-11-24T08:22:25.906356+00:00", + "source": { + "content": "", + "mediaType": "text/markdown" + }, + "to": [ + "https://www.w3.org/ns/activitystreams#Public", + "https://jolly-piefed.jomandoa.net/u/jollyroberts" + ], + "type": "Note" + } + ], + "sensitive": false, + "source": { + "content": "this is the poll post body", + "mediaType": "text/markdown" + }, + "stickied": false, + "tag": [], + "to": [ + "https://piefed.social/c/playground", + "https://www.w3.org/ns/activitystreams#Public" + ], + "type": "Question", + "votersCount": 2 +} +``` diff --git a/docs/activitypub_examples/users.md b/docs/activitypub_examples/users.md new file mode 100644 index 00000000..754674a9 --- /dev/null +++ b/docs/activitypub_examples/users.md @@ -0,0 +1,57 @@ +# Users as ActivityPub 'Person' Actors + +Users on the fediverse are [Person](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-person) actors. + +## User objects as JSON + +Server-to-server or server-to-client traffic that represents Users are sent as .json. I.e. when a remote server wishes to find out information about your user account on your local server, the remote server will be sent that data in a json payload. + +### Getting user information + +Piefed internally keeps track of users in a database, but you can query the information from the server as .json. There are many ways to do so, but here is an example using `curl`. + +We will use the https://piefed.social flagship instance in the example. We will ask for information about the `rimu` user, PieFeds main developer. + +Run this curl command: +```bash +curl -H 'Accept: application/activity+json' https://piefed.social/u/rimu +``` + +The result should look something like this: +```json +{ + "@context": [ + "https://www.w3.org/ns/activitystreams", + "https://w3id.org/security/v1" + ], + "discoverable": true, + "endpoints": { + "sharedInbox": "https://piefed.social/inbox" + }, + "icon": { + "type": "Image", + "url": "https://piefed.social/static/media/users/oW/FB/oWFBklQomqpBX52.jpg" + }, + "id": "https://piefed.social/u/rimu", + "inbox": "https://piefed.social/u/rimu/inbox", + "indexable": true, + "manuallyApprovesFollowers": false, + "matrixUserId": "@rimuatkinson:matrix.org", + "name": "Rimu", + "outbox": "https://piefed.social/u/rimu/outbox", + "preferredUsername": "rimu", + "publicKey": { + "id": "https://piefed.social/u/rimu#main-key", + "owner": "https://piefed.social/u/rimu", + "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA165M8pQFvf7YY08Yt9pM\nC7CAf9nW/Xy16dk65pIsdKZ42Le1eQrJ6vEplbFdeO7WJkF89liSBnSnYhdfKCId\nGg1hD5rDjKNHgvNPNWHh2y4KXGgkZ2ry6uxk1h4iAu+zJbQ7l2gUHscalY1/wtOz\naRPGKdhN6A49VShjujTHBV3ZxieddC60AjF5m/CHeNg0PXCdfvdqniOp9m33+2bF\nEYnyV4IbreBg24tmmxWAjEaH0NntCh/5KhLz3YZcqQnrmC5QNNk5K1yeeEDMukOd\nK+tT0khsudgcfC26iBdzyKUNXkKOwSP1ivBSPEFxMKqJvL0BKhjtm8WjQMJhZVOM\nrwIDAQAB\n-----END PUBLIC KEY-----\n" + }, + "published": "2024-01-04T03:12:32.116738+00:00", + "source": { + "content": "Developer of [PieFed](https://piefed.social), a sibling of Lemmy & Kbin.", + "mediaType": "text/markdown" + }, + "summary": "Developer of PieFed, a sibling of Lemmy & Kbin.
\n", + "type": "Person" +} +``` +