diff --git a/templates/default/documentation.html.ep b/templates/default/documentation.html.ep index 74a8161..a3566a3 100644 --- a/templates/default/documentation.html.ep +++ b/templates/default/documentation.html.ep @@ -26,7 +26,7 @@ Most of them are more polished than VROOM, but I've found none entirely opensource, so I started this project.

- You can get the source, and folow the development of VROOM on the github page + You can get the source, and follow the development of VROOM on the github page of the project.

@@ -38,11 +38,11 @@

VROOM implements the following features:

- VROOM is available in French and English. You're welcome to submit patches or pull requests to enhance localization, or add new ones. + VROOM is available in French and English. You're welcome to submit patches or pull requests to enhance existing localizations, or add new ones.

@@ -62,19 +62,20 @@

WebRTC allows browsers to browsers direct connections. This provides the best latency as it avoids round trip through a server, which is important with real time communications. But it also ensures the privacy of your communications. VROOM takes advantage of those - new WebRTC technologies, and does the following: + new technologies, and does the following:

-
- As long as possible, data channels are established directly between peers, but in some situations, this is not possible (NAT, firewalls etc...). In those case - data streams are relayed through a TURN server +
+ As long as possible, data channels and audio/video streams are established directly between peers, but in some situations, this is not possible (NAT, firewalls etc...). In those case + data streams are relayed through a TURN server

@@ -82,12 +83,11 @@

The following guide will help you installing VROOM on your own server -

Requirements

- If you want to run your own server, you'll need the following components + If you want to run your own VROOM instance, you'll need the following components

Copy the config you want in /etc/httpd/conf.d/

-
+
In either case, you might want to adjust the apache configuration
@@ -288,7 +289,7 @@ cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini TURN servers will be used by the ICE process. If you plan to use VROOM only on a local network, where each peer can connect to each others, you can just omit this part. But if you want - VROOM to work from anywhere, you'll need use STUN and most likely TURN too. + VROOM to work from anywhere, you'll need to use STUN and most likely TURN too.
  • stun_server: The STUN server(s) to use. For example stun_server = 'stun:stun.l.google.com:19302','stun:vroom.example.net:3478'. @@ -321,7 +322,7 @@ cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini

    This section is for video quality settings. the available settings are

      -
    • frame_rate: Number of frames per seconds for webcam streams. A bigger number will provide a better quality stream +
    • frame_rate: Number of frames per second for webcam streams. A bigger number will provide a better quality stream but will also require more bandwidth and CPU on each peer. The default is 15 fps

    @@ -446,7 +447,7 @@ cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini

    Download the latest version from here and extract the archive

    -
    +
    Branch 3.x is rfc5766-turn-server and 4.x is coturn. 4.x is recommanded
    @@ -491,7 +492,7 @@ use-auth-secret static-auth-secret SuperSecretPassword EOF

    -
    +
    • An SSL certificate is needed for everything to work correctly and securely (/etc/turnserver/cert.pem and /etc/turnserver/key.pem in this example)
    • Both key and certificate must be readable by turnserver user and/or group
    • @@ -518,7 +519,7 @@ systemctl start turnserver
       journalctl -fl -u turnserver.service

      -
      +
      Configuration of your firewall is out of scope for this doc, but you have to ensure the following ports are open:
      • TCP 3478, 3479, 5349, 5350 and 49152 to 65535
      • @@ -571,7 +572,7 @@ git clone https://github.com/ether/etherpad-lite.git chown -R etherpad:etherpad ./etherpad-lite cp -a etherpad-lite/settings.json.template etherpad-lite/settings.json

        -
        +
        Adapt /opt/etherpad-lite/settings.json to your need. The important settings are
        • "requireSession" : true
        • @@ -638,7 +639,7 @@ systemctl restart vroom.service
          As VROOM is still in early development, you'll have to closely follow how the default templates evolve and merge the changes in your own template
          -
          +
          While working on your new template, it's recommanded to switch to the morbo backend as templates will be reloaded automatically after each modification