A multitenant ActivityPub server for Ghost, built with Fedify. This service makes it possible for independent websites to publish their content directly to the Fediverse, enabling networked publishing to the open social web.
This repository is being actively developed and is currently in early alpha - expect many breaking changes. It is not suitable for production use.
We're publishing a weekly build-log about the development of this project. Sign up on https://activitypub.ghost.org
All requests to /.ghost/activitypub/*
, /.well-known/webfinger
and /.well-known/nodeinfo
are proxied to this ActivityPub service using nginx. All other requests are forwarded to Ghost.
- Follow
- Unfollow
- Auto Accept Follows
- Manually Accept/Reject Follows
- Publish Articles to Followers
- Receive Articles in Inbox
- Receive Notes in Inbox
This has only been tested on macOS using Docker for Mac and OrbStack.
- Install Ghost
- Ensure Ghost is running locally at
localhost:2368
- Ensure Ghost is running locally at
- Proxy with Tailscale (or ngrok)
- Use
tailscale funnel 80
orngrok http 80
to expose your local port 80
- Use
- Configure Ghost
- Run
ghost config url
and set it to the URL provided by Tailscale
- Run
- Start the ActivityPub Service
- Run
yarn dev
in the root directory of this project
- Run
- Open Ghost Admin
- Access your Ghost instance via the URL provided by Tailscale
- Enable ActivityPub Alpha
- Enable the ActivityPub Alpha flag in Settings → Labs
- Restart Ghost
- This will do the handshake between Ghost and ActivityPub to setup webhooks and Actor data
We use Biome for code formatting and linting.
If you use VS Code, you can install the Biome extension to get inline feedback.
To enable auto-formatting on save, you'll need to set the default formatter to Biome
and enable Format on Save
in your VS Code settings.
- Run
yarn test
to execute tests within a Docker Compose stack.
The below command will populate the DB with ~5000 followers for the activitypub
host
- Run
docker compose run scripts populate-activitypub-db
docker compose run migrate
or docker compose run migrate-testing
will run the up
migrations against your dev or testing db respectively.
If you would like to run other commands you can run docker compose exec -it migrate /bin/bash
or docker compose exec -it migrate-testing /bin/bash
- This will drop you into a shell with the migrate
binary available as well as a MYSQL_DB
environment variable that is correctly formated for use as the -database
argument to the migrate
binary
Copyright (c) 2013-2024 Ghost Foundation - Released under the MIT license. Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our trademark policy for info on acceptable usage.