You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Reid 'arrdem' McKenzie 4593021e4f Update the README a smidge 2 weeks ago
docs docs: don't assume activityrelay is in PATH 7 months ago
installation add caddyfile and systemd service 4 years ago
relay Merge !40 2 weeks ago
.gitignore Add config file to gitignore 3 years ago
Dockerfile Reorganize codebase 7 months ago
LICENSE Initial commit 4 years ago
README.md Update the README a smidge 2 weeks ago
docker.sh Reorganize codebase 7 months ago
pyproject.toml add packaging 1 year ago
relay.yaml.example Reorganize codebase 7 months ago
requirements.txt Reorganize codebase 7 months ago
setup.cfg version bump 4 months ago
setup.py add packaging 1 year ago

README.md

ActivityRelay

A generic LitePub message relay.

This relay is forked from https://git.pleroma.social/pleroma/relay, and patched to a working state.

What is a relay?

A relay is a webserver implementing ActivityPub/LitePub. Normally when posting content on an ActivityPub server, that content is only listed publicly on the feed of the hosting server. Relays provide a way for ActivityPub servers to announce posts to a wider audience and receive posts from elsewhere.

What is this program?

The relay itself is a webserver providing two major components.

  • A hardcoded webfinger implementation for resolving the user acct:relay@your.relay.hostname
  • A message relay, which will perform a stateless relay of new activity to connected nodes

The relay offers three moderation capabilities:

  • An explicit allowlist mode restricting connected nodes
  • A denylist mode restricting connected nodes by name
  • A denylist mode restricting connected nodes by self-identified server software

Getting Started

Normally, you would direct your LitePub instance software to follow the LitePub actor found on the relay. In Pleroma this would be something like:

$ MIX_ENV=prod mix relay_follow https://your.relay.hostname/actor

On Mastodon the process is similar, in Administration > Relays > Add New Relay one would list the relay's URL

https://your.relay.hostname/actor

Copyleft

ActivityRelay is copyrighted, but free software, licensed under the terms of the GNU Affero General Public License version 3 (AGPLv3) license. You can find a copy of it in this package as the LICENSE file.