![]() |
||
---|---|---|
.htaccess | ||
CRAPL-LICENSE.txt | ||
README.md | ||
agpl-3.0.txt | ||
banner.png | ||
icon.png | ||
index.php | ||
robots.txt |
README.md
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.
- Edit the
index.php
file to add a username, password, and keypair. - Upload
index.php
and.htaccess
to the root directory of your domain. For exampletest.example.com/
. It will not work in a subdirectory. - Optionally, upload an
icon.png
to make the user look nice. - Visit
https://test.example.com/.well-known/webfinger
and check that it shows a JSON file with your user's details. - Go to Mastodon or other Fediverse site and search for your user:
@username@test.example.com
- Follow your user.
- Check your
/data/logs/
directory to see if the follow request was received correctly. - To post a message, visit
https://test.example.com/write
type in your message and password. Press the "Post Message" button. - Check social media to see if the message appears.
- To follow other users, visit
https://test.example.com/follow
type in the name of the user you want to follow and your password. Press the "Send Follow Request" button. - Check social media to see if the follow request came through.
- To read the messages that your server's inbox has received, visit
https://test.example.com/read
How this works
- The
.htaccess
file transforms requests fromexample.com/whatever
toexample.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
/data/logs
directory. - Post files are saved as .json in the
/posts
directory. - Details of accounts who follow you are saved as .json in the
/data/followers
directory. - Details of accounts who you follow are saved as .json in the
/data/following
directory. - Messages sent to your inbox are saved as .json in the
/data/inbox
directory. - This has sloppy support for sending posts with linked #hashtags, https:// URls, and @ mentions.
- HTTP Message Signatures are verified.
Requirements
- PHP 8.3 (We live in the future now)
- The OpenSSL Extension (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. This means, if you modify this code and let other people interact with it over a computer network, you must release the source code.
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:
Any appearance of design in the Program is purely coincidental and should not in any way be mistaken for evidence of thoughtful software construction.