Skip to content

Latest commit

 

History

History
98 lines (63 loc) · 4.24 KB

README.md

File metadata and controls

98 lines (63 loc) · 4.24 KB
Raw

 

Ghost Ghost

 

ActivityPub 🚧

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.

Subscribe to updates

We're publishing a weekly build-log about the development of this project. Sign up on https://activitypub.ghost.org

image

 

How it works

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.

Current features

  • Follow
  • Unfollow
  • Auto Accept Follows
  • Manually Accept/Reject Follows
  • Publish Articles to Followers
  • Receive Articles in Inbox
  • Receive Notes in Inbox

 

Running locally for development

This has only been tested on macOS using Docker for Mac and OrbStack.

Setup

  1. Install Ghost
    • Ensure Ghost is running locally at localhost:2368
  2. Proxy with Tailscale (or ngrok)
    • Use tailscale funnel 80 or ngrok http 80 to expose your local port 80
  3. Configure Ghost
    • Run ghost config url and set it to the URL provided by Tailscale
  4. Start the ActivityPub Service
    • Run yarn dev in the root directory of this project
  5. Open Ghost Admin
    • Access your Ghost instance via the URL provided by Tailscale
  6. Enable ActivityPub Alpha
    • Enable the ActivityPub Alpha flag in Settings → Labs
  7. Restart Ghost
    • This will do the handshake between Ghost and ActivityPub to setup webhooks and Actor data

Code formatting + linting

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.

Running Tests

  • Run yarn test to execute tests within a Docker Compose stack.

Populating the DB

The below command will populate the DB with ~5000 followers for the activitypub host

  • Run docker compose run scripts populate-activitypub-db

Migrations

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

 

Community leaderboard

Leaderboard

 

Copyright & license

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.