From 4053efa74d2e123e19b34b47557f040ccfe9459f Mon Sep 17 00:00:00 2001 From: Daniel Berteaud Date: Fri, 13 Mar 2015 12:04:29 +0100 Subject: [PATCH] More documentation --- templates/default/documentation.html.ep | 107 +++++++++++++++++++++++++++++--- 1 file changed, 98 insertions(+), 9 deletions(-) diff --git a/templates/default/documentation.html.ep b/templates/default/documentation.html.ep index adc3196..8740561 100644 --- a/templates/default/documentation.html.ep +++ b/templates/default/documentation.html.ep @@ -8,6 +8,9 @@
+ + +

Introduction

@@ -23,6 +26,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.

+ + +

Features

@@ -45,10 +51,15 @@

VROOM is translated in French and English. You're welcome to submit patches or pull requests to enhance localization, or add new ones.

+ + +

Install your own VROOM instance

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

Requirements

@@ -74,19 +85,27 @@ - It's also advised to run VROOM on a systemd powered distribution (simply because that's what I use and I include service units for VROOM). For the same reason, I recommend running Apache as webserver (others like Nginx probably work too, but I provide configuration sample only for Apache) + It's also advised to run VROOM on a systemd powered distribution (simply because that's what I use and I include service units for VROOM). + For the same reason, I recommend running Apache as webserver (others like Nginx probably work too, but I provide configuration sample only for Apache)

-

+

+ VROOM can probably with other DB engine (like PostgreSQL) with minor modifications. + If you're interrested in adding support for other engines, you're welcome to help +

+

While VROOM should run on any distro, it's only tested on CentOS 7 x86_64, so it's the recommended platform. Also, I provide packages for all dependencies in my repository, so it'll be much easier to install it this way. If you have it running on another system, please send me your notes so I can update this documentation.

+ +

Install on CentOS 7 x86_64

This guide assumes that you have installed a minimal CentOS 7 x86_64 system

+

Configure the required repositories

@@ -112,6 +131,7 @@ enablegroups=0 _EOF yum install epel-release

+

Install dependencies

@@ -124,6 +144,7 @@ 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)'

+

Clone the repository

@@ -133,6 +154,7 @@ yum install git tar wget httpd mod_ssl openssl mariadb-server \\ cd /opt git clone https://github.com/dani/vroom.git

+

Database

@@ -157,6 +179,7 @@ FLUSH PRIVILEGES; 
 mysql -uroot vroom < /opt/vroom/docs/database/schema.mysql

+

Setup Apache

@@ -164,7 +187,8 @@ mysql -uroot vroom < /opt/vroom/docs/database/schema.mysql Two sample apache configurations are provided in the conf directory Copy the config you want in /etc/httpd/conf.d/

@@ -172,7 +196,9 @@ mysql -uroot vroom < /opt/vroom/docs/database/schema.mysql 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 + 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 @@ -180,6 +206,7 @@ mysql -uroot vroom < /opt/vroom/docs/database/schema.mysql echo "LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so" \\ > /etc/httpd/conf.modules.d/00-proxy_ws.conf

+

Setup systemd units

@@ -190,6 +217,8 @@ cp /opt/vroom/docs/systemd/vroom.service /etc/systemd/system/ systemctl daemon-reload systemctl enable vroom

+ +

Configure VROOM

@@ -197,19 +226,77 @@ 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 + And edit it to your need. settings.ini has plenty of comments, but here's an explanation of the different sections and settings +

+ +

+ database +

+

+ This section is where you define access to the database used by VROOM. The following settings are available +

+

+ +

+ signaling +

+

+ This section is where you define your signaling server settings. + This is because VROOM was using a modified SignalMaster + as signaling server, which could run on a separate server. Now, the signaling server is directly included in VROOM daemon + so this section might be removed in the future +

+

+ +

+ turn +

+

+ This section defines which STUN and + 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. +

+ + + +

Customize

+ +

Music on hold

- VROOM include 5 different songs available as music on hold. If you want to add more, - just drop your files in public/snd/moh. When loading the page, VROOM will + VROOM includes 5 different songs available as music on hold. If you want to add more, + just drop your files in public/snd/moh. When joining a room, VROOM will randomly choose one file from this directory

+ +

Appearence

@@ -224,15 +311,17 @@ cp -a /opt/vroom/templates/default /opt/vroom/templates/my_template systemctl restart vroom.service And you can start modifying your template.

- As VROOM is still in early development, you'll have to closely follow how the default template evolve and merge the changes in your own template + 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. + While working on your new template, it's recommanded to switch to the morbo backend as templates will be + reloaded automatically after each modification

+ %= include 'js_common'