aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/relay.md
diff options
context:
space:
mode:
authorIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 11:43:49 +0300
committerIvan Tashkinov <ivantashkinov@gmail.com>2019-10-06 11:43:49 +0300
commit06b3bb54c5567fe82ad2a015673fffba667997ee (patch)
tree84bde8abcef86ef398eef0afdc9ae77e5f464bf1 /docs/administration/CLI_tasks/relay.md
parent64095961fe490029886cae358683532ea65bf2c0 (diff)
parent9e34919dcdbeedf8eb623dc86b05f63ef44d8859 (diff)
downloadpleroma-06b3bb54c5567fe82ad2a015673fffba667997ee.tar.gz
Merge remote-tracking branch 'remotes/upstream/develop' into 1234-mastodon-2-4-3-oauth-scopes
# Conflicts: # CHANGELOG.md # lib/pleroma/web/mastodon_api/controllers/account_controller.ex # lib/pleroma/web/mastodon_api/controllers/mastodon_api_controller.ex # lib/pleroma/web/router.ex
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
+```