aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/relay.md
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2019-10-05 10:42:29 +0200
committerlain <lain@soykaf.club>2019-10-05 10:42:29 +0200
commitd9aaea44ff02d6a07d3be0f0675830eb51ac85ef (patch)
treece715c85f98875dd0ddf133f95a071fd40b91335 /docs/administration/CLI_tasks/relay.md
parent8e83c8423fa846e82103b20798f0cbde676354ff (diff)
parent9c47d8571c6c46503d9bb836aea933eda6e9e0a5 (diff)
downloadpleroma-d9aaea44ff02d6a07d3be0f0675830eb51ac85ef.tar.gz
Merge remote-tracking branch 'origin/develop' into reactions
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
+```