Merge pull request #124 from s074/pion-docs

add docs for pion webrtc

Author: TheArcaneBrony

docs/setup/server/voice.md

@@ -2,10 +2,23 @@
 
 **Currently only WebRTC connections are supported. UDP connections will be dropped** 
 
-Voice support is left as an optional dependency in {{ project.name }}, which means that it is disabled by default unless you decide to install additional dependencies. {{ project.name }} is designed so that anyone can develop a voice package compatible with the project as long as the implementation adheres to the [WebRTC types]({{ repositories.base_url }}/{{ repositories.voice_types }}). Currently there are two sample implementations which can be used:
-
-- [Medooze Implementation]({{ repositories.base_url }}/{{ repositories.voice_medooze }}) - Supports video&audio for guild voice, DM voice, as well as GoLive streams. Only supports Linux & MacOS environments.
-- [Mediasoup Implementation]({{ repositories.base_url }}/{{ repositories.voice_mediasoup }}) - Supports audio only for guild voice, DM voice, and GoLive streams. Supports Windows, Linux, and MacOS environments
+Voice support is left as an optional dependency in {{ project.name }}, which means that it is disabled by default unless you decide to install additional dependencies. {{ project.name }} is designed so that anyone can develop a voice package compatible with the project as long as the implementation adheres to the [WebRTC types]({{ repositories.base_url }}/{{ repositories.voice_types }}). Currently there are three sample implementations which can be used:
+
+- (**Recommended**) [Pion Implementation]({{ repositories.base_url }}/{{repositories.voice_pion }}) - Golang SFU which is bridged via IPC to communicate with your voice gateway
+    - ✅ Video
+    - ✅ Audio
+    - ✅ Guild + DM voice
+    - ✅ Go Live streams
+- [Medooze Implementation]({{ repositories.base_url }}/{{ repositories.voice_medooze }}) - SFU written in C++ with Node.js native bindings
+    - ✅ Video
+    - ✅ Audio
+    - ✅ Guild + DM voice
+    - ✅ Go Live streams
+- [Mediasoup Implementation]({{ repositories.base_url }}/{{ repositories.voice_mediasoup }}) - From the Mediasoup FAQ: "mediasoup launches a set of C++ child processes (media workers) and communicates with them by means of inter-process communication"
+    - ❌ Video
+    - ✅ Audio
+    - ✅ Guild + DM voice
+    - ❌ Go Live streams (no video, only audio)
 
 ## Configuring Voice Gateway
 
@@ -18,7 +31,7 @@ WRTC_WS_PORT=3004
 You also have to configure the Voice Gateway endpoint in your database. In table `config` you can set the default region endpoint to your Voice Gateway domain. It is set to `localhost:3004` by default:
 
 ```
-"regions_available_0_endpoint":   "localhost:3004"
+"regions_available_0_endpoint":   "voice.example.com:3004"
 ```
 
 ### Nginx reverse proxy for Voice Gateway
@@ -56,6 +69,28 @@ server {
 
 You can install one of the provided sample implementations or you can choose to install another third-party one. Installation process will be the same regardless:
 
+### Pion implementation installation
+
+1. First install the package in your {{ project.name }} server:
+
+    ```
+    npm install {{ npm_packages.voice_pion }} --no-save
+    ```
+
+2. Configure the package name in your {{ project.name }} server `.env`:
+
+    ```
+    WRTC_LIBRARY={{ npm_packages.voice_pion }}
+    ```
+
+3. Download the Golang SFU from [Pion Repository]({{ repositories.base_url }}/{{repositories.voice_pion }})
+4. Make sure you have Golang installed, then start your SFU:
+    ```
+    cd pion-sfu
+    go run . -port <udp port> -ip <your server public ip>
+    ```
+The ip should be a public IP that can be accessed from the internet if this is a production instance. It will be the address that will get sent to the client during the WebRTC connection negotiation
+
 ### Medooze implementation installation
 
 1. First install the package in your {{ project.name }} server:
@@ -78,4 +113,20 @@ You can install one of the provided sample implementations or you can choose to
 
 ### Mediasoup implementation installation
 
-The process is exactly the same as the Medooze installation, just replace the package name in the commands with ` {{ npm_packages.voice_mediasoup }} `
+1. First install the package in your {{ project.name }} server:
+
+    ```
+    npm install {{ npm_packages.voice_mediasoup }} --no-save
+    ```
+
+2. Configure the package name in your {{ project.name }} server `.env`:
+
+    ```
+    WRTC_LIBRARY={{ npm_packages.voice_mediasoup }}
+    ```
+
+3. Configure the public IP for your WebRTC server in your {{ project.name }} server `.env`. This should be a public IP that can be accessed from the internet if this is a production instance. It will be the address that will get sent to the client during the WebRTC connection negotiation:
+
+    ```
+    WRTC_PUBLIC_IP=127.0.0.1
+    ```

mkdocs.yml

@@ -12,15 +12,17 @@ extra:
         server: spacebarchat/server
         client: spacebarchat/client
         voice_types: spacebarchat/spacebar-webrtc-types
-        voice_medooze: spacebarchat/medooze-spacebar-wrtc
-        voice_mediasoup: spacebarchat/mediasoup-spacebar-wrtc
+        voice_pion: spacebarchat/pion-webrtc
+        voice_medooze: spacebarchat/medooze-webrtc
+        voice_mediasoup: spacebarchat/mediasoup-webrtc
         missing_routes: spacebarchat/missing-routes
         main: &repo_url https://github.com/spacebarchat/spacebarchat # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
     site:
         name: &site_name Spacebar Documentation
         description: &site_description "Documentation for Spacebar: a free open source selfhostable chat, voice and video discord-compatible platform"
         edit_uri: &edit_uri https://github.com/spacebarchat/docs/edit/master/docs/ # This gets read by mkdocs without being pre-proccessed by mkdocs-macros, which is why the URL is in full.
     npm_packages:
+        voice_pion: "@spacebarchat/pion-webrtc"
         voice_medooze: "@spacebarchat/medooze-webrtc"
         voice_mediasoup:  "mediasoup-spacebar-wrtc"
 site_name: *site_name