# 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](docs/index.md)
