summaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/relay.md
diff options
context:
space:
mode:
authorrinpatch <rinpatch@sdf.org>2019-12-09 10:27:43 +0000
committerrinpatch <rinpatch@sdf.org>2019-12-09 10:27:43 +0000
commit990cd7ef5d26beb49ed19279844ccc6c1ebe2218 (patch)
treeb24f7ec6372d3b9e931a54e99fabf909e746d22f /docs/administration/CLI_tasks/relay.md
parent1e2bb450dbff1b8c0eee5d131992ec0a9e57c743 (diff)
parenteb9ea8475b19d6a00f690421b193310c09ba40f3 (diff)
downloadpleroma-990cd7ef5d26beb49ed19279844ccc6c1ebe2218.tar.gz
pleroma-990cd7ef5d26beb49ed19279844ccc6c1ebe2218.zip
Merge branch 'feat/docs-otp-source-picker' into 'develop'
docs: add OTP/From source tabs to CLI tasks See merge request pleroma/pleroma!2046
Diffstat (limited to 'docs/administration/CLI_tasks/relay.md')
-rw-r--r--docs/administration/CLI_tasks/relay.md29
1 files changed, 16 insertions, 13 deletions
diff --git a/docs/administration/CLI_tasks/relay.md b/docs/administration/CLI_tasks/relay.md
index aa44617df..c4f078f4d 100644
--- a/docs/administration/CLI_tasks/relay.md
+++ b/docs/administration/CLI_tasks/relay.md
@@ -1,30 +1,33 @@
# 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`.
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
## Follow a relay
-```sh
-$PREFIX follow <relay_url>
+
+```sh tab="OTP"
+./bin/pleroma_ctl relay follow <relay_url>
```
-Example:
-```sh
-$PREFIX follow https://example.org/relay
+```sh tab="From Source"
+mix pleroma.relay follow <relay_url>
```
## Unfollow a remote relay
-```sh
-$PREFIX unfollow <relay_url>
+```sh tab="OTP"
+./bin/pleroma_ctl relay unfollow <relay_url>
```
-Example:
-```sh
-$PREFIX unfollow https://example.org/relay
+```sh tab="From Source"
+mix pleroma.relay unfollow <relay_url>
```
## List relay subscriptions
-```sh
-$PREFIX list
+```sh tab="OTP"
+./bin/pleroma_ctl relay list
+```
+
+```sh tab="From Source"
+mix pleroma.relay list
```