diff --git a/templates/default/documentation.html.ep b/templates/default/documentation.html.ep index 6ebfc25..b264b74 100644 --- a/templates/default/documentation.html.ep +++ b/templates/default/documentation.html.ep @@ -7,10 +7,10 @@
VROOM (short for Video ROOM) is a simple to use, web-based and opensource (MIT licence) video conferencing application. It's based on several other softwares, most notably the excellent SimpleWebRTC lib. @@ -23,9 +23,9 @@ vLine.com for example). Most of them are more polished than VROOM, but I've found none entirely opensource, so I started this project.
-VROOM implements the following features:
VROOM is translated in French and English. You're welcome to submit patches or pull requests to enhance localization, or add new ones.
-If you want to run your own server, you'll need the following components
This guide assumes that you have installed a minimal CentOS 7 x86_64 system
-
You need to configure both EPEL and FWS repo
@@ -113,9 +113,9 @@ _EOF yum install epel-release-
The follwoing command will install everything required to run VROOM
@@ -125,7 +125,90 @@ yum install git tar wget httpd mod_ssl openssl mariadb-server \\ 'perl(Sesion::Token)' 'perl(Mojolicious::Plugin::Database)' 'perl(Email::Valid)' \\ 'perl(Config::Simple)' 'perl(Session::Token)' 'perl(URI)'- + +
+ Lets install VROOM in /opt/vroom +
+cd /opt +git clone https://github.com/dani/vroom.git ++ +
+ A database will be used to store rooms configuration, you must enable the server. +
+systemctl enable mariadb.service +systemctl start mariadb.service ++ Now, create a new database for VROOM +
+mysql -uroot ++
+CREATE DATABASE `vroom` CHARACTER SET utf8 COLLATE utf8_general_ci; +GRANT ALL PRIVILEGES ON `vroom`.* TO 'vroom'@'localhost' IDENTIFIED BY 'MySuperPassw0rd'; +FLUSH PRIVILEGES; ++ +
+ It's better to generate a long, random password here. Just write it somewhere, you'll need it later +
++ Now that we have our MySQL database, we can create the tables +
+mysql -uroot vroom < /opt/vroom/docs/database/schema.mysql ++ +
+ Two sample apache configurations are provided in the conf directory +
+ In either case, you might want to adjust the apache configuration +
++ The admin interface of VROOM will be available on /vroom/admin (alias) or /admin (vhost) must be protected by your web server. VROOM provides no authentication at all. In the sample configuration, the access is restriucted to localhost, but you can change this to anything you want +
++ You also have to make sure the mod_proxy_ws module is enabled, which is not the case by default on CentOS 7 +
+echo "LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so" \\ + > /etc/httpd/conf.modules.d/00-proxy_ws.conf ++ +
+ Here, we'll copy the sample vroom.service unit so that systemd picks it up +
+cp /opt/vroom/docs/systemd/vroom.service /etc/systemd/system/ +systemctl daemon-reload +systemctl enable vroom ++ +
+ Now, we just need to configure vroom itself. Just copy the sample conf file +
+cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini ++ And edit it to your need +