mirror of https://git.pleroma.social/pleroma/relay.git synced 2024-11-09 01:57:58 +00:00

Pleroma ActivityRelay

Go to file

Izalia Mae 38ea8b390e ensure int config values are above 0		2024-02-18 08:02:29 -05:00
docs	add swagger api docs	2024-02-16 20:25:50 -05:00
installation	update relay.service file to use run command	2024-01-23 22:04:07 -05:00
relay	ensure int config values are above 0	2024-02-18 08:02:29 -05:00
.gitignore	use postgresql/sqlite for database backend	2024-01-22 05:32:16 -05:00
dev-requirements.txt	move dev requirements to dev-requirements.txt and only use flake8 for checking unused imports	2024-01-23 21:51:17 -05:00
docker.sh	Reorganize codebase	2022-05-06 07:04:51 +00:00
Dockerfile	Reorganize codebase	2022-05-06 07:04:51 +00:00
LICENSE	Initial commit	2018-08-10 18:36:17 +00:00
MANIFEST.in	add swagger api docs	2024-02-16 20:25:50 -05:00
pyproject.toml	add plugins to pylint	2024-01-23 21:54:05 -05:00
README.md	Reorganize codebase	2022-05-06 07:04:51 +00:00
relay.spec	fix running via pyinstaller bin	2024-02-16 21:05:12 -05:00
relay.yaml.example	add database and redis caching	2024-01-31 21:23:45 -05:00
requirements.txt	add swagger api docs	2024-02-16 20:25:50 -05:00
setup.cfg	add swagger api docs	2024-02-16 20:25:50 -05:00
setup.py	add packaging	2021-10-14 16:09:21 -04:00

README.md

ActivityRelay

A generic LitePub message relay.

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.

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

Documentation

To install or manage your relay, check the documentation