aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/relay.md
diff options
context:
space:
mode:
authorfeld <feld@feld.me>2019-10-04 14:16:28 +0000
committerfeld <feld@feld.me>2019-10-04 14:16:28 +0000
commit31e57cd1b34798afb07a8de4c0c95ef3c15e22ed (patch)
tree461d3d50b855d080eb17f0946213168a87ac7625 /docs/administration/CLI_tasks/relay.md
parentb8b98ac40f042a8c3d2562edc095f0e1a309760f (diff)
parent27110793a7d8e3aa6434bde63a1f687424ae779c (diff)
downloadpleroma-31e57cd1b34798afb07a8de4c0c95ef3c15e22ed.tar.gz
Merge branch 'develop' into 'fix/extended-nickname-format-default-config'
# Conflicts: # CHANGELOG.md
Diffstat (limited to 'docs/administration/CLI_tasks/relay.md')
-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
+```