forked from AkkomaGang/akkoma
Move relay docs to a separate file
This commit is contained in:
parent
6435ba83cd
commit
808d0a0170
2 changed files with 30 additions and 18 deletions
30
docs/administration/CLI_tasks/relay.md
Normal file
30
docs/administration/CLI_tasks/relay.md
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
# Managing relays
|
||||||
|
|
||||||
|
Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl relay` and in case of source installs it's `mix pleroma.relay`.
|
||||||
|
|
||||||
|
## Follow a relay
|
||||||
|
```sh
|
||||||
|
$PREFIX follow <relay_url>
|
||||||
|
```
|
||||||
|
|
||||||
|
Example:
|
||||||
|
```sh
|
||||||
|
$PREFIX follow https://example.org/relay
|
||||||
|
```
|
||||||
|
|
||||||
|
## Unfollow a remote relay
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$PREFIX unfollow <relay_url>
|
||||||
|
```
|
||||||
|
|
||||||
|
Example:
|
||||||
|
```sh
|
||||||
|
$PREFIX unfollow https://example.org/relay
|
||||||
|
```
|
||||||
|
|
||||||
|
## List relay subscriptions
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$PREFIX list
|
||||||
|
```
|
|
@ -9,25 +9,7 @@ defmodule Mix.Tasks.Pleroma.Relay do
|
||||||
alias Pleroma.Web.ActivityPub.Relay
|
alias Pleroma.Web.ActivityPub.Relay
|
||||||
|
|
||||||
@shortdoc "Manages remote relays"
|
@shortdoc "Manages remote relays"
|
||||||
@moduledoc """
|
|
||||||
Manages remote relays
|
|
||||||
|
|
||||||
## Follow a remote relay
|
|
||||||
|
|
||||||
``mix pleroma.relay follow <relay_url>``
|
|
||||||
|
|
||||||
Example: ``mix pleroma.relay follow https://example.org/relay``
|
|
||||||
|
|
||||||
## Unfollow a remote relay
|
|
||||||
|
|
||||||
``mix pleroma.relay unfollow <relay_url>``
|
|
||||||
|
|
||||||
Example: ``mix pleroma.relay unfollow https://example.org/relay``
|
|
||||||
|
|
||||||
## List relay subscriptions
|
|
||||||
|
|
||||||
``mix pleroma.relay list``
|
|
||||||
"""
|
|
||||||
def run(["follow", target]) do
|
def run(["follow", target]) do
|
||||||
start_pleroma()
|
start_pleroma()
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue