aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/relay.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/administration/CLI_tasks/relay.md')
-rw-r--r--docs/administration/CLI_tasks/relay.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/relay.md b/docs/administration/CLI_tasks/relay.md
new file mode 100644
index 0000000..bdd7e8b
--- /dev/null
+++ b/docs/administration/CLI_tasks/relay.md
@@ -0,0 +1,45 @@
+# Managing relays
+
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+
+## Follow a relay
+
+=== "OTP"
+
+ ```sh
+ ./bin/pleroma_ctl relay follow <relay_url>
+ ```
+
+=== "From Source"
+
+ ```sh
+ mix pleroma.relay follow <relay_url>
+ ```
+
+## Unfollow a remote relay
+
+=== "OTP"
+
+ ```sh
+ ./bin/pleroma_ctl relay unfollow <relay_url>
+ ```
+
+=== "From Source"
+
+ ```sh
+ mix pleroma.relay unfollow <relay_url>
+ ```
+
+## List relay subscriptions
+
+=== "OTP"
+
+ ```sh
+ ./bin/pleroma_ctl relay list
+ ```
+
+=== "From Source"
+
+ ```sh
+ mix pleroma.relay list
+ ```