summaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/relay.md
diff options
context:
space:
mode:
authorIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 09:30:49 +0300
committerIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 09:30:49 +0300
commitf459aabdfafa990b33610438650f882ccac072d2 (patch)
treee5bfcb4f8fc7c2dd06e08f90b3a841c4f9ad759a /docs/administration/CLI_tasks/relay.md
parent6ffa2b5f661c2db424334c6fb5de6f4d1bfeb745 (diff)
parent9e34919dcdbeedf8eb623dc86b05f63ef44d8859 (diff)
downloadpleroma-f459aabdfafa990b33610438650f882ccac072d2.tar.gz
pleroma-f459aabdfafa990b33610438650f882ccac072d2.zip
Merge remote-tracking branch 'remotes/upstream/develop' into 1260-rate-limited-auth-actions
# 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
+```