diff --git a/templates/default/documentation.html.ep b/templates/default/documentation.html.ep index 0a01ace..c84546c 100644 --- a/templates/default/documentation.html.ep +++ b/templates/default/documentation.html.ep @@ -88,26 +88,26 @@ 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 -

-

+

+
For now, VROOM requires SELinux to be disabled, or permissive. You can set this in /etc/selinux/config -

+

Configure the required repositories @@ -174,9 +174,9 @@ 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

@@ -195,14 +195,14 @@ mysql -uroot vroom < /opt/vroom/docs/database/schema.mysql
Copy the config you want in /etc/httpd/conf.d/

-

+

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

@@ -409,9 +409,9 @@ cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini

Download the latest version from here and extract the archive

-

+

Only the 3.x branch is supported -

+

@@ -541,13 +541,13 @@ 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 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 -

+