summaryrefslogtreecommitdiff
path: root/docs/administration
diff options
context:
space:
mode:
authorrinpatch <rinpatch@sdf.org>2019-10-03 09:10:31 +0300
committerrinpatch <rinpatch@sdf.org>2019-10-03 09:10:31 +0300
commit808d0a0170577155d0f1097c66c4e0b23c8303b9 (patch)
treeae1476cec769f40742cd9d62e1ee35afe6622406 /docs/administration
parent6435ba83cd07162a9ad9a386253814e2f12d951d (diff)
downloadpleroma-808d0a0170577155d0f1097c66c4e0b23c8303b9.tar.gz
pleroma-808d0a0170577155d0f1097c66c4e0b23c8303b9.zip
Move relay docs to a separate file
Diffstat (limited to 'docs/administration')
-rw-r--r--docs/administration/CLI_tasks/relay.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/relay.md b/docs/administration/CLI_tasks/relay.md
new file mode 100644
index 000000000..aa44617df
--- /dev/null
+++ b/docs/administration/CLI_tasks/relay.md
@@ -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
+```