https://github.com/greg-kennedy/phpactivitypub
Simple, post-only ActivityPub implementation in PHP
https://github.com/greg-kennedy/phpactivitypub
activitypub activitystreams fediverse php
Last synced: 10 days ago
JSON representation
Simple, post-only ActivityPub implementation in PHP
- Host: GitHub
- URL: https://github.com/greg-kennedy/phpactivitypub
- Owner: greg-kennedy
- License: cc0-1.0
- Created: 2022-11-27T00:38:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-09T13:42:42.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T11:12:43.480Z (10 days ago)
- Topics: activitypub, activitystreams, fediverse, php
- Language: PHP
- Homepage:
- Size: 20.5 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# phpActivityPub
Greg Kennedy, 2023
Small, post-only ActivityPub implementation in PHP
## Overview
This is a PHP-based project to allow a host to post messages into the Fediverse to subscribed Followers. It implements the minimum of [the ActivityPub spec](https://www.w3.org/TR/activitypub/) for server-to-server federation, specifically:
* a WebFinger response at /.well-known/webfinger to describe Actor inboxes and accounts
* an Inbox which receives (and approves) Follow and Undo-Follow requests
* a post.php webhook which accepts a post and broadcasts it to Followers' inboxes
These features together allow the host's accounts to be discoverable by other ActivityPub servers, and they may issue Follow requests which are automatically approved. When this host wants to make a post, a cURL call will then broadcast the message to all Followers who have opted in.
It is similar to [express-activitypub](https://github.com/dariusk/express-activitypub) by Darius Kazemi, except written in PHP instead of Node.js.
There is a basic human-readable Index page with information about the Actors located on the server. For managing Actors on this host, or manual posting, there is an admin page as well. Newly created actors receive a randomized API Key, which must be included in the header of subsequent calls to the post.php webhook.
Note that this extremely reduced spec is missing a lot of critical functionality one would expect in an ActivityPub service - for example, phpActivityPub does not accept posts from others. It is thus mostly useful as a tool for bots, relays (RSS / Twitter / etc), or other read-only broadcast applications.
## Requirements
* PHP
* php-sqlite3
* php-openssl
* php-curl
* Web server: I use Apache with `.htaccess` rewrites, you will need alternate rules for other servers
## Installation
Clone the repository into your web service HTML tree.
The `admin/` folder is password-protected using HTTP Basic auth with a `.htpasswd` file. Use the `htpasswd` utility to create a username and password for logging in.
## Posting
Log into the Admin page and click "create" to set up a new Actor. The server will provide a random string of characters for your Key, which must be present in an HTTP "X-API-KEY" header to post.
Posts should be JSON and will be added to the necessary Activity fields to build a complete post. Some examples of post body:
```json
{ "content": "Hello, world!" }
```
creates a Note (the default) with the text "Hello, world!"
```json
{ "type": "Link", "url": "http://www.example.com" }
```
```json
{ "type": "Image", "url": "http://www.example.com/image.jpg" }
```
etc.