47 wiersze
2.9 KiB
Markdown
47 wiersze
2.9 KiB
Markdown
# ActivityPub Server in a Single PHP File
|
|
|
|
This is a single PHP file - and an `.htaccess file` - which acts as an extremely basic ActivityPub server.
|
|
|
|
## Getting started
|
|
|
|
This is designed to be a lightweight educational tool to show you the basics of how ActivityPub works.
|
|
|
|
There are no tests, no checks, no security features, no formal verifications, no containers, no gods, no masters.
|
|
|
|
1. Edit the `index.php` file to add a username, password, and keypair.
|
|
1. Upload `index.php` and `.htaccess` to the *root* directory of your domain. For example `test.example.com/`. It will not work in a subdirectory.
|
|
1. Optionally, upload an `icon.png` to make the user look nice.
|
|
1. Visit `https://test.example.com/.well-known/webfinger` and check that it shows a JSON file with your user's details.
|
|
1. Go to Mastodon or other Fediverse site and search for your user: `@username@test.example.com`
|
|
1. Follow your user.
|
|
1. Check your `/logs/` directory to see if the follow request was received correctly.
|
|
1. To post a message, visit `https://test.example.com/write` type in your message and password. Press the "Post Message" button.
|
|
1. Check social media to see if the message appears.
|
|
|
|
## How this works
|
|
|
|
* The `.htaccess` file transforms requests from `example.com/whatever` to `example.com/index.php?path=whatever`.
|
|
* The `index.php` file performs a specific action depending on the path requested.
|
|
* Log files are saved as .txt in the `/logs` directory.
|
|
* Post files are saved as .json in the `/posts` directory.
|
|
* Followers' details are saved as .json in the `/data/followers` directory.
|
|
* This has sloppy support for linking #hashtags, https:// URls, and @ mentions.
|
|
* HTTP Message Signatures are verified.
|
|
|
|
## Requirements
|
|
|
|
* PHP 8.3 (We live in the future now)
|
|
* The [OpenSSL Extension](https://www.php.net/manual/en/book.openssl.php) (This is usually installed by default)
|
|
* HTTPS certificate (Let's Encrypt is fine)
|
|
* 100MB free disk space (ActivityPub is a very "chatty" protocol. Expect lots of logs.)
|
|
* Docker, Node, MongoDB, Wayland, GLaDOS, React, LLM, Adobe Creative Cloud, Maven (Absolutely none of these!)
|
|
|
|
## Licence
|
|
|
|
This code is released to you under the [GNU Affero General Public License v3.0 or later](https://www.gnu.org/licenses/agpl-3.0.html). This means, if you modify this code and let other people interact with it over a computer network, [you **must** release the source code](https://www.gnu.org/licenses/gpl-faq.html#UnreleasedModsAGPL).
|
|
|
|
I actively do *not* want you to use this code in production. It is not suitable for anything other than educational use. The use of AGPL is designed to be an incentive for you to learn from this software and then write something better.
|
|
|
|
Please take note of [CRAPL v0](https://matt.might.net/articles/crapl/):
|
|
|
|
> Any appearance of design in the Program is purely coincidental and should not in any way be mistaken for evidence of thoughtful software construction. |