From d829109a008fbe5a358b409a7195208c928f4730 Mon Sep 17 00:00:00 2001
From: Daniel Berteaud
Date: Thu, 18 Jun 2015 19:29:03 +0200
Subject: [PATCH] Some documentation fixes
---
templates/default/documentation.html.ep | 63 +++++++++++++------------
1 file changed, 32 insertions(+), 31 deletions(-)
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:
- - Video/audio conversations (no limit on the number of peers)
- - Text chat (and you can save history)
- - Screen sharing
- - Email invitations
- - Email notifications when someone joins one of your rooms
+ - Audio/Video conversations (no limit on the number of peers per room)
+ - Text chat (with possibility to save the history)
+ - Screen or single windows sharing sharing
+ - Invite anyone by email
+ - Be notified (by email) when someone joins one of your rooms
- Persistent/reserved rooms
- Chairman functionnalities (mute/pause/kick other peers)
- Grant chairman role to other peers
@@ -52,7 +52,7 @@
- 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:
- - When a client joins a room, it establishes a Websocket link to VROOM. This is called the signaling channel. With this, all peers are able
- to exchange small messages between them. But messages sent through this channels is routed through VROOM server, so it's not yet peer to peer
- - When a second peer joins the same room, he gets through this signaling channel informations about how to connect directly to the other one(s)
+ - When a client joins a room, it establishes a websocket connection to VROOM server.
+ This is called the signaling channel. With this, all peers are able to exchange small messages with each other. But messages sent through this channels are
+ routed through VROOM server, so it's not yet peer to peer
+ - When a second peer joins the same room, he gets informations about how to connect directly to the other one(s) through this signaling channel.
- Now, both peer exchange their video and audio stream directly
- The signaling channel stays open and is used to transmit non sensitive informations (peer colors synchronization, notification of muting/kicking etc...)
- - Everything else (audio/video/text chat) is sent through data channels
+
- Everything else (audio/video/text chat) is sent through data channels
-
- 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