Watch 1

Star 0

HTTPS

Download ZIP Download TAR.GZ Download BUNDLE Open with VS Code Open with VSCodium Open with Intellij IDEA

appy

appy

A lightweight server implementing the ActivityPub protocol in Python over fastAPI.

---

Key Features

• Full support for the ActivityPub protocol (actors, activities, inbox, outbox, etc.).
• Compatible with federated platforms like Akkoma, Mastodon, Misskey and Pleroma
• Accesible via API only.
• HTTP Signatures support for secure communication.

---

Built With

FastAPI Pydantic Uvicorn asyncpg

Requirements

Dependencies

• Python: Version 3.10 or later.
• Postgresql: Running Postgresql server with a created role with LOGIN and CREATEDB privileges.
• Redis: Running Redis server with requirepass enabled.
• Libraries:
  • FastAPI
  • uvicorn
  • httpx
  • cryptography
  • asyncpg

Getting Started

Follow these steps to run the server locally:

1. Clone the Repository
   Clone the project repository to your local machine:

git clone https://codeberg.org/spla/appy.git
cd appy

2. Create Python Virtual Environment Create the Python Virtual Environment::

python3.x -m venv .

Don't forget the . at then end

3. Activate it
   Enable Python Environment::

source bin/activate

4. Install Dependencies
   Install the required Python libraries:

pip install -r requirements.txt

5. Copy dist/nginx.conf to /etc/nginx/sites-available/<your_appy_domain>.conf and edit it to change <example.net> to your domain.

6. Enable it with:

ln -s /etc/nginx/sites-available/<your_appy_domain>.conf /etc/nginx/sites-enabled/<your_appy_domain>.conf

7. Check if nginx like it:

nginx -t

8. Restart nginx.

9. Run the Server
   Start the server with the following command:

python app/main.py

First time run will ask for needed parameters and will create your user profile. Later on, the server will be running locally at http://127.0.0.1:{configured_port}.

Updating

Update appy by issuing:

git pull origin main && git fetch --tags

Usage Example

Here’s how to interact with the server. Use any of the following apps to sign in:

iOS: Icecubes, Ivory, Mastodon (official), Mona, Tusker
Android: Fedilab, Mastodon (official), Moshidon, Pachli, Tusky

Architecture

The server is built to follow the standard ActivityPub flow: 1. An actor sends an activity via the outbox. 2. The server signs the activity with HTTP Signatures and dispatches it to the inboxes of other actors. 3. Recipient actors process the activity in their inbox.

A simplified diagram of the flow:

[Client] --> [Outbox] --> [HTTP Signatures] --> [Remote Inbox]
↑ ↓
[ActivityPub Actor] <-- [Inbox] <-- [HTTP Signature check] <-- [Remote Outbox]

Contributing

We welcome contributions to the project! To get started:

1. Fork this repository.
2. Create a new branch for your feature or fix:

git checkout -b feature/new-feature

3. Make your changes and commit them with a clear message:

git commit -m "Add new feature"

4. Push your branch:

git push origin feature/new-feature

5. Submit a pull request.

Please ensure that your code follows the PEP 8 style guide.

License

This project is licensed under the GNU GENERAL PUBLIC LICENSE. See the LICENSE file for more details.

Additional Resources

Here are some resources to help you understand ActivityPub and related technologies:
• Official ActivityPub Documentation
• Mastodon's really great API docs
• FastAPI Documentation
• Understanding ActivityPub

Support

If you encounter any issues, feel free to open an issue or contact the project maintainer.