sedi-relay/README.md

24 lines
606 B
Markdown
Raw Normal View History

2018-10-30 03:17:25 +00:00
# ActivityRelay
2018-08-10 18:36:17 +00:00
2018-10-30 03:17:25 +00:00
A generic LitePub message relay.
2018-08-18 05:05:48 +00:00
## Copyleft
2018-10-30 03:17:25 +00:00
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.
2018-08-18 05:05:48 +00:00
2018-10-30 03:17:25 +00:00
## Getting Started
2018-08-18 05:05:48 +00:00
2018-10-30 03:17:25 +00:00
Normally, you would direct your LitePub instance software to follow the LitePub actor
found on the relay. In Pleroma this would be something like:
2018-08-18 05:05:48 +00:00
2022-05-06 07:04:51 +00:00
$ MIX_ENV=prod mix relay_follow https://your.relay.hostname/actor
2022-05-06 07:04:51 +00:00
## Documentation
2022-05-06 07:04:51 +00:00
To install or manage your relay, check the [documentation](docs/index.md)