README.md 606 Bytes
Newer Older
kaniini's avatar
kaniini committed
1
# ActivityRelay
kaniini's avatar
kaniini committed
2

kaniini's avatar
kaniini committed
3
A generic LitePub message relay.
kaniini's avatar
kaniini committed
4
5
6
7


## Copyleft

kaniini's avatar
kaniini committed
8
9
10
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.
kaniini's avatar
kaniini committed
11
12


kaniini's avatar
kaniini committed
13
## Getting Started
kaniini's avatar
kaniini committed
14

kaniini's avatar
kaniini committed
15
16
Normally, you would direct your LitePub instance software to follow the LitePub actor
found on the relay.  In Pleroma this would be something like:
kaniini's avatar
kaniini committed
17

Izalia Mae's avatar
Izalia Mae committed
18
	$ MIX_ENV=prod mix relay_follow https://your.relay.hostname/actor
19
20


Izalia Mae's avatar
Izalia Mae committed
21
## Documentation
22

Izalia Mae's avatar
Izalia Mae committed
23
To install or manage your relay, check the [documentation](docs/index.md)