activitypub-single-php-file/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 header 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 example `test.example.com/`. It will not work in a subdirectory.

Optionally, upload an `icon.png` as well to make the account look nice.

## 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.

##	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)
* 50MB free disk space (ActivityPub is a very "chatty" protocol. Expect lots of logs.)
Initial upload 2024-02-12 21:21:05 +00:00			`# ActivityPub Server in a Single PHP File`
Initial commit 2024-02-12 21:08:34 +00:00
Initial upload 2024-02-12 21:21:05 +00:00			This is a single PHP file - and an `.htaccess file` - which acts as an extremely basic ActivityPub server.
Initial commit 2024-02-12 21:08:34 +00:00
			`## Getting started`

Initial upload 2024-02-12 21:21:05 +00:00			`This is designed to be a lightweight educational tool to show you the basics of how ActivityPub works.`
Initial commit 2024-02-12 21:08:34 +00:00
Initial upload 2024-02-12 21:21:05 +00:00			`There are no tests, no checks, no security features, no header verifications, no containers, no gods, no masters.`
Initial commit 2024-02-12 21:08:34 +00:00
Update README 2024-02-16 08:51:52 +00:00			Edit the `index.php` file to add a username, password, and keypair.
Initial commit 2024-02-12 21:08:34 +00:00
Update README 2024-02-16 08:51:52 +00:00			Upload `index.php` and `.htaccess` to the root directory of your domain. For example `test.example.com/`. It will not work in a subdirectory.
Initial commit 2024-02-12 21:08:34 +00:00
Initial upload 2024-02-12 21:21:05 +00:00			Optionally, upload an `icon.png` as well to make the account look nice.
Initial commit 2024-02-12 21:08:34 +00:00
Initial upload 2024-02-12 21:21:05 +00:00			`## How this works`
Initial commit 2024-02-12 21:08:34 +00:00
Initial upload 2024-02-12 21:21:05 +00:00			* 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.
Readme 2024-02-15 10:25:17 +00:00			* Log files are saved as .txt in the `/logs` directory.
Initial upload 2024-02-12 21:21:05 +00:00			* Post files are saved as .json in the `/posts` directory.
Update README 2024-02-16 08:51:52 +00:00
			`## 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)`
			`* 50MB free disk space (ActivityPub is a very "chatty" protocol. Expect lots of logs.)`