Merge branch 'develop' into feature/gen-magic
[akkoma] / docs / administration / CLI_tasks / relay.md
index aa44617dfbba08822da6da6ed82df1533e9d14bc..bdd7e8be4cba27128182c2ebaabe389897236fba 100644 (file)
@@ -1,30 +1,45 @@
 # 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>
-```
 
-Example:
-```sh
-$PREFIX follow https://example.org/relay
-```
+=== "OTP"
+
+    ```sh
+    ./bin/pleroma_ctl relay follow <relay_url>
+    ```
+
+=== "From Source"
+
+    ```sh
+    mix pleroma.relay follow <relay_url>
+    ```
 
 ## Unfollow a remote relay
 
-```sh
-$PREFIX unfollow <relay_url>
-```
+=== "OTP"
+
+    ```sh
+    ./bin/pleroma_ctl relay unfollow <relay_url>
+    ```
 
-Example:
-```sh
-$PREFIX unfollow https://example.org/relay
-```
+=== "From Source"
+
+    ```sh
+    mix pleroma.relay unfollow <relay_url>
+    ```
 
 ## List relay subscriptions
 
-```sh
-$PREFIX list
-```
+=== "OTP"
+
+    ```sh
+    ./bin/pleroma_ctl relay list
+    ```
+
+=== "From Source"
+
+    ```sh
+    mix pleroma.relay list
+    ```